Get all information about a tag
The result structure is the following:
tag:
id
name (eg: DEAR)
+ translation:
+ langcode (eg: en|de|fr)
id
name (eg: CHER)
+ replacements
id
title_id (each company may have a different id for the same title)
formal_text (such as 'Cher Monsieur #'. Note the # is part of the replacement text. See next)
formal_value (this is what the # sign is replaced with. See below for the list of replacement values)
informal_text (such as 'Cher #'. Note the # is part of the replacement text. See next)
informal_value (this is what the # sign is replaced with. See below for the list of replacement values)
Arguments
required: tag (array or serialized string of an array in the same format of getTag)
tag must have an id, in other places where is missing, a new one is created is created
// Here is a pseudo version for saving a tag that already exists
$aData = arrray();
$aData['id] = 1; // This means that the tag already exists and we are replacing it.
// Note If this is a system defined title tag than changing the name does nothing
$aData['name'] = 'WELCOME'; // If not provided the old value is not changed.
$aData['translations']['en]['id] = 1234; // This assumes that it already exists
$aData['translations']['en]['name] = 'WELCOME'; // This should not be empty if no id is provided. Again if its a system defined title tag, no change is done to the name
$aData['translations']['en]['replacements][0]['title_id] = 23; // This represents a title from wbs/company/title object
$aData['en]['replacements]['formal_text] = 'Sincely welcome #'; // The # sign should exist
$aData['en]['replacements]['formal_value] = 'LN'; // The # sign would be replaced with Lastname
$aData['en]['replacements]['informal_text] = 'Hey you #'; // The # sign should exist
$aData['en]['replacements]['informal_value] = 'FN'; // The # sign would be replaced with firstname
And then someting like
$API->call("Settings/TitleTags/saveTag?tag=" . serialized($aData));
Arguments
| id |
integer |
| tag |
string, required |
Get all records with pagination.
The function accepts limit and has a maximum limit that can not be overwritten
@return
Data Table object
Arguments
Get Change Log for an object
Arguments