RetrieveEnvironmentVariables Function
API responsible for retrieving all environment variables based on a given criteria.
Parameters
Parameters allow for data to be passed to the function.
| Name | Type | Nullable | Unicode | Description |
|---|---|---|---|---|
|
SchemaNames
|
Collection( Edm.String ) | False | False | Array of schema names corresponding to environment variables. If no schema name collection is provided, all variables accessible by the calling user will be returned (Optional). |
Return type
| Type | Nullable | Description |
|---|---|---|
| Collection(crmbaseentity) | False | The RetrieveEnvironmentVariables function returns the following value. |
Entities
Use the RetrieveEnvironmentVariables function with these entity types:
| Name | Display name | Description |
|---|---|---|
| environmentvariabledefinition | Environment Variable Definition | Contains information about the settable variable: its type, default value, and etc. |