Release notesDeprecations

Reduced integration responses

Deprecation notice

The following deprecation has been issued in the Itential Platform 6 release, with the change scheduled for 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.

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 you to specify an integration response format through standard HTTP headers. The integration response size will also be smaller, reducing impact on job execution performance.

What should I do?

To prepare for this change, Itential recommends refactoring workflows to use the "body" response field within integration responses. This ensures the response is parsed correctly based on the Content-Type header. For example, if the Content-Type header is "content-type": "application/xml", the "body" field will be formatted as text.

A sample response is shown below:

1{
2  "response": {
3    "ok": true,
4    "url": "https://petstore.swagger.io/v2/pet/findByStatus?status=pending",
5    "status": 200,
6    "statusText": "OK",
7    "headers": {
8      "access-control-allow-headers": [
9        "Content-Type",
10        "api_key",
11        "Authorization"
12      ],
13      "access-control-allow-methods": [
14        "GET",
15        "POST",
16        "DELETE",
17        "PUT"
18      ],
19      "access-control-allow-origin": "*",
20      "connection": "keep-alive",
21      "content-type": "application/json",
22      "date": [
23        "Thu",
24        "30 Jan 2025 15:13:50 GMT"
25      ],
26      "server": "Jetty(9.2.9.v20150224)",
27      "transfer-encoding": "chunked"
28    },
29    "body": [
30      {
31        "id": 31662904,
32        "category": {
33          "id": -72976378,
34          "name": "consequat commodo dolor"
35        },
36        "name": "doggie",
37        "photoUrls": [
38          "dolor",
39          "aliquip"
40        ],
41        "tags": [
42          {
43            "id": -81536039,
44            "name": "officia non exercitation laborum"
45          },
46          {
47            "id": -81700539,
48            "name": "sed quis"
49          }
50        ],
51        "status": "pending"
52      },
53      {
54        "id": 31759937,
55        "category": {
56          "id": 1,
57          "name": "Dogs"
58        },
59        "name": "Gordinho",
60        "photoUrls": [
61          "https://www.iamurl.com/labrador_gordinho.jpg"
62        ],
63        "tags": [
64          {
65            "id": 1,
66            "name": "friendly"
67          }
68        ],
69        "status": "pending"
70      },
71      {
72        "id": 22292890,
73        "category": {
74          "id": 1,
75          "name": "Dogs"
76        },
77        "name": "Gordinho",
78        "photoUrls": [
79          "https://www.iamurl.com/labrador_gordinho.jpg"
80        ],
81        "tags": [
82          {
83            "id": 1,
84            "name": "friendly"
85          }
86        ],
87        "status": "pending"
88      },
89      {
90        "id": 24507780,
91        "category": {
92          "id": 1,
93          "name": "Dogs"
94        },
95        "name": "Gordinho",
96        "photoUrls": [
97          "https://www.iamurl.com/labrador_gordinho.jpg"
98        ],
99        "tags": [
100          {
101            "id": 1,
102            "name": "friendly"
103          }
104        ],
105        "status": "pending"
106      },
107      {
108        "id": 18774350,
109        "category": {
110          "id": 1,
111          "name": "Dogs"
112        },
113        "name": "Gordinho",
114        "photoUrls": [
115          "https://www.iamurl.com/labrador_gordinho.jpg"
116        ],
117        "tags": [
118          {
119            "id": 1,
120            "name": "friendly"
121          }
122        ],
123        "status": "pending"
124      }
125    ],
126    "method": "GET"
127  }
128}

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

  • Removing duplicate data properties in response object