Documentation

RecordHistory extends RecordHistory
in package

Webservice premium container - Get the record history class.

Table of Contents

$allowedHeaders  : array<string|int, mixed>
$allowedMethod  : array<string|int, string>
$controller  : Controller
$responseType  : string
$recordModel  : Vtiger_Record_Model
$userData  : array<string|int, mixed>
checkAction()  : void
Check called action.
get()  : array<string|int, mixed>
Get the record history.
getLanguage()  : string
Get current language.
getParentCrmId()  : int|null
Get parent record.
getPermissionType()  : int
Get permission type.
getUserCrmId()  : int
Get crmid for portal user.
getUserData()  : mixed
Get user data and session data.
getUserStorageId()  : int
Get user storage ID.
preProcess()  : mixed
Pre process function.
setAllUserData()  : void
Set user data.
setUserData()  : void
Set user data.
updateSession()  : void
Update user session.
updateUser()  : void
Update user data.
checkLifetimeSession()  : void
Check lifetime user session.
checkPermission()  : void
Check permission to method.
checkPermissionToModule()  : void
Check permission to module.
isRawData()  : bool
Check if you send raw data.
loadSession()  : void
Load user session data .

Properties

$allowedHeaders

public array<string|int, mixed> $allowedHeaders = []

Allowed headers

$allowedMethod

public array<string|int, string> $allowedMethod

Allowed methods

$responseType

public string $responseType = 'data'

Response data type.

$userData

private array<string|int, mixed> $userData = []

User data

Methods

checkAction()

Check called action.

public checkAction() : void
Tags
throws
Exception
Return values
void —

get()

Get the record history.

public get() : array<string|int, mixed>
Tags
OA\Get

( path="/webservice/WebservicePremium/{moduleName}/RecordHistory/{recordId}", description="Gets the history of the record", summary="Record history", tags={"BaseModule"}, security={{"basicAuth" : }, "ApiKeyAuth" : }, "token" : }}}, @OA\Parameter(name="moduleName", in="path", @OA\Schema(type="string"), description="Module name", required=true, example="Contacts"), @OA\Parameter(name="recordId", in="path", @OA\Schema(type="integer"), description="Record id", required=true, example=116), @OA\Parameter(name="x-row-limit", in="header", @OA\Schema(type="integer"), description="Get rows limit, default: 100", required=false, example=50), @OA\Parameter(name="x-page", in="header", @OA\Schema(type="integer"), description="Page number, default: 1", required=false, example=1), @OA\Parameter(name="x-start-with", in="header", @OA\Schema(type="integer"), description="Show history from given ID", required=false, example=5972), @OA\Parameter(name="x-raw-data", in="header", @OA\Schema(type="integer", enum={0, 1}), description="Gets raw data", required=false, example=1), @OA\Parameter(name="X-ENCRYPTED", in="header", @OA\Schema(ref="#/components/schemas/Header-Encrypted"), required=true), @OA\Response(response=200, description="Recent activities detail", @OA\JsonContent(ref="#/components/schemas/BaseModule_Get_RecordHistory_Response"), @OA\XmlContent(ref="#/components/schemas/BaseModule_Get_RecordHistory_Response"), ), @OA\Response(response=403, description="No permissions to view record OR MadTracker is turned off", @OA\JsonContent(ref="#/components/schemas/Exception"), @OA\XmlContent(ref="#/components/schemas/Exception"), ), @OA\Response(response=404, description="Record doesn't exist", @OA\JsonContent(ref="#/components/schemas/Exception"), @OA\XmlContent(ref="#/components/schemas/Exception"), ), ),

OA\Schema

( schema="BaseModule_Get_RecordHistory_Response", title="Base module - Response action history record", description="Action module for recent activities in CRM", type="object", @OA\Property(property="status", type="integer", enum={0, 1}, description="A numeric value of 0 or 1 that indicates whether the communication is valid. 1 - success , 0 - error"), @OA\Property(property="result", type="object", title="Returns recent activities that took place in CRM", required={"records", "isMorePages"}, @OA\Property(property="records", type="object", title="Entires of recent record activities", @OA\AdditionalProperties(type="object", title="Key indicating the number of changes made to a given record", required={"time", "owner", "status"}, @OA\Property(property="time", type="string", description="Showing the exact date on which the change took place", example="2019-10-07 08:32:38"), @OA\Property(property="owner", type="string", description="Username of the user who made the change", example="System Admin"), @OA\Property(property="status", type="string", description="Name of the action that was carried out", example="changed"), @OA\Property(property="rawTime", type="string", description="Showing the exact date on which the change took place", example="2019-10-07 08:32:38"), @OA\Property(property="rawOwner", type="integer", description="User ID of the user who made the change", example=1), @OA\Property(property="rawStatus", type="string", description="The name of the untranslated label", example="LBL_UPDATED"), @OA\Property(property="data", title="Additional information", oneOf={ @OA\Schema(type="object", title="Record data create", @OA\AdditionalProperties( required={"label", "value", "raw"}, @OA\Property(property="label", type="string", description="Translated field label", example="Name"), @OA\Property(property="value", type="string", description="Value, the data type depends on the field type", example="Jan Kowalski"), @OA\Property(property="raw", type="string", description="Value in database format, only available in x-raw-data", example="Jan Kowalski"), ), ), @OA\Schema(type="object", title="Record data change", description="Edit, conversation", @OA\AdditionalProperties( required={"label", "from", "to"}, @OA\Property(property="label", type="string", description="Translated field label", example="Name"), @OA\Property(property="from", type="string", description="Value before change, the data type depends on the field type", example="Jan Kowalski"), @OA\Property(property="to", type="string", description="Value after change, the data type depends on the field type", example="Jan Nowak"), @OA\Property(property="rawFrom", type="string", description="Value before change, value in database format, only available in x-raw-data", example="Jan Kowalski"), @OA\Property(property="rawTo", type="string", description="Value after change, value in database format, only available in x-raw-data", example="Jan Nowak"), ), ), @OA\Schema(type="object", title="Operations on related records", description="Adding relations, removing relations, transferring records", required={"targetModule", "targetModuleLabel", "targetLabel"}, @OA\Property(property="targetModule", type="string", description="The name of the target related module", example="Contacts"), @OA\Property(property="targetModuleLabel", type="string", description="Translated module name", example="Kontakt"), @OA\Property(property="targetLabel", type="string", description="The label name of the target related module", example="Jan Kowalski"), @OA\Property(property="targetId", type="integer", description="Id of the target related module", example=394), ), }, ), ), ), @OA\Property(property="isMorePages", type="boolean", example=true), ), ),

Return values
array<string|int, mixed> —

getLanguage()

Get current language.

public getLanguage() : string
Return values
string —

getParentCrmId()

Get parent record.

public getParentCrmId() : int|null
Tags
throws
Exception
Return values
int|null —

getPermissionType()

Get permission type.

public getPermissionType() : int
Return values
int —

getUserCrmId()

Get crmid for portal user.

public getUserCrmId() : int
Return values
int —

getUserData()

Get user data and session data.

public getUserData(string $key[, string $param = '' ]) : mixed
Parameters
$key : string
$param : string = ''
Return values
mixed —

getUserStorageId()

Get user storage ID.

public getUserStorageId() : int
Return values
int —

preProcess()

Pre process function.

public preProcess() : mixed
Return values
mixed —

setAllUserData()

Set user data.

public setAllUserData(array<string|int, mixed> $data) : void
Parameters
$data : array<string|int, mixed>
Return values
void —

setUserData()

Set user data.

public setUserData(string $key, mixed $value) : void
Parameters
$key : string
$value : mixed
Return values
void —

updateSession()

Update user session.

public updateSession([array<string|int, mixed> $data = [] ]) : void
Parameters
$data : array<string|int, mixed> = []
Return values
void —

updateUser()

Update user data.

public updateUser([array<string|int, mixed> $data = [] ]) : void
Parameters
$data : array<string|int, mixed> = []
Return values
void —

checkLifetimeSession()

Check lifetime user session.

protected checkLifetimeSession() : void
Tags
throws
Exception
Return values
void —

checkPermission()

Check permission to method.

protected checkPermission() : void
Tags
throws
Exception
Return values
void —

checkPermissionToModule()

Check permission to module.

protected checkPermissionToModule() : void
Tags
throws
Exception
Return values
void —

isRawData()

Check if you send raw data.

protected isRawData() : bool
Return values
bool —

loadSession()

Load user session data .

protected loadSession() : void
Tags
throws
Exception
Return values
void — 

        

        
    




    

    

                

    

        

            
Search results