Boomi Data Integration API Reference (1.0.0) - DataFlowsMetadata

Toggle Pane

• Data Flows Metadata
  • getGet Data Source Types
  • getGet Target Types

API docs by Redocly

Download OpenAPI Specification: Download

For more information about Postman collections, forking, and making your first API call, refer to the Working with Boomi APIs on Postman page.

Find out more about Data Integration

Data Flows Metadata

Internal endpoints for data flow metadata

Get Data Source Types

Authorization scope: data flow:list

Get all data source type entities as a paginated list.

Authorizations:

HTTPBearer

query Parameters

items_per_page	integer (Items Per Page) [ 1 .. 1000 ] Default: 20 The number of items per page in the paginated list.
page	integer (Page) >= 1 Default: 1 The current page number in the paginated list.
	DataSourceTypesSegmentEnum (string) or Segment (null) (Segment) Examples: segment=source The segment of the data source type.

Responses

Response Schema: application/json

current_page_size required	integer (Current Page Size) The current page size
required	Array of objects (Items)
	Next Page (string) or Next Page (null) (Next Page) The next page URL
	Previous Page (string) or Previous Page (null) (Previous Page) The previous page URL
page	integer (Page) Default: 1 The page number
total_items	integer (Total Items) Default: 0 The total number of entities fetched

US

https://api.rivery.io/v1/data_source_types

EU

https://api.eu-west-1.rivery.io/v1/data_source_types

Response samples

• 200
• 422

Content type

application/json

{

• "next_page": "string",
• "previous_page": "string",
• "page": 1,
• "current_page_size": 0,
• "total_items": 0,
• "items": [

  • {

    • "id": "fb_ads",
    • "name": "Salesforce",
    • "description": "A distributed document-oriented database.",
    • "documentation_url": "https://docs.rivery.io/docs/walkthrow-s3",
    • "section_id": "sec_crm",
    • "status": "enabled",
    • "segment": [

      • "source",
      • "connections",
      • "target"

      ],
    • "icon": "https://static-assets.console.rivery.io/snowflake.png",
    • "connection_type": "zendesk_talk",
    • "data_source_type_settings": {

      • "allow_high_frequency": true

      },
    • "labels": [

      • "sunset"

      ],
    • "feature_flags": {

      • "is_connection_generic_pattern": true,
      • "is_new_interface": true

      },
    • "api_name": "bigquery"

    }

  ]

}

Get Target Types

Authorization scope: data flow:list

Get all target type entities as a paginated list.

Authorizations:

HTTPBearer

query Parameters

items_per_page	integer (Items Per Page) [ 1 .. 1000 ] Default: 20 The number of items per page in the paginated list.
page	integer (Page) >= 1 Default: 1 The current page number in the paginated list.

Responses

Response Schema: application/json

current_page_size required	integer (Current Page Size) The current page size
required	Array of objects (Items)
	Next Page (string) or Next Page (null) (Next Page) The next page URL
	Previous Page (string) or Previous Page (null) (Previous Page) The previous page URL
page	integer (Page) Default: 1 The page number
total_items	integer (Total Items) Default: 0 The total number of entities fetched

US

https://api.rivery.io/v1/target_types

EU

https://api.eu-west-1.rivery.io/v1/target_types

Response samples

• 200
• 422

Content type

application/json

{

• "next_page": "string",
• "previous_page": "string",
• "page": 1,
• "current_page_size": 0,
• "total_items": 0,
• "items": [

  • {

    • "name": "Snowflake",
    • "target_type": "snowflake",
    • "datasource_type_id": "snowflake",
    • "connection_type": "snowflake",
    • "target_task_type_id": "fz2snowflake",
    • "logic_step_type": "snowflake",
    • "target_settings": {

      • "dataframe_as_source": true,
      • "dataframe_as_target": true,
      • "enable_sql_results": true

      },
    • "segment": [

      • "technical"

      ],
    • "river_type_id": "src_to_trgt",
    • "icon": "https://static-assets.console.rivery.io/amazon-s3.png",
    • "file_zone_settings": {

      • "is_default": true

      },
    • "api_name": "bigquery"

    }

  ]

}