Waiting for engine...
Skip to main content

Boomi Platform API Reference (1.0.0) - EnvironmentMapExtensionUserDefinedFunctionSummary

Toggle Pane
API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

EnvironmentMapExtensionUserDefinedFunctionSummary

Use the Environment Map Extension User Defined Function Summary object to query for a list of all available user-defined functions associated with a given environment map extension. You can use this object in combination with other Environment Map Extension objects. For example, you can query this object to retrieve a list of user-defined functions and then employ the Environment Map Extension User Defined object to modify the properties of a function returned in the list of results.

Queries for an EnvironmentMapExtensionUserDefinedFunctionSummary 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: environmentId, extensionGroupId

required
object
required
EnvironmentMapExtensionUserDefinedFunctionSummarySimpleExpression (object) or EnvironmentMapExtensionUserDefinedFunctionSummaryGroupingExpression (object) (EnvironmentMapExtensionUserDefinedFunctionSummaryExpression)
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: "environmentId" "extensionGroupId"
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 (EnvironmentMapExtensionUserDefinedFunctionSummary)

Request samples

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

Response samples

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

Retrieves additional results for an EnvironmentMapExtensionUserDefinedFunctionSummary 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 (EnvironmentMapExtensionUserDefinedFunctionSummary)

Response samples

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