Waiting for engine...
Skip to main content

Boomi Platform API Reference (1.0.0) - Process

Toggle Pane
API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

Process

The Process object represents a process that is available to the requesting account. The primary use of this object is to assist with integration packs and extensions for multi-install integration packs. To retrieve general information about a process or other type of component, use the Component Metadata object instead.

Required Privileges

Write access

  • N/A

Read access

  • API — Use the Boomi Platform API to access account data.

Retrieves an instance of a Process object

Retrieves the properties of the process having the specified ID.

The ordinary GET operation retrieves the properties of the process having the specified ID. The bulk GET operation retrieves the properties of the processes having the specified IDs, to a maximum of 100.

Authorizations:
basicAuth
path Parameters
id
required
string

A unique ID assigned by the system to the process. For deployed processes and processes belonging to single-install integration packs, this value is the process component ID. For processes belonging to multi-install integration packs, this is an synthetic ID and does not match an actual process component. You can use this value as the extensionGroupId when querying the Environment Extensions object.

Responses

Response Schema:
Description
required
string
Array of objects (ProcessIntegrationPackInfo)
id
string

A unique ID assigned by the system to the process. For deployed processes and processes belonging to single-install integration packs, this value is the process component ID.For processes belonging to multi-install integration packs, this is an synthetic ID and does not match an actual process component. You can use this value as the extensionGroupId when querying the Environment Extensions object

name
string

The name of the process.

Response samples

Content type
{
  • "@type": "Process",
  • "IntegrationPack": [
    • {
      }
    ],
  • "Description": "string",
  • "name": "Order Intake",
  • "id": "56789abc-def0-1234-5678-9abcdef01234"
}

Retrieves multiple Process objects by identifier

To learn more about bulk, refer to the topic Bulk GET operations.

Authorizations:
basicAuth
Request Body schema:
optional
Array of objects (BulkId)
type
string
Enum: "GET" "DELETE" "UPDATE" "CREATE"

Responses

Response Schema:
Array of objects
Array
required
object (Process)
index
integer <int32>
id
string
statusCode
integer <int32>
errorMessage
string

Request samples

Content type
{
  • "request": [
    • {
      }
    ],
  • "type": "GET"
}

Response samples

Content type
{
  • "response": [
    • {
      }
    ]
}

Queries for a Process object(s)

For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging.

Authorizations:
basicAuth
Request Body schema:
optional

Possible properties include: name, id, integrationPackId, integrationPackInstanceId

required
object
required
ProcessSimpleExpression (object) or ProcessGroupingExpression (object) (ProcessExpression)
One of
operator
required
string
Enum: "EQUALS" "LIKE" "NOT_EQUALS" "IS_NULL" "IS_NOT_NULL" "BETWEEN" "GREATER_THAN" "GREATER_THAN_OR_EQUAL" "LESS_THAN" "LESS_THAN_OR_EQUAL" "CONTAINS" "NOT_CONTAINS"
property
required
string
Enum: "name" "id" "integrationPackId" "integrationPackInstanceId"
argument
Array of strings

Responses

Response Schema:
numberOfResults
integer <int32>
queryToken
string

By default, the queryToken parameter is not available in the query response. It appears only when the query response contains more than 100 results. The maximum number of results returned per query is 100. To retrieve the next set of results, use the queryToken in the queryMore request.

Array of objects (Process)

Request samples

Content type
Example
{
  • "QueryFilter": {
    • "expression": {
      }
    }
}

Response samples

Content type
{
  • "numberOfResults": 4,
  • "@type": "QueryResult",
  • "result": [
    • {
      },
    • {
      }
    ]
}

Retrieves additional results for a Process query

To learn about using queryMore, refer to the topic Query paging.

Authorizations:
basicAuth
Request Body schema: text/plain
required
string

Responses

Response Schema:
numberOfResults
integer <int32>
queryToken
string

By default, the queryToken parameter is not available in the query response. It appears only when the query response contains more than 100 results. The maximum number of results returned per query is 100. To retrieve the next set of results, use the queryToken in the queryMore request.

Array of objects (Process)

Response samples

Content type
{
  • "numberOfResults": 4,
  • "@type": "QueryResult",
  • "result": [
    • {
      },
    • {
      }
    ]
}