Function get
has a Cognitive Complexity of 17 (exceeds 5 allowed). Consider refactoring. Open
public function get(): array
{
$return = parent::get();
if ($this->controller->headers['x-header-fields'] ?? 0) {
$fieldsHeader = [];
- Read upRead up
Cognitive Complexity
Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.
A method's cognitive complexity is based on a few simple rules:
- Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
- Code is considered more complex for each "break in the linear flow of the code"
- Code is considered more complex when "flow breaking structures are nested"
Further reading
Avoid assigning values to variables in if clauses and the like (line '170', column '44'). Open
public function get(): array
{
$return = parent::get();
if ($this->controller->headers['x-header-fields'] ?? 0) {
$fieldsHeader = [];
- Read upRead up
- Exclude checks
IfStatementAssignment
Since: 2.7.0
Assignments in if clauses and the like are considered a code smell. Assignments in PHP return the right operand as their result. In many cases, this is an expected behavior, but can lead to many difficult to spot bugs, especially when the right operand could result in zero, null or an empty string and the like.
Example
class Foo
{
public function bar($flag)
{
if ($foo = 'bar') { // possible typo
// ...
}
if ($baz = 0) { // always false
// ...
}
}
}
Source http://phpmd.org/rules/cleancode.html#ifstatementassignment
The method get uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them. Open
} else {
$value = $this->recordModel->get($fieldModel->getName());
if ('' === $value) {
continue;
}
- Read upRead up
- Exclude checks
ElseExpression
Since: 1.4.0
An if expression with an else branch is basically not necessary. You can rewrite the conditions in a way that the else clause is not necessary and the code becomes simpler to read. To achieve this, use early return statements, though you may need to split the code it several smaller methods. For very simple assignments you could also use the ternary operations.
Example
class Foo
{
public function bar($flag)
{
if ($flag) {
// one branch
} else {
// another branch
}
}
}
Source https://phpmd.org/rules/cleancode.html#elseexpression
Possibly zero references to use statement for classlike/namespace OA
(\OpenApi\Annotations)
Open
use OpenApi\Annotations as OA;
- Exclude checks
Call to undeclared method \Vtiger_Base_UIType::getProgressHeader
Open
$headerField['values'] = $fieldModel->getUITypeModel()->getProgressHeader($this->recordModel);
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* tags={"BaseModule"},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Parameter(name="x-fields-params", in="header", description="JSON array - list of fields to be returned in the specified way", required=false,
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* description="Get header fields",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* description="`No permissions to remove record` OR `No permissions to view record` OR `No permissions to edit record`",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Response(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
public $allowedHeaders = ['x-parent-id', 'x-header-fields', 'x-fields-params'];
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Get(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* security={{"basicAuth" : {}, "ApiKeyAuth" : {}, "token" : {}}},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Response(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* description="Gets data for the record",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\XmlContent(ref="#/components/schemas/Exception"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
/**
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @api
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* required=false
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
*
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Parameter(name="moduleName", in="path", @OA\Schema(type="string"), description="Module name", required=true, example="Contacts"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Parameter(name="X-ENCRYPTED", in="header", @OA\Schema(ref="#/components/schemas/Header-Encrypted"), required=true),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Parameter(name="X-ENCRYPTED", in="header", @OA\Schema(ref="#/components/schemas/Header-Encrypted"), required=true),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Parameter(name="x-raw-data", in="header", @OA\Schema(type="integer", enum={0, 1}), description="Gets raw data", required=false, example=1),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Parameter(name="x-parent-id", in="header", @OA\Schema(type="integer"), description="Parent record id", required=false, example=5),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* description="Get header fields",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\XmlContent(ref="#/components/schemas/Exception"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* title="Custom field settings",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* title="Custom field settings",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* description="A list of custom parameters that can affect the return value of a given field.",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* example={"password" : {"showHiddenData" : true}}
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* security={{"basicAuth" : {}, "ApiKeyAuth" : {}, "token" : {}}},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* response=200,
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Schema(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* description="A list of custom parameters that can affect the return value of a given field.",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* schema="BaseModule_Get_Record_Response",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* title="Base module - Response body for Record",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Parameter(name="recordId", in="path", @OA\Schema(type="integer"), description="Record id", required=true, example=116),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* response=200,
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* description="Gets data for the record",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\JsonContent(ref="#/components/schemas/Fields-Settings"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Response(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* description="`No permissions to remove record` OR `No permissions to view record` OR `No permissions to edit record`",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\JsonContent(ref="#/components/schemas/Exception"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* example={"password" : {"showHiddenData" : true}}
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @author Radosław Skrzypczak <r.skrzypczak@yetiforce.com>
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
*
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* description="Gets the details of a record",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Response(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\JsonContent(ref="#/components/schemas/Exception"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* Get record detail.
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* path="/webservice/WebservicePremium/{moduleName}/Record/{recordId}",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Parameter(name="x-parent-id", in="header", @OA\Schema(type="integer"), description="Parent record id", required=false, example=5),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* in="header",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\XmlContent(ref="#/components/schemas/BaseModule_Get_Record_Response"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\XmlContent(ref="#/components/schemas/Exception"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* summary="Data for the record",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* operationId="getRecord",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Schema(type="integer"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* in="header",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* response=404,
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* path="/webservice/WebservicePremium/{moduleName}/Record/{recordId}",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\JsonContent(ref="#/components/schemas/BaseModule_Get_Record_Response"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* description="`No record id` OR `Record doesn't exist`",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\XmlContent(ref="#/components/schemas/Exception"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @return array
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* summary="Data for the record",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Parameter(name="recordId", in="path", @OA\Schema(type="integer"), description="Record id", required=true, example=116),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Parameter(name="x-raw-data", in="header", @OA\Schema(type="integer", enum={0, 1}), description="Gets raw data", required=false, example=1),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\JsonContent(ref="#/components/schemas/Fields-Settings"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Parameter(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* name="x-header-fields",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\JsonContent(ref="#/components/schemas/BaseModule_Get_Record_Response"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\XmlContent(ref="#/components/schemas/BaseModule_Get_Record_Response"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\JsonContent(ref="#/components/schemas/Exception"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\JsonContent(ref="#/components/schemas/Exception"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* title="Base module - Response body for Record",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
*
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Get(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* tags={"BaseModule"},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* operationId="getRecord",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Parameter(name="moduleName", in="path", @OA\Schema(type="string"), description="Module name", required=true, example="Contacts"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* required=false
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Schema(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @author Mariusz Krzaczkowski <m.krzaczkowski@yetiforce.com>
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Parameter(name="x-fields-params", in="header", description="JSON array - list of fields to be returned in the specified way", required=false,
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Response(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* description="`No record id` OR `Record doesn't exist`",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* schema="Fields-Settings",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* type="object",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* property="privileges",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* title="Parameters determining checking of editing rights and moving to the trash",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* required={"isEditable", "moveToTrash"},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="isEditable", description="Check if record is editable", type="boolean", example=true),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* type="object", title="Header field details",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="value", description="Data in API format", oneOf={@OA\Schema(type="object"), @OA\Schema(type="string"), @OA\Schema(type="number"), @OA\Schema(type="integer")}),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @license YetiForce Public License 6.5 (licenses/LicenseEN.txt or yetiforce.com)
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
/** {@inheritdoc} */
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* description="Gets the details of a record",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Schema(type="integer"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* response=403,
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* response=404,
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* type="object",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Parameter(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* name="x-header-fields",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* response=403,
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Response(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* schema="Fields-Settings",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* type="object",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Schema(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* schema="BaseModule_Get_Record_Response",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* type="object",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="class", type="string", description="Class name", example="badge-info"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="label", type="string", description="Value to display", example="Awaiting verification"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* title="Record data",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* property="progress", type="object", title="Progress header fields",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="isEditable", type="boolean", description="Is editable", example=false),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="description", type="string", description="Description", example=""),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="color", type="string", description="Color", example="ffa800"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\AdditionalProperties(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="id", description="Record Id", type="integer", example=152),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="fields", type="object", title="System field names and field labels", example={"field_name_1" : "Field label 1", "field_name_2" : "Field label 2", "assigned_user_id" : "Assigned user", "createdtime" : "Created time"},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* required={"isEditable", "moveToTrash"},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* property="headerFields", type="object", title="Get header fields details.",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* property="value",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="data", title="Record data", type="object", ref="#/components/schemas/Record_Display_Details"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* property="privileges",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="isEditable", description="Check if record is editable", type="boolean", example=true),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="moveToTrash", description="Permission to delete", type="boolean", example=false),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* property="values", type="object", title="Class name",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* type="object", title="Header field details",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="isActive", type="boolean", description="Is active", example=false),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="description", type="string", description="Description", example=""),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* required={"type", "label", "value"},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="label", type="string", description="Translated field label", example="Assigned To"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* required={"status", "result"},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @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"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\AdditionalProperties(type="string", description="Field label"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="data", title="Record data", type="object", ref="#/components/schemas/Record_Display_Details"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* property="headerFields", type="object", title="Get header fields details.",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* property="progress", type="object", title="Progress header fields",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="label", type="string", description="Translated field label", example="Assigned To"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* property="values", type="object", title="Class name",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="color", type="string", description="Color", example="ffa800"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* type="object",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* required={"type", "label", "value"},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="value", description="Data in API format", oneOf={@OA\Schema(type="object"), @OA\Schema(type="string"), @OA\Schema(type="number"), @OA\Schema(type="integer")}),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* type="object",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* required={"name", "id", "fields", "data"},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="id", description="Record Id", type="integer", example=152),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="rawData", description="Raw record data", type="object", ref="#/components/schemas/Record_Raw_Details"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="class", type="string", description="Class name", example="badge-info"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="isLocked", type="boolean", description="Is locked", example=false),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* title="Value header fields",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\AdditionalProperties(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="class", type="string", description="Class name", example="badge-info"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="moveToTrash", description="Permission to delete", type="boolean", example=false),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="rawData", description="Raw record data", type="object", ref="#/components/schemas/Record_Raw_Details"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* required={"label", "isActive", "isLocked", "isEditable"},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* type="object", title="Header field details",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* property="highlights",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* required={"status", "result"},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @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"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* title="Parameters determining checking of editing rights and moving to the trash",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="summaryInventory", description="Value summary inventory data", type="object"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\AdditionalProperties(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
continue;
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* path="/webservice/WebservicePremium/{moduleName}/Record/{recordId}",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Parameter(name="moduleName", in="path", @OA\Schema(type="string"), description="Module name", required=true, example="Contacts"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\JsonContent(ref="#/components/schemas/BaseModule_Delete_Record_Response"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* summary="Edit record",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* security={{"basicAuth" : {}, "ApiKeyAuth" : {}, "token" : {}}},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="name", description="Record name", type="string", example="Driving school"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="fields", type="object", title="System field names and field labels", example={"field_name_1" : "Field label 1", "field_name_2" : "Field label 2", "assigned_user_id" : "Assigned user", "createdtime" : "Created time"},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="inventory", description="Value inventory data", type="object"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\AdditionalProperties(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* property="value",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="type", type="string", description="Header field type", example="value"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
}
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
}
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Delete(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* description="List of records moved to the trash",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Schema(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
if ($this->controller->headers['x-header-fields'] ?? 0) {
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
$fieldsHeader = [];
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
}
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Delete(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Parameter(name="X-ENCRYPTED", in="header", @OA\Schema(ref="#/components/schemas/Header-Encrypted"), required=true),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @api
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
*
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* path="/webservice/WebservicePremium/{moduleName}/Record/{recordId}",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\RequestBody(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* required={"name", "id", "fields", "data"},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* type="object",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\AdditionalProperties(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* type="object", title="Header field details",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* required={"type", "label", "values"},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="label", type="string", description="Value to display", example="Awaiting verification"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="label", type="string", description="Translated field label", example="Assigned To"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="label", type="string", description="Translated field label", example="Assigned To"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="class", type="string", description="Class name", example="badge-info"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
$headerField['label'] = $fieldModel->getFullLabelTranslation();
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
} else {
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
}
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @api
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* description="List of records moved to the trash",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* type="object",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
return parent::delete();
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* tags={"BaseModule"},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* required=true,
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* title="Record data",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\AdditionalProperties(type="string", description="Field label"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="summaryInventory", description="Value summary inventory data", type="object"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* required={"type", "label", "values"},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="type", type="string", description="Header field type", example="value"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="label", type="string", description="Translated field label", example="Assigned To"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="isLocked", type="boolean", description="Is locked", example=false),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* title="Value header fields",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
*
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* path="/webservice/WebservicePremium/{moduleName}/Record/{recordId}",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* description="Changes the state of a record, moving it to the trash",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* summary="Delete record",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Parameter(name="X-ENCRYPTED", in="header", @OA\Schema(ref="#/components/schemas/Header-Encrypted"), required=true),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\XmlContent(ref="#/components/schemas/BaseModule_Delete_Record_Response"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
*
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* type="object",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* type="object",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="rawInventory", description="Inventory data", type="object"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="isEditable", type="boolean", description="Is editable", example=false),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="type", type="string", description="Header field type", example="value"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="label", type="string", description="Translated field label", example="Assigned To"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="class", type="string", description="Class name", example="badge-info"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* type="object",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="value", description="Data in API format", oneOf={@OA\Schema(type="object"), @OA\Schema(type="string"), @OA\Schema(type="number"), @OA\Schema(type="integer")}),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
return $return;
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* tags={"BaseModule"},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* security={{"basicAuth" : {}, "ApiKeyAuth" : {}, "token" : {}}},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* description="List of records moved to the trash",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* required={"status", "result"},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @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"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
}
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="name", description="Record name", type="string", example="Driving school"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* type="object", title="Header field details",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="type", type="string", description="Header field type", example="value"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="class", type="string", description="Class name", example="badge-info"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
$fieldsHeader[$headerField['type']][$fieldModel->getName()] = $headerField;
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* response=200,
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* type="object",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @return array
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* required=true,
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* property="result",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="inventory", description="Value inventory data", type="object"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="rawInventory", description="Inventory data", type="object"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* required={"label", "isActive", "isLocked", "isEditable"},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="isActive", type="boolean", description="Is active", example=false),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* property="highlights",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="type", type="string", description="Header field type", example="value"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="value", description="Data in API format", oneOf={@OA\Schema(type="object"), @OA\Schema(type="string"), @OA\Schema(type="number"), @OA\Schema(type="integer")}),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
*/
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
{
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
$value = $this->recordModel->get($fieldModel->getName());
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
if ('' === $value) {
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* description="Changes the state of a record, moving it to the trash",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* tags={"BaseModule"},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Parameter(name="recordId", in="path", @OA\Schema(type="integer"), description="Record id", required=true, example=116),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="result", type="boolean", description="Status of successful transfer of the record to the recycle bin"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* property="result",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\AdditionalProperties(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* type="object",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* type="object", title="Header field details",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
if ('progress' === $headerField['type']) {
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
}
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Parameter(name="moduleName", in="path", @OA\Schema(type="string"), description="Module name", required=true, example="Contacts"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Schema(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* title="Base module - Transfer to the trash",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @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"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* path="/webservice/WebservicePremium/{moduleName}/Record/{recordId}",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* type="object", title="Header field details",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
foreach ($this->recordModel->getModule()->getFields() as $fieldModel) {
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
*
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\RequestBody(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* title="Highlights header fields",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="type", type="string", description="Header field type", example="value"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
if (!$fieldModel->isActiveField() || !($headerField = $fieldModel->getHeaderField())) {
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\JsonContent(ref="#/components/schemas/BaseModule_Delete_Record_Response"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
public function delete(): bool
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Put(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
$return = parent::get();
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
continue;
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* Delete record.
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* summary="Delete record",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="result", type="boolean", description="Status of successful transfer of the record to the recycle bin"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
}
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
$return['headerFields'] = $fieldsHeader;
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
/**
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* schema="BaseModule_Delete_Record_Response",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* title="Base module - Transfer to the trash",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* Edit record.
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* description="Retrieves data for editing a record",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* tags={"BaseModule"},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* title="Highlights header fields",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* type="object",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\AdditionalProperties(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\AdditionalProperties(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @return bool
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
*
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* description="List of records moved to the trash",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* schema="BaseModule_Delete_Record_Response",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* required={"status", "result"},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
*/
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* required={"type", "label", "value"},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
$headerField['value'] = $fieldModel->getUITypeModel()->getApiDisplayValue($value, $this->recordModel);
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* security={{"basicAuth" : {}, "ApiKeyAuth" : {}, "token" : {}}},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Parameter(name="recordId", in="path", @OA\Schema(type="integer"), description="Record id", required=true, example=116),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
{
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* description="Retrieves data for editing a record",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\JsonContent(ref="#/components/schemas/BaseModule_Put_Record_Response"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Schema(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="result", type="object", title="Record data", description="Created record id and name.",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* tags={"BaseModule"},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* security={{"basicAuth" : {}, "ApiKeyAuth" : {}, "token" : {}}},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* type="object", title="Header field details",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* required={"type", "label", "value"},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
public function get(): array
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
$headerField['values'] = $fieldModel->getUITypeModel()->getProgressHeader($this->recordModel);
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
*
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Response(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Response(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* response=200,
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\XmlContent(ref="#/components/schemas/BaseModule_Delete_Record_Response"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
/**
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Put(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* summary="Edit record",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* security={{"basicAuth" : {}, "ApiKeyAuth" : {}, "token" : {}}},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* description="Contents of the request contains an associative array with the data record.",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\XmlContent(ref="#/components/schemas/Record_Edit_Details"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Response(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\JsonContent(ref="#/components/schemas/BaseModule_Put_Record_Response"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Link(link="GetRecordById", ref="#/components/links/GetRecordById")
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\JsonContent(ref="#/components/schemas/Exception"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* schema="BaseModule_Put_Record_Response",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* title="Base module - Response body for Record",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* description="Contents of the response contains only id",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* required={"id", "name"},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="skippedData", type="object", description="List of parameters passed in the request that were skipped in the write process"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Schema(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* schema="Record_Display_Details",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* title="General - Record display details",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\JsonContent(ref="#/components/schemas/Record_Edit_Details"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="name", type="string", description="Id of the newly created record", example="YetiForce Name"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Schema(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* schema="Record_Edit_Details",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
return parent::put();
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
*
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* summary="Create record",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\JsonContent(ref="#/components/schemas/Record_Edit_Details"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Response(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* response=200, description="Contents of the response contains only id",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Response(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\JsonContent(ref="#/components/schemas/Exception"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* required={"status", "result"},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* description="Record data in user format for preview",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @return array
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
*
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* path="/webservice/WebservicePremium/{moduleName}/Record",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* summary="Create record",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\RequestBody(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\JsonContent(ref="#/components/schemas/Record_Edit_Details"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Parameter(name="recordId", in="path", @OA\Schema(type="integer"), description="Record id", required=true, example=116),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Response(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Schema(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="result", type="object", title="Record data", description="Created record id and name.",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Schema(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* type="object",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @api
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\XmlContent(ref="#/components/schemas/Record_Edit_Details"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* required={"id", "name"},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* example={"field_name_1" : "Tom", "field_name_2" : "Kowalski", "assigned_user_id" : 1, "createdtime" : "2014-09-24 20:51:12"},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
/**
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* description="Create new record",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* tags={"BaseModule"},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Parameter(name="X-ENCRYPTED", in="header", @OA\Schema(ref="#/components/schemas/Header-Encrypted"), required=true),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\XmlContent(ref="#/components/schemas/Exception"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="id", type="integer", description="Id of the newly created record", example=22),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* description="Record data in user format for edit view",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* description="Record data in the system format as stored in a database",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Schema(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
public function put(): array
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
*
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* path="/webservice/WebservicePremium/{moduleName}/Record",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* security={{"basicAuth" : {}, "ApiKeyAuth" : {}, "token" : {}}},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Parameter(name="moduleName", in="path", @OA\Schema(type="string"), description="Module name", required=true, example="Contacts"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* type="object",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @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"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="skippedData", type="object", description="List of parameters passed in the request that were skipped in the write process"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* title="General - Record edit details",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* type="object",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* title="General - Record raw details",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* type="object",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* example={"id" : 11, "field_name_1" : "Tom", "field_name_2" : "Kowalski", "assigned_user_id" : "YetiForce Administrator", "createdtime" : "2014-09-24 20:51"},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Post(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* description="Contents of the request contains an associative array with the data record.",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\XmlContent(ref="#/components/schemas/Record_Edit_Details"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Parameter(name="X-ENCRYPTED", in="header", @OA\Schema(ref="#/components/schemas/Header-Encrypted"), required=true),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Response(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* required={"id", "name"},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* "recordId" = "$response.body#/result/id"
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* )
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* response=406, description="No input data",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\XmlContent(ref="#/components/schemas/Exception"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* title="General - Record edit details",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
*/
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* description="Contents of the response contains only id",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\XmlContent(ref="#/components/schemas/BaseModule_Put_Record_Response"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* title="General - Record raw details",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* schema="Record_Display_Details",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
}
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* description="Create new record",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Parameter(name="moduleName", in="path", @OA\Schema(type="string"), description="Module name", required=true, example="Contacts"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Schema(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* type="object",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
{
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Parameter(name="X-ENCRYPTED", in="header", @OA\Schema(ref="#/components/schemas/Header-Encrypted"), required=true),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="result", type="object", title="Record data", description="Created record id and name.",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\JsonContent(ref="#/components/schemas/Record_Edit_Details"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* response=200, description="Contents of the response contains only id",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\XmlContent(ref="#/components/schemas/BaseModule_Put_Record_Response"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="name", type="string", description="Id of the newly created record", example="YetiForce Name"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* example={"field_name_1" : "Tom", "field_name_2" : "Kowalski", "assigned_user_id" : 1, "createdtime" : "2014-09-24 20:51:12"},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* example={"id" : 11, "field_name_1" : "Tom", "field_name_2" : "Kowalski", "assigned_user_id" : 1, "createdtime" : "2014-09-24 20:51:12"},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* required=true,
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Parameter(name="moduleName", in="path", @OA\Schema(type="string"), description="Module name", required=true, example="Contacts"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* response=406, description="No input data",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Schema(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* type="object",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* parameters={
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Parameter(name="X-ENCRYPTED", in="header", @OA\Schema(ref="#/components/schemas/Header-Encrypted"), required=true),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Link(link="GetRecordById", ref="#/components/links/GetRecordById")
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* response=406, description="No input data",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* description="Contents of the response contains only id",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* required={"status", "result"},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* description="Record data in user format for edit view",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="id", type="integer", description="Id of the newly created record", example=22),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* schema="Record_Raw_Details",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* description="Record data in the system format as stored in a database",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* description="The `id` value returned in the response can be used as the `recordId` parameter in `GET /webservice/{moduleName}/Record/{recordId}`.",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* type="object",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* }
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Post(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* required=true,
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
return parent::post();
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* description="Contents of the request contains an associative array with the data record.",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\JsonContent(ref="#/components/schemas/Exception"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* title="Base module - Created records",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* required={"id", "name"},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Link(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* parameters={
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
public function post(): array
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\XmlContent(ref="#/components/schemas/Exception"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="id", type="integer", description="Id of the newly created record", example=22),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="skippedData", type="object", description="List of parameters passed in the request that were skipped in the write process"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Parameter(name="recordId", in="path", @OA\Schema(type="integer"), description="Record id", required=true, example=116),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* type="object",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Schema(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* example={"id" : 11, "field_name_1" : "Tom", "field_name_2" : "Kowalski", "assigned_user_id" : 1, "createdtime" : "2014-09-24 20:51:12"},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* title="General - Record display details",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* example={"id" : 11, "field_name_1" : "Tom", "field_name_2" : "Kowalski", "assigned_user_id" : "YetiForce Administrator", "createdtime" : "2014-09-24 20:51"},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Response(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* response=200, description="Contents of the response contains only id",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\JsonContent(ref="#/components/schemas/BaseModule_Post_Record_Response"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\JsonContent(ref="#/components/schemas/BaseModule_Post_Record_Response"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
}
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\XmlContent(ref="#/components/schemas/Record_Edit_Details"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Link(link="GetRecordById", ref="#/components/links/GetRecordById")
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Link(link="GetRecordById", ref="#/components/links/GetRecordById")
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* response=406, description="No input data",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* schema="BaseModule_Post_Record_Response",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* description="Contents of the response contains only id",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* link="GetRecordById",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* "recordId" = "$response.body#/result/id"
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* description="Contents of the request contains an associative array with the data record.",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* schema="BaseModule_Put_Record_Response",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* title="Base module - Response body for Record",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @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"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* schema="Record_Edit_Details",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* schema="Record_Raw_Details",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* description="Record data in user format for preview",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* type="object",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* Create record.
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\RequestBody(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* title="Base module - Created records",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* type="object",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* description="The `id` value returned in the response can be used as the `recordId` parameter in `GET /webservice/{moduleName}/Record/{recordId}`.",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* operationId="getRecord",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* response=200, description="Contents of the response contains only id",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Response(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* schema="BaseModule_Post_Record_Response",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @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"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="result", type="object", title="Record data", description="Created record id and name.",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* link="GetRecordById",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* operationId="getRecord",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\XmlContent(ref="#/components/schemas/Exception"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="id", type="integer", description="Id of the newly created record", example=22),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="skippedData", type="object", description="List of parameters passed in the request that were skipped in the write process"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* }
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* )
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\XmlContent(ref="#/components/schemas/BaseModule_Post_Record_Response"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* required={"status", "result"},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\JsonContent(ref="#/components/schemas/Exception"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="name", type="string", description="Id of the newly created record", example="YetiForce Name"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Property(property="name", type="string", description="Id of the newly created record", example="YetiForce Name"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Link(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
*/
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Parameter(name="moduleName", in="path", @OA\Schema(type="string"), description="Module name", required=true, example="Contacts"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Response(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* required={"status", "result"},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @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"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
{
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\XmlContent(ref="#/components/schemas/BaseModule_Post_Record_Response"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* @OA\Schema(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
* ),
- Exclude checks
Line exceeds 120 characters; contains 157 characters Open
* @OA\Parameter(name="x-fields-params", in="header", description="JSON array - list of fields to be returned in the specified way", required=false,
- Exclude checks
Line exceeds 120 characters; contains 135 characters Open
* @OA\Parameter(name="recordId", in="path", @OA\Schema(type="integer"), description="Record id", required=true, example=116),
- Exclude checks
Line exceeds 120 characters; contains 131 characters Open
* @OA\Parameter(name="X-ENCRYPTED", in="header", @OA\Schema(ref="#/components/schemas/Header-Encrypted"), required=true),
- Exclude checks
Line exceeds 120 characters; contains 146 characters Open
* @OA\Parameter(name="x-parent-id", in="header", @OA\Schema(type="integer"), description="Parent record id", required=false, example=5),
- Exclude checks
Line exceeds 120 characters; contains 126 characters Open
* @OA\Property(property="isActive", type="boolean", description="Is active", example=false),
- Exclude checks
Line exceeds 120 characters; contains 121 characters Open
* @OA\Property(property="color", type="string", description="Color", example="ffa800"),
- Exclude checks
Line exceeds 120 characters; contains 145 characters Open
* @OA\Parameter(name="moduleName", in="path", @OA\Schema(type="string"), description="Module name", required=true, example="Contacts"),
- Exclude checks
Line exceeds 120 characters; contains 155 characters Open
* @OA\Parameter(name="x-raw-data", in="header", @OA\Schema(type="integer", enum={0, 1}), description="Gets raw data", required=false, example=1),
- Exclude checks
Line exceeds 120 characters; contains 134 characters Open
* description="`No permissions to remove record` OR `No permissions to view record` OR `No permissions to edit record`",
- Exclude checks
Line exceeds 120 characters; contains 255 characters Open
* @OA\Property(property="fields", type="object", title="System field names and field labels", example={"field_name_1" : "Field label 1", "field_name_2" : "Field label 2", "assigned_user_id" : "Assigned user", "createdtime" : "Created time"},
- Exclude checks
Line exceeds 120 characters; contains 126 characters Open
* @OA\Property(property="isLocked", type="boolean", description="Is locked", example=false),
- Exclude checks
Line exceeds 120 characters; contains 189 characters Open
* @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"),
- Exclude checks
Line exceeds 120 characters; contains 122 characters Open
* @OA\Property(property="class", type="string", description="Class name", example="badge-info"),
- Exclude checks
Line exceeds 120 characters; contains 147 characters Open
* @OA\Property(property="label", type="string", description="Value to display", example="Awaiting verification"),
- Exclude checks
Line exceeds 120 characters; contains 130 characters Open
* @OA\Property(property="isEditable", type="boolean", description="Is editable", example=false),
- Exclude checks
Line exceeds 120 characters; contains 123 characters Open
* @OA\Property(property="type", type="string", description="Header field type", example="value"),
- Exclude checks
Line exceeds 120 characters; contains 122 characters Open
* @OA\Property(property="class", type="string", description="Class name", example="badge-info"),
- Exclude checks
Line exceeds 120 characters; contains 189 characters Open
* @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"),
- Exclude checks
Line exceeds 120 characters; contains 127 characters Open
* @OA\Property(property="description", type="string", description="Description", example=""),
- Exclude checks
Line exceeds 120 characters; contains 123 characters Open
* @OA\Property(property="type", type="string", description="Header field type", example="value"),
- Exclude checks
Line exceeds 120 characters; contains 135 characters Open
* @OA\Parameter(name="recordId", in="path", @OA\Schema(type="integer"), description="Record id", required=true, example=116),
- Exclude checks
Line exceeds 120 characters; contains 129 characters Open
* @OA\Property(property="isEditable", description="Check if record is editable", type="boolean", example=true),
- Exclude checks
Line exceeds 120 characters; contains 123 characters Open
* @OA\Property(property="type", type="string", description="Header field type", example="value"),
- Exclude checks
Line exceeds 120 characters; contains 131 characters Open
* @OA\Parameter(name="X-ENCRYPTED", in="header", @OA\Schema(ref="#/components/schemas/Header-Encrypted"), required=true),
- Exclude checks
Line exceeds 120 characters; contains 124 characters Open
* @OA\Property(property="moveToTrash", description="Permission to delete", type="boolean", example=false),
- Exclude checks
Line exceeds 120 characters; contains 135 characters Open
* @OA\Property(property="label", type="string", description="Translated field label", example="Assigned To"),
- Exclude checks
Line exceeds 120 characters; contains 142 characters Open
* @OA\Property(property="rawData", description="Raw record data", type="object", ref="#/components/schemas/Record_Raw_Details"),
- Exclude checks
Line exceeds 120 characters; contains 135 characters Open
* @OA\Property(property="label", type="string", description="Translated field label", example="Assigned To"),
- Exclude checks
Line exceeds 120 characters; contains 210 characters Open
* @OA\Property(property="value", description="Data in API format", oneOf={@OA\Schema(type="object"), @OA\Schema(type="string"), @OA\Schema(type="number"), @OA\Schema(type="integer")}),
- Exclude checks
Line exceeds 120 characters; contains 210 characters Open
* @OA\Property(property="value", description="Data in API format", oneOf={@OA\Schema(type="object"), @OA\Schema(type="string"), @OA\Schema(type="number"), @OA\Schema(type="integer")}),
- Exclude checks
Line exceeds 120 characters; contains 122 characters Open
$headerField['value'] = $fieldModel->getUITypeModel()->getApiDisplayValue($value, $this->recordModel);
- Exclude checks
Line exceeds 120 characters; contains 133 characters Open
* @OA\Property(property="data", title="Record data", type="object", ref="#/components/schemas/Record_Display_Details"),
- Exclude checks
Line exceeds 120 characters; contains 135 characters Open
* @OA\Property(property="label", type="string", description="Translated field label", example="Assigned To"),
- Exclude checks
Line exceeds 120 characters; contains 145 characters Open
* @OA\Parameter(name="moduleName", in="path", @OA\Schema(type="string"), description="Module name", required=true, example="Contacts"),
- Exclude checks
Line exceeds 120 characters; contains 122 characters Open
* @OA\Property(property="class", type="string", description="Class name", example="badge-info"),
- Exclude checks
Line exceeds 120 characters; contains 138 characters Open
* @OA\Property(property="result", type="boolean", description="Status of successful transfer of the record to the recycle bin"),
- Exclude checks
Line exceeds 120 characters; contains 145 characters Open
* @OA\Parameter(name="moduleName", in="path", @OA\Schema(type="string"), description="Module name", required=true, example="Contacts"),
- Exclude checks
Line exceeds 120 characters; contains 122 characters Open
* @OA\Property(property="result", type="object", title="Record data", description="Created record id and name.",
- Exclude checks
Line exceeds 120 characters; contains 133 characters Open
* @OA\Property(property="name", type="string", description="Id of the newly created record", example="YetiForce Name"),
- Exclude checks
Line exceeds 120 characters; contains 131 characters Open
* @OA\Parameter(name="X-ENCRYPTED", in="header", @OA\Schema(ref="#/components/schemas/Header-Encrypted"), required=true),
- Exclude checks
Line exceeds 120 characters; contains 169 characters Open
* example={"id" : 11, "field_name_1" : "Tom", "field_name_2" : "Kowalski", "assigned_user_id" : "YetiForce Administrator", "createdtime" : "2014-09-24 20:51"},
- Exclude checks
Line exceeds 120 characters; contains 189 characters Open
* @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"),
- Exclude checks
Line exceeds 120 characters; contains 163 characters Open
* @OA\Property(property="skippedData", type="object", description="List of parameters passed in the request that were skipped in the write process"),
- Exclude checks
Line exceeds 120 characters; contains 135 characters Open
* @OA\Parameter(name="recordId", in="path", @OA\Schema(type="integer"), description="Record id", required=true, example=116),
- Exclude checks
Line exceeds 120 characters; contains 148 characters Open
* example={"id" : 11, "field_name_1" : "Tom", "field_name_2" : "Kowalski", "assigned_user_id" : 1, "createdtime" : "2014-09-24 20:51:12"},
- Exclude checks
Line exceeds 120 characters; contains 137 characters Open
* example={"field_name_1" : "Tom", "field_name_2" : "Kowalski", "assigned_user_id" : 1, "createdtime" : "2014-09-24 20:51:12"},
- Exclude checks
Line exceeds 120 characters; contains 189 characters Open
* @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"),
- Exclude checks
Line exceeds 120 characters; contains 163 characters Open
* @OA\Property(property="skippedData", type="object", description="List of parameters passed in the request that were skipped in the write process"),
- Exclude checks
Line exceeds 120 characters; contains 131 characters Open
* @OA\Parameter(name="X-ENCRYPTED", in="header", @OA\Schema(ref="#/components/schemas/Header-Encrypted"), required=true),
- Exclude checks
Line exceeds 120 characters; contains 122 characters Open
* @OA\Property(property="result", type="object", title="Record data", description="Created record id and name.",
- Exclude checks
Line exceeds 120 characters; contains 145 characters Open
* @OA\Parameter(name="moduleName", in="path", @OA\Schema(type="string"), description="Module name", required=true, example="Contacts"),
- Exclude checks
Line exceeds 120 characters; contains 133 characters Open
* @OA\Property(property="name", type="string", description="Id of the newly created record", example="YetiForce Name"),
- Exclude checks
Line exceeds 120 characters; contains 159 characters Open
* description="The `id` value returned in the response can be used as the `recordId` parameter in `GET /webservice/{moduleName}/Record/{recordId}`.",
- Exclude checks