create_alias

Use this command to create or update a meaningful name for a data value or object in reports or queries.

Use create_alias to add a meaningful (or user-friendly) synonym to any of the objects listed in the groupTypeDesc parameter field.

For more information about using aliases, see Aliases.

This API is available in Guardium V9.5 and later.

REST API syntax

This API is available as a REST service with the POST method. Call this API as follows:
POST https://[Guardium hostname or IP address]:8443/restAPI/alias

GuardAPI syntax

create_alias parameter=value

Parameters

Parameter Value type Description
aliasValue String Required. The alias for the object or data value.
dbValue String Required. The name of the database or other value for which you are creating an alias.
groupTypeDesc String Required. The type of object for which you are creating the alias. For valid values, call create_alias from the command line with --help=true.
overrideIfExist Boolean Valid values:
  • 0 (false) Default.
  • 1 (true)
  • If set to 1:
    • If an alias does not exist for the specified object, the alias is created.
    • If the specified object already has an alias, the alias for that object is updated to the new alias name.
  • If set to 0, Guardium returns an error message if an alias exists for the object.

GuardAPI example

grdapi create_alias aliasValue="New Central Manager" dbValue=1 groupTypeDesc="Server Hostname"