Media Types
The Akana API Platform API uses the media types listed below, in either the request or response messages or both.
| Mediatype | in Req? | In Resp? | Description |
|---|---|---|---|
| application/json | Yes | Yes | JSON format. |
| application/vnd.soa.v71+json | Yes | Yes | A custom media type that can be used with version 7.1 of the product (and later): essentially, a JSON format. |
| application/vnd.soa.v72+json | Yes | Yes | A custom media type that can be used with version 7.2 of the product (and later): essentially, a JSON format. |
| application/vnd.soa.v80+json | Yes | Yes | A custom media type that can be used with version 8.0 of the product (and later): essentially, a JSON format. |
| application/vnd.soa.v81+json | Yes | Yes | A custom media type that can be used with version 8.1 of the product (and later): essentially, a JSON format. |
| application/vnd.soa.v83+json | Yes | Yes | A custom media type that can be used with version 8.3 of the product (and later): essentially, a JSON format. |
| application/vnd.soa.v84+json | Yes | Yes | A custom media type that can be used with version 8.4 of the product (and later): essentially, a JSON format. |
| application/vnd.soa.v85+json | Yes | Yes | A custom media type that can be used with version 2018 of the product (and later): essentially, a JSON format. |
| application/xml | Yes | Yes | XML format. |
| application/vnd.soa.v71+xml | Yes | Yes | A custom media type that can be used with version 7.1 of the product (and later): essentially, an XML format. |
| application/vnd.soa.v72+xml | Yes | Yes | A custom media type that can be used with version 7.2 of the product (and later): essentially, an XML format. |
| application/vnd.soa.v80+xml | Yes | Yes | A custom media type that can be used with version 8.0 of the product (and later): essentially, an XML format. |
| application/vnd.soa.v81+xml | Yes | Yes | A custom media type that can be used with version 8.1 of the product (and later): essentially, an XML format. |
| application/vnd.soa.v83+xml | Yes | Yes | A custom media type that can be used with version 8.3 of the product (and later): essentially, an XML format. |
| application/vnd.soa.v84+xml | Yes | Yes | A custom media type that can be used with version 8.4 of the product (and later): essentially, an XML format. |
| application/vnd.soa.v2019+json | Yes | Yes | A custom media type that can be used with version 2019 of the product (and later): essentially, a JSON format. |
| application/x-www-form-urlencoded | Yes | No | The message information is URL-encoded. For example, the POST passwordmanagement/sendPasswordResetCode operation takes the user's email address as a form parameter. The request message must be URL-encoded, so the @ sign in the email address is encoded to %40 for sending over HTTP. |
| */* | Yes | No | Used in a request to indicate that the expected response can be any format. |
| image/jpeg | Yes | Yes | Used to upload or fetch an image, such as an avatar. |
| multipart/form-data | Yes |
A format used when the content has multiple sections of different content types. The multipart/form-data media type has separate components, separated by boundaries, and each component has its own media type. An example of usage is the POST /api/dropbox/pictures method where the message includes some text and also an image. For more information about operations that support file upload, see File Upload with Ajax. For more information about uploading files to the platform with the multipart/form-data media type, see Managing Multipart/Form-Data Uploads. |
|
| text/markdown | No | No |
Indicates that the content is some type of markup; that is, essentially plain text with some formatting instruction syntax included, such as bold, italics, or heading style, to determine how the content is displayed. Used in association with certain board items, such as discussions or tickets, to identify whether the board item is in plain text or uses markup to add formatting. |
| text/plain | Yes | Plain text. | |
| text/xml | Yes | Yes | XML format. |