Bulk UPDATE operations

The Bulk UPDATE operation updates multiple API objects based on the supplied object IDs.

With a Bulk UPDATE operation, you specify the object type and up to a specific number of object IDs. The operation updates all objects having the specified IDs.

Important

Typically, the Bulk UPDATE operation can apply updates up to 100 object IDs. However, only the Process Schedules object currently supports the Bulk UPDATE operation and is limited to 15 objects.

The following example Bulk UPDATE requests are for the Process Schedules object.

Implementation

REST

UPDATE operation

Send an HTTP POST to:

https://api.boomi.com/api/rest/v1/{accountId}/ProcessSchedules/bulk

where accountId is the ID of the authenticating account for the request.

JSON

For a JSON request, send the request with the following HTTP header:

Content-Type: application/json

Request:

{
    "type": "UPDATE",
    "request": [
        {
            "Schedule": [
                {
                    "minutes": "20",
                    "hours": "8",
                    "daysOfWeek": "5,6",
                    "daysOfMonth": "*",
                    "months": "*",
                    "years": "*"
                },
                {
                    "minutes": "1",
                    "hours": "8",
                    "daysOfWeek": "5,6",
                    "daysOfMonth": "*",
                    "months": "*",
                    "years": "*"
                }
            ],
            "Retry": {
                "Schedule": [],
                "maxRetry": 2
            },
            "processId": "123456ab-cdef-7891-0123-45abcdef6789",
            "atomId": "1a234f35-6b78-901c-2d34-f5e678f90123"
        },
        {
            "Schedule": [],
            "processId": "123456ab-cdef-7891-0123-45abcdef6789",
            "atomId": "abc12345-6def-7g8h-90ij-k1l2mn345678"
        }
    ]
}

For a JSON response, send the request with the following HTTP header:

Accept: application/json

Response:

{
    "@type": "BulkResult",
    "response": [
        {
            "@type": "BulkResponse",
            "Result": {
                "@type": "ProcessSchedules",
                "Schedule": [
                    {
                        "@type": "Schedule",
                        "minutes": "20",
                        "hours": "8",
                        "daysOfWeek": "5,6",
                        "daysOfMonth": "*",
                        "months": "*",
                        "years": "*"
                    },
                    {
                        "@type": "Schedule",
                        "minutes": "1",
                        "hours": "8",
                        "daysOfWeek": "5,6",
                        "daysOfMonth": "*",
                        "months": "*",
                        "years": "*"
                    }
                ],
                "Retry": {
                    "@type": "ScheduleRetry",
                    "Schedule": [],
                    "maxRetry": 2
                },
                "processId": "123456ab-cdef-7891-0123-45abcdef6789",
                "atomId": "1a234f35-6b78-901c-2d34-f5e678f90123"
            },
            "statusCode": 200
        },
        {
            "@type": "BulkResponse",
            "Result": {
                "@type": "ProcessSchedules",
                "Schedule": [],
                "processId": "123456ab-cdef-7891-0123-45abcdef6789",
                "atomId": "abc12345-6def-7g8h-90ij-k1l2mn345678"
            },
            "statusCode": 200
        }
    ]
}

XML

Request:

<api:BulkRequest xmlns:api="http://api.platform.boomi.com/"  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" type="UPDATE">
    <api:request xsi:type="api:ProcessSchedules" xmlns:api="http://api.platform.boomi.com/" processId="123456ab-cdef-7891-0123-45abcdef6789" atomId="1a234f35-6b78-901c-2d34-f5e678f90123">
        <api:Schedule minutes="31" hours="8" daysOfWeek="5,6" daysOfMonth="*" months="*" years="*"/>
        <api:Retry maxRetry="5">
            <api:Schedule minutes="15" hours="8" daysOfWeek="5,6" daysOfMonth="*" months="*" years="*"/>
        </api:Retry>
    </api:request>
    <api:request xsi:type="api:ProcessSchedules" xmlns:api="http://api.platform.boomi.com/" processId="123456ab-cdef-7891-0123-45abcdef6789" atomId="abc12345-6def-7g8h-90ij-k1l2mn345678">
    </api:request>
</api:BulkRequest>

Response:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<bns:BulkResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/">
    <bns:response statusCode="200">
        <bns:Result xsi:type="bns:ProcessSchedules" processId="123456ab-cdef-7891-0123-45abcdef6789" atomId="1a234f35-6b78-901c-2d34-f5e678f90123">
            <bns:Schedule minutes="31" hours="8" daysOfWeek="5,6" daysOfMonth="*" months="*" years="*"/>
            <bns:Retry maxRetry="5">
                <bns:Schedule minutes="15" hours="8" daysOfWeek="5,6" daysOfMonth="*" months="*" years="*"/>
            </bns:Retry>
        </bns:Result>
    </bns:response>
    <bns:response statusCode="200">
        <bns:Result xsi:type="bns:ProcessSchedules" processId="123456ab-cdef-7891-0123-45abcdef6789" atomId="abc12345-6def-7g8h-90ij-k1l2mn345678"/>
    </bns:response>
</bns:BulkResult>

SOAP

Send a POST to:

https://api.boomi.com/apim/api/soap/v1/{accountID}

where accountId is the ID of the authenticating account for the request.

CREATE operation

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
    <soapenv:Header>
        <wsse:Security
       xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
            <wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
                <wsse:Username>username@boomi.com</wsse:Username>
                <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">password</wsse:Password>
            </wsse:UsernameToken>
        </wsse:Security>
    </soapenv:Header>
    <soapenv:Body>
        <api:updateBulk xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <api:objectType>ProcessSchedules</api:objectType>
            <api:bulkObject>
                <api:request xsi:type="api:ProcessSchedules" processId="123456ab-cdef-7891-0123-45abcdef6789" atomId="1a234f35-6b78-901c-2d34-f5e678f90123">
                    <api:Schedule minutes="31" hours="8" daysOfWeek="5,6" daysOfMonth="*" months="*" years="*"/>
                    <api:Schedule minutes="15" hours="8" daysOfWeek="5,6" daysOfMonth="*" months="*" years="*"/>
                    <api:Retry maxRetry="5"/>
                </api:request>
                <api:request xsi:type="api:ProcessSchedules" processId="123456ab-cdef-7891-0123-45abcdef6789" atomId="abc12345-6def-7g8h-90ij-k1l2mn345678">
    </api:request>
            </api:bulkObject>
        </api:updateBulk>
    </soapenv:Body>
</soapenv:Envelope>

Response:

<?xml version='1.0' encoding='UTF-8'?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <bns:updateBulkResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/">
            <bns:results>
                <bns:response statusCode="200">
                    <bns:Result xsi:type="bns:ProcessSchedules" processId="123456ab-cdef-7891-0123-45abcdef6789" atomId="1a234f35-6b78-901c-2d34-f5e678f90123">
                        <bns:Schedule minutes="31" hours="8" daysOfWeek="5,6" daysOfMonth="*" months="*" years="*"/>
                        <bns:Schedule minutes="15" hours="8" daysOfWeek="5,6" daysOfMonth="*" months="*" years="*"/>
                        <bns:Retry maxRetry="5"/>
                    </bns:Result>
                </bns:response>
                <bns:response statusCode="200">
                    <bns:Result xsi:type="bns:ProcessSchedules" processId="123456ab-cdef-7891-0123-45abcdef6789" atomId="abc12345-6def-7g8h-90ij-k1l2mn345678"/>
                </bns:response>
            </bns:results>
        </bns:updateBulkResponse>
    </S:Body>
</S:Envelope>