Ana içeriğe atla

Documentation Index

Fetch the complete documentation index at: https://docs.apinizer.com/llms.txt

Use this file to discover all available pages before exploring further.

General Information

Policy Type

policy-response-protocol-transformation
Important: This policy is automatically managed by the system. It is added to the API Proxy when SOAP/REST transformation is enabled during API Proxy creation. It cannot be added, updated, or deleted via API. It is only visible in the List Policies response.

List Policies

This policy appears in the List Policies response when an API Proxy has SOAP/REST transformation enabled.

Endpoint

GET /apiops/projects/{projectName}/apiProxies/{apiProxyName}/policies/

Request

Headers

HeaderValue
AuthorizationBearer {token}

Path Parameters

ParameterTypeRequiredDescription
projectNamestringYesProject name
apiProxyNamestringYesAPI Proxy name

Response

Success Response (200 OK)

{
  "status": "SUCCESS",
  "resultList": [
    {
      "apiProxy": {
        "name": "MyAPI",
        "requestPolicyList": [],
        "responsePolicyList": [
          {
            "type": "policy-response-protocol-transformation",
            "name": "soap-to-rest-transformation",
            "description": "Transform SOAP responses to REST",
            "active": true,
            "apiMethodList": [
              {
                "name": "getUser",
                "description": "Get user information",
                "active": true,
                "httpMethod": "GET",
                "backendResourceUrl": "/soap/UserService",
                "backendHttpMethod": "POST"
              },
              {
                "name": "createUser",
                "description": "Create a new user",
                "active": true,
                "httpMethod": "POST",
                "backendResourceUrl": "/soap/UserService",
                "backendHttpMethod": "POST"
              }
            ],
            "policyCondition": null,
            "errorMessageList": []
          }
        ],
        "errorPolicyList": []
      }
    }
  ],
  "resultCount": 1
}

Policy Object Fields

FieldTypeDescription
typestring"policy-response-protocol-transformation"
namestringPolicy name
descriptionstringPolicy description
activebooleanWhether the policy is active
apiMethodListarrayList of API method configurations (see below)
policyConditionobjectPolicy condition (null if not set)
errorMessageListarrayList of error messages

API Method Object (apiMethodList)

FieldTypeDescription
namestringAPI Method name
descriptionstringAPI Method description
activebooleanWhether the method is active
httpMethodstringHTTP method exposed to clients (e.g., GET, POST, PUT, DELETE)
backendResourceUrlstringBackend SOAP service resource URL
backendHttpMethodstringBackend HTTP method (typically POST for SOAP)

cURL Example

curl -X GET \
  'https://api.apinizer.com/apiops/projects/my-project/apiProxies/my-api/policies/' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Add / Update / Delete Policy

Not Supported: This policy cannot be added, updated, or deleted via API. It is automatically managed by the system and is tied to the SOAP/REST transformation configuration of the API Proxy. To enable or disable this policy, configure SOAP/REST transformation settings in the API Proxy configuration.