Reduced Integration Responses

Deprecation Notice

The following deprecation has been issued in the Itential Platform 6 release, with the change scheduled to be made in the Platform 6.1 version.

Dual-Format Response No Longer Supported

Integrations in prior Platform versions supplied response data in two formats: JSON and plain text. This dual-format response was inefficient as it doubled the amount of data flowing through the system, impacting performance and resource usage. To streamline operations and align with best practices, Itential has decided to deprecate the dual response format.

Beginning with the Platform 6.1 release, integrations will supply a single response format, as determined by the Content-Type HTTP header:

• If the Content-Type is set to application/json, Integrations will automatically parse and return the response as JSON.

• For any other Content-Type, the response will default to plain text.

These changes will improve system efficiency, reduce overhead, and maintain flexibility by allowing users to specify an integration response format through standard HTTP headers. Moreover, the integration response size will be smaller so that the payload does not slow down job execution.

What should I do?

To prepare for this change, Itential recommends refactoring workflows to utilize the "body" response field within Integration responses. This will ensure the response is parsed correctly by ensuring the Content-Type header correctly identifies the response as JSON or another format (e.g., XML, HTML). For example, if the Content-Type header is identified as:

"content-type": "application/xml"

... then the "body" field will be formatted as text.

A sample response is shown below.

{
  "response": {
    "ok": true,
    "url": "https://petstore.swagger.io/v2/pet/findByStatus?status=pending",
    "status": 200,
    "statusText": "OK",
    "headers": {
      "access-control-allow-headers": [
        "Content-Type",
        "api_key",
        "Authorization"
      ],
      "access-control-allow-methods": [
        "GET",
        "POST",
        "DELETE",
        "PUT"
      ],
      "access-control-allow-origin": "*",
      "connection": "keep-alive",
      "content-type": "application/json",
      "date": [
        "Thu",
        "30 Jan 2025 15:13:50 GMT"
      ],
      "server": "Jetty(9.2.9.v20150224)",
      "transfer-encoding": "chunked"
    },
    "body": [
      {
        "id": 31662904,
        "category": {
          "id": -72976378,
          "name": "consequat commodo dolor"
        },
        "name": "doggie",
        "photoUrls": [
          "dolor",
          "aliquip"
        ],
        "tags": [
          {
            "id": -81536039,
            "name": "officia non exercitation laborum"
          },
          {
            "id": -81700539,
            "name": "sed quis"
          }
        ],
        "status": "pending"
      },
      {
        "id": 31759937,
        "category": {
          "id": 1,
          "name": "Dogs"
        },
        "name": "Gordinho",
        "photoUrls": [
          "https://www.iamurl.com/labrador_gordinho.jpg"
        ],
        "tags": [
          {
            "id": 1,
            "name": "friendly"
          }
        ],
        "status": "pending"
      },
      {
        "id": 22292890,
        "category": {
          "id": 1,
          "name": "Dogs"
        },
        "name": "Gordinho",
        "photoUrls": [
          "https://www.iamurl.com/labrador_gordinho.jpg"
        ],
        "tags": [
          {
            "id": 1,
            "name": "friendly"
          }
        ],
        "status": "pending"
      },
      {
        "id": 24507780,
        "category": {
          "id": 1,
          "name": "Dogs"
        },
        "name": "Gordinho",
        "photoUrls": [
          "https://www.iamurl.com/labrador_gordinho.jpg"
        ],
        "tags": [
          {
            "id": 1,
            "name": "friendly"
          }
        ],
        "status": "pending"
      },
      {
        "id": 18774350,
        "category": {
          "id": 1,
          "name": "Dogs"
        },
        "name": "Gordinho",
        "photoUrls": [
          "https://www.iamurl.com/labrador_gordinho.jpg"
        ],
        "tags": [
          {
            "id": 1,
            "name": "friendly"
          }
        ],
        "status": "pending"
      }
    ],
    "method": "GET"
  }
}

If you experience any issues with refactoring, or need additional assistance, please contact the Product Support Team.

Related Reading

• Removing Duplicate Data Properties in Response Object