Chilkat Online Tools

Python / Creatio API / $batch parameter (Content-Type: multipart/mixed)

Back to Collection Items

import sys
import chilkat2

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = chilkat2.Http()

sbRequestBody = chilkat2.StringBuilder()
sbRequestBody.Append("--batch_a685-9724-d873\n")
sbRequestBody.Append("Content-Type: multipart/mixed; boundary=changeset_06da-d998-8e7e\n")
sbRequestBody.Append("\n")
sbRequestBody.Append("--changeset_06da-d998-8e7e\n")
sbRequestBody.Append("Content-Type: application/http\n")
sbRequestBody.Append("Content-Transfer-Encoding: binary\n")
sbRequestBody.Append("\n")
sbRequestBody.Append("POST {{CollectionName5}} HTTP/1.1\n")
sbRequestBody.Append("Content-ID: 1\n")
sbRequestBody.Append("Accept: application/atomsvc+xml;q=0.8, application/json;odata=verbose;q=0.5, */*;q=0.1\n")
sbRequestBody.Append("Content-Type: application/json;odata=verbose\n")
sbRequestBody.Append("\n")
sbRequestBody.Append("{\"{{FieldName1}}\": \"{{FieldName1Value9}}\"}\n")
sbRequestBody.Append("\n")
sbRequestBody.Append("--changeset_06da-d998-8e7e\n")
sbRequestBody.Append("Content-Type: application/http\n")
sbRequestBody.Append("Content-Transfer-Encoding: binary\n")
sbRequestBody.Append("\n")
sbRequestBody.Append("PATCH {{CollectionName5}}/{{ObjectId5}} HTTP/1.1\n")
sbRequestBody.Append("Content-ID: 2\n")
sbRequestBody.Append("Accept: application/atomsvc+xml;q=0.8, application/json;odata=verbose;q=0.5, */*;q=0.1\n")
sbRequestBody.Append("Content-Type: application/json;odata=verbose\n")
sbRequestBody.Append("\n")
sbRequestBody.Append("{\"{{FieldName1}}\": \"{{FieldName1Value10}}\"}\n")
sbRequestBody.Append("\n")
sbRequestBody.Append("--changeset_06da-d998-8e7e\n")
sbRequestBody.Append("Content-Type: application/http\n")
sbRequestBody.Append("Content-Transfer-Encoding: binary\n")
sbRequestBody.Append("\n")
sbRequestBody.Append("DELETE {{CollectionName5}}/{{ObjectId5}} HTTP/1.1\n")
sbRequestBody.Append("Content-ID: 3\n")
sbRequestBody.Append("Accept: application/atomsvc+xml;q=0.8, application/json;odata=verbose;q=0.5, */*;q=0.1\n")
sbRequestBody.Append("Content-Type: application/json;odata=verbose")

http.SetRequestHeader("Content-Type","multipart/mixed; boundary=batch_a685-9724-d873; IEEE754Compatible=true")
http.SetRequestHeader("ForceUseSession","true")
http.SetRequestHeader("BPMCSRF","{{BPMCSRF}}")

# resp is a CkHttpResponse
resp = http.PTextSb("POST","https://myserver.com/0/odata/$batch",sbRequestBody,"utf-8","multipart/mixed; boundary=batch_a685-9724-d873; IEEE754Compatible=true",False,False)
if (http.LastMethodSuccess == False):
    print(http.LastErrorText)
    sys.exit()

print(str(resp.StatusCode))
print(resp.BodyStr)

Curl Command

curl -X POST
	-H "Content-Type: multipart/mixed; boundary=batch_a685-9724-d873; IEEE754Compatible=true"
	-H "BPMCSRF: {{BPMCSRF}}"
	-H "ForceUseSession: true"
	-d '--batch_a685-9724-d873
Content-Type: multipart/mixed; boundary=changeset_06da-d998-8e7e

--changeset_06da-d998-8e7e
Content-Type: application/http
Content-Transfer-Encoding: binary

POST {{CollectionName5}} HTTP/1.1
Content-ID: 1
Accept: application/atomsvc+xml;q=0.8, application/json;odata=verbose;q=0.5, */*;q=0.1
Content-Type: application/json;odata=verbose

{"{{FieldName1}}": "{{FieldName1Value9}}"}

--changeset_06da-d998-8e7e
Content-Type: application/http
Content-Transfer-Encoding: binary

PATCH {{CollectionName5}}/{{ObjectId5}} HTTP/1.1
Content-ID: 2
Accept: application/atomsvc+xml;q=0.8, application/json;odata=verbose;q=0.5, */*;q=0.1
Content-Type: application/json;odata=verbose

{"{{FieldName1}}": "{{FieldName1Value10}}"}

--changeset_06da-d998-8e7e
Content-Type: application/http
Content-Transfer-Encoding: binary

DELETE {{CollectionName5}}/{{ObjectId5}} HTTP/1.1
Content-ID: 3
Accept: application/atomsvc+xml;q=0.8, application/json;odata=verbose;q=0.5, */*;q=0.1
Content-Type: application/json;odata=verbose'
https://myserver.com/0/odata/$batch

Postman Collection Item JSON

{
  "name": "$batch parameter (Content-Type: multipart/mixed)",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "type": "text",
        "value": "multipart/mixed; boundary=batch_a685-9724-d873; IEEE754Compatible=true"
      },
      {
        "key": "BPMCSRF",
        "type": "text",
        "value": "{{BPMCSRF}}"
      },
      {
        "key": "ForceUseSession",
        "type": "text",
        "value": "true"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "--batch_a685-9724-d873\nContent-Type: multipart/mixed; boundary=changeset_06da-d998-8e7e\n\n--changeset_06da-d998-8e7e\nContent-Type: application/http\nContent-Transfer-Encoding: binary\n\nPOST {{CollectionName5}} HTTP/1.1\nContent-ID: 1\nAccept: application/atomsvc+xml;q=0.8, application/json;odata=verbose;q=0.5, */*;q=0.1\nContent-Type: application/json;odata=verbose\n\n{\"{{FieldName1}}\": \"{{FieldName1Value9}}\"}\n\n--changeset_06da-d998-8e7e\nContent-Type: application/http\nContent-Transfer-Encoding: binary\n\nPATCH {{CollectionName5}}/{{ObjectId5}} HTTP/1.1\nContent-ID: 2\nAccept: application/atomsvc+xml;q=0.8, application/json;odata=verbose;q=0.5, */*;q=0.1\nContent-Type: application/json;odata=verbose\n\n{\"{{FieldName1}}\": \"{{FieldName1Value10}}\"}\n\n--changeset_06da-d998-8e7e\nContent-Type: application/http\nContent-Transfer-Encoding: binary\n\nDELETE {{CollectionName5}}/{{ObjectId5}} HTTP/1.1\nContent-ID: 3\nAccept: application/atomsvc+xml;q=0.8, application/json;odata=verbose;q=0.5, */*;q=0.1\nContent-Type: application/json;odata=verbose"
    },
    "url": {
      "raw": "{{BaseURI}}/0/odata/$batch",
      "host": [
        "{{BaseURI}}"
      ],
      "path": [
        "0",
        "odata",
        "$batch"
      ]
    },
    "description": "Batch request with different types of returned content (uses the [$batch](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part2-url-conventions.html#sec_AddressingtheBatchEndpointforaServic) parameter)."
  },
  "response": [
    {
      "name": "[200] Batch request with Content-Type: multipart/mixed",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "name": "Content-Type",
            "type": "text",
            "value": "multipart/mixed; boundary=batch_a685-9724-d873; IEEE754Compatible=true"
          },
          {
            "key": "BPMCSRF",
            "type": "text",
            "value": "{{BPMCSRF}}"
          },
          {
            "key": "ForceUseSession",
            "type": "text",
            "value": "true"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "--batch_a685-9724-d873\nContent-Type: multipart/mixed; boundary=changeset_06da-d998-8e7e\n\n--changeset_06da-d998-8e7e\nContent-Type: application/http\nContent-Transfer-Encoding: binary\n\nPOST City HTTP/1.1\nContent-ID: 1\nAccept: application/atomsvc+xml;q=0.8, application/json;odata=verbose;q=0.5, */*;q=0.1\nContent-Type: application/json;odata=verbose\n\n{\"Name\": \"Gilbert\"}\n\n--changeset_06da-d998-8e7e\nContent-Type: application/http\nContent-Transfer-Encoding: binary\n\nPATCH City/62f9bc01-57cf-4cc7-90bf-8672acc922e2 HTTP/1.1\nContent-ID: 2\nAccept: application/atomsvc+xml;q=0.8, application/json;odata=verbose;q=0.5, */*;q=0.1\nContent-Type: application/json;odata=verbose\n\n{\"Name\": \"Lincoln\"}\n\n--changeset_06da-d998-8e7e\nContent-Type: application/http\nContent-Transfer-Encoding: binary\n\nDELETE City//62f9bc01-57cf-4cc7-90bf-8672acc922e2 HTTP/1.1\nContent-ID: 3\nAccept: application/atomsvc+xml;q=0.8, application/json;odata=verbose;q=0.5, */*;q=0.1\nContent-Type: application/json;odata=verbose"
        },
        "url": {
          "raw": "https://myserver.com/0/odata/$batch",
          "protocol": "https",
          "host": [
            "myserver",
            "com"
          ],
          "path": [
            "0",
            "odata",
            "$batch"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "Text",
      "header": [
      ],
      "cookie": [
      ],
      "body": "--batchresponse_e17aace9-5cbb-49bd-b7ad-f1be8cc8c9d8\r\nContent-Type: multipart/mixed; boundary=changesetresponse_a08c1df6-4b82-4a9b-be61-7ef4cc7b23ba\r\n\r\n--changesetresponse_a08c1df6-4b82-4a9b-be61-7ef4cc7b23ba\r\nContent-Type: application/http\r\nContent-Transfer-Encoding: binary\r\nContent-ID: 1\r\n\r\nHTTP/1.1 201 Created\r\nLocation: https://myserver.com/odata/City(fbd0565f-fa8a-4214-ae89-c976c5f3acb4)\r\nContent-Type: application/json; odata.metadata=minimal\r\nOData-Version: 4.0\r\n\r\n{\"@odata.context\":\"https://myserver.com/0/odata/$metadata#City/$entity\",\"Id\":\"fbd0565f-fa8a-4214-ae89-c976c5f3acb4\",\"CreatedOn\":\"2020-05-18T18:41:57.0917235Z\",\"CreatedById\":\"dad159f3-6c2d-446a-98d2-0f4d26662bbe\",\"ModifiedOn\":\"2020-05-18T18:41:57.0917235Z\",\"ModifiedById\":\"dad159f3-6c2d-446a-98d2-0f4d26662bbe\",\"Name\":\"Gilbert\",\"Description\":\"\",\"CountryId\":\"00000000-0000-0000-0000-000000000000\",\"RegionId\":\"00000000-0000-0000-0000-000000000000\",\"TimeZoneId\":\"00000000-0000-0000-0000-000000000000\",\"ProcessListeners\":0}\r\n--changesetresponse_a08c1df6-4b82-4a9b-be61-7ef4cc7b23ba\r\nContent-Type: application/http\r\nContent-Transfer-Encoding: binary\r\nContent-ID: 2\r\n\r\nHTTP/1.1 204 No Content\r\nOData-Version: 4.0\r\n\r\n\r\n--changesetresponse_a08c1df6-4b82-4a9b-be61-7ef4cc7b23ba\r\nContent-Type: application/http\r\nContent-Transfer-Encoding: binary\r\nContent-ID: 3\r\n\r\nHTTP/1.1 204 No Content\r\n\r\n\r\n--changesetresponse_a08c1df6-4b82-4a9b-be61-7ef4cc7b23ba--\r\n--batchresponse_e17aace9-5cbb-49bd-b7ad-f1be8cc8c9d8--\r\n"
    }
  ]
}