Boomi Platform API Reference (1.0.0) - OrganizationComponent

Toggle Pane

• OrganizationComponent
  • postCreates an OrganizationComponent object
  • getRetrieves an instance of an OrganizationComponent object.
  • postModifies or updates an OrganizationComponent object
  • delDeletes an OrganizationComponent object
  • postRetrieves multiple OrganizationComponent objects by identifier
  • postQueries for an OrganizationComponent object
  • postRetrieves additional results for an OrganizationComponent query

API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

OrganizationComponent

The Organization Component object represents an Organization component in the service. You can reuse organization components across multiple Trading Partners, API Services, and API Proxies.

Creates an OrganizationComponent object

The CREATE operation creates an Organization Component object with the specified component name.

The request body requires the componentName field. If you omit the folderName field, it requires the folderId field — and vice versa. If you omit the componentID field, it assigns the value when you create the component. If you omit the folderID field, it assigns the value when you create the component.

Authorizations:

basicAuth

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

required	object (OrganizationContactInfo)
branchId	string
branchName	string
componentId	string A unique ID assigned by the system to the component.
componentName	string A user-defined name for the component.
deleted	boolean Indicates if the component is deleted. A value of true indicates a deleted status, whereas false indicates an active status.
description	string Description of the component. Note: Although this field is in the object, operations do not support the field. For example, the system ignores the field if it is present in a QUERY, CREATE, or UPDATE request.
folderId	integer <int64> The ID of the folder in which the component currently resides.
folderName	string The folder location of the component within Component Explorer.

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

required	object (OrganizationContactInfo)
branchId	string
branchName	string
componentId	string A unique ID assigned by the system to the component.
componentName	string A user-defined name for the component.
deleted	boolean Indicates if the component is deleted. A value of true indicates a deleted status, whereas false indicates an active status.
description	string Description of the component. Note: Although this field is in the object, operations do not support the field. For example, the system ignores the field if it is present in a QUERY, CREATE, or UPDATE request.
folderId	integer <int64> The ID of the folder in which the component currently resides.
folderName	string The folder location of the component within Component Explorer.

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}/OrganizationComponent

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "OrganizationComponent",
• "OrganizationContactInfo": {

  • "@type": "OrganizationContactInfo",
  • "contactName": "Tom Miller",
  • "address1": "127 Comstock Ave.",
  • "address2": "",
  • "city": "Philadelphia",
  • "state": "PA",
  • "postalcode": "19100",
  • "country": "US",
  • "email": "tom@bestwholesaling.biz",
  • "phone": "311 555-3579",
  • "contactUrl": "https://www.bestwholesaling.biz",
  • "fax": "311 555-9753"

  },
• "componentName": "Best Wholesaling",
• "folderName": "Commercial",
• "branchId": "QjoxNDMxNg",
• "branchName": "branch-1"

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "OrganizationComponent",
• "OrganizationContactInfo": {

  • "@type": "OrganizationContactInfo",
  • "contactName": "Tom Miller",
  • "address1": "127 Comstock Ave.",
  • "address2": "",
  • "city": "Philadelphia",
  • "state": "PA",
  • "postalcode": "19100",
  • "country": "US",
  • "email": "tom@bestwholesaling.biz",
  • "phone": "311 555-3579",
  • "contactUrl": "https://www.bestwholesaling.biz",
  • "fax": "311 555-9753"

  },
• "componentName": "Best Wholesaling",
• "componentId": "89abcdef-0123-4567-89ab-cdef01234567",
• "folderName": "Commercial",
• "folderId": 11356,
• "branchId": "QjoxNDMxNg",
• "branchName": "branch-1"

}

Retrieves an instance of an OrganizationComponent object.

The GET operation returns a single Organization Component object based on the supplied ID. A GET operation specifying the ID of a deleted Organization Component retrieves the component. In the component, the deleted field’s value is true.

Authorizations:

basicAuth

path Parameters

id required

string Organization component ID

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

required	object (OrganizationContactInfo)
branchId	string
branchName	string
componentId	string A unique ID assigned by the system to the component.
componentName	string A user-defined name for the component.
deleted	boolean Indicates if the component is deleted. A value of true indicates a deleted status, whereas false indicates an active status.
description	string Description of the component. Note: Although this field is in the object, operations do not support the field. For example, the system ignores the field if it is present in a QUERY, CREATE, or UPDATE request.
folderId	integer <int64> The ID of the folder in which the component currently resides.
folderName	string The folder location of the component within Component Explorer.

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}/OrganizationComponent/{id}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "OrganizationComponent",
• "OrganizationContactInfo": {

  • "@type": "OrganizationContactInfo",
  • "contactName": "Tom Miller",
  • "address1": "127 Comstock Ave.",
  • "address2": "",
  • "city": "Philadelphia",
  • "state": "PA",
  • "postalcode": "19100",
  • "country": "US",
  • "email": "tom@bestwholesaling.biz",
  • "phone": "311 555-3579",
  • "contactUrl": "https://www.bestwholesaling.biz",
  • "fax": "311 555-9753"

  },
• "componentName": "Best Wholesaling",
• "componentId": "89abcdef-0123-4567-89ab-cdef01234567",
• "folderName": "Commercial",
• "folderId": 11356,
• "branchId": "QjoxNDMxNg",
• "branchName": "branch-1"

}

Modifies or updates an OrganizationComponent object

The UPDATE operation overwrites the Organization Component object with the specified component ID. An UPDATE operation specifying the ID of a deleted Organization component restores the component to a non-deleted state, assuming the request is otherwise valid.

Authorizations:

basicAuth

path Parameters

id required

string Organization component ID

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

required	object (OrganizationContactInfo)
branchId	string
branchName	string
componentId	string A unique ID assigned by the system to the component.
componentName	string A user-defined name for the component.
deleted	boolean Indicates if the component is deleted. A value of true indicates a deleted status, whereas false indicates an active status.
description	string Description of the component. Note: Although this field is in the object, operations do not support the field. For example, the system ignores the field if it is present in a QUERY, CREATE, or UPDATE request.
folderId	integer <int64> The ID of the folder in which the component currently resides.
folderName	string The folder location of the component within Component Explorer.

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

required	object (OrganizationContactInfo)
branchId	string
branchName	string
componentId	string A unique ID assigned by the system to the component.
componentName	string A user-defined name for the component.
deleted	boolean Indicates if the component is deleted. A value of true indicates a deleted status, whereas false indicates an active status.
description	string Description of the component. Note: Although this field is in the object, operations do not support the field. For example, the system ignores the field if it is present in a QUERY, CREATE, or UPDATE request.
folderId	integer <int64> The ID of the folder in which the component currently resides.
folderName	string The folder location of the component within Component Explorer.

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}/OrganizationComponent/{id}

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "OrganizationComponent",
• "OrganizationContactInfo": {

  • "@type": "OrganizationContactInfo",
  • "contactName": "Tom Miller",
  • "address1": "127 Comstock Ave.",
  • "address2": "",
  • "city": "Philadelphia",
  • "state": "PA",
  • "postalcode": "19100",
  • "country": "US",
  • "email": "tom@bestwholesaling.biz",
  • "phone": "311 555-3597",
  • "contactUrl": "https://www.bestwholesaling.biz",
  • "fax": "311 555-9753"

  },
• "componentName": "Best Wholesaling",
• "componentId": "89abcdef-0123-4567-89ab-cdef01234567",
• "folderName": "Commercial",
• "folderId": 11356,
• "branchId": "QjoxNDMxNg",
• "branchName": "branch-1"

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "OrganizationComponent",
• "OrganizationContactInfo": {

  • "@type": "OrganizationContactInfo",
  • "contactName": "Tom Miller",
  • "address1": "127 Comstock Ave.",
  • "address2": "",
  • "city": "Philadelphia",
  • "state": "PA",
  • "postalcode": "19100",
  • "country": "US",
  • "email": "tom@bestwholesaling.biz",
  • "phone": "311 555-3597",
  • "contactUrl": "https://www.bestwholesaling.biz",
  • "fax": "311 555-9753"

  },
• "componentName": "Best Wholesaling",
• "componentId": "89abcdef-0123-4567-89ab-cdef01234567",
• "folderName": "Commercial",
• "folderId": 11356,
• "branchId": "QjoxNDMxNg",
• "branchName": "branch-1"

}

Deletes an OrganizationComponent object

The DELETE operation deletes the Organization Component object with the specified component ID. A DELETE operation specifying the ID of a deleted Organization component returns a false response. If the component is deleted successfully, the response is true.

Authorizations:

basicAuth

path Parameters

id required

string ID of the Organization component you are attempting to delete.

Responses

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}/OrganizationComponent/{id}

Response samples

• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "message": "Access denied due to insufficient permissions."

}

Retrieves multiple OrganizationComponent objects by identifier

The bulk GET operation returns multiple Account objects based on the supplied account IDs, to a maximum of 100. To learn more about bulk, refer to Bulk GET operations.

Authorizations:

basicAuth

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

	Array of objects (BulkId)
type	string Enum: "GET" "DELETE" "UPDATE" "CREATE"

Responses

Response Schema:

application/xmlapplication/jsonapplication/xml

	Array of objects
Array required object (OrganizationComponent) index integer <int32> id string statusCode integer <int32> errorMessage string

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}/OrganizationComponent/bulk

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "request": [

  • {

    • "id": "56789abc-def0-1234-5678-9abcdef01234"

    }

  ],
• "type": "GET"

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/xmlapplication/jsonapplication/xml

No sample

Queries for an OrganizationComponent object

• Only the LIKE operator is allowed with a name filter. Likewise, only the EQUALS operator is permitted with a contactName, email, or phone filter.

• If the QUERY request includes multiple filters, you can connect the filters with a logical AND operator — the query does not support the logical OR operator .

• The QUERY results omit the folderName field.

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: name, contactName, email, phone

required

object

required OrganizationComponentSimpleExpression (object) or OrganizationComponentGroupingExpression (object) (OrganizationComponentExpression) 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" "contactName" "email" "phone" 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 (OrganizationComponent)

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}/OrganizationComponent/query

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

Example

SimpleExpressionGroupingExpressionSimpleExpression

{

• "QueryFilter": {

  • "expression": {

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

      • {

        • "argument": [

          • "Tom Miller"

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

        },
      • {

        • "argument": [

          • "311 555-3579"

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

        }

      ]

    }

  }

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

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

  • {

    • "@type": "OrganizationComponent",
    • "OrganizationContactInfo": {

      • "@type": "OrganizationContactInfo",
      • "contactName": "Tom Miller",
      • "description": "Shared Organization component for Best Wholesaling",
      • "address1": "127 Comstock Ave.",
      • "address2": "",
      • "city": "Philadelphia",
      • "state": "PA",
      • "postalcode": "19100",
      • "country": "US",
      • "email": "tom@bestwholesaling.biz",
      • "phone": "311 555-3579",
      • "contactUrl": "https://www.bestwholesaling.biz",
      • "fax": "311 555-9753"

      },
    • "componentName": "Best Wholesaling",
    • "componentId": "89abcdef-0123-4567-89ab-cdef01234567",
    • "folderId": 11356,
    • "branchId": "QjoxNDMxNg",
    • "branchName": "branch-1"

    }

  ],
• "numberOfResults": 1

}

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

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}/OrganizationComponent/queryMore

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

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

  • {

    • "@type": "OrganizationComponent",
    • "OrganizationContactInfo": {

      • "@type": "OrganizationContactInfo",
      • "contactName": "Tom Miller",
      • "description": "Shared Organization component for Best Wholesaling",
      • "address1": "127 Comstock Ave.",
      • "address2": "",
      • "city": "Philadelphia",
      • "state": "PA",
      • "postalcode": "19100",
      • "country": "US",
      • "email": "tom@bestwholesaling.biz",
      • "phone": "311 555-3579",
      • "contactUrl": "https://www.bestwholesaling.biz",
      • "fax": "311 555-9753"

      },
    • "componentName": "Best Wholesaling",
    • "componentId": "89abcdef-0123-4567-89ab-cdef01234567",
    • "folderId": 11356,
    • "branchId": "QjoxNDMxNg",
    • "branchName": "branch-1"

    }

  ],
• "numberOfResults": 1

}