Boomi Platform API Reference (1.0.0) - EnvironmentMapExtensionExternalComponent

Toggle Pane

• EnvironmentMapExtensionExternalComponent
  • postQueries for an EnvironmentMapExtensionExternalComponent object(s)
  • postRetrieves additional results for an EnvironmentMapExtensionExternalComponent query

API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

EnvironmentMapExtensionExternalComponent

Query the Environment Map Extension External Components object for a list of all available cross-reference components with a given environment map extension.

This object is helpful for process and integration pack developers that need to perform a cross-reference lookup function. After using this object to get a list of available cross-reference components, you can then use the Component API to retrieve a table's definition from the results list.

Component types

Use the following table to determine the component types that are available for use within the Environment Map Extension External Component object. The following content does not define the connector subtype fields; you can retrieve subtype values using the Connector object.

Component type field	Component type description
certificate	X.509 Certificate
certificate.pgp	PGP Certificate
connector-action	Connector Operation
connector-settings	Connector Connection
crossref	Cross-Reference Table
documentcache	Document Cache
transform.map	Map
transform.function	Map Function
process	Process
processproperty	Process Property
profile.db	Database Profile
profile.edi	EDI Profile
profile.flatfile	Flat File Profile
profile.xml	XML Profile
profile.json	JSON Profile
queue	Queue
tradingpartner	Trading Partner
tpgroup	Processing Group
tporganization	Organization
tpcommoptions	Communication Channel
webservice	API Service
webservice.external	API Proxy
processroute	Process Route
customlibrary	Custom Library
flowservice	Flow Service
script.processing	Process Script
script.mapping	Map Script
xslt	XSLT Stylesheet

Queries for an EnvironmentMapExtensionExternalComponent 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:

application/jsonapplication/xmlapplication/json

optional

Possible properties include: ACCOUNT_ID, ENVIRONMENT_MAP_EXTENSION_ID, PACKAGED_COMPONENT_UID, COMPONENT_ID, COMPONENT_VERSION, COMPONENT_NAME, COMPONENT_TYPE

required

object

required EnvironmentMapExtensionExternalComponentSimpleExpression (object) or EnvironmentMapExtensionExternalComponentGroupingExpression (object) (EnvironmentMapExtensionExternalComponentExpression) 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: "ACCOUNT_ID" "ENVIRONMENT_MAP_EXTENSION_ID" "PACKAGED_COMPONENT_UID" "COMPONENT_ID" "COMPONENT_VERSION" "COMPONENT_NAME" "COMPONENT_TYPE" argument Array of strings

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

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 (EnvironmentMapExtensionExternalComponent)

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/EnvironmentMapExtensionExternalComponent/query

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

Example

SimpleExpressionGroupingExpressionSimpleExpression

{

• "QueryFilter": {

  • "expression": {

    • "operator": "and",
    • "nestedExpression": [

      • {

        • "argument": [

          • "1234b56a-ea78-90f1-beec-2fe23456cb8e"

          ],
        • "operator": "EQUALS",
        • "property": "componentId"

        },
      • {

        • "argument": [

          • "ZWNlYjg3Y2ItMWEwNC00MjIwLTgxYW..."

          ],
        • "operator": "EQUALS",
        • "property": "environmentMapExtensionId"

        }

      ]

    }

  }

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "QueryResult",
• "result": [

  • {

    • "@type": "EnvironmentMapExtensionExternalComponent",
    • "environmentMapExtensionId": "ZWNlYjg3Y2ItM...",
    • "componentId": "1234b56a-ea78-90f1-beec-2fe23456cb8e",
    • "componentVersion": 1,
    • "componentType": "crossref",
    • "componentName": "component1"

    }

  ],
• "numberOfResults": 1

}

Retrieves additional results for an EnvironmentMapExtensionExternalComponent query

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

Authorizations:

basicAuth

Request Body schema: text/plain

required

string

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

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 (EnvironmentMapExtensionExternalComponent)

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/EnvironmentMapExtensionExternalComponent/queryMore

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "QueryResult",
• "result": [

  • {

    • "@type": "EnvironmentMapExtensionExternalComponent",
    • "environmentMapExtensionId": "ZWNlYjg3Y2ItM...",
    • "componentId": "1234b56a-ea78-90f1-beec-2fe23456cb8e",
    • "componentVersion": 1,
    • "componentType": "crossref",
    • "componentName": "component1"

    }

  ],
• "numberOfResults": 1

}