Boomi Data Integration API Reference (1.0.0) - Environments

Toggle Pane

• Environments
  • getList Environments
  • postAdd Environment
  • getGet Environment
  • putPatch Environment
  • delDelete Environment

API docs by Redocly

Download OpenAPI Specification: Download

Find out more about Data Integration

Environments

Listing account's environments

List Environments

Authorization scope: environment:list

Get list of environments entities for an account

Authorizations:

HTTPBearer

path Parameters

account_id required

string (Account Id)

query Parameters

include_deleted	boolean (Include Deleted) Default: false
is_deployable_environments	boolean (Is Deployable Environments) Default: false
items_per_page	integer (Items Per Page) [ 1 .. 500 ] 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
account_id required	string (Account Id) The account id
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/accounts/{account_id}/environments

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments

Response samples

• 200
• 422

Content type

application/json

{

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

  • {

    • "_id": "633ede20f1fc5500111fd7b3",
    • "account": "62e7f4352c13160013dc39be",
    • "user_created": "62e7f4352c13160013dc39be",
    • "created_at": "2022-07-25T18:38:55.640Z",
    • "cross_id": "62e7f4352c13160013dc39be",
    • "updated_at": "2022-08-02T13:38:44.054000",
    • "environment_name": "Dev Environment",
    • "color": "Gray",
    • "description": "Development environment for new rivers",
    • "variables": {

      • "aws_file_zone": "Rivery-rivery",
      • "azure_file_zone": "Rivery-rivery",
      • "days_ago": "0",
      • "gcs_file_zone": "Rivery-rivery",
      • "hours_offset": "0"

      },
    • "is_deleted": "False",
    • "deleted_by": "62e7f4352c13160013dc39be",
    • "deleted_at": "2022-07-25T18:38:55.640Z",
    • "is_default": "True",
    • "updated_by": "62e7f4352c13160013dc39be",
    • "is_delete_lock": "True"

    }

  ]

}

Add Environment

Authorization scope: environment:edit

Creates a new environment entity

Authorizations:

HTTPBearer

path Parameters

account_id required

string (Account Id)

Request Body schema: application/json

required

name required	string (Name) The environment name
color	string (EnvironmentsColorEnum) Default: "gray.400" Enum: "gray.400" "tagGreen" "cBlues" "tagCyan" "tagGeekBlue" "cPurples" "tagPurple" "tagMagenta" "cOranges" "tagOrange" "yellow.200" The environment color as shown in the app
	Description (string) or Description (null) (Description) The environment description
is_default	boolean (Is Default) Default: "False" A flag that indicates whether the environment is the account's default environment

Responses

US

https://api.rivery.io/v1/accounts/{account_id}/environments

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments

Request samples

• Payload

Content type

application/json

{

• "name": "Dev Environment",
• "color": "Gray.400",
• "description": "Development environment for new rivers",
• "is_default": "True"

}

Response samples

• 201
• 422

Content type

application/json

{

• "_id": "633ede20f1fc5500111fd7b3",
• "account": "62e7f4352c13160013dc39be",
• "user_created": "62e7f4352c13160013dc39be",
• "created_at": "2022-07-25T18:38:55.640Z",
• "cross_id": "62e7f4352c13160013dc39be",
• "updated_at": "2022-08-02T13:38:44.054000",
• "environment_name": "Dev Environment",
• "color": "Gray",
• "description": "Development environment for new rivers",
• "variables": {

  • "aws_file_zone": "Rivery-rivery",
  • "azure_file_zone": "Rivery-rivery",
  • "days_ago": "0",
  • "gcs_file_zone": "Rivery-rivery",
  • "hours_offset": "0"

  },
• "is_deleted": "False",
• "deleted_by": "62e7f4352c13160013dc39be",
• "deleted_at": "2022-07-25T18:38:55.640Z",
• "is_default": "True",
• "updated_by": "62e7f4352c13160013dc39be",
• "is_delete_lock": "True"

}

Get Environment

Authorization scope: environment:list

Get a specific environment

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)

Responses

Response Schema: application/json

_id required	string ( Id) The environment id
account required	string (Account) The account id of the user
cross_id required	string (Cross Id) The cross id of the environment
environment_name required	string (Environment Name) The environment name
variables required	object (Variables) Environment's variables
	User Created (string) or User Created (null) (User Created) The user id of the user who first created the environment
	Created At (string) or Created At (string) or Created At (null) (Created At) The environment creation date time in UTC timezone. Time format YYYY-MM-DDThh:mm:ss.ms
	Updated At (string) or Updated At (string) or Updated At (null) (Updated At) The time in which the environment was last updated (UTC time zone)
color	string (EnvironmentsColorEnum) Default: "gray.400" Enum: "gray.400" "tagGreen" "cBlues" "tagCyan" "tagGeekBlue" "cPurples" "tagPurple" "tagMagenta" "cOranges" "tagOrange" "yellow.200" The environment color as shown in the app
	Description (string) or Description (null) (Description) The environment description
	Is Deleted (boolean) or Is Deleted (null) (Is Deleted) Default: false A flag that indicates whether the environment is deleted
	Deleted By (string) or Deleted By (null) (Deleted By) The user id of the user who deleted the environment (if the environment is deleted)
	Deleted At (string) or Deleted At (string) or Deleted At (null) (Deleted At) The time in which the environment was deleted (if the environment is deleted). Time format YYYY-MM-DDThh:mm:ss.ms
is_default	boolean (Is Default) Default: "False" A flag that indicates whether the environment is the account's default environment
	Updated By (string) or Updated By (null) (Updated By) The user id of the user who last updated the environment
	Is Delete Lock (boolean) or Is Delete Lock (null) (Is Delete Lock) A flag that indicates the environment deletion progress

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments/{environment_id}

Response samples

• 200
• 422

Content type

application/json

{

• "_id": "633ede20f1fc5500111fd7b3",
• "account": "62e7f4352c13160013dc39be",
• "user_created": "62e7f4352c13160013dc39be",
• "created_at": "2022-07-25T18:38:55.640Z",
• "cross_id": "62e7f4352c13160013dc39be",
• "updated_at": "2022-08-02T13:38:44.054000",
• "environment_name": "Dev Environment",
• "color": "Gray",
• "description": "Development environment for new rivers",
• "variables": {

  • "aws_file_zone": "Rivery-rivery",
  • "azure_file_zone": "Rivery-rivery",
  • "days_ago": "0",
  • "gcs_file_zone": "Rivery-rivery",
  • "hours_offset": "0"

  },
• "is_deleted": "False",
• "deleted_by": "62e7f4352c13160013dc39be",
• "deleted_at": "2022-07-25T18:38:55.640Z",
• "is_default": "True",
• "updated_by": "62e7f4352c13160013dc39be",
• "is_delete_lock": "True"

}

Patch Environment

Authorization scope: environment:edit

Updates an existing environment entity

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)

Request Body schema: application/json

required

	Environment Name (string) or Environment Name (null) (Environment Name) The environment name
	EnvironmentsColorEnum (string) or null The environment color as shown in the app
	Description (string) or Description (null) (Description) The environment description
	Is Default (boolean) or Is Default (null) (Is Default) A flag that indicates whether the environment is the account's default environment

Responses

Response Schema: application/json

_id required	string ( Id) The environment id
account required	string (Account) The account id of the user
cross_id required	string (Cross Id) The cross id of the environment
environment_name required	string (Environment Name) The environment name
variables required	object (Variables) Environment's variables
	User Created (string) or User Created (null) (User Created) The user id of the user who first created the environment
	Created At (string) or Created At (string) or Created At (null) (Created At) The environment creation date time in UTC timezone. Time format YYYY-MM-DDThh:mm:ss.ms
	Updated At (string) or Updated At (string) or Updated At (null) (Updated At) The time in which the environment was last updated (UTC time zone)
color	string (EnvironmentsColorEnum) Default: "gray.400" Enum: "gray.400" "tagGreen" "cBlues" "tagCyan" "tagGeekBlue" "cPurples" "tagPurple" "tagMagenta" "cOranges" "tagOrange" "yellow.200" The environment color as shown in the app
	Description (string) or Description (null) (Description) The environment description
	Is Deleted (boolean) or Is Deleted (null) (Is Deleted) Default: false A flag that indicates whether the environment is deleted
	Deleted By (string) or Deleted By (null) (Deleted By) The user id of the user who deleted the environment (if the environment is deleted)
	Deleted At (string) or Deleted At (string) or Deleted At (null) (Deleted At) The time in which the environment was deleted (if the environment is deleted). Time format YYYY-MM-DDThh:mm:ss.ms
is_default	boolean (Is Default) Default: "False" A flag that indicates whether the environment is the account's default environment
	Updated By (string) or Updated By (null) (Updated By) The user id of the user who last updated the environment
	Is Delete Lock (boolean) or Is Delete Lock (null) (Is Delete Lock) A flag that indicates the environment deletion progress

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments/{environment_id}

Request samples

• Payload

Content type

application/json

{

• "environment_name": "Dev Environment",
• "color": "Gray.400",
• "description": "Development environment for new rivers",
• "is_default": "True"

}

Response samples

• 200
• 422

Content type

application/json

{

• "_id": "633ede20f1fc5500111fd7b3",
• "account": "62e7f4352c13160013dc39be",
• "user_created": "62e7f4352c13160013dc39be",
• "created_at": "2022-07-25T18:38:55.640Z",
• "cross_id": "62e7f4352c13160013dc39be",
• "updated_at": "2022-08-02T13:38:44.054000",
• "environment_name": "Dev Environment",
• "color": "Gray",
• "description": "Development environment for new rivers",
• "variables": {

  • "aws_file_zone": "Rivery-rivery",
  • "azure_file_zone": "Rivery-rivery",
  • "days_ago": "0",
  • "gcs_file_zone": "Rivery-rivery",
  • "hours_offset": "0"

  },
• "is_deleted": "False",
• "deleted_by": "62e7f4352c13160013dc39be",
• "deleted_at": "2022-07-25T18:38:55.640Z",
• "is_default": "True",
• "updated_by": "62e7f4352c13160013dc39be",
• "is_delete_lock": "True"

}

Delete Environment

Authorization scope: environment:delete

Delete Environment

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)

Responses

Response Schema: application/json

operation_id required	string (Operation Id) The ID of the operation
operation_type required	string (Operation Type) The type of the operation
run_id required	string (Run Id) The run id of the operation
last_update_date required	string <date-time> (Last Update Date) The date time in UTC timezone of the last update
status required	string (PullRequestStatus) Enum: "W" "E" "R" "D" The current status of the operation id
	Result (any) or Result (null) (Result) The result of the operation
	Error Message (string) or Error Message (null) (Error Message) The error message of the operation

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments/{environment_id}

Response samples

• 200
• 422

Content type

application/json

{

• "operation_id": "62e7f4352c13160013dc39be",
• "operation_type": "dataframe",
• "run_id": "5cbc6bbbc90a4658b00c70a3bb0f3b31",
• "last_update_date": "2022-08-02T13:38:44.054000",
• "status": "D",
• "result": "true",
• "error_message": "[RVR-QBK-003]: Response value error: Missing Rows/Columns"

}