View details of an environment

Learn about the GetDestinationEnvironments endpoint in the DestinationEnvironment collection.

This API enables you to retrieve details of an existing environment entity, such as its name, description, entity ID, and more.

API request

Sample

Parameters

Parameter
Description

id

Unique identifier of the environment entity.

API response

Sample

{
    "result": [
        {
            "id": 30596,
            "name": "Data_Collection_Environment_d100",
            "description": "environment to be used for data collection",
            "identifier": "Data_Collection_Environment_100",
            "creationTime": "2024-11-21T10:55:15.391Z"
        }
    ],
    "targetUrl": null,
    "success": true,
    "error": null,
    "unAuthorizedRequest": false,
    "__abp": true
}

Attributes

Attribute
Description

id

Unique identifier of the environment entity.

name

Name of the environment entity.

description

An explanation of what the environment is.

identifier

An identifying label for the environment entity, for reference.

creationTime

Exact date and time when the environment entity was created.

destination_Entity_Id

Unique identifier of the environment entity.

Last updated

Was this helpful?