Guida SDK › Integration › API Reference List › Translation Script Objects › Tools › Resource Group Methods › GetResourceGroupDetails
GetResourceGroupDetails
Description
This method returns a map with the resource group details.
Syntax
GetResourceGroupDetails (ResourceGroupName, ChangeSetName, CommittedOnly)
Parameters
|
Name
|
Type
|
Description
|
|
ResourceGroupName
|
string
|
The name of the resource group.
|
|
ChangeSetName
|
string
|
The name of the change set.
|
|
CommittedOnly
|
boolean
|
This parameter is optional.
The default is False.
When True, only committed values are retrieved.
When False, get value and consider uncommitted values.
|
Return Value
The map contains the following entries:
- ChangeSetName
- ContractParties: Map of contract parties. The map can be empty.
- CustomAttributes: Map of custom attributes. Each entry in this map is a map that defines one custom attribute. The key of each entry is the custom attribute name and the value is an internal map with the following two entries:
- CustomAttributeName: The custom attribute name.
- CustomAttributeValue: The custom attribute value.
- Effective: Yes or No. Defines if the resource group is effective in the specific date.
- ResourceGroupDescription
- ResourceGroupDisplayName
- ResourceGroupId: The resource group ID.
- ResourceGroupName
- ResourceGroups: Map of resource groups that contains this resource group. The map can be empty.
- Resources: Map of resources and resource groups contained in this resource group. The map can be empty.
- Services: Map of services. The map can be empty.
Remarks
Each entry in each internal map contains the object name in the key and in the value.
This method fails if the resource group and/or the change set do not exist.
