Skip to content

Latest commit

 

History

History
128 lines (96 loc) · 3.27 KB

api-post.md

File metadata and controls

128 lines (96 loc) · 3.27 KB
Raw

PATCH | TOC | PUT

POST

POST queries data about XPath axes and functions via transformation. For this, an XSLT stylesheet is sent with the request-body, which is then applied by the XSLT processor to the data in storage. Thus the content type application/xslt+xml is always required. The client defines the content type for the output with the output-tag and the method-attribute.

The XPath is optional for this method and is used to limit and preselect the data. If the XPath addresses one or more attributes as preselection, then tags of the same name of these attributes are used, which contain the value of the attribute as content.

The processing is strict and does not accept unnecessary spaces.

Contents Overview

Request

POST /<xpath> HTTP/1.0
Storage: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ (identifier)
Content-Length: (bytes)
Content-Type: application/xslt+xml
    Request-Body
XSLT stylesheet

Example

POST /xmex!/ HTTP/1.0
Storage: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ books
Content-Type: application/xslt+xml
Content-Length: 212

<?xml version="1.0"?>
<xsl:stylesheet version="1.0"
    xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
  <xsl:output method="xml"/>
  <xsl:template match="/">
    ...
  </xsl:template>
</xsl:stylesheet>

Response

HTTP/1.0 200 Success
Storage: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ (identifier)
Storage-Revision: Revision (number)   
Storage-Space: Total/Used (bytes)
Storage-Last-Modified: Timestamp (RFC822)
Storage-Expiration: Timestamp (RFC822)
Storage-Expiration-Time: Timeout (milliseconds)
Content-Length: (bytes)

Example

HTTP/1.0 200 Success
Date: Wed, 11 Nov 2020 12:00:00 GMT
Access-Control-Allow-Origin: *
Storage: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ
Storage-Revision: 123
Storage-Space: 262144/1363 bytes
Storage-Last-Modified: Wed, 11 Nov 20 12:00:00 +0000
Storage-Expiration: Wed, 11 Nov 20 12:00:00 +0000
Storage-Expiration-Time: 900000 ms
Content-Length: 26
Content-Type: application/xml
Execution-Time: 4 ms

<?xml version="1.0"?>
...

Response codes / behavior

HTTP/1.0 200 Success

  • Request was successfully executed

HTTP/1.0 204 No Content

  • TODO:

HTTP/1.0 400 Bad Request

  • Storage header is invalid, 1 - 64 characters (0-9A-Z_) are expected
  • XPath is missing or malformed
  • XSLT Stylesheet is erroneous

HTTP/1.0 404 Resource Not Found

  • Storage does not exist

HTTP/1.0 415 Unsupported Media Type

  • Attribute request without Content-Type text/plain

HTTP/1.0 422 Unprocessable Entity

  • Data in the request body cannot be processed

HTTP/1.0 500 Internal Server Error

  • An unexpected error has occurred.

PATCH | TOC | PUT