The API Default Profile
When first setting up an API in the platform, or when adding a new API version, the API owner can specify a default profile. This defines the input and output media types that are most commonly valid for operations within the API. For example:
- JSON: "DefaultProfile":"JSON in and out"
- XML: <DefaultProfile>XML in and out</DefaultProfile>
If an API version has a default profile, those values are automatically assigned to any new operations added. However, the default values can be changed as needed. The default profile is a value intended to minimize API setup work.
The default profiles are listed below.
| This Default Profile... | Corresponds to these Request/Response Media Types... |
|---|---|
| Any in and out |
Request: */* Response: */* |
| JSON in and out |
Request: application/json Response: application/json |
| Form in/JSON out |
Request: application/x-www-form-urlencoded Response: application/json |
| Form in/XML or JSON out |
Request: application/x-www-form-urlencoded Response: application/xml, text/xml, application/json |
| XML or JSON in/XML or JSON out |
Request: application/xml, text/xml, application/json Response: application/xml, text/xml, application/json |
| Form in/Any out |
Request: application/x-www-form-urlencoded Response: */* |
| Form in/XML out |
Request: application/x-www-form-urlencoded Response: application/xml, text/xml |
| XML in and out |
Request: application/xml, text/xml Response: application/xml, text/xml |