Documentation

Files extends BaseAction
in package

Webservice standard container - Get elements of menu class.

Tags
OA\Info

( title="YetiForce API for Webservice App. Type: WebserviceStandard", description="Skip the /webservice fragment for connections via ApiProxy. There are two ways to connect to API, with or without rewrite, below are examples of both: rewrite

  • CRM_URL/webservice/WebserviceStandard/Users/Login
  • CRM_URL/webservice/WebserviceStandard/Accounts/RecordRelatedList/117/Contacts without rewrite
  • CRM_URL/webservice.php?_container=WebserviceStandard&module=Users&action=Login
  • CRM_URL/webservice.php?_container=WebserviceStandard&module=Accounts&action=RecordRelatedList&record=117&param=Contacts", version="0.2", termsOfService="https://yetiforce.com/", @OA\Contact( email="devs@yetiforce.com", name="Devs API Team", url="https://yetiforce.com/" ), @OA\License( name="YetiForce Public License", url="https://yetiforce.com/en/yetiforce/license" ), )
OA\Server

( url="https://gitdeveloper.yetiforce.com", description="Demo server of the development version", )

OA\Server

( url="https://gitstable.yetiforce.com", description="Demo server of the latest stable version", )

OA\Tag

( name="BaseModule", description="Access to record methods" )

OA\Tag

( name="BaseAction", description="Access to user methods" )

OA\Tag

( name="Users", description="Access to user methods" )

Table of Contents

$allowedHeaders  : array<string|int, mixed>
$allowedMethod  : array<string|int, string>
$controller  : Controller
$responseType  : string
$userData  : array<string|int, mixed>
checkAction()  : void
Check called action.
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.
put()  : File
Put method.
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.
loadSession()  : void
Load user session data .

Properties

$allowedHeaders

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

Allowed headers

$allowedMethod

public array<string|int, string> $allowedMethod = ['PUT']

Allowed methods

$responseType

public string $responseType = 'file'

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 —

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 —

put()

Put method.

public put() : File
Tags
throws
Exception
OA\Put

( path="/webservice/WebserviceStandard/Files", description="Download files from the system", summary="Download files", tags={"BaseAction"}, security={ {"basicAuth" : }, "ApiKeyAuth" : }, "token" : }} }, @OA\RequestBody( required=true, description="Action parameters to download the file", @OA\MediaType( mediaType="application/x-www-form-urlencoded", @OA\Schema(ref="#/components/schemas/BaseAction_Files_Request") ), @OA\JsonContent(ref="#/components/schemas/BaseAction_Files_Request"), @OA\XmlContent(ref="#/components/schemas/BaseAction_Files_Request"), ), @OA\Parameter(name="X-ENCRYPTED", in="header", @OA\Schema(ref="#/components/schemas/Header-Encrypted"), required=true), @OA\Response( response=200, description="File content, mediaType is dynamic depending on the type of file being downloaded", @OA\MediaType( mediaType="application/octet-stream", @OA\Schema( type="string", format="binary" ) ) ), @OA\Response( response=403, description="No permissions", @OA\JsonContent(ref="#/components/schemas/Exception"), @OA\XmlContent(ref="#/components/schemas/Exception"), ), @OA\Response( response=404, description="File not found", @OA\JsonContent(ref="#/components/schemas/Exception"), @OA\XmlContent(ref="#/components/schemas/Exception"), ), @OA\Response( response=405, description="Invalid method", @OA\JsonContent(ref="#/components/schemas/Exception"), @OA\XmlContent(ref="#/components/schemas/Exception"), ), @OA\Response( response=406, description="Not Acceptable", @OA\JsonContent(ref="#/components/schemas/Exception"), @OA\XmlContent(ref="#/components/schemas/Exception"), ), ),

OA\Schema

( schema="BaseAction_Files_Request", title="Base action - Files request schema", description="Action parameters to download the file", type="object", required={"module", "actionName", "record"}, @OA\Property(property="module", type="string", description="Module name", example="Contacts"), @OA\Property(property="actionName", type="string", enum={"MultiImage", "DownloadFile"}, description="Action name", example="MultiImage"), @OA\Property(property="record", type="integer", description="Record ID", example=123), @OA\Property(property="field", type="string", description="Field name. Required for MultiImage action", example="imagename"), @OA\Property(property="key", type="string", description="Unique key for attachment. Required for MultiImage action", example="14f01c4ea4da107c4145f0519ea1b9027fb24aa7MS2AqcUFuC") ),

Return values
File —

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 —

loadSession()

Load user session data .

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

        

        
    




    

    

                

    

        

            
Search results