api/webservice/WebservicePremium/BaseAction/Files.php
Possibly zero references to use statement for classlike/namespace OA
(\OpenApi\Annotations)
Open
Open
use OpenApi\Annotations as OA;
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
*
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* mediaType="application/x-www-form-urlencoded",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Contact(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Tag(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
*
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* summary="Download files",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* 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:
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Tag(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* {"basicAuth" : {}, "ApiKeyAuth" : {}, "token" : {}}
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* },
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\XmlContent(ref="#/components/schemas/BaseAction_Put_Files_Request"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* url="https://gitdeveloper.yetiforce.com",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* )
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* )
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Tag(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="Products methods"
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* )
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="Action parameters to download the file",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\MediaType(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* termsOfService="https://yetiforce.com/",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="Access to record methods"
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* name="BaseAction",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="Download files from the system",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* tags={"BaseAction"},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* required=true,
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\JsonContent(ref="#/components/schemas/BaseAction_Put_Files_Request"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* url="https://yetiforce.com/"
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* name="YetiForce Public License",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* )
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* name="Users",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="Download files from the system",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* name="Devs API Team",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Server(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
/**
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Schema(ref="#/components/schemas/BaseAction_Put_Files_Request")
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* path="/webservice/WebservicePremium/Files",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* },
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* email="devs@yetiforce.com",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* url="https://yetiforce.com/en/yetiforce/license"
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* url="https://gitstable.yetiforce.com",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="Access to user methods"
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* path="/webservice/WebservicePremium/Files",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* security={
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* {"basicAuth" : {}, "ApiKeyAuth" : {}, "token" : {}}
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\JsonContent(ref="#/components/schemas/BaseAction_Put_Files_Request"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* name="Products",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Tag(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Put(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* security={
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* mediaType="application/octet-stream",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* response=403,
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="No permissions",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\XmlContent(ref="#/components/schemas/Exception"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="Demo server of the development version",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Server(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @return \App\Fields\File
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* summary="Download files",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\RequestBody(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\RequestBody(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* version="0.2",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\License(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @throws \Api\Core\Exception
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* tags={"BaseAction"},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* required=true,
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="File content, mediaType is dynamic depending on the type of file being downloaded",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* )
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Response(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* response=406,
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="Not Acceptable",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Info(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* )
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* Put method.
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="Action parameters to download the file",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\XmlContent(ref="#/components/schemas/BaseAction_Put_Files_Request"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Response(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* response=403,
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\JsonContent(ref="#/components/schemas/Exception"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Response(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* type="object",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
}
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* title="YetiForce API for Webservice App. Type: WebservicePremium",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* )
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="Demo server of the latest stable version",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="Access to user methods"
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\MediaType(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* mediaType="application/x-www-form-urlencoded",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Schema(ref="#/components/schemas/BaseAction_Put_Files_Request")
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="Not Acceptable",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Property(property="actionName", type="string", enum={"MultiImage", "DownloadFile"}, description="Action name", example="MultiImage"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
*
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* mediaType="application/octet-stream",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="File not found",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\XmlContent(ref="#/components/schemas/Exception"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="Invalid method",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* required={"module", "actionName", "record"},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Property(property="module", type="string", description="Module name", example="Contacts"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Response(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* type="string",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\XmlContent(ref="#/components/schemas/Exception"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Property(property="module", type="string", description="Module name", example="Contacts"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* name="BaseModule",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* format="binary"
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* )
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* response=404,
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Response(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Property(property="key", type="string", description="Unique key for attachment. Required for MultiImage action", example="14f01c4ea4da107c4145f0519ea1b9027fb24aa7MS2AqcUFuC")
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Property(property="key", type="string", description="Unique key for attachment. Required for MultiImage action", example="14f01c4ea4da107c4145f0519ea1b9027fb24aa7MS2AqcUFuC")
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
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
Open
* @OA\MediaType(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* response=405,
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* schema="BaseAction_Put_Files_Request",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Property(property="record", type="integer", description="Record ID", example=123),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Property(property="field", type="string", description="Field name. Required for MultiImage action", example="imagename"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
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
Open
* response=200,
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Schema(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* format="binary"
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\XmlContent(ref="#/components/schemas/Exception"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\JsonContent(ref="#/components/schemas/Exception"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Response(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Response(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* response=405,
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\JsonContent(ref="#/components/schemas/Exception"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* required={"module", "actionName", "record"},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Property(property="field", type="string", description="Field name. Required for MultiImage action", example="imagename"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* type="string",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* )
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Response(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\JsonContent(ref="#/components/schemas/Exception"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="Action parameters to download the file",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="File not found",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="File content, mediaType is dynamic depending on the type of file being downloaded",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\JsonContent(ref="#/components/schemas/Exception"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* response=404,
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="Invalid method",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* )
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* schema="BaseAction_Put_Files_Request",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="No permissions",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Property(property="actionName", type="string", enum={"MultiImage", "DownloadFile"}, description="Action name", example="MultiImage"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\JsonContent(ref="#/components/schemas/Exception"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\XmlContent(ref="#/components/schemas/Exception"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Property(property="record", type="integer", description="Record ID", example=123),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* response=406,
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
public function put()
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Schema(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
return parent::put();
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="Action parameters to download the file",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* type="object",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* response=200,
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Schema(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Response(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\JsonContent(ref="#/components/schemas/Exception"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\MediaType(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\XmlContent(ref="#/components/schemas/Exception"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\JsonContent(ref="#/components/schemas/Exception"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Response(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\XmlContent(ref="#/components/schemas/Exception"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\XmlContent(ref="#/components/schemas/Exception"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* title="Base action - Files request schema",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* title="Base action - Files request schema",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
*/
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
{
- Exclude checks
Line exceeds 120 characters; contains 173 characters Open
Open
* 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:
- Exclude checks
Line exceeds 120 characters; contains 190 characters Open
Open
* @OA\Property(property="key", type="string", description="Unique key for attachment. Required for MultiImage action", example="14f01c4ea4da107c4145f0519ea1b9027fb24aa7MS2AqcUFuC")
- Exclude checks
Line exceeds 120 characters; contains 137 characters Open
Open
* @OA\Property(property="field", type="string", description="Field name. Required for MultiImage action", example="imagename"),
- Exclude checks
Line exceeds 120 characters; contains 150 characters Open
Open
* @OA\Property(property="actionName", type="string", enum={"MultiImage", "DownloadFile"}, description="Action name", example="MultiImage"),
- Exclude checks
Line exceeds 120 characters; contains 131 characters Open
Open
* @OA\Parameter(name="X-ENCRYPTED", in="header", @OA\Schema(ref="#/components/schemas/Header-Encrypted"), required=true),
- Exclude checks