Page last modified 06:56, 21 Jun 2008 by SteveB
How do I...Get an overview of the MindTouch API?
Table of contents
- 1. Overview
- 1.1.1.1. Configuration
- 1.1.1.2. Features
- 2. Implementation Notes
Overview
Assembly: mindtouch.dekiClass: MindTouch.Deki.DekiWikiService
SID: sid://mindtouch.com/2006/11/dekiwiki
Configuration
| Name | Type | Description |
| admin-db-password | string | Database administrator password. |
| admin-db-user | string? | Database administrator user name (default: "root"). |
| apikey | string? | Key to access protected features of the service. |
| authtoken-salt | string | Private key used to generate unique auth tokens |
| banned-words | string? | Comma separated list of banned words |
| deki-db-catalog | string? | Database table name (default: wikidb). |
| deki-db-options | string | Optional connection string parameters |
| deki-db-password | string | Password for database user. |
| deki-db-port | int? | Database port (default: 3306). |
| deki-db-server | string? | Database host name (default: localhost). |
| deki-db-user | string? | Database user name (default: wikiuser). |
| deki-language | string? | Site language (default: "en-US"). |
| deki-path | string | Application installation folder |
| deki-resources-path | string? | Path to resources folder (default: "%deki-path%/resources") |
| deki-signature | string? | Puglic Digital Signature key to verify incoming requests from MindTouch. (default: none) |
| deki-sitename | string? | Site name (default: "MindTouch"). |
| imagemagick-convert-path | string | Path to ImageMagick converter tool |
| imagemagick-identify-path | string | Path to ImageMagick identify tool |
| max-image-size | int? | Maximum supported image size in bytes or 0 for no limit (default: 0). |
| service-license | string? | signed service-license |
| uri.log | uri? | Uri for logging service. |
| uri.self | uri | Uri for current service (provided by Host). |
Features
| Name | Description |
| *:site/services/{id}/proxy//* | Proxy requets to a service. |
| DELETE:archive/files/{fileid} | Remove a file from the archive (wipe) |
| DELETE:archive/files | Removes all files from the archive (wipe) |
| DELETE:files/{fileid}/description | Reset the file description |
| DELETE:files/{fileid}/properties/{key} | Remove an attachment property |
| DELETE:files/{fileid}/{filename} | Delete file attachment |
| DELETE:files/{fileid} | Delete file attachment |
| DELETE:groups/{groupid}/users/{userid} | Remove given member from a group |
| DELETE:groups/{groupid} | Remove a group |
| DELETE:pages/{pageid}/comments/{commentnumber} | Mark a comment as being deleted. This hides comment content from non admins |
| DELETE:pages/{pageid}/files/{filename}/description | Reset the file description |
| DELETE:pages/{pageid}/files/{filename} | Delete file attachment |
| DELETE:pages/{pageid}/properties/{key} | Remove a page property |
| DELETE:pages/{pageid}/security | Reset page restricts and grants |
| DELETE:pages/{pageid} | Deletes a page and optionally descendant pages by moving them to the archive |
| DELETE:site/bans/{banid} | Remove a ban entry |
| DELETE:site/logo.png | Remove the site logo |
| DELETE:site/logo | Remove the site logo |
| DELETE:site/properties/{key} | Remove a site property |
| DELETE:site/services/{id} | Delete a service |
| DELETE:users/{userid}/properties/{key} | Remove a user property |
| DELETE: | Stop service |
| GET:$files/{name} | Retrieve file contents |
| GET:archive/files/{fileid}/info | Retrieves file info for a deleted file |
| GET:archive/files/{fileid}/{filename} | Retrieve file attachment content |
| GET:archive/files/{fileid} | Retrieves file content for a deleted file |
| GET:archive/files | Retrieves file info for all deleted files |
| GET:archive/pages/{pageid}/contents | Retrieve the contents of a deleted page for previewing |
| GET:archive/pages/{pageid}/info | Retrieve basic page information for the deleted page |
| GET:archive/pages/{pageid}/subpages | Retrieve the child pages that were deleted as well from deleting the given page |
| GET:archive/pages/{pageid} | Retrieve basic page information for the deleted page |
| GET:archive/pages | Retrieve the pages that can be potentially restored from deletion. |
| GET:archive | Retrieves a summary of available archive information |
| GET:comments/{commentid} | Retrieve a comment and metadata |
| GET:files/{fileid}/description | retrieves a file description |
| GET:files/{fileid}/info | Retrieve file attachment information |
| GET:files/{fileid}/properties/{key}/info | Retrieve the metadata about an attachment property |
| GET:files/{fileid}/properties/{key} | Retrieve the content of an attachment property |
| GET:files/{fileid}/properties | Retrieve the properties associated with a file attachment |
| GET:files/{fileid}/revisions | Retrieve file revision info |
| GET:files/{fileid}/{filename} | Retrieve file attachment content |
| GET:files/{fileid} | Retrieve file attachment content |
| GET:files | Retrieve information for all attached files |
| GET:groups/{groupid}/users | Return a list of users in a group |
| GET:groups/{groupid} | Retrieve group information |
| GET:groups | Retrieve list of groups. |
| GET:license | Retrieve server license. Requires ADMIN permission to retrieve private information, otherwise only the public information is obtained. |
| GET:pages/popular | Retrieves a list of popular pages. |
| GET:pages/{pageid}/aliases | Retrieve list of page aliases |
| GET:pages/{pageid}/comments/{commentnumber}/content | Retrieve the comment text only |
| GET:pages/{pageid}/comments/{commentnumber} | Retrieve a comment and metadata |
| GET:pages/{pageid}/comments | Retrieve the comments on a page |
| GET:pages/{pageid}/contents | Retrieve the contents of a page. |
| GET:pages/{pageid}/diff | Show changes between revisions |
| GET:pages/{pageid}/feed/new | Retrieve feed of new page creations |
| GET:pages/{pageid}/feed | Retrieve feed of page changes |
| GET:pages/{pageid}/files,subpages | Retrieves a list of files and subpages for a given page |
| GET:pages/{pageid}/files/{filename}/description | retrieves a file description |
| GET:pages/{pageid}/files/{filename}/info | Retrieve file attachment information |
| GET:pages/{pageid}/files/{filename}/revisions | Retrieve file revision info |
| GET:pages/{pageid}/files/{filename} | Retrieve file attachment content |
| GET:pages/{pageid}/files | Retrieves a list of files for a given page |
| GET:pages/{pageid}/info | Retrieve page information |
| GET:pages/{pageid}/links | Retrieve list of inbound or outbound page links |
| GET:pages/{pageid}/pdf | Export a page to PDF |
| GET:pages/{pageid}/properties/{key}/info | Retrieve the metadata about a page property |
| GET:pages/{pageid}/properties/{key} | Retrieve the content of a page property |
| GET:pages/{pageid}/properties | Retrieve the properties associated with a page |
| GET:pages/{pageid}/ratings | Retrieve the page rating |
| GET:pages/{pageid}/revisions | Retrieve revision history of a given title |
| GET:pages/{pageid}/security | Retrieve page security info |
| GET:pages/{pageid}/subpages | Retrieve list of sub-pages |
| GET:pages/{pageid}/subscribers | Retrieve list of subscribed users |
| GET:pages/{pageid}/tags | Retrieve the tags on a page |
| GET:pages/{pageid}/tree | Builds a site map starting from a given page. |
| GET:pages/{pageid} | Retrieve aggregate page information including attachments |
| GET:pages | Builds a site map starting from 'home' page. |
| GET:site/bans/{banid} | See a specific ban entry |
| GET:site/bans | Get a list of all IP and user bans |
| GET:site/feed/new | Retrieve feed of new page creations |
| GET:site/feed | Retrieve feed of site changes |
| GET:site/functions | Get list of available extensions |
| GET:site/localization | Retrieve a resource string localized for the current user, or provided culture |
| GET:site/logo.png | Retrieve the site logo image |
| GET:site/logo | Retrieve the site logo image |
| GET:site/nav/{pageid}/children,siblings | Retrieve <div> tags for the sub-pages and sibling pages of the given page. |
| GET:site/nav/{pageid}/children | Retrieve <div> tags for the sub-pages of the given page. |
| GET:site/nav/{pageid}/full | Retrieve <div> tags of the full navigation tree for the given page. |
| GET:site/nav/{pageid}/siblings | Retrieve <div> tags for sibling pages of the given page. |
| GET:site/opensearch/description | Get the OpenSearch Description document |
| GET:site/opensearch/suggestions | Search the site index |
| GET:site/opensearch | Search the site index |
| GET:site/operations | Retrieve all known security operations |
| GET:site/properties/{key}/info | Retrieve the metadata about a site property |
| GET:site/properties/{key} | Retrieve the content of a site property |
| GET:site/properties | Retrieve the properties associated with the site |
| GET:site/query/log/terms | Get tracked search terms |
| GET:site/query/log/{queryid} | Get tracked search detail |
| GET:site/query/log | Get tracked search data. |
| GET:site/query | Search the site index with analytical tracking. Primarily for user facing search. |
| GET:site/roles/{roleid} | Retrieve a role |
| GET:site/roles | Retrieve list of defined roles |
| GET:site/search/properties | Retrieve all pages with a specified property |
| GET:site/search/rebuild | Return rebuild information |
| GET:site/search | Search the site index |
| GET:site/services/{id} | Retrieve service. |
| GET:site/services | Retrieve list of services. |
| GET:site/settings | Retrieve all configuration settings |
| GET:site/status | Get mindtouch instance status information |
| GET:site/tags/{tagid} | Retrieve pages with tag |
| GET:site/tags | Retrieve all tags |
| GET:users/authenticate | Authenticate a user given http header Credentials or an auth token. Response status 200 implies valid credentials and contains a new auth token. |
| GET:users/{userid}/favorites/feed | Retrieve feed of user favorites changes |
| GET:users/{userid}/favorites | Retrieves a list of favorite pages for a user. |
| GET:users/{userid}/feed | Retrieve feed of user contributions |
| GET:users/{userid}/properties/{key}/info | Retrieve the metadata about a user property |
| GET:users/{userid}/properties/{key} | Retrieve the content of a user property |
| GET:users/{userid}/properties | Retrieve the properties associated with a user |
| GET:users/{userid} | Retrieve information about a user. |
| GET:users | Retrieve list of users. |
| GET: | Retrieve extension description |
| HEAD:$files/{name} | Retrieve file headers |
| HEAD:files/{fileid}/{filename} | Retrieve file attachment content (Note: image manipulation arguments are ignored for HEAD requests) |
| HEAD:files/{fileid} | Retrieve file attachment content (Note: image manipulation arguments are ignored for HEAD requests) |
| HEAD:pages/{pageid}/files/{filename} | Retrieve file attachment content (Note: image manipulation arguments are ignored for HEAD requests) |
| LOCK:files/{fileid}/{filename} | Lock file (always returns 412 - Precondition Failed) |
| LOCK:files/{fileid} | Lock file (always returns 412 - Precondition Failed) |
| LOCK:pages/{pageid}/files/{filename} | Lock file (always returns 412 - Precondition Failed) |
| OPTIONS:files/{fileid}/{filename} | Retrieve available HTTP options |
| OPTIONS:files/{fileid} | Retrieve available HTTP options |
| OPTIONS:pages/{pageid}/files/{filename} | Retrieve available HTTP options |
| POST:archive/files/restore/{fileid} | Restores a deleted file back to its page |
| POST:archive/pages/{pageid}/restore | Restore all revisions of a given page |
| POST:files/{fileid}/copy | Copy an attachment from one page to another and/or change the filename |
| POST:files/{fileid}/index | re-index an attachment |
| POST:files/{fileid}/move | Move an attachment from one page to another and/or change the filename |
| POST:files/{fileid}/properties | Create an attachment property |
| POST:files/{fileid}/revisions | Performs operations such as hide/unhide for revisions of files |
| POST:groups/{groupid}/users | Add members to a group |
| POST:groups | Add or modify a group |
| POST:pages/{pageid}/allowed | Filter a list of user ids based on access to the page |
| POST:pages/{pageid}/comments | Post a new comment to a page |
| POST:pages/{pageid}/contents | Update contents of a page |
| POST:pages/{pageid}/copy | Copy page to a new location |
| POST:pages/{pageid}/files/{filename}/revisions | Performs operations such as hide/unhide for revisions of files |
| POST:pages/{pageid}/index | re-index a page and it's attributes |
| POST:pages/{pageid}/message/*//* | Post a custom page event into the pubsub bus (limited to 128KB) |
| POST:pages/{pageid}/move | Move page to a new location |
| POST:pages/{pageid}/properties | Create a page property |
| POST:pages/{pageid}/ratings | Rate the quality of a page |
| POST:pages/{pageid}/revert | Revert page to an earlier revision |
| POST:pages/{pageid}/revisions | Performs operations such as hide/unhide for revisions of pages |
| POST:pages/{pageid}/security | Modify page security by adding and removing grants |
| POST:site/bans | Create a ban entry |
| POST:site/export | Generates export information |
| POST:site/import | Generates import information |
| POST:site/properties | Create a site property |
| POST:site/query/{queryid} | Register a tracked search result selection. |
| POST:site/search/rebuild | Rebuild the site index |
| POST:site/services/{id}/start | Start or restart a service |
| POST:site/services/{id}/stop | Stop a service |
| POST:site/services/{id} | Restart a service (backwards compatibility) |
| POST:site/services | Add a service (backward compatibility: empty body will restart all services) |
| POST:users/authenticate | Authenticate a user given http header Credentials or an auth token. When using external authentication, this will automatically create an account and synchronize groups. Response status 200 implies valid credentials and contains a new auth token. |
| POST:users/{userid}/allowed | Check one or more resources if given operation is allowed. |
| POST:users/{userid}/properties | Create a user property |
| POST:users | Add or modify a user |
| POST:{function} | Invoke extension function |
| PUT:files/{fileid}/description | Update attachment description |
| PUT:files/{fileid}/properties/{key} | Update an existing attachment property |
| PUT:files/{fileid}/properties | Perform changes on multiple attachment properties |
| PUT:files/{fileid}/{filename} | Replace an existing attachment with a new version |
| PUT:files/{fileid} | Replace an existing attachment with a new version |
| PUT:groups/{groupid}/users | Set the members for a group |
| PUT:groups/{groupid} | Modify an existing group |
| PUT:license | Update server license. |
| PUT:pages/{pageid}/comments/{commentnumber}/content | Edit the specified comment |
| PUT:pages/{pageid}/files/{filename}/description | Update attachment description |
| PUT:pages/{pageid}/files/{filename}/properties/{key} | Update an existing attachment property |
| PUT:pages/{pageid}/files/{filename} | Replace an existing attachment with a new version or create a new attachment |
| PUT:pages/{pageid}/properties/{key} | Update an existing page property |
| PUT:pages/{pageid}/properties | Perform changes on multiple page properties |
| PUT:pages/{pageid}/security | Set page security info |
| PUT:pages/{pageid}/subscribers/{userid} | Subscribe user to a page |
| PUT:pages/{pageid}/tags | Sets the tags on a page. |
| PUT:site/logo.png | Save a new site logo image |
| PUT:site/logo | Save a new site logo image |
| PUT:site/properties/{key} | Update an existing site property |
| PUT:site/properties | Perform changes on multiple site properties |
| PUT:site/roles/{roleid} | Modify or add a role |
| PUT:site/services/{id} | Update a service |
| PUT:site/settings | Set all configuration settings |
| PUT:users/{userid}/password | Set password for a given user. |
| PUT:users/{userid}/properties/{key} | Update an existing user property |
| PUT:users/{userid}/properties | Perform changes on multiple user properties |
| PUT:users/{userid} | Modify an existing user |
Implementation Notes
To learn more about a particular feature, click on the corresponding link above.
- Tag page
- What links here
| Images 0 | ||
|---|---|---|
| No images to display in the gallery. |
You must login to post a comment.
Copyright © 2011 MindTouch, Inc. Powered by