Get the list of environments for an account

This query retrieves the list of available environments along with their corresponding Integration Pack attachment details for the authorizing account.

Code samples

Input syntax

query env {
  environments {
    id
    name
    classification
    integrationPackEnvironmentAttachment {
       environmentId
       id
       integrationPackInstanceId
    }
   atoms {
         id
         name
     }
  }
}

Field	Type	Description	Required/Optional
id	ID	The environment ID	Response-only field
name	String	The environment name	Response-only field
classification	Classification	The classification of the environment. Input value - PROD	TEST
integrationPackEnvironmentAttachment	IntegrationPackEnvironmentAttachment	The Integration Pack attachment data	Response-only field
atoms	basic runtime	The runtimes data.	Response-only field

IntegrationPackEnvironmentAttachment

Field	Type	Description	Required/Optional
id	ID	The Integration Pack instance environment attachment ID.	Response-only field
integrationPackInstanceId	String	The Integration Pack instance ID.	Response-only field
environmentId	String	The environment ID.	Response-only field

Field	Type	Description	Required/Optional
id	ID	The unique basic runtime ID.	Response-only field
name	String	The name of the basic runtime.	Response-only field

Return syntax

The available environments for the account are returned in the response of a QUERY operation performed on the Environment object. Then, to get the Integration Pack attachment status of each of the environments that are available to the account, a QUERY operation is performed on the Integration Pack Environment Attachment object.

{
  "data": {
    "environments": [
      {
        "id": "ID",
        "name": "String",
        "classification": "Classification",
        "integrationPackEnvironmentAttachment": [
{
            "environmentId": "String",
            "id": "ID",
            "integrationPackInstanceId": "String"
          }
        ],
        "atoms": [
          {
            "id": "ID",
            "name": "String"
          },
          {
            "id": "ID",
            "name": "String"
          },
          {
            "id": "ID",
            "name": "String"
          }
        ]
      }
    ]
  }
}

Implementation

To get the available environments for an account, send the query to platform.boomi.com/graphqlwith the following headers:

Key	Value
SPACE_GUID	<The Space guid\>
Authorization	Bearer <Token\>
Accept	application/json

Sample request

query env {
  environments {
    id
    name
    classification
    integrationPackEnvironmentAttachment {
        environmentId
       id
        integrationPackInstanceId
    }
   atoms {
         id
         name
     }
  }
}

Sample response

{
  "data": {
    "environments": [
      {
        "id": "aec9a3ba-2a9a-43da-998d-1466de6eba23",
        "name": "TestEnvPr",
        "classification": "PROD",
        "integrationPackEnvironmentAttachment": [
          {
            "environmentId": "aec9a3ba-2a9a-43da-998d-1466de6eba23",
            "id": "QVRUQUNIX0lQQUNLX0VOVlNXNTBaV2R5WVhScGIyNVFZV05yU1c1emRHRnVZMlV5TnprM01nOmFlYzlhM2JhLTJhOWEtNDNkYS05OThkLTE0NjZkZTZlYmEyMw",
            "integrationPackInstanceId": "SW50ZWdyYXRpb25QYWNrSW5zdGFuY2UyNzk3Mg"
          }
        ],
        "atoms": [
{
            "id": "5578ce86-0963-4f26-ad74-5f510789b022",
            "name": "Test_atom1"
          },
          {
            "id": "b27c0697-a989-4b53-9fee-724abd301f46",
            "name": "Test_atom2"
          },
          {
            "id": "b57535c3-b650-4ef2-9430-171b9bd4c287",
            "name": "Test_atom"
          }
        ]
      }
    ]
  }
}