From cb7d52788294fe76220fcbaa89d68a64188e4ac2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julio=20Cesar=20Laura=20Avenda=C3=B1o?= Date: Mon, 27 Jul 2026 15:02:43 -0400 Subject: [PATCH 1/3] FOUR-31416 Remove guided templates --- .../Console/Commands/SyncGuidedTemplates.php | 41 - ProcessMaker/Console/Kernel.php | 3 - ProcessMaker/Events/ProcessCompleted.php | 5 +- .../Api/WizardTemplateController.php | 42 - .../ProcessesCatalogueController.php | 6 - ProcessMaker/Jobs/SyncGuidedTemplates.php | 384 -- ProcessMaker/Jobs/SyncScreenTemplates.php | 2 +- ProcessMaker/Models/WizardTemplate.php | 101 - ProcessMaker/Templates/ProcessTemplate.php | 74 - config/services.php | 7 - .../Models/WizardTemplateFactory.php | 26 - ...7_215150_create_wizard_templates_table.php | 32 - ...4_210217_modify_wizard_templates_table.php | 55 - ...te_id_column_to_wizard_templates_table.php | 27 - public/images/wizard-icon.svg | 7 - public/images/wizard-template-icon.svg | 8 - resources/img/wizard-icon.svg | 7 - resources/img/wizard-template-icon.svg | 8 - .../templates/TemplateAssetsView.vue | 8 - .../components/templates/TemplateSearch.vue | 61 +- .../templates/TemplateSelectCard.vue | 18 +- .../templates/WizardHelperProcessModal.vue | 67 - .../templates/WizardTemplateCard.vue | 86 - .../templates/WizardTemplateDetails.vue | 162 - .../mixins/wizardHelperProcessModal.js | 144 - .../components/CatalogueEmpty.vue | 13 +- .../components/ProcessCollapseInfo.vue | 25 - .../components/ProcessHeader.vue | 275 - .../components/ProcessInfo.vue | 20 - .../components/ProcessListing.vue | 14 - .../components/ProcessesCatalogue.vue | 11 - .../components/WizardTemplates.vue | 42 - .../components/menuCatologue.vue | 15 +- .../components/optionsMenu/ProcessCounter.vue | 4 - .../slideProcessInfo/SlideProcessInfo.vue | 22 - resources/js/templates/assets.js | 2 - resources/lang/en.json | 1 - resources/sass/app.scss | 36 - resources/views/templates/assets.blade.php | 1 - routes/api.php | 5 - storage/api-docs/api-docs.json | 5692 +++++++++++++---- tests/Feature/Api/WizardTemplatesTest.php | 61 - 42 files changed, 4585 insertions(+), 3035 deletions(-) delete mode 100644 ProcessMaker/Console/Commands/SyncGuidedTemplates.php delete mode 100644 ProcessMaker/Http/Controllers/Api/WizardTemplateController.php delete mode 100644 ProcessMaker/Jobs/SyncGuidedTemplates.php delete mode 100644 ProcessMaker/Models/WizardTemplate.php delete mode 100644 database/factories/ProcessMaker/Models/WizardTemplateFactory.php delete mode 100644 database/migrations/2023_11_27_215150_create_wizard_templates_table.php delete mode 100644 database/migrations/2023_12_04_210217_modify_wizard_templates_table.php delete mode 100644 database/migrations/2024_01_16_181933_add_unique_template_id_column_to_wizard_templates_table.php delete mode 100644 public/images/wizard-icon.svg delete mode 100644 public/images/wizard-template-icon.svg delete mode 100644 resources/img/wizard-icon.svg delete mode 100644 resources/img/wizard-template-icon.svg delete mode 100644 resources/js/components/templates/WizardHelperProcessModal.vue delete mode 100644 resources/js/components/templates/WizardTemplateCard.vue delete mode 100644 resources/js/components/templates/WizardTemplateDetails.vue delete mode 100644 resources/js/components/templates/mixins/wizardHelperProcessModal.js delete mode 100644 resources/js/processes-catalogue/components/ProcessHeader.vue delete mode 100644 resources/js/processes-catalogue/components/WizardTemplates.vue delete mode 100644 tests/Feature/Api/WizardTemplatesTest.php diff --git a/ProcessMaker/Console/Commands/SyncGuidedTemplates.php b/ProcessMaker/Console/Commands/SyncGuidedTemplates.php deleted file mode 100644 index 2849a9be8a..0000000000 --- a/ProcessMaker/Console/Commands/SyncGuidedTemplates.php +++ /dev/null @@ -1,41 +0,0 @@ -option('queue')) { - $randomDelay = random_int(10, 120); - Job::dispatch()->delay(now()->addMinutes($randomDelay)); - - return 0; - } - - Job::dispatchSync(); - - return 0; - } -} diff --git a/ProcessMaker/Console/Kernel.php b/ProcessMaker/Console/Kernel.php index 03fc408949..df4ce44dd8 100644 --- a/ProcessMaker/Console/Kernel.php +++ b/ProcessMaker/Console/Kernel.php @@ -37,9 +37,6 @@ protected function schedule(Schedule $schedule) $schedule->command('processmaker:sync-default-templates --queue') ->daily(); - $schedule->command('processmaker:sync-guided-templates --queue') - ->daily(); - $schedule->command('processmaker:sync-screen-templates --queue') ->daily(); diff --git a/ProcessMaker/Events/ProcessCompleted.php b/ProcessMaker/Events/ProcessCompleted.php index 566fd59730..be95f14dae 100644 --- a/ProcessMaker/Events/ProcessCompleted.php +++ b/ProcessMaker/Events/ProcessCompleted.php @@ -28,10 +28,7 @@ public function __construct(ProcessRequest $processRequest) { $this->payloadUrl = route('api.requests.show', ['request' => $processRequest->getKey()]); $this->processRequest = $processRequest; - - if ($processRequest->process->asset_type !== 'GUIDED_HELPER_PROCESS') { - $this->endEventDestination = $processRequest->getElementDestination(); - } + $this->endEventDestination = $processRequest->getElementDestination(); } /** diff --git a/ProcessMaker/Http/Controllers/Api/WizardTemplateController.php b/ProcessMaker/Http/Controllers/Api/WizardTemplateController.php deleted file mode 100644 index 0e71f2b66b..0000000000 --- a/ProcessMaker/Http/Controllers/Api/WizardTemplateController.php +++ /dev/null @@ -1,42 +0,0 @@ -input('per_page', 10); - $column = $request->input('order_by', 'id'); - $filter = $request->input('filter', ''); - - $direction = $request->input('order_direction', 'asc'); - - $query = WizardTemplate::with('process')->filter($filter) - ->orderBy($column, $direction); - - $data = $query->paginate($perPage); - - return new ApiCollection($data); - } - - public function getHelperProcess($wizardTemplateUuid) - { - $helperProcessID = WizardTemplate::select('helper_process_id')->where('uuid', $wizardTemplateUuid)->value('helper_process_id'); - $start_events = Process::select('start_events')->where('id', $helperProcessID)->value('start_events'); - - return json_encode([ - 'helper_process_id' => $helperProcessID, - 'start_events' => json_encode($start_events), - ]); - } -} diff --git a/ProcessMaker/Http/Controllers/ProcessesCatalogueController.php b/ProcessMaker/Http/Controllers/ProcessesCatalogueController.php index 596c5821ed..3348a20fd1 100644 --- a/ProcessMaker/Http/Controllers/ProcessesCatalogueController.php +++ b/ProcessMaker/Http/Controllers/ProcessesCatalogueController.php @@ -31,12 +31,6 @@ class ProcessesCatalogueController extends Controller public function index(Request $request, Process $process = null) { - if ($request->has('guided_templates')) { - return redirect()->route('process.browser.index', [ - 'categoryId' => 'guided_templates', - 'template' => $request->input('template'), - ]); - } $manager = app(ScreenBuilderManager::class); event(new ScreenBuilderStarting($manager, 'DISPLAY')); $launchpad = null; diff --git a/ProcessMaker/Jobs/SyncGuidedTemplates.php b/ProcessMaker/Jobs/SyncGuidedTemplates.php deleted file mode 100644 index a0494fcaab..0000000000 --- a/ProcessMaker/Jobs/SyncGuidedTemplates.php +++ /dev/null @@ -1,384 +0,0 @@ - 'Guided Templates', - ], [ - 'status' => 'ACTIVE', - 'is_system' => 1, - ])->getKey(); - - // Fetch the guided template list from Github - $response = Http::get($url); - - // Check if the request was successful - if (!$response->successful()) { - throw new Exception('Unable to fetch guided template list.'); - } - - // Extract the JSON data from the response - $data = $response->json(); - - // Iterate over categories and templates to retrieve them - foreach ($data as $templateCategory => $guidedTemplates) { - if (!in_array($templateCategory, $categories) && !in_array('all', $categories)) { - continue; - } - - try { - // Import templates from the index.json file. - foreach ($guidedTemplates as $template) { - $this->importTemplate($template, $config, $guidedTemplateCategoryId); - } - } catch (Exception $e) { - Log::error("Error Importing Guided Templates: {$e->getMessage()}"); - } - } - } catch (Exception $e) { - Log::error("Error Syncing Guided Templates: {$e->getMessage()}"); - } - } - - /** - * Import a guided template into the database. - * - * @param array $template - * @param array $config - * @param int $guidedTemplateCategoryId - * @return void - */ - private function importTemplate($template, $config, $guidedTemplateCategoryId) - { - // Check for template changes and determine if helper process and template process need to be imported - [$importHelperProcess, $importTemplateProcess] = $this->checkForTemplateChanges($template); - - // Check for template asset hash changes - $assetsHashChanged = $this->checkForTemplateAssetChanges($template); - - // Fetch payloads if necessary - $helperProcessPayload = $importHelperProcess ? - $this->fetchPayload($this->buildTemplateUrl($config, $template['helper_process'])) : null; - $templateProcessPayload = $importTemplateProcess ? - $this->fetchPayload($this->buildTemplateUrl($config, $template['template_process'])) : null; - - // Update process categories for the helper process and process template - $this->updateProcessCategories($helperProcessPayload, $templateProcessPayload, $guidedTemplateCategoryId); - - // Initialize variables for new process IDs - $newHelperProcessId = null; - $newProcessTemplateId = null; - - // Import helper process if necessary and get new ID - if ($importHelperProcess) { - $newHelperProcessId = $this->importProcess($helperProcessPayload, 'GUIDED_HELPER_PROCESS'); - } - - // Import template process if necessary and get new ID - if ($importTemplateProcess) { - $newProcessTemplateId = $this->importProcess($templateProcessPayload, 'GUIDED_PROCESS_TEMPLATE'); - } - - // Update or create the guided template in the database - $guidedTemplate = $this->updateOrCreateGuidedTemplate($template, $newHelperProcessId, $newProcessTemplateId); - - // Create a media collection for template assets - $mediaCollectionName = $this->createMediaCollection($guidedTemplate); - - if ($assetsHashChanged) { - // Import template assets and associate with the media collection - $this->importTemplateAssets($template, $config, $mediaCollectionName, $guidedTemplate); - } - - // Save the media collection name to the guided template and persist changes - $guidedTemplate->media_collection = $mediaCollectionName; - - $guidedTemplate->save(); - } - - // Helper functions used within importTemplate - private function buildTemplateUrl($config, $templatePath) - { - // Build the URL for a template based on the configuration and template path - if (empty($templatePath)) { - return null; - } - - return $config['base_url'] . - $config['template_repo'] . '/' . - $config['template_branch'] . '/' . - Str::replace('./', '', $templatePath); - } - - private function fetchPayload($url) - { - // Fetch the JSON payload from a given URL - return Http::get($url)->json(); - } - - private function updateProcessCategories(&$helperProcessPayload, &$templateProcessPayload, - $guidedTemplateCategoryId) - { - // Update process categories for both the helper process and process template - if ($helperProcessPayload !== null) { - data_set( - $helperProcessPayload, - "export.{$helperProcessPayload['root']}.attributes.process_category_id", - $guidedTemplateCategoryId - ); - } - - if ($templateProcessPayload !== null) { - data_set( - $templateProcessPayload, - "export.{$templateProcessPayload['root']}.attributes.process_category_id", - $guidedTemplateCategoryId - ); - } - } - - private function importProcess($payload, $assetType) - { - // Import a process and return the new ID - $postOptions = []; - foreach ($payload['export'] as $key => $asset) { - $postOptions[$key] = [ - 'mode' => 'update', - 'is_template' => true, - 'asset_type' => $assetType, - 'saveAssetsMode' => 'saveAllAssets', - ]; - if (in_array($asset['type'], ['Process', 'Screen', 'Script', - 'Collections', 'DataConnector', 'ProcessTemplates'])) { - $payload['export'][$key]['attributes']['asset_type'] = $assetType; - } - - if (Arr::get($asset, 'type') === 'Screen' && Arr::get($asset, 'attributes.key') === 'interstitial') { - Arr::set($payload, "export.{$key}.attributes.key", null); - } - } - - $options = new Options($postOptions); - try { - $importer = new Importer($payload, $options); - $manifest = $importer->doImport(); - $rootLog = $manifest[$payload['root']]->log; - - return $rootLog['newId']; - } catch (Exception $e) { - throw new Exception('Error: ' . $e->getMessage()); - } - } - - private function updateOrCreateGuidedTemplate($template, $newHelperProcessId, $newProcessTemplateId) - { - $templateDetails = $template['template_details']; - $uniqueTemplateId = $templateDetails['unique-template-id']; - $cardTitle = $templateDetails['card-title']; - $cardExcerpt = $templateDetails['card-excerpt']; - $templateDetailsJson = json_encode($templateDetails); - - // Check if the wizard template exists - $guidedTemplate = WizardTemplate::where('unique_template_id', $uniqueTemplateId)->first(); - - if ($guidedTemplate) { - // Update existing wizard template - $guidedTemplate->update([ - 'name' => $cardTitle, - 'description' => $cardExcerpt, - 'media_collection' => '', - 'template_details' => $templateDetailsJson, - ]); - - if ($newHelperProcessId !== null) { - $guidedTemplate['helper_process_id'] = $newHelperProcessId; - $guidedTemplate->save(); - } - if ($newProcessTemplateId !== null) { - $guidedTemplate['process_template_id'] = $newProcessTemplateId; - $guidedTemplate->save(); - } - } else { - // Create new wizard template - $guidedTemplate = WizardTemplate::create([ - 'unique_template_id' => $uniqueTemplateId, - 'name' => $cardTitle, - 'description' => $cardExcerpt, - 'helper_process_id' => $newHelperProcessId, - 'process_template_id' => $newProcessTemplateId, - 'media_collection' => '', - 'template_details' => $templateDetailsJson, - ]); - } - - return $guidedTemplate; - } - - private function createMediaCollection($guidedTemplate) - { - // Create a media collection for template assets and return the collection name - $mediaCollectionName = 'wt-' . $guidedTemplate->uuid . '-media'; - $guidedTemplate->addMediaCollection($mediaCollectionName); - - return $mediaCollectionName; - } - - private function importTemplateAssets($template, $config, $mediaCollectionName, $guidedTemplate) - { - // Clear the collection to prevent duplicate images - $guidedTemplate->clearMediaCollection($mediaCollectionName); - - // Build asset urls - $templateIconUrl = $this->buildTemplateUrl($config, $template['assets']['icon']); - $templateCardBackgroundUrl = $this->buildTemplateUrl($config, $template['assets']['card-background']); - $templateListIconUrl = $this->buildTemplateUrl($config, $template['assets']['list-icon']); - // Import template assets and associate with the media collection - $this->importMedia($templateIconUrl, 'icon', $mediaCollectionName, $guidedTemplate); - $this->importMedia($templateCardBackgroundUrl, 'cardBackground', $mediaCollectionName, $guidedTemplate); - $this->importMedia($templateListIconUrl, 'listIcon', $mediaCollectionName, $guidedTemplate); - - if (!empty($template['assets']['launchpad']['process-card-background'])) { - $templateProcessCardBackgroundUrl = - $this->buildTemplateUrl($config, $template['assets']['launchpad']['process-card-background']); - $this->importMedia($templateProcessCardBackgroundUrl, 'launchpadProcessCardBackground', - $mediaCollectionName, $guidedTemplate); - } - - foreach ($template['assets']['slides'] as $slide) { - $templateSlideUrl = $this->buildTemplateUrl($config, $slide); - $this->importMedia($templateSlideUrl, 'slide', $mediaCollectionName, $guidedTemplate); - } - - if (!empty($template['assets']['launchpad']['slides'])) { - foreach ($template['assets']['launchpad']['slides'] as $slide) { - $templateSlideUrl = $this->buildTemplateUrl($config, $slide); - $this->importMedia($templateSlideUrl, 'launchpadSlides', $mediaCollectionName, $guidedTemplate); - } - } - } - - private function importMedia($assetUrl, $customProperty, $mediaCollectionName, $guidedTemplate) - { - // Import a media asset and associate it with the media collection - if (!is_null($assetUrl)) { - $guidedTemplate - ->addMediaFromUrl($assetUrl) - ->withCustomProperties(['media_type' => $customProperty]) - ->toMediaCollection($mediaCollectionName); - } - } - - private function checkForTemplateChanges($template) - { - // Initialize variables to track changes - $helperProcessHashChanged = true; - $templateProcessHashChanged = true; - - // Retrieve wizard template details if it exists - $wizardTemplate = - WizardTemplate::where('unique_template_id', $template['template_details']['unique-template-id']) - ->select('template_details') - ->first(); - - if ($wizardTemplate) { - $wizardTemplateDetails = json_decode($wizardTemplate->template_details, true); - - // Check if helper process hash has changed - if (isset($wizardTemplateDetails['helper_process_hash']) && - $template['template_details']['helper_process_hash'] === - $wizardTemplateDetails['helper_process_hash']) { - $helperProcessHashChanged = false; - } - - // Check if template process hash has changed - if (isset($wizardTemplateDetails['template_process_hash']) && - $template['template_details']['template_process_hash'] === - $wizardTemplateDetails['template_process_hash']) { - $templateProcessHashChanged = false; - } - } - - return [$helperProcessHashChanged, $templateProcessHashChanged]; - } - - private function checkForTemplateAssetChanges($template) - { - // Initialize variables to track changes - $assetHashChanged = true; - // Retrieve wizard template details if it exists - $wizardTemplate = - WizardTemplate::where('unique_template_id', $template['template_details']['unique-template-id']) - ->select('template_details') - ->first(); - - if ($wizardTemplate) { - $wizardTemplateDetails = json_decode($wizardTemplate->template_details, true); - // Check if helper process hash has changed - if (isset($wizardTemplateDetails['asset_hash']) && - $template['template_details']['asset_hash'] === - $wizardTemplateDetails['asset_hash'] || - !isset($wizardTemplateDetails['asset_hash'])) { - $assetHashChanged = false; - } - } - - return $assetHashChanged; - } -} diff --git a/ProcessMaker/Jobs/SyncScreenTemplates.php b/ProcessMaker/Jobs/SyncScreenTemplates.php index 3ea0205fbf..0545ca6a1a 100644 --- a/ProcessMaker/Jobs/SyncScreenTemplates.php +++ b/ProcessMaker/Jobs/SyncScreenTemplates.php @@ -50,7 +50,7 @@ public function handle() if (!$config) { return; } - // Build the URL to fetch the guided templates list from GitHub + // Build the URL to fetch the screen templates list from GitHub $url = $config['base_url'] . $config['template_repo'] . '/' . $config['template_branch'] . '/index.json'; // If there are multiple categories of templates defined in the .env, separate them into an array diff --git a/ProcessMaker/Models/WizardTemplate.php b/ProcessMaker/Models/WizardTemplate.php deleted file mode 100644 index 0e09ff546e..0000000000 --- a/ProcessMaker/Models/WizardTemplate.php +++ /dev/null @@ -1,101 +0,0 @@ -belongsTo(Process::class, 'helper_process_id'); - } - - /** - * Get the process template associated with the wizard template. - */ - public function process_template(): BelongsTo - { - return $this->belongsTo(ProcessTemplates::class, 'process_template_id'); - } - - /** - * Filter settings with a string - * - * @param $query - * - * @param $filter string - */ - public function scopeFilter($query, $filterStr) - { - $filter = '%' . mb_strtolower($filterStr) . '%'; - $query->where(function ($query) use ($filter) { - $query->where('wizard_templates.name', 'like', $filter) - ->orWhere('wizard_templates.description', 'like', $filter); - }); - - return $query; - } - - public function getTemplateMediaAttribute() - { - $mediaCollectionName = 'wt-' . $this->uuid . '-media'; - $slides = $this->getMedia($mediaCollectionName, ['media_type' => 'slide']); - $slideUrls = $slides->map(function ($slide) { - return $slide->getFullUrl(); - }); - $iconMedia = $this->getMedia($mediaCollectionName, ['media_type' => 'icon'])->first(); - $cardBackgroundMedia = $this->getMedia($mediaCollectionName, ['media_type' => 'cardBackground'])->first(); - $listIconMedia = $this->getMedia($mediaCollectionName, ['media_type' => 'listIcon'])->first(); - - return [ - 'icon' => !is_null($iconMedia) ? $iconMedia->getFullUrl() : '', - 'cardBackground' => !is_null($cardBackgroundMedia) ? $cardBackgroundMedia->getFullUrl() : '', - 'listIcon' => !is_null($listIconMedia) ? $listIconMedia->getFullUrl() : '', - 'slides' => $slideUrls, - ]; - } - - /** - * Add files to media collection - */ - public function addFilesToMediaCollection(string $directoryPath) - { - $files = File::allFiles($directoryPath); - $collectionName = basename($directoryPath); - - foreach ($files as $file) { - $this->addMedia($file->getPathname())->toMediaCollection($collectionName); - } - } -} diff --git a/ProcessMaker/Templates/ProcessTemplate.php b/ProcessMaker/Templates/ProcessTemplate.php index 3d9f6f6aa4..ca24deb766 100644 --- a/ProcessMaker/Templates/ProcessTemplate.php +++ b/ProcessMaker/Templates/ProcessTemplate.php @@ -15,10 +15,8 @@ use ProcessMaker\Models\Process; use ProcessMaker\Models\ProcessCategory; use ProcessMaker\Models\ProcessTemplates; -use ProcessMaker\Models\WizardTemplate; use ProcessMaker\Traits\HasControllerAddons; use SebastianBergmann\CodeUnit\Exception; -use Spatie\MediaLibrary\MediaCollections\Models\Media; /** * Summary of ProcessTemplate @@ -257,18 +255,6 @@ public function create($request) : JsonResponse $payload['export'][$key]['attributes']['name'] = $requestData['name']; $payload['export'][$key]['attributes']['description'] = $requestData['description']; $payload['export'][$key]['attributes']['process_category_id'] = $requestData['process_category_id']; - // Store the wizard template uuid on the process to rerun the helper process - if (isset($requestData['wizardTemplateUuid'])) { - $properties = json_decode($payload['export'][$key]['attributes']['properties'], true); - $properties['wizardTemplateUuid'] = $requestData['wizardTemplateUuid']; - $payload['export'][$key]['attributes']['properties'] = json_encode($properties); - } - // Store the helper process request id that initiated the process creation - if (isset($requestData['helperProcessRequestId'])) { - $properties = json_decode($payload['export'][$key]['attributes']['properties'], true); - $properties['helperProcessRequestId'] = $requestData['helperProcessRequestId']; - $payload['export'][$key]['attributes']['properties'] = json_encode($properties); - } $payload['export'][$key]['name'] = $requestData['name']; $payload['export'][$key]['description'] = $requestData['description']; @@ -296,8 +282,6 @@ public function create($request) : JsonResponse $process->user_id = Auth::id(); $process->save(); - $this->syncLaunchpadAssets($request, $process); - if (class_exists(self::PROJECT_ASSET_MODEL_CLASS) && !empty($requestData['projects'])) { $manifest = $this->getManifest('process', $processId); @@ -506,64 +490,6 @@ public function existingTemplate($request) : ?array return null; } - /** - * Syncs launchpad assets from a guided template to the imported process. - * - * @param Illuminate\Http\Request $request - * @param App\Models\Process $process - * @return void - */ - protected function syncLaunchpadAssets($request, $process) - { - if (empty($request->wizardTemplateUuid)) { - return; - } - - // Add media collection for the imported process - $processMediaCollectionName = $process->uuid . '_images_carousel'; - $process->addMediaCollection($processMediaCollectionName); - - // Retrieve the guided template by UUID - $guidedTemplateUuid = $request->input('wizardTemplateUuid'); - $template = WizardTemplate::where('uuid', $guidedTemplateUuid)->first(); - - // Get launchpad slides media from the guided template - $templateLaunchpadSlides = $template->getMedia($template->media_collection, function (Media $media) { - return $media->custom_properties['media_type'] === 'launchpadSlides'; - }); - - // Iterate over each launchpad slide and add to the imported process media collection - foreach ($templateLaunchpadSlides as $slide) { - // Extract order index from file name - $orderIndex = $this->extractOrderIndexFromFileName($slide->getPath()); - - // Add media to the imported process collection - $media = $process->addMedia($slide->getPath())->preservingOriginal()->toMediaCollection($processMediaCollectionName); - - // Set order column if available - if (!is_null($orderIndex)) { - $media->order_column = $orderIndex; - $media->save(); - } - } - } - - /** - * Extracts order index from the file name. - * - * @param string $fileName - * @return int|null - */ - protected function extractOrderIndexFromFileName($fileName) - { - preg_match('/\d+/', basename($fileName), $matches); - if (!empty($matches)) { - return intval($matches[0]) - 1; - } - - return null; - } - /** * Prepare payload for import. * diff --git a/config/services.php b/config/services.php index fde93f96cd..bcf0b7b9c8 100644 --- a/config/services.php +++ b/config/services.php @@ -46,13 +46,6 @@ 'template_categories' => env('DEFAULT_TEMPLATE_CATEGORIES', 'accounting-and-finance,customer-success,human-resources,marketing-and-sales,operations,it'), ], - 'guided_templates_github' => [ - 'base_url' => 'https://raw.githubusercontent.com/processmaker/', - 'template_repo' => env('GUIDED_TEMPLATE_REPO', 'wizard-templates'), - 'template_branch' => env('GUIDED_TEMPLATE_BRANCH', '2023-winter'), - 'template_categories' => env('GUIDED_TEMPLATE_CATEGORIES', 'all'), - ], - 'screen_templates_github' => [ 'base_url' => 'https://raw.githubusercontent.com/processmaker/', 'template_repo' => env('SCREEN_TEMPLATE_REPO', 'screen-templates'), diff --git a/database/factories/ProcessMaker/Models/WizardTemplateFactory.php b/database/factories/ProcessMaker/Models/WizardTemplateFactory.php deleted file mode 100644 index 6860dabca3..0000000000 --- a/database/factories/ProcessMaker/Models/WizardTemplateFactory.php +++ /dev/null @@ -1,26 +0,0 @@ - $this->faker->uuid, - 'unique_template_id' => $this->faker->uuid, - 'process_template_id' => null, - 'name' => $this->faker->unique()->name(), - 'description' => $this->faker->unique()->name(), - 'media_collection' => $this->faker->unique()->name(), - 'template_details' => '{}', - 'helper_process_id' => Process::factory()->create()->id, - ]; - } -} diff --git a/database/migrations/2023_11_27_215150_create_wizard_templates_table.php b/database/migrations/2023_11_27_215150_create_wizard_templates_table.php deleted file mode 100644 index d7a34c4789..0000000000 --- a/database/migrations/2023_11_27_215150_create_wizard_templates_table.php +++ /dev/null @@ -1,32 +0,0 @@ -id(); - $table->uuid('uuid')->unique(); - $table->unsignedBigInteger('process_template_id')->nullable(); - $table->unsignedInteger('process_id'); - $table->string('media_collection')->nullable(); - $table->timestamps(); - - // Foreign keys - $table->foreign('process_id') - ->references('id') - ->on('processes') - ->onDelete('cascade') - ->constrained('processes'); - }); - } - - public function down() - { - Schema::dropIfExists('wizard_templates'); - } -} diff --git a/database/migrations/2023_12_04_210217_modify_wizard_templates_table.php b/database/migrations/2023_12_04_210217_modify_wizard_templates_table.php deleted file mode 100644 index 776d4e4b20..0000000000 --- a/database/migrations/2023_12_04_210217_modify_wizard_templates_table.php +++ /dev/null @@ -1,55 +0,0 @@ -renameColumn('process_id', 'helper_process_id'); - $table->string('name')->after('uuid'); - $table->string('description')->after('name'); - $table->json('template_details')->after('description'); - $table->unsignedInteger('config_collection_id')->nullable()->after('template_details'); - }); - - // Change the foreign key reference to helper_process_id - Schema::table('wizard_templates', function (Blueprint $table) { - $table->foreign('helper_process_id') - ->references('id') - ->on('processes') - ->onDelete('cascade') - ->constrained('processes'); - }); - - // Add the foreign key reference to process_template_id - Schema::table('wizard_templates', function (Blueprint $table) { - $table->foreign('process_template_id') - ->references('id') - ->on('process_templates') - ->onDelete('cascade') - ->constrained('process_templates'); - }); - } - - public function down() - { - // Reverse the changes in the down method if needed - Schema::table('wizard_templates', function (Blueprint $table) { - $table->renameColumn('helper_process_id', 'process_id'); - - // Reverse the foreign key changes - $table->dropForeign(['helper_process_id']); - $table->dropForeign(['process_template_id']); - - $table->dropColumn('name'); - $table->dropColumn('description'); - $table->dropColumn('template_details'); - $table->dropColumn('config_collection_id'); - }); - } -} diff --git a/database/migrations/2024_01_16_181933_add_unique_template_id_column_to_wizard_templates_table.php b/database/migrations/2024_01_16_181933_add_unique_template_id_column_to_wizard_templates_table.php deleted file mode 100644 index 8af6d8371b..0000000000 --- a/database/migrations/2024_01_16_181933_add_unique_template_id_column_to_wizard_templates_table.php +++ /dev/null @@ -1,27 +0,0 @@ -string('unique_template_id')->unique()->after('uuid'); - }); - } - - /** - * Reverse the migrations. - */ - public function down(): void - { - Schema::table('wizard_templates', function (Blueprint $table) { - $table->dropColumn('unique_template_id'); - }); - } -}; diff --git a/public/images/wizard-icon.svg b/public/images/wizard-icon.svg deleted file mode 100644 index a2be69d748..0000000000 --- a/public/images/wizard-icon.svg +++ /dev/null @@ -1,7 +0,0 @@ - - - - - - - \ No newline at end of file diff --git a/public/images/wizard-template-icon.svg b/public/images/wizard-template-icon.svg deleted file mode 100644 index 9ea25abd12..0000000000 --- a/public/images/wizard-template-icon.svg +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - - - \ No newline at end of file diff --git a/resources/img/wizard-icon.svg b/resources/img/wizard-icon.svg deleted file mode 100644 index a2be69d748..0000000000 --- a/resources/img/wizard-icon.svg +++ /dev/null @@ -1,7 +0,0 @@ - - - - - - - \ No newline at end of file diff --git a/resources/img/wizard-template-icon.svg b/resources/img/wizard-template-icon.svg deleted file mode 100644 index 9ea25abd12..0000000000 --- a/resources/img/wizard-template-icon.svg +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - - - \ No newline at end of file diff --git a/resources/js/components/templates/TemplateAssetsView.vue b/resources/js/components/templates/TemplateAssetsView.vue index 57e0e65958..e1ffd106b2 100644 --- a/resources/js/components/templates/TemplateAssetsView.vue +++ b/resources/js/components/templates/TemplateAssetsView.vue @@ -88,11 +88,6 @@ export default { type: [String, null], default: null, }, - wizardTemplateUuid: { - type: String, - required: false, - default: null, - }, }, data() { return { @@ -126,9 +121,6 @@ export default { formData.append("id", this.responseId); formData.append("request", JSON.stringify(this.request)); formData.append("existingAssets", JSON.stringify(this.updatedAssets)); - if (this.wizardTemplateUuid !== null) { - formData.append("wizardTemplateUuid", this.wizardTemplateUuid); - } ProcessMaker.apiClient.post(`/template/create/${this.assetType}/${this.responseId}`, formData) .then((response) => { this.$nextTick(() => { diff --git a/resources/js/components/templates/TemplateSearch.vue b/resources/js/components/templates/TemplateSearch.vue index e95a365484..ef8a820890 100644 --- a/resources/js/components/templates/TemplateSearch.vue +++ b/resources/js/components/templates/TemplateSearch.vue @@ -19,7 +19,7 @@ -
+
- - - - - diff --git a/resources/js/processes-catalogue/components/menuCatologue.vue b/resources/js/processes-catalogue/components/menuCatologue.vue index e043959878..448ad4c5a4 100644 --- a/resources/js/processes-catalogue/components/menuCatologue.vue +++ b/resources/js/processes-catalogue/components/menuCatologue.vue @@ -64,7 +64,7 @@
@@ -124,7 +124,7 @@ export default { modalProcess: true, countCategories: 0, showCatalogue: false, - showGuidedTemplates: false, + showTemplates: false, selectedProcessItem: null, selectedTemplateItem: null, templateOptions: [ @@ -133,11 +133,6 @@ export default { selected: false, id: "all_templates", }, - { - label: this.$t("Guided Templates"), - selected: false, - id: "guided_templates", - }, ], comeFromProcess: false, }; @@ -147,7 +142,7 @@ export default { this.openTemplate(obj); }); - window.ProcessMaker.EventBus.$on("wizard-templates-selected", (obj) => { + window.ProcessMaker.EventBus.$on("all-templates-selected", (obj) => { this.selectTemplateItem(obj); }); }, @@ -235,7 +230,7 @@ export default { selectTemplateItem(item = null) { if (item === null) { item = this.templateOptions.find((obj) => { - return obj.id === "guided_templates"; + return obj.id === "all_templates"; }); } this.selectedTemplateItem = item; @@ -269,7 +264,7 @@ export default { this.showCatalogue = !this.showCatalogue; }, onToggleTemplates() { - this.showGuidedTemplates = !this.showGuidedTemplates; + this.showTemplates = !this.showTemplates; }, /** * Filter categories diff --git a/resources/js/processes-catalogue/components/optionsMenu/ProcessCounter.vue b/resources/js/processes-catalogue/components/optionsMenu/ProcessCounter.vue index 449e2b674b..41fd12db39 100644 --- a/resources/js/processes-catalogue/components/optionsMenu/ProcessCounter.vue +++ b/resources/js/processes-catalogue/components/optionsMenu/ProcessCounter.vue @@ -150,8 +150,4 @@ export default { margin-top: 10px; padding-left: 15px; } -.icon-wizard-class { - border-left: 1px solid rgba(0, 0, 0, 0.125); - z-index: 5; -} diff --git a/resources/js/processes-catalogue/components/slideProcessInfo/SlideProcessInfo.vue b/resources/js/processes-catalogue/components/slideProcessInfo/SlideProcessInfo.vue index 681a3eb123..624f9a1068 100644 --- a/resources/js/processes-catalogue/components/slideProcessInfo/SlideProcessInfo.vue +++ b/resources/js/processes-catalogue/components/slideProcessInfo/SlideProcessInfo.vue @@ -20,21 +20,6 @@ {{ title }}
-
-
- - {{ $t('Re-run Wizard') }} -
-
@endsection diff --git a/routes/api.php b/routes/api.php index 9cc716d4d4..a94349b9b8 100644 --- a/routes/api.php +++ b/routes/api.php @@ -43,7 +43,6 @@ use ProcessMaker\Http\Controllers\Api\UserConfigurationController; use ProcessMaker\Http\Controllers\Api\UserController; use ProcessMaker\Http\Controllers\Api\UserTokenController; -use ProcessMaker\Http\Controllers\Api\WizardTemplateController; use ProcessMaker\Http\Controllers\Auth\TwoFactorAuthController; use ProcessMaker\Http\Controllers\TestStatusController; @@ -378,10 +377,6 @@ Route::post('template/{type}/{id}/apply', [TemplateController::class, 'applyTemplate'])->name('template.applyTemplate')->middleware('template-authorization'); Route::get('screen-builder/{type}/{id}', [TemplateController::class, 'show'])->name('screenBuilder.template.show')->middleware('template-authorization'); - // Wizard Templates - Route::get('wizard-templates', [WizardTemplateController::class, 'index'])->name('wizard-templates.index'); - Route::get('wizard-templates/{template_uuid}/get-helper-process', [WizardTemplateController::class, 'getHelperProcess'])->name('wizard-templates.getHelperProcess'); - // debugging javascript errors Route::post('debug', [DebugController::class, 'store'])->name('debug.store')->middleware('throttle'); diff --git a/storage/api-docs/api-docs.json b/storage/api-docs/api-docs.json index 3b01de8d45..832f903c0e 100644 --- a/storage/api-docs/api-docs.json +++ b/storage/api-docs/api-docs.json @@ -4069,16 +4069,10 @@ "schema": { "properties": { "data": { - "type": "array", - "items": { - "type": "object" - } + "type": "object" }, "config": { - "type": "array", - "items": { - "type": "object" - } + "type": "object" }, "code": { "type": "string" @@ -4123,16 +4117,10 @@ "schema": { "properties": { "data": { - "type": "array", - "items": { - "type": "object" - } + "type": "object" }, "config": { - "type": "array", - "items": { - "type": "object" - } + "type": "object" }, "sync": { "type": "boolean" @@ -6052,412 +6040,3718 @@ }, "servers": [ { - "url": "http://landlord.test/api/1.1", + "url": "http://localhost/api/1.1", "description": "API v1.1 Server" } ] } - } - }, - "components": { - "schemas": { - "DateTime": { - "properties": { - "date": { - "type": "string" - } - }, - "type": "object" - }, - "updateUserGroups": { - "properties": { - "groups": { - "type": "array", - "items": { - "type": "integer", - "example": 1 - } - } - }, - "type": "object" - }, - "restoreUser": { - "properties": { - "username": { - "description": "Username to restore", - "type": "string" - } - }, - "type": "object" - }, - "Variable": { - "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "process_id": { - "type": "integer", - "example": 1 - }, - "uuid": { - "type": "string", - "format": "uuid", - "example": "550e8400-e29b-41d4-a716-446655440000" + }, + "/collections": { + "get": { + "tags": [ + "Collections" + ], + "summary": "Returns all collections that the user has access to", + "description": "Get a list of Collections.", + "operationId": "getCollections", + "parameters": [ + { + "$ref": "#/components/parameters/filter" }, - "field": { - "type": "string", - "example": "string", - "enum": [ - "string", - "number", - "boolean", - "array" - ] + { + "$ref": "#/components/parameters/order_by" }, - "label": { - "type": "string", - "example": "Variable 1 for Process 1" + { + "$ref": "#/components/parameters/order_direction" }, - "name": { - "type": "string", - "example": "var_1_1" + { + "$ref": "#/components/parameters/per_page" }, - "asset": { - "properties": { - "id": { - "type": "string", - "example": "asset_1_1" - }, - "type": { - "type": "string", - "example": "sensor", - "enum": [ - "sensor", - "actuator", - "controller", - "device" - ] - }, - "name": { - "type": "string", - "example": "Asset 1 for Process 1" - }, - "uuid": { - "type": "string", - "format": "uuid", - "example": "550e8400-e29b-41d4-a716-446655440000" + { + "$ref": "#/components/parameters/include" + } + ], + "responses": { + "200": { + "description": "list of collections", + "content": { + "application/json": { + "schema": { + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/collections" + } + }, + "meta": { + "$ref": "#/components/schemas/metadata" + } + }, + "type": "object" + } } - }, - "type": "object" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" + } } - }, - "type": "object" + } }, - "PaginationMeta": { - "properties": { - "current_page": { - "type": "integer", - "example": 1 - }, - "from": { - "type": "integer", - "example": 1 - }, - "last_page": { - "type": "integer", - "example": 5 - }, - "path": { - "type": "string", - "example": "http://processmaker.com/processes/variables" - }, - "per_page": { - "type": "integer", - "example": 20 - }, - "to": { - "type": "integer", - "example": 20 - }, - "total": { - "type": "integer", - "example": 100 - }, - "links": { - "properties": { - "first": { - "type": "string", - "example": "http://processmaker.com/processes/variables?page=1" - }, - "last": { - "type": "string", - "example": "http://processmaker.com/processes/variables?page=5" - }, - "prev": { - "type": "string", - "nullable": true - }, - "next": { - "type": "string", - "example": "http://processmaker.com/processes/variables?page=2" + "post": { + "tags": [ + "Collections" + ], + "summary": "Save a new collections", + "description": "Create a new Collection.", + "operationId": "createCollection", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/collectionsEditable" } - }, - "type": "object" + } } }, - "type": "object" + "responses": { + "201": { + "description": "success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/collections" + } + } + } + } + } + } + }, + "/collections/{collection_id}": { + "get": { + "tags": [ + "Collections" + ], + "summary": "Get single collections by ID", + "description": "Get a single Collection.", + "operationId": "getCollectionById", + "parameters": [ + { + "name": "collection_id", + "in": "path", + "description": "ID of collection to return", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successfully found the collections", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/collections" + } + } + } + } + } }, - "metadata": { - "properties": { - "filter": { - "type": "string" - }, - "sort_by": { - "type": "string" - }, + "put": { + "tags": [ + "Collections" + ], + "summary": "Update a collection", + "description": "Update a Collection.", + "operationId": "updateCollection", + "parameters": [ + { + "name": "collection_id", + "in": "path", + "description": "ID of collection to update", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/collectionsEditable" + } + } + } + }, + "responses": { + "204": { + "description": "success" + } + } + }, + "delete": { + "tags": [ + "Collections" + ], + "summary": "Delete a collection", + "description": "Delete a Collection.", + "operationId": "deleteCollection", + "parameters": [ + { + "name": "collection_id", + "in": "path", + "description": "ID of collection to return", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "success" + } + } + } + }, + "/collections/{collection_id}/export": { + "post": { + "tags": [ + "Screens" + ], + "summary": "Trigger export collections job", + "description": "Export the specified collection.", + "operationId": "exportCollection", + "parameters": [ + { + "name": "collection_id", + "in": "path", + "description": "ID of the collection to export", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "202": { + "description": "success" + } + } + } + }, + "/collections/import": { + "post": { + "tags": [ + "Collections" + ], + "summary": "Import a new collection", + "description": "Import the specified collection.", + "operationId": "importCollection", + "requestBody": { + "required": true, + "content": { + "multipart/form-data": { + "schema": { + "required": [ + "file" + ], + "properties": { + "file": { + "description": "file to upload", + "type": "file", + "format": "file" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "201": { + "description": "success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/collections" + } + } + } + }, + "200": { + "description": "success" + } + } + } + }, + "/collections/{collection_id}/truncate": { + "delete": { + "tags": [ + "Collections" + ], + "summary": "Deletes all records in a collection", + "description": "Truncate a Collection.", + "operationId": "truncateCollection", + "parameters": [ + { + "name": "collection_id", + "in": "path", + "description": "ID of collection to truncate", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "success" + } + } + } + }, + "/collections/{collection_id}/records": { + "get": { + "tags": [ + "Collections" + ], + "summary": "Returns paginated collection records", + "description": "Get the list of records of a collection.", + "operationId": "getRecords", + "parameters": [ + { + "name": "collection_id", + "in": "path", + "description": "ID of collection to get records for", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pmql", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "in": "query", + "description": "Number of records to return per page. Defaults to 10,000 when omitted, invalid, or non-positive.", + "schema": { + "type": "integer", + "default": 10000 + } + }, + { + "$ref": "#/components/parameters/filter" + }, + { + "$ref": "#/components/parameters/order_by" + }, + { + "$ref": "#/components/parameters/order_direction" + }, + { + "$ref": "#/components/parameters/include" + } + ], + "responses": { + "200": { + "description": "list of records of a collection", + "content": { + "application/json": { + "schema": { + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/records" + } + }, + "meta": { + "$ref": "#/components/schemas/metadata" + } + }, + "type": "object" + } + } + } + } + } + }, + "post": { + "tags": [ + "Collections" + ], + "summary": "Save a new record in a collection", + "description": "Create a new record in a Collection.", + "operationId": "createRecord", + "parameters": [ + { + "name": "collection_id", + "in": "path", + "description": "ID of the collection", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/recordsEditable" + } + } + } + }, + "responses": { + "201": { + "description": "success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/records" + } + } + } + } + } + } + }, + "/collections/{collection_id}/records/{record_id}": { + "get": { + "tags": [ + "Collections" + ], + "summary": "Get single record of a collection", + "description": "Get a single record of a Collection.", + "operationId": "getRecordById", + "parameters": [ + { + "name": "collection_id", + "in": "path", + "description": "ID of the collection", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "record_id", + "in": "path", + "description": "ID of the record to return", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successfully found the record", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/records" + } + } + } + } + } + }, + "put": { + "tags": [ + "Collections" + ], + "summary": "Update a record", + "description": "Update a record in a Collection.", + "operationId": "updateRecord", + "parameters": [ + { + "name": "collection_id", + "in": "path", + "description": "ID of collection", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "record_id", + "in": "path", + "description": "ID of the record ", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/recordsEditable" + } + } + } + }, + "responses": { + "204": { + "description": "success" + } + } + }, + "delete": { + "tags": [ + "Collections" + ], + "summary": "Delete a collection record", + "description": "Delete a record of a Collection.", + "operationId": "deleteRecord", + "parameters": [ + { + "name": "collection_id", + "in": "path", + "description": "ID of collection", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "record_id", + "in": "path", + "description": "ID of record in collection", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "success" + } + } + }, + "patch": { + "tags": [ + "Collections" + ], + "summary": "Partial update of a record", + "description": "Implements a partial update of a record in a Collection.", + "operationId": "patchRecord", + "parameters": [ + { + "name": "collection_id", + "in": "path", + "description": "ID of collection ", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "record_id", + "in": "path", + "description": "ID of the record ", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/collectionsEditable" + } + } + } + }, + "responses": { + "200": { + "description": "success" + } + } + } + }, + "/comments/tasks": { + "get": { + "tags": [ + "Comments" + ], + "summary": "Returns all the tasks that are active.", + "description": "Display a listing of the resource.", + "operationId": "getCommentTasks", + "parameters": [ + { + "name": "process_request_id", + "in": "query", + "description": "Process request id", + "required": false, + "schema": { + "type": "integer" + } + }, + { + "$ref": "#/components/parameters/filter" + }, + { + "$ref": "#/components/parameters/order_by" + }, + { + "$ref": "#/components/parameters/order_direction" + } + ], + "responses": { + "200": { + "description": "list all tasks taht are active", + "content": { + "application/json": { + "schema": { + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/processRequestToken" + } + }, + "meta": { + "$ref": "#/components/schemas/metadata" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "/data_source_categories": { + "get": { + "tags": [ + "DataSourcesCategories" + ], + "summary": "Returns all Data Connectors categories that the user has access to", + "description": "Display a listing of the Data Connector Categories.", + "operationId": "getDataSourceCategories", + "parameters": [ + { + "$ref": "#/components/parameters/filter" + }, + { + "$ref": "#/components/parameters/order_by" + }, + { + "$ref": "#/components/parameters/order_direction" + }, + { + "$ref": "#/components/parameters/per_page" + } + ], + "responses": { + "200": { + "description": "list of Data Connectors categories", + "content": { + "application/json": { + "schema": { + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DataSourceCategory" + } + }, + "meta": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/metadata" + } + ] + } + }, + "type": "object" + } + } + } + } + } + }, + "post": { + "tags": [ + "DataSourcesCategories" + ], + "summary": "Save a new Data Connector Category", + "description": "Store a newly created Data Connector Category in storage", + "operationId": "createDataSourceCategory", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dataSourceCategoryEditable" + } + } + } + }, + "responses": { + "201": { + "description": "success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DataSourceCategory" + } + } + } + } + } + } + }, + "/data_source_categories/{data_source_category_id}": { + "get": { + "tags": [ + "DataSourcesCategories" + ], + "summary": "Get single Data Connector category by ID", + "description": "Display the specified data Source category.", + "operationId": "getDatasourceCategoryById", + "parameters": [ + { + "name": "data_source_category_id", + "in": "path", + "description": "ID of Data Connector category to return", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successfully found the Data Connector", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DataSourceCategory" + } + } + } + } + } + }, + "put": { + "tags": [ + "DataSourcesCategories" + ], + "summary": "Update a Data Connector Category", + "description": "Updates the current element", + "operationId": "updateDatasourceCategory", + "parameters": [ + { + "name": "data_source_category_id", + "in": "path", + "description": "ID of Data Connector category to return", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dataSourceCategoryEditable" + } + } + } + }, + "responses": { + "200": { + "description": "success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DataSourceCategory" + } + } + } + } + } + }, + "delete": { + "tags": [ + "DataSourcesCategories" + ], + "summary": "Delete a Data Connector category", + "description": "Remove the specified resource from storage.", + "operationId": "deleteDataSourceCategory", + "parameters": [ + { + "name": "data_source_category_id", + "in": "path", + "description": "ID of Data Connector category to return", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "success" + } + } + } + }, + "/data_sources": { + "get": { + "tags": [ + "DataSources" + ], + "summary": "Returns all Data Connectors that the user has access to", + "description": "Get the list of records of a Data Connector", + "operationId": "getDataSources", + "parameters": [ + { + "$ref": "#/components/parameters/filter" + }, + { + "$ref": "#/components/parameters/order_by" + }, + { + "$ref": "#/components/parameters/order_direction" + }, + { + "$ref": "#/components/parameters/per_page" + }, + { + "$ref": "#/components/parameters/include" + } + ], + "responses": { + "200": { + "description": "list of Data Connectors", + "content": { + "application/json": { + "schema": { + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/dataSource" + } + }, + "meta": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/metadata" + } + ] + } + }, + "type": "object" + } + } + } + } + } + }, + "post": { + "tags": [ + "DataSources" + ], + "summary": "Save a new Data Connector", + "description": "Create a new Data Connector.", + "operationId": "createDataSource", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dataSourceEditable" + } + } + } + }, + "responses": { + "201": { + "description": "success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dataSource" + } + } + } + } + } + } + }, + "/data_sources/{data_source_id}": { + "get": { + "tags": [ + "DataSources" + ], + "summary": "Get single Data Connector by ID", + "description": "Get a single Data Connector.", + "operationId": "getDataSourceById", + "parameters": [ + { + "name": "data_source_id", + "in": "path", + "description": "ID of Data Connector to return", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successfully found the Data Connector", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dataSource" + } + } + } + } + } + }, + "put": { + "tags": [ + "DataSources" + ], + "summary": "Update a Data Connector", + "description": "Update a Data Connector.", + "operationId": "updateDataSource", + "parameters": [ + { + "name": "data_source_id", + "in": "path", + "description": "ID of Data Connector to return", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dataSourceEditable" + } + } + } + }, + "responses": { + "204": { + "description": "success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dataSource" + } + } + } + } + } + }, + "delete": { + "tags": [ + "DataSources" + ], + "summary": "Delete a Data Connector", + "description": "Delete a Data Connector.", + "operationId": "deleteDataSource", + "parameters": [ + { + "name": "data_source_id", + "in": "path", + "description": "ID of Data Connector to return", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dataSource" + } + } + } + } + } + } + }, + "/data_sources/{data_source_id}/test": { + "post": { + "tags": [ + "DataSources" + ], + "summary": "Send a Data Connector request", + "description": "Send a Data Connector request.", + "operationId": "sendDataSource", + "parameters": [ + { + "name": "data_source_id", + "in": "path", + "description": "ID of Data Connector to return", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dataSourceEditable" + } + } + } + }, + "responses": { + "204": { + "description": "success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dataSource" + } + } + } + } + } + } + }, + "/requests/{request_id}/data_sources/{data_source_id}": { + "post": { + "tags": [ + "DataSources" + ], + "summary": "execute Data Source", + "description": "Execute a data Source endpoint", + "operationId": "executeDataSourceForRequest", + "parameters": [ + { + "name": "request_id", + "in": "path", + "description": "ID of the request in whose context the datasource will be executed", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "data_source_id", + "in": "path", + "description": "ID of DataSource to be run", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "config": { + "$ref": "#/components/schemas/DataSourceCallParameters" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DataSourceResponse" + } + } + } + } + } + } + }, + "/requests/data_sources/{data_source_id}": { + "post": { + "tags": [ + "DataSources" + ], + "summary": "execute Data Source", + "operationId": "executeDataSource", + "parameters": [ + { + "name": "data_source_id", + "in": "path", + "description": "ID of DataSource to be run", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "config": { + "$ref": "#/components/schemas/DataSourceCallParameters" + }, + "data": { + "type": "object" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DataSourceResponse" + } + } + } + } + } + } + }, + "/requests/data_sources/{data_source_id}/resources/{endpoint}/data": { + "post": { + "tags": [ + "DataSources" + ], + "summary": "Get Data from Data Source", + "operationId": "getDataFromDataSource", + "parameters": [ + { + "name": "data_source_id", + "in": "path", + "description": "ID of DataSource to be run", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "endpoint", + "in": "path", + "description": "Endpoint of the data source", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DataSourceResponse" + } + } + } + } + } + } + }, + "/decision_table_categories": { + "get": { + "tags": [ + "DecisionTableCategories" + ], + "summary": "Returns all Decision Tables categories that the user has access to", + "description": "Display a listing of the Decision Tables Categories.", + "operationId": "getDecisionTableCategories", + "parameters": [ + { + "$ref": "#/components/parameters/filter" + }, + { + "$ref": "#/components/parameters/order_by" + }, + { + "$ref": "#/components/parameters/order_direction" + }, + { + "$ref": "#/components/parameters/per_page" + } + ], + "responses": { + "200": { + "description": "list of Decision Tables categories", + "content": { + "application/json": { + "schema": { + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DecisionTableCategory" + } + }, + "meta": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/metadata" + } + ] + } + }, + "type": "object" + } + } + } + } + } + }, + "post": { + "tags": [ + "DecisionTableCategories" + ], + "summary": "Save a new Decision Table Category", + "description": "Store a newly created Decision Tables Category in storage", + "operationId": "createDecisionTableCategory", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/decisionTableCategoryEditable" + } + } + } + }, + "responses": { + "201": { + "description": "success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DecisionTableCategory" + } + } + } + } + } + } + }, + "/decision_table_categories/{decision_table_categories_id}": { + "get": { + "tags": [ + "DecisionTableCategories" + ], + "summary": "Get single Decision Table category by ID", + "description": "Display the specified decision Tables category.", + "operationId": "getDecisionTableCategoryById", + "parameters": [ + { + "name": "decision_table_categories_id", + "in": "path", + "description": "ID of Decision Table category to return", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successfully found the Decision Table", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DecisionTableCategory" + } + } + } + } + } + }, + "put": { + "tags": [ + "DecisionTableCategories" + ], + "summary": "Update a Decision Table Category", + "description": "Updates the current element", + "operationId": "updateDecisionTableCategory", + "parameters": [ + { + "name": "decision_table_categories_id", + "in": "path", + "description": "ID of Decision Table category to return", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/decisionTableCategoryEditable" + } + } + } + }, + "responses": { + "200": { + "description": "success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DecisionTableCategory" + } + } + } + } + } + }, + "delete": { + "tags": [ + "DecisionTableCategories" + ], + "summary": "Delete a Decision Table category", + "description": "Remove the specified resource from storage.", + "operationId": "deleteDecisionTableCategory", + "parameters": [ + { + "name": "decision_table_categories_id", + "in": "path", + "description": "ID of Decision Table category to return", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "success" + } + } + } + }, + "/decision_tables": { + "get": { + "tags": [ + "DecisionTables" + ], + "summary": "Returns all Decision tables that the user has access to", + "description": "Display a listing of the resource.", + "operationId": "getDecisionTables", + "parameters": [ + { + "$ref": "#/components/parameters/filter" + }, + { + "$ref": "#/components/parameters/order_by" + }, + { + "$ref": "#/components/parameters/order_direction" + }, + { + "$ref": "#/components/parameters/per_page" + }, + { + "$ref": "#/components/parameters/include" + } + ], + "responses": { + "200": { + "description": "list of Decision Tables", + "content": { + "application/json": { + "schema": { + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/decisionTable" + } + }, + "meta": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/metadata" + } + ] + } + }, + "type": "object" + } + } + } + } + } + }, + "post": { + "tags": [ + "DecisionTables" + ], + "summary": "Save a new Decision Table", + "description": "Store a newly created resource in storage.", + "operationId": "createDecisionTable", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/decisionTableEditable" + } + } + } + }, + "responses": { + "201": { + "description": "success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/decisionTable" + } + } + } + } + } + } + }, + "/decision_tables/{decision_table_id}": { + "get": { + "tags": [ + "DecisionTables" + ], + "summary": "Get single Decision Table by ID", + "description": "Display the specified resource.", + "operationId": "getDecisionTableById", + "parameters": [ + { + "name": "decision_table_id", + "in": "path", + "description": "ID of Decision Table to return", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successfully found the Decision Table", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/decisionTable" + } + } + } + } + } + }, + "put": { + "tags": [ + "DecisionTables" + ], + "summary": "Update a Decision Table", + "description": "Update a Decision table", + "operationId": "updateDecisionTable", + "parameters": [ + { + "name": "decision_table_id", + "in": "path", + "description": "ID of Decision Table to return", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/decisionTableEditable" + } + } + } + }, + "responses": { + "204": { + "description": "success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/decisionTable" + } + } + } + } + } + }, + "delete": { + "tags": [ + "DecisionTables" + ], + "summary": "Delete a Decision Table", + "description": "Delete a Decision tables", + "operationId": "deleteDecisionTable", + "parameters": [ + { + "name": "decision_table_id", + "in": "path", + "description": "ID of Decision Table to return", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/decisionTable" + } + } + } + } + } + } + }, + "/decision_tables/{decision_table_id}/duplicate": { + "put": { + "tags": [ + "DecisionTables" + ], + "summary": "duplicate a Decision Table", + "description": "duplicate a Decision table.", + "operationId": "duplicateDecisionTable", + "parameters": [ + { + "name": "decision_table_id", + "in": "path", + "description": "ID of Decision Table to return", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/decisionTableEditable" + } + } + } + }, + "responses": { + "201": { + "description": "success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/decisionTable" + } + } + } + } + } + } + }, + "/decision_tables/{decision_table_id}/excel-import": { + "post": { + "tags": [ + "DecisionTables" + ], + "summary": "Import a new decision table", + "description": "Import a Decision table from excel", + "operationId": "importExcel", + "parameters": [ + { + "name": "decision_table_id", + "in": "path", + "description": "ID of Decision Table to return", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "multipart/form-data": { + "schema": { + "properties": { + "file": { + "description": "file to import", + "type": "string", + "format": "binary" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "201": { + "description": "success", + "content": { + "application/json": { + "schema": { + "properties": { + "status": { + "type": "object" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "/decision_tables/{decision_table_id}/export": { + "post": { + "tags": [ + "DecisionTables" + ], + "summary": "Export a single Decision Table by ID", + "description": "Export the specified screen.", + "operationId": "exportDecisionTable", + "parameters": [ + { + "name": "decision_table_id", + "in": "path", + "description": "ID of Decision Table to return", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successfully exported the decision table", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DecisionTableExported" + } + } + } + } + } + } + }, + "/decision_tables/import": { + "post": { + "tags": [ + "DecisionTables" + ], + "summary": "Import a new Decision Table", + "description": "Import the specified Decision Table.", + "operationId": "importDecisionTable", + "requestBody": { + "required": true, + "content": { + "multipart/form-data": { + "schema": { + "properties": { + "file": { + "description": "file to import", + "type": "string", + "format": "binary" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "201": { + "description": "success", + "content": { + "application/json": { + "schema": { + "properties": { + "status": { + "type": "object" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "/decision_tables/{decision_table_id}/execute": { + "post": { + "tags": [ + "DecisionTables" + ], + "summary": "Execute a Decision Table definition", + "description": "Execute a Decision Table definition", + "operationId": "previewDecisionTable", + "parameters": [ + { + "name": "decision_table_id", + "in": "path", + "description": "Decision Table unique Identifier", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successfully executed", + "content": { + "application/json": { + "schema": {} + } + } + } + } + } + }, + "/saved-searches/{saved_search_id}/charts": { + "get": { + "tags": [ + "SavedSearchCharts" + ], + "summary": "Returns all saved search charts that the user has access to", + "description": "Get a list of SavedSearchCharts.", + "operationId": "getSavedSearchCharts", + "parameters": [ + { + "$ref": "#/components/parameters/filter" + }, + { + "name": "type", + "in": "query", + "description": "Only return saved searches by type", + "required": false, + "schema": { + "type": "string", + "enum": [ + "request", + "task", + "collection" + ] + } + }, + { + "$ref": "#/components/parameters/order_by" + }, + { + "$ref": "#/components/parameters/order_direction" + }, + { + "$ref": "#/components/parameters/per_page" + }, + { + "$ref": "#/components/parameters/include" + } + ], + "responses": { + "200": { + "description": "list of saved search charts", + "content": { + "application/json": { + "schema": { + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SavedSearchChart" + } + }, + "meta": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/metadata" + } + ] + } + }, + "type": "object" + } + } + } + } + } + }, + "put": { + "tags": [ + "SavedSearchCharts" + ], + "summary": "Update several saved search charts at once", + "description": "Batch update several SavedSearchCharts.", + "operationId": "batchUpdateSavedSearchCharts", + "parameters": [ + { + "name": "saved_search_id", + "in": "path", + "description": "ID of saved search to which these charts will be saved", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SavedSearchChart" + } + } + } + } + }, + "responses": { + "204": { + "description": "success" + } + } + }, + "post": { + "tags": [ + "SavedSearchCharts" + ], + "summary": "Save a new saved search chart", + "description": "Create a new SavedSearchChart.", + "operationId": "createSavedSearchChart", + "parameters": [ + { + "name": "saved_search_id", + "in": "path", + "description": "ID of saved search to which this chart will be saved", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SavedSearchChartEditable" + } + } + } + }, + "responses": { + "201": { + "description": "success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SavedSearchChart" + } + } + } + } + } + } + }, + "/saved-searches/charts/{chart_id}": { + "get": { + "tags": [ + "SavedSearchCharts" + ], + "summary": "Get single saved search chart by ID", + "description": "Get a single SavedSearchChart.", + "operationId": "getSavedSearchChartById", + "parameters": [ + { + "name": "chart_id", + "in": "path", + "description": "ID of chart to return", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successfully found the saved search chart", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SavedSearchChart" + } + } + } + } + } + }, + "put": { + "tags": [ + "SavedSearchCharts" + ], + "summary": "Update a saved search chart", + "description": "Update a SavedSearchChart.", + "operationId": "updateSavedSearchChart", + "parameters": [ + { + "name": "chart_id", + "in": "path", + "description": "ID of chart to return", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SavedSearchChartEditable" + } + } + } + }, + "responses": { + "200": { + "description": "success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SavedSearchChart" + } + } + } + } + } + }, + "delete": { + "tags": [ + "SavedSearchCharts" + ], + "summary": "Delete a saved search chart", + "description": "Delete a SavedSearchChart.", + "operationId": "deleteSavedSearchChart", + "parameters": [ + { + "name": "chart_id", + "in": "path", + "description": "ID of chart to return", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "success" + } + } + } + }, + "/saved-searches/charts/{chart_id}/fields": { + "get": { + "tags": [ + "SavedSearchCharts" + ], + "summary": "Get available chart fields for a Saved Search by ID", + "description": "Get available chart fields for a Saved Search.", + "operationId": "getSavedSearchFieldsById", + "parameters": [ + { + "name": "chart_id", + "in": "path", + "description": "ID of Saved Search to return", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successfully found the saved search", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SavedSearch" + } + } + } + } + } + } + }, + "/saved-searches/qa/batch-create-requests": { + "post": { + "tags": [ + "SavedSearches" + ], + "summary": "Batch-create test process requests for saved search testing (QA only)", + "description": "Batch-create process requests via the seed-performance Artisan command.", + "operationId": "batchCreateRequests", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "required": [ + "cases" + ], + "properties": { + "cases": { + "description": "Number of cases to create", + "type": "integer", + "example": 1000 + }, + "process_id": { + "description": "Reuse an existing process ID", + "type": "integer", + "nullable": true + }, + "data_size": { + "description": "Target payload size in bytes (default 262144 = 256KB)", + "type": "integer", + "nullable": true + }, + "status": { + "type": "string", + "default": "ACTIVE", + "enum": [ + "ACTIVE", + "COMPLETED", + "ERROR", + "CANCELED" + ] + } + }, + "type": "object" + } + } + } + }, + "responses": { + "201": { + "description": "Requests created successfully", + "content": { + "application/json": { + "schema": { + "properties": { + "cases": { + "type": "integer" + }, + "exit_code": { + "type": "integer" + }, + "output": { + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "403": { + "description": "QA endpoint is disabled" + }, + "422": { + "description": "Command failed" + } + } + } + }, + "/saved-searches/reports": { + "post": { + "tags": [ + "Reports" + ], + "summary": "Save a new report", + "operationId": "createReport", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ReportEditable" + } + } + } + }, + "responses": { + "201": { + "description": "success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Report" + } + } + } + } + } + } + }, + "/saved-searches/reports/{reportId}": { + "put": { + "tags": [ + "SavedSearches" + ], + "summary": "Update a saved search", + "description": "Update a Report", + "operationId": "updateReport", + "parameters": [ + { + "name": "reportId", + "in": "path", + "description": "ID of report", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SavedSearchEditable" + } + } + } + }, + "responses": { + "200": { + "description": "success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SavedSearch" + } + } + } + } + } + } + }, + "/saved-searches": { + "get": { + "tags": [ + "SavedSearches" + ], + "summary": "Returns all saved searches that the user has access to", + "description": "Get a list of SavedSearches.", + "operationId": "getSavedSearches", + "parameters": [ + { + "$ref": "#/components/parameters/filter" + }, + { + "name": "type", + "in": "query", + "description": "Only return saved searches by type", + "required": false, + "schema": { + "type": "string", + "enum": [ + "request", + "task", + "collection" + ] + } + }, + { + "name": "subset", + "in": "query", + "description": "Only return saved searches that are yours or those that have been shared with you", + "required": false, + "schema": { + "type": "string", + "enum": [ + "mine", + "shared" + ] + } + }, + { + "$ref": "#/components/parameters/order_by" + }, + { + "$ref": "#/components/parameters/order_direction" + }, + { + "$ref": "#/components/parameters/per_page" + }, + { + "$ref": "#/components/parameters/include" + } + ], + "responses": { + "200": { + "description": "list of saved searches", + "content": { + "application/json": { + "schema": { + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SavedSearch" + } + }, + "meta": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/metadata" + } + ] + } + }, + "type": "object" + } + } + } + } + } + }, + "post": { + "tags": [ + "SavedSearches" + ], + "summary": "Save a new saved search", + "description": "Create a new SavedSearch.", + "operationId": "createSavedSearch", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SavedSearchEditable" + } + } + } + }, + "responses": { + "201": { + "description": "success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SavedSearch" + } + } + } + } + } + } + }, + "/saved-searches/{savedSearchId}": { + "get": { + "tags": [ + "SavedSearches" + ], + "summary": "Get single saved searches by ID", + "description": "Get a single SavedSearch.", + "operationId": "getSavedSearchById", + "parameters": [ + { + "name": "savedSearchId", + "in": "path", + "description": "ID of saved search to return", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successfully found the saved search", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SavedSearch" + } + } + } + } + } + }, + "put": { + "tags": [ + "SavedSearches" + ], + "summary": "Update a saved search", + "description": "Update a SavedSearch.", + "operationId": "updateSavedSearch", + "parameters": [ + { + "name": "savedSearchId", + "in": "path", + "description": "ID of saved search to return", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SavedSearchEditable" + } + } + } + }, + "responses": { + "200": { + "description": "success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SavedSearch" + } + } + } + } + } + } + }, + "/saved-searches/{savedSearchId}/columns": { + "get": { + "tags": [ + "SavedSearches" + ], + "summary": "Returns all columns associated with a Saved Search", + "description": "Display a listing of columns.", + "operationId": "getSavedSearchColumns", + "parameters": [ + { + "name": "savedSearchId", + "in": "path", + "description": "ID of saved search to return", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "include", + "in": "query", + "description": "Include specific categories. Comma separated list.", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "current", + "default", + "available", + "data" + ] + }, + "uniqueItems": false + } + } + ], + "responses": { + "200": { + "description": "Categorized list of columns", + "content": { + "application/json": { + "schema": { + "properties": { + "current": { + "type": "array", + "items": { + "$ref": "#/components/schemas/columns" + } + }, + "default": { + "type": "array", + "items": { + "$ref": "#/components/schemas/columns" + } + }, + "available": { + "type": "array", + "items": { + "$ref": "#/components/schemas/columns" + } + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/columns" + } + } + }, + "type": "object" + } + } + } + } + } + } + }, + "/saved-searches/{savedSearchId}/users": { + "get": { + "tags": [ + "Users" + ], + "summary": "Returns all users", + "description": "Display a listing of the resource.", + "operationId": "getSavedSearchUsers", + "parameters": [ + { + "name": "savedSearchId", + "in": "path", + "description": "ID of saved search to return", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "filter", + "in": "query", + "description": "Filter results by string. Searches First Name, Last Name, Email and Username.", + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/order_by" + }, + { + "$ref": "#/components/parameters/order_direction" + }, + { + "$ref": "#/components/parameters/per_page" + }, + { + "$ref": "#/components/parameters/include" + } + ], + "responses": { + "200": { + "description": "list of users", + "content": { + "application/json": { + "schema": { + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/users" + } + }, + "meta": { + "$ref": "#/components/schemas/metadata" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "/saved-searches/{savedSearchId}/groups": { + "get": { + "tags": [ + "Groups" + ], + "summary": "Returns all groups that the user has access to", + "description": "Display a listing of the resource.", + "operationId": "getSavedSearchGroups", + "parameters": [ + { + "$ref": "#/components/parameters/order_by" + }, + { + "$ref": "#/components/parameters/order_direction" + }, + { + "$ref": "#/components/parameters/per_page" + }, + { + "$ref": "#/components/parameters/include" + } + ], + "responses": { + "200": { + "description": "list of groups", + "content": { + "application/json": { + "schema": { + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/groups" + } + }, + "meta": { + "$ref": "#/components/schemas/metadata" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "/saved-searches/{saved_search_id}": { + "delete": { + "tags": [ + "SavedSearches" + ], + "summary": "Delete a saved search", + "description": "Delete a SavedSearch.", + "operationId": "deleteSavedSearch", + "parameters": [ + { + "name": "saved_search_id", + "in": "path", + "description": "ID of saved search to return", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "success" + } + } + } + }, + "/saved-searches/icons": { + "get": { + "tags": [ + "SavedSearches" + ], + "summary": "Returns all icons for saved searches", + "description": "Get a list of icons available for SavedSearches.", + "operationId": "getSavedSearchesIcons", + "parameters": [ + { + "$ref": "#/components/parameters/per_page" + } + ], + "responses": { + "200": { + "description": "list of icons for saved searches", + "content": { + "application/json": { + "schema": { + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SavedSearchIcon" + } + }, + "meta": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/metadata" + } + ] + } + }, + "type": "object" + } + } + } + } + } + } + }, + "/version_histories": { + "get": { + "tags": [ + "Version History" + ], + "summary": "Return all version History according to the model", + "description": "Get the list of records of Version History", + "operationId": "getVersionHistories", + "parameters": [ + { + "$ref": "#/components/parameters/filter" + }, + { + "$ref": "#/components/parameters/order_by" + }, + { + "$ref": "#/components/parameters/order_direction" + }, + { + "$ref": "#/components/parameters/per_page" + }, + { + "$ref": "#/components/parameters/include" + } + ], + "responses": { + "200": { + "description": "list of Version History", + "content": { + "application/json": { + "schema": { + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/versionHistory" + } + }, + "meta": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/metadata" + } + ] + } + }, + "type": "object" + } + } + } + } + } + }, + "post": { + "tags": [ + "Version History" + ], + "summary": "Save a new Version History", + "description": "Create a new Version History.", + "operationId": "createVersion", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/versionHistoryEditable" + } + } + } + }, + "responses": { + "201": { + "description": "success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/versionHistory" + } + } + } + } + } + } + }, + "/version_histories/{version_history_id}": { + "get": { + "tags": [ + "Version History" + ], + "summary": "Get single Version History by ID", + "description": "Get a single Version History.", + "operationId": "getVersionHistoryById", + "parameters": [ + { + "name": "version_history_id", + "in": "path", + "description": "ID of Version History to return", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successfully found the Version History", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/versionHistory" + } + } + } + } + } + }, + "put": { + "tags": [ + "Version History" + ], + "summary": "Update a Version History", + "description": "Update a Version History.", + "operationId": "updateVersion", + "parameters": [ + { + "name": "version_history_id", + "in": "path", + "description": "ID of Version History to return", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/versionHistoryEditable" + } + } + } + }, + "responses": { + "204": { + "description": "success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/versionHistory" + } + } + } + } + } + }, + "delete": { + "tags": [ + "Version History" + ], + "summary": "Delete a Version History", + "description": "Delete a Version History.", + "operationId": "deleteVersion", + "parameters": [ + { + "name": "version_history_id", + "in": "path", + "description": "ID of Version History to return", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/versionHistory" + } + } + } + } + } + } + }, + "/version_histories/clone": { + "post": { + "tags": [ + "Version History" + ], + "summary": "Clone a new Version History", + "description": "Clone a new Version History.", + "operationId": "cloneVersion", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/versionHistoryEditable" + } + } + } + }, + "responses": { + "201": { + "description": "success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/versionHistory" + } + } + } + } + } + } + } + }, + "components": { + "schemas": { + "DateTime": { + "properties": { + "date": { + "type": "string" + } + }, + "type": "object" + }, + "updateUserGroups": { + "properties": { + "groups": { + "type": "array", + "items": { + "type": "integer", + "example": 1 + } + } + }, + "type": "object" + }, + "restoreUser": { + "properties": { + "username": { + "description": "Username to restore", + "type": "string" + } + }, + "type": "object" + }, + "Variable": { + "properties": { + "id": { + "type": "integer", + "example": 1 + }, + "process_id": { + "type": "integer", + "example": 1 + }, + "uuid": { + "type": "string", + "format": "uuid", + "example": "550e8400-e29b-41d4-a716-446655440000" + }, + "field": { + "type": "string", + "example": "string", + "enum": [ + "string", + "number", + "boolean", + "array" + ] + }, + "label": { + "type": "string", + "example": "Variable 1 for Process 1" + }, + "name": { + "type": "string", + "example": "var_1_1" + }, + "asset": { + "properties": { + "id": { + "type": "string", + "example": "asset_1_1" + }, + "type": { + "type": "string", + "example": "sensor", + "enum": [ + "sensor", + "actuator", + "controller", + "device" + ] + }, + "name": { + "type": "string", + "example": "Asset 1 for Process 1" + }, + "uuid": { + "type": "string", + "format": "uuid", + "example": "550e8400-e29b-41d4-a716-446655440000" + } + }, + "type": "object" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "type": "object" + }, + "PaginationMeta": { + "properties": { + "current_page": { + "type": "integer", + "example": 1 + }, + "from": { + "type": "integer", + "example": 1 + }, + "last_page": { + "type": "integer", + "example": 5 + }, + "path": { + "type": "string", + "example": "http://processmaker.com/processes/variables" + }, + "per_page": { + "type": "integer", + "example": 20 + }, + "to": { + "type": "integer", + "example": 20 + }, + "total": { + "type": "integer", + "example": 100 + }, + "links": { + "properties": { + "first": { + "type": "string", + "example": "http://processmaker.com/processes/variables?page=1" + }, + "last": { + "type": "string", + "example": "http://processmaker.com/processes/variables?page=5" + }, + "prev": { + "type": "string", + "nullable": true + }, + "next": { + "type": "string", + "example": "http://processmaker.com/processes/variables?page=2" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "metadata": { + "properties": { + "filter": { + "type": "string" + }, + "sort_by": { + "type": "string" + }, "sort_order": { "type": "string", - "enum": [ - "asc", - "desc" - ] + "enum": [ + "asc", + "desc" + ] + }, + "count": { + "type": "integer" + }, + "total_pages": { + "type": "integer" + }, + "current_page": { + "type": "integer" + }, + "form": { + "type": "integer" + }, + "last_page": { + "type": "integer" + }, + "path": { + "type": "string" + }, + "per_page": { + "type": "integer" + }, + "to": { + "type": "integer" + }, + "total": { + "type": "integer" + } + }, + "type": "object" + }, + "taskMetadata": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/metadata" + }, + { + "properties": { + "filter": { + "type": "string" + }, + "sort_by": { + "type": "string" + }, + "sort_order": { + "type": "string", + "enum": [ + "asc", + "desc" + ] + }, + "count": { + "type": "integer" + }, + "total_pages": { + "type": "integer" + }, + "current_page": { + "type": "integer" + }, + "form": { + "type": "integer" + }, + "last_page": { + "type": "integer" + }, + "path": { + "type": "string" + }, + "per_page": { + "type": "integer" + }, + "to": { + "type": "integer" + }, + "total": { + "type": "integer" + }, + "in_overdue": { + "type": "integer" + } + }, + "type": "object" + } + ] + }, + "signalsEditable": { + "properties": { + "id": { + "description": "Represents a business signal definition.", + "type": "string", + "format": "id" + }, + "name": { + "type": "string" + }, + "detail": { + "type": "string" + } + }, + "type": "object" + }, + "signals": { + "allOf": [ + { + "$ref": "#/components/schemas/signalsEditable" + }, + { + "properties": { + "type": { + "type": "string" + }, + "processes": { + "type": "array", + "items": { + "properties": { + "id": { + "type": "integer", + "format": "id" + }, + "is_system": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "catches": { + "type": "array", + "items": { + "properties": { + "id": { + "type": "integer", + "format": "id" + }, + "name": { + "type": "string" + }, + "type": { + "type": "string" + } + }, + "type": "object" + } + } + }, + "type": "object" + } + } + }, + "type": "object" + } + ] + }, + "columns": { + "properties": { + "label": { + "type": "string" + }, + "field": { + "type": "string" + }, + "sortable": { + "type": "boolean" + }, + "default": { + "type": "boolean" + }, + "format": { + "type": "string" + }, + "mask": { + "type": "string" + } + }, + "type": "object" + }, + "commentsEditable": { + "properties": { + "id": { + "description": "Represents a business process definition.", + "type": "string", + "format": "id" }, - "count": { - "type": "integer" + "user_id": { + "type": "string", + "format": "id" }, - "total_pages": { - "type": "integer" + "commentable_id": { + "type": "string", + "format": "id" }, - "current_page": { - "type": "integer" + "commentable_type": { + "type": "string" }, - "form": { + "up": { "type": "integer" }, - "last_page": { + "down": { "type": "integer" }, - "path": { + "subject": { "type": "string" }, - "per_page": { - "type": "integer" + "body": { + "type": "string" }, - "to": { - "type": "integer" + "hidden": { + "type": "boolean" }, - "total": { - "type": "integer" + "type": { + "type": "string", + "enum": [ + "LOG", + "MESSAGE" + ] + } + }, + "type": "object" + }, + "comments": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/commentsEditable" + }, + { + "properties": { + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "type": "object" + } + ] + }, + "EnvironmentVariableEditable": { + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "value": { + "type": "string" + }, + "asset_type": { + "type": "string", + "nullable": true + }, + "do_not_update": { + "type": "boolean" + } + }, + "type": "object" + }, + "EnvironmentVariable": { + "allOf": [ + { + "$ref": "#/components/schemas/EnvironmentVariableEditable" + }, + { + "properties": { + "id": { + "type": "integer", + "format": "id" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "type": "object" + } + ] + }, + "groupsEditable": { + "properties": { + "name": { + "description": "Represents a group definition.", + "type": "string" + }, + "description": { + "type": "string" + }, + "manager_id": { + "type": "integer", + "format": "id" + }, + "status": { + "type": "string", + "enum": [ + "ACTIVE", + "INACTIVE" + ] + } + }, + "type": "object" + }, + "groups": { + "allOf": [ + { + "$ref": "#/components/schemas/groupsEditable" + }, + { + "properties": { + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "id": { + "type": "string", + "format": "id" + } + }, + "type": "object" + } + ] + }, + "groupMembersEditable": { + "properties": { + "group_id": { + "description": "Represents a group Members definition.", + "type": "string", + "format": "id" + }, + "member_id": { + "type": "string", + "format": "id" + }, + "member_type": { + "type": "string" + }, + "description": { + "type": "string" + } + }, + "type": "object" + }, + "groupMembers": { + "allOf": [ + { + "$ref": "#/components/schemas/groupMembersEditable" + }, + { + "properties": { + "id": { + "type": "string", + "format": "id" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "type": "object" } - }, - "type": "object" + ] }, - "taskMetadata": { - "type": "object", + "createGroupMembers": { "allOf": [ { - "$ref": "#/components/schemas/metadata" + "$ref": "#/components/schemas/groupMembersEditable" }, { "properties": { - "filter": { - "type": "string" + "id": { + "type": "string", + "format": "id" }, - "sort_by": { - "type": "string" + "group": { + "type": "object" }, - "sort_order": { + "member": { + "type": "object" + }, + "created_at": { "type": "string", - "enum": [ - "asc", - "desc" - ] + "format": "date-time" }, - "count": { - "type": "integer" + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "type": "object" + } + ] + }, + "getGroupMembersById": { + "allOf": [ + { + "properties": { + "group_id": { + "type": "string", + "format": "id" }, - "total_pages": { - "type": "integer" + "member_id": { + "type": "string", + "format": "id" }, - "current_page": { - "type": "integer" + "member_type": { + "type": "string" }, - "form": { - "type": "integer" + "id": { + "type": "string", + "format": "id" }, - "last_page": { - "type": "integer" + "created_at": { + "type": "string", + "format": "date-time" }, - "path": { + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "type": "object" + } + ] + }, + "availableGroupMembers": { + "allOf": [ + { + "properties": { + "id": { + "type": "string", + "format": "id" + }, + "description": { "type": "string" }, - "per_page": { - "type": "integer" + "name": { + "type": "string" }, - "to": { - "type": "integer" + "status": { + "type": "string", + "enum": [ + "ACTIVE", + "INACTIVE" + ] }, - "total": { - "type": "integer" + "created_at": { + "type": "string", + "format": "date-time" }, - "in_overdue": { - "type": "integer" + "updated_at": { + "type": "string", + "format": "date-time" } }, "type": "object" } ] }, - "signalsEditable": { + "mediaEditable": { "properties": { "id": { - "description": "Represents a business signal definition.", + "description": "Represents media files stored in the database", + "type": "integer", + "format": "id" + }, + "model_id": { + "type": "integer", + "format": "id" + }, + "model_type": { "type": "string", "format": "id" }, + "collection_name": { + "type": "string" + }, "name": { "type": "string" }, - "detail": { + "file_name": { + "type": "string" + }, + "mime_type": { "type": "string" + }, + "disk": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "manipulations": { + "type": "object" + }, + "custom_properties": { + "type": "object" + }, + "responsive_images": { + "type": "object" + }, + "order_column": { + "type": "integer" } }, "type": "object" }, - "signals": { + "media": { + "type": "object", "allOf": [ { - "$ref": "#/components/schemas/signalsEditable" + "$ref": "#/components/schemas/mediaEditable" }, { "properties": { - "type": { - "type": "string" + "created_at": { + "type": "string", + "format": "date-time" }, - "processes": { - "type": "array", - "items": { - "properties": { - "id": { - "type": "integer", - "format": "id" - }, - "is_system": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "catches": { - "type": "array", - "items": { - "properties": { - "id": { - "type": "integer", - "format": "id" - }, - "name": { - "type": "string" - }, - "type": { - "type": "string" - } - }, - "type": "object" - } - } - }, - "type": "object" - } + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "type": "object" + } + ] + }, + "mediaExported": { + "properties": { + "url": { + "type": "string" + } + }, + "type": "object" + }, + "NotificationEditable": { + "properties": { + "type": { + "description": "Represents a notification definition.", + "type": "string" + }, + "notifiable_type": { + "type": "string" + }, + "notifiable_id": { + "type": "integer" + }, + "data": { + "type": "string" + }, + "name": { + "type": "string" + }, + "message": { + "type": "string" + }, + "processName": { + "type": "string" + }, + "userName": { + "type": "string" + }, + "request_id": { + "type": "string" + }, + "url": { + "type": "string" + } + }, + "type": "object" + }, + "Notification": { + "allOf": [ + { + "$ref": "#/components/schemas/NotificationEditable" + }, + { + "properties": { + "id": { + "type": "string" + }, + "read_at": { + "type": "string", + "format": "date-time" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" } }, "type": "object" } ] }, - "columns": { + "ProcessEditable": { "properties": { - "label": { - "type": "string" + "process_category_id": { + "description": "Represents a business process definition.", + "type": "integer", + "format": "id" }, - "field": { + "name": { "type": "string" }, - "sortable": { - "type": "boolean" - }, - "default": { - "type": "boolean" - }, - "format": { + "case_title": { "type": "string" }, - "mask": { + "description": { "type": "string" - } - }, - "type": "object" - }, - "commentsEditable": { - "properties": { - "id": { - "description": "Represents a business process definition.", - "type": "string", - "format": "id" - }, - "user_id": { - "type": "string", - "format": "id" }, - "commentable_id": { + "status": { "type": "string", - "format": "id" + "enum": [ + "ACTIVE", + "INACTIVE", + "ARCHIVED" + ] }, - "commentable_type": { - "type": "string" + "pause_timer_start": { + "type": "integer" }, - "up": { + "cancel_screen_id": { "type": "integer" }, - "down": { + "has_timer_start_events": { + "type": "boolean" + }, + "request_detail_screen_id": { + "type": "integer", + "format": "id" + }, + "is_valid": { "type": "integer" }, - "subject": { + "package_key": { "type": "string" }, - "body": { + "start_events": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProcessStartEvents" + } + }, + "warnings": { "type": "string" }, - "hidden": { - "type": "boolean" + "self_service_tasks": { + "type": "object" }, - "type": { - "type": "string", - "enum": [ - "LOG", - "MESSAGE" - ] + "signal_events": { + "type": "array", + "items": { + "type": "object" + } + }, + "category": { + "type": "object" + }, + "manager_id": { + "type": "array", + "items": { + "type": "integer", + "format": "id" + } } }, "type": "object" }, - "comments": { - "type": "object", + "Process": { "allOf": [ { - "$ref": "#/components/schemas/commentsEditable" + "$ref": "#/components/schemas/ProcessEditable" }, { "properties": { + "user_id": { + "type": "integer", + "format": "id" + }, + "id": { + "type": "string", + "format": "id" + }, + "deleted_at": { + "type": "string", + "format": "date-time" + }, "created_at": { "type": "string", "format": "date-time" @@ -6465,35 +9759,126 @@ "updated_at": { "type": "string", "format": "date-time" + }, + "notifications": { + "type": "object" + }, + "task_notifications": { + "type": "object" } }, "type": "object" } ] }, - "EnvironmentVariableEditable": { + "ProcessStartEvents": { "properties": { - "name": { + "eventDefinitions": { + "type": "object" + }, + "parallelMultiple": { + "type": "boolean" + }, + "outgoing": { + "type": "object" + }, + "incoming": { + "type": "object" + }, + "id": { "type": "string" }, - "description": { + "name": { "type": "string" + } + }, + "type": "object" + }, + "ProcessWithStartEvents": { + "allOf": [ + { + "$ref": "#/components/schemas/Process" }, - "value": { + { + "properties": { + "events": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProcessStartEvents" + } + } + }, + "type": "object" + } + ] + }, + "ProcessImport": { + "allOf": [ + { + "$ref": "#/components/schemas/ProcessEditable" + }, + { + "properties": { + "status": { + "type": "array", + "items": { + "type": "object" + } + }, + "assignable": { + "type": "array", + "items": { + "type": "object" + } + }, + "process": {} + }, + "type": "object" + } + ] + }, + "ProcessAssignments": { + "properties": { + "assignable": { + "type": "array", + "items": { + "type": "object" + } + }, + "cancel_request": { + "type": "object" + }, + "edit_data": { + "type": "object" + } + }, + "type": "object" + }, + "ProcessCategoryEditable": { + "properties": { + "name": { + "description": "Represents a business process category definition.", "type": "string" + }, + "status": { + "type": "string", + "enum": [ + "ACTIVE", + "INACTIVE" + ] } }, "type": "object" }, - "EnvironmentVariable": { + "ProcessCategory": { "allOf": [ { - "$ref": "#/components/schemas/EnvironmentVariableEditable" + "$ref": "#/components/schemas/ProcessCategoryEditable" }, { "properties": { "id": { - "type": "integer", + "type": "string", "format": "id" }, "created_at": { @@ -6509,33 +9894,36 @@ } ] }, - "groupsEditable": { + "processPermissionsEditable": { "properties": { - "name": { - "description": "Represents a group definition.", - "type": "string" + "id": { + "description": "Represents a Process permission.", + "type": "integer", + "format": "id" }, - "description": { - "type": "string" + "process_id": { + "type": "integer", + "format": "id" }, - "manager_id": { + "permission_id": { "type": "integer", "format": "id" }, - "status": { - "type": "string", - "enum": [ - "ACTIVE", - "INACTIVE" - ] + "assignable_id": { + "type": "integer", + "format": "id" + }, + "assignable_type": { + "type": "string" } }, "type": "object" }, - "groups": { + "processPermissions": { + "type": "object", "allOf": [ { - "$ref": "#/components/schemas/groupsEditable" + "$ref": "#/components/schemas/processPermissionsEditable" }, { "properties": { @@ -6546,40 +9934,63 @@ "updated_at": { "type": "string", "format": "date-time" - }, - "id": { - "type": "string", - "format": "id" } }, "type": "object" } ] }, - "groupMembersEditable": { + "processRequestEditable": { "properties": { - "group_id": { - "description": "Represents a group Members definition.", + "user_id": { + "description": "Represents an Eloquent model of a Request which is an instance of a Process.", "type": "string", "format": "id" }, - "member_id": { + "callable_id": { "type": "string", "format": "id" }, - "member_type": { + "data": { + "type": "object" + }, + "status": { + "type": "string", + "enum": [ + "ACTIVE", + "COMPLETED", + "ERROR", + "CANCELED" + ] + }, + "name": { "type": "string" }, - "description": { + "case_title": { + "type": "string" + }, + "case_title_formatted": { + "type": "string" + }, + "user_viewed_at": { "type": "string" + }, + "case_number": { + "type": "integer" + }, + "process_id": { + "type": "integer" + }, + "process": { + "type": "object" } }, "type": "object" }, - "groupMembers": { + "processRequest": { "allOf": [ { - "$ref": "#/components/schemas/groupMembersEditable" + "$ref": "#/components/schemas/processRequestEditable" }, { "properties": { @@ -6587,6 +9998,22 @@ "type": "string", "format": "id" }, + "process_id": { + "type": "string", + "format": "id" + }, + "process_collaboration_id": { + "type": "string", + "format": "id" + }, + "participant_id": { + "type": "string", + "format": "id" + }, + "process_category_id": { + "type": "string", + "format": "id" + }, "created_at": { "type": "string", "format": "date-time" @@ -6594,16 +10021,54 @@ "updated_at": { "type": "string", "format": "date-time" + }, + "user": {}, + "participants": { + "type": "array", + "items": { + "$ref": "#/components/schemas/users" + } } }, "type": "object" } ] }, - "createGroupMembers": { + "processRequestTokenEditable": { + "properties": { + "user_id": { + "description": "ProcessRequestToken is used to store the state of a token of the\nNayra engine", + "type": "string", + "format": "id" + }, + "status": { + "type": "string" + }, + "due_at": { + "type": "string", + "format": "date-time" + }, + "initiated_at": { + "type": "string", + "format": "date-time" + }, + "riskchanges_at": { + "type": "string", + "format": "date-time" + }, + "subprocess_start_event_id": { + "type": "string" + }, + "data": { + "type": "object" + } + }, + "type": "object" + }, + "processRequestToken": { "allOf": [ { - "$ref": "#/components/schemas/groupMembersEditable" + "$ref": "#/components/schemas/processRequestTokenEditable" }, { "properties": { @@ -6611,43 +10076,27 @@ "type": "string", "format": "id" }, - "group": { - "type": "object" - }, - "member": { - "type": "object" - }, - "created_at": { + "process_id": { "type": "string", - "format": "date-time" + "format": "id" }, - "updated_at": { + "process_request_id": { "type": "string", - "format": "date-time" - } - }, - "type": "object" - } - ] - }, - "getGroupMembersById": { - "allOf": [ - { - "properties": { - "group_id": { + "format": "id" + }, + "element_id": { "type": "string", "format": "id" }, - "member_id": { + "element_type": { "type": "string", "format": "id" }, - "member_type": { + "element_index": { "type": "string" }, - "id": { - "type": "string", - "format": "id" + "element_name": { + "type": "string" }, "created_at": { "type": "string", @@ -6656,33 +10105,68 @@ "updated_at": { "type": "string", "format": "date-time" + }, + "initiated_at": { + "type": "string", + "format": "date-time" + }, + "advanceStatus": { + "type": "string" + }, + "due_notified": { + "type": "integer" + }, + "user": { + "type": "object" + }, + "process": { + "type": "object" + }, + "process_request": { + "type": "object" } }, "type": "object" } ] }, - "availableGroupMembers": { + "taskAssignmentsEditable": { + "properties": { + "process_id": { + "description": "Represents a business process task assignment definition.", + "type": "integer", + "format": "id" + }, + "process_task_id": { + "type": "string", + "format": "id" + }, + "assignment_id": { + "type": "integer", + "format": "id" + }, + "assignment_type": { + "type": "string", + "enum": [ + "ProcessMaker\\Models\\User", + "ProcessMaker\\Models\\Group" + ] + } + }, + "type": "object" + }, + "taskAssignments": { + "type": "object", "allOf": [ + { + "$ref": "#/components/schemas/taskAssignmentsEditable" + }, { "properties": { "id": { - "type": "string", + "type": "integer", "format": "id" }, - "description": { - "type": "string" - }, - "name": { - "type": "string" - }, - "status": { - "type": "string", - "enum": [ - "ACTIVE", - "INACTIVE" - ] - }, "created_at": { "type": "string", "format": "date-time" @@ -6696,62 +10180,56 @@ } ] }, - "mediaEditable": { + "screensEditable": { "properties": { - "id": { - "description": "Represents media files stored in the database", - "type": "integer", - "format": "id" - }, - "model_id": { - "type": "integer", - "format": "id" - }, - "model_type": { - "type": "string", - "format": "id" - }, - "collection_name": { - "type": "string" - }, - "name": { - "type": "string" - }, - "file_name": { + "title": { + "description": "Class Screen", "type": "string" }, - "mime_type": { + "type": { "type": "string" }, - "disk": { + "description": { "type": "string" }, - "size": { - "type": "integer" + "config": { + "type": "array", + "items": { + "type": "object" + } }, - "manipulations": { - "type": "object" + "computed": { + "type": "array", + "items": { + "type": "object" + } }, - "custom_properties": { - "type": "object" + "watchers": { + "type": "array", + "items": { + "type": "object" + } }, - "responsive_images": { - "type": "object" + "custom_css": { + "type": "string" }, - "order_column": { - "type": "integer" + "screen_category_id": { + "type": "string" } }, "type": "object" }, - "media": { - "type": "object", + "screens": { "allOf": [ { - "$ref": "#/components/schemas/mediaEditable" + "$ref": "#/components/schemas/screensEditable" }, { "properties": { + "id": { + "type": "string", + "format": "id" + }, "created_at": { "type": "string", "format": "date-time" @@ -6765,7 +10243,7 @@ } ] }, - "mediaExported": { + "screenExported": { "properties": { "url": { "type": "string" @@ -6773,55 +10251,32 @@ }, "type": "object" }, - "NotificationEditable": { + "ScreenCategoryEditable": { "properties": { - "type": { - "description": "Represents a notification definition.", - "type": "string" - }, - "notifiable_type": { - "type": "string" - }, - "notifiable_id": { - "type": "integer" - }, - "data": { - "type": "string" - }, "name": { + "description": "Represents a business screen category definition.", "type": "string" }, - "message": { - "type": "string" - }, - "processName": { - "type": "string" - }, - "userName": { - "type": "string" - }, - "request_id": { - "type": "string" - }, - "url": { - "type": "string" + "status": { + "type": "string", + "enum": [ + "ACTIVE", + "INACTIVE" + ] } }, "type": "object" }, - "Notification": { + "ScreenCategory": { "allOf": [ { - "$ref": "#/components/schemas/NotificationEditable" + "$ref": "#/components/schemas/ScreenCategoryEditable" }, { "properties": { "id": { - "type": "string" - }, - "read_at": { "type": "string", - "format": "date-time" + "format": "id" }, "created_at": { "type": "string", @@ -6836,99 +10291,72 @@ } ] }, - "ProcessEditable": { + "ScreenTypeEditable": { "properties": { - "process_category_id": { - "description": "Represents a business process definition.", - "type": "integer", - "format": "id" - }, "name": { + "description": "Represents a business screen Type definition.", "type": "string" + } + }, + "type": "object" + }, + "ScreenType": { + "allOf": [ + { + "$ref": "#/components/schemas/ScreenTypeEditable" }, - "case_title": { + { + "properties": { + "id": { + "type": "string", + "format": "id" + } + }, + "type": "object" + } + ] + }, + "scriptsEditable": { + "properties": { + "title": { + "description": "Represents an Eloquent model of a Script", "type": "string" }, "description": { "type": "string" }, - "status": { - "type": "string", - "enum": [ - "ACTIVE", - "INACTIVE", - "ARCHIVED" - ] + "language": { + "type": "string" }, - "pause_timer_start": { - "type": "integer" + "code": { + "type": "string" }, - "cancel_screen_id": { + "timeout": { "type": "integer" }, - "has_timer_start_events": { - "type": "boolean" - }, - "request_detail_screen_id": { - "type": "integer", - "format": "id" - }, - "is_valid": { + "run_as_user_id": { "type": "integer" }, - "package_key": { - "type": "string" - }, - "start_events": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProcessStartEvents" - } - }, - "warnings": { + "key": { "type": "string" }, - "self_service_tasks": { - "type": "object" - }, - "signal_events": { - "type": "array", - "items": { - "type": "object" - } - }, - "category": { - "type": "object" - }, - "manager_id": { - "type": "array", - "items": { - "type": "integer", - "format": "id" - } + "script_category_id": { + "type": "integer" } }, "type": "object" }, - "Process": { + "scripts": { "allOf": [ { - "$ref": "#/components/schemas/ProcessEditable" + "$ref": "#/components/schemas/scriptsEditable" }, { "properties": { - "user_id": { - "type": "integer", - "format": "id" - }, "id": { - "type": "string", + "type": "integer", "format": "id" }, - "deleted_at": { - "type": "string", - "format": "date-time" - }, "created_at": { "type": "string", "format": "date-time" @@ -6936,121 +10364,228 @@ "updated_at": { "type": "string", "format": "date-time" - }, - "notifications": { - "type": "object" - }, - "task_notifications": { - "type": "object" } }, "type": "object" } ] }, - "ProcessStartEvents": { + "scriptsPreview": { "properties": { - "eventDefinitions": { - "type": "object" - }, - "parallelMultiple": { - "type": "boolean" - }, - "outgoing": { - "type": "object" - }, - "incoming": { - "type": "object" + "status": { + "type": "string" }, - "id": { + "key": { "type": "string" }, + "output": { + "type": "object" + } + }, + "type": "object" + }, + "ScriptCategoryEditable": { + "properties": { "name": { + "description": "Represents a business script category definition.", "type": "string" + }, + "status": { + "type": "string", + "enum": [ + "ACTIVE", + "INACTIVE" + ] } }, "type": "object" }, - "ProcessWithStartEvents": { + "ScriptCategory": { "allOf": [ { - "$ref": "#/components/schemas/Process" + "$ref": "#/components/schemas/ScriptCategoryEditable" }, { "properties": { - "events": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProcessStartEvents" - } + "id": { + "type": "string", + "format": "id" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" } }, "type": "object" } ] }, - "ProcessImport": { + "scriptExecutorsEditable": { + "properties": { + "title": { + "description": "Represents an Eloquent model of a Script Executor", + "type": "string" + }, + "description": { + "type": "string" + }, + "language": { + "type": "string" + }, + "config": { + "type": "string" + }, + "is_system": { + "type": "boolean" + } + }, + "type": "object" + }, + "scriptExecutors": { "allOf": [ { - "$ref": "#/components/schemas/ProcessEditable" + "$ref": "#/components/schemas/scriptExecutorsEditable" }, { "properties": { - "status": { - "type": "array", - "items": { - "type": "object" - } + "id": { + "type": "integer", + "format": "id" }, - "assignable": { - "type": "array", - "items": { - "type": "object" - } + "created_at": { + "type": "string", + "format": "date-time" }, - "process": {} + "updated_at": { + "type": "string", + "format": "date-time" + } }, "type": "object" } ] }, - "ProcessAssignments": { + "availableLanguages": { "properties": { - "assignable": { + "text": { + "type": "string" + }, + "value": { + "type": "string" + }, + "initDockerFile": { + "type": "string" + } + }, + "type": "object" + }, + "securityLog": { + "properties": { + "id": { + "description": "Class SecurityLog", + "type": "integer" + }, + "event": { + "type": "string" + }, + "ip": { + "type": "string" + }, + "meta": { "type": "array", "items": { + "properties": { + "os": { + "type": "array", + "items": { + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string" + } + }, + "type": "object" + } + }, + "browser": { + "type": "array", + "items": { + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string" + } + }, + "type": "object" + } + }, + "user_agent": { + "type": "string" + } + }, "type": "object" } }, - "cancel_request": { - "type": "object" + "user_id": { + "type": "integer" }, - "edit_data": { - "type": "object" + "occured_at": { + "type": "string" } }, "type": "object" }, - "ProcessCategoryEditable": { + "settingsEditable": { "properties": { + "key": { + "description": "Class Settings", + "type": "string" + }, + "config": { + "type": "array", + "items": { + "type": "object" + } + }, "name": { - "description": "Represents a business process category definition.", "type": "string" }, - "status": { - "type": "string", - "enum": [ - "ACTIVE", - "INACTIVE" - ] + "helper": { + "type": "string" + }, + "group": { + "type": "string" + }, + "format": { + "type": "string" + }, + "hidden": { + "type": "boolean" + }, + "readonly": { + "type": "boolean" + }, + "variables": { + "type": "string" + }, + "sansSerifFont": { + "type": "string" } }, "type": "object" }, - "ProcessCategory": { + "settings": { "allOf": [ { - "$ref": "#/components/schemas/ProcessCategoryEditable" + "$ref": "#/components/schemas/settingsEditable" }, { "properties": { @@ -7071,125 +10606,166 @@ } ] }, - "processPermissionsEditable": { + "TokenClient": { "properties": { "id": { - "description": "Represents a Process permission.", - "type": "integer", - "format": "id" + "type": "integer" }, - "process_id": { - "type": "integer", - "format": "id" + "user_id": { + "type": "integer" }, - "permission_id": { - "type": "integer", - "format": "id" + "name": { + "type": "string" }, - "assignable_id": { - "type": "integer", - "format": "id" + "provider": { + "type": "string" }, - "assignable_type": { + "redirect": { "type": "string" + }, + "personal_access_client": { + "type": "boolean" + }, + "password_client": { + "type": "boolean" + }, + "revoked": { + "type": "boolean" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" } }, "type": "object" }, - "processPermissions": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/processPermissionsEditable" - }, - { - "properties": { - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "type": "object" - } - ] - }, - "processRequestEditable": { + "usersEditable": { "properties": { - "user_id": { - "description": "Represents an Eloquent model of a Request which is an instance of a Process.", + "email": { + "description": "The attributes that are mass assignable.", "type": "string", - "format": "id" + "format": "email" + }, + "firstname": { + "type": "string" + }, + "lastname": { + "type": "string" + }, + "username": { + "type": "string" + }, + "password": { + "type": "string" + }, + "address": { + "type": "string" + }, + "city": { + "type": "string" + }, + "state": { + "type": "string" + }, + "postal": { + "type": "string" + }, + "country": { + "type": "string" + }, + "phone": { + "type": "string" + }, + "fax": { + "type": "string" + }, + "cell": { + "type": "string" + }, + "title": { + "type": "string" + }, + "timezone": { + "type": "string" + }, + "datetime_format": { + "type": "string" + }, + "language": { + "type": "string" + }, + "is_administrator": { + "type": "boolean" + }, + "expires_at": { + "type": "string" }, - "callable_id": { - "type": "string", - "format": "id" + "loggedin_at": { + "type": "string" }, - "data": { - "type": "object" + "remember_token": { + "type": "string" }, "status": { "type": "string", "enum": [ "ACTIVE", - "COMPLETED", - "ERROR", - "CANCELED" + "INACTIVE", + "SCHEDULED", + "OUT_OF_OFFICE", + "BLOCKED" ] }, - "name": { + "fullname": { "type": "string" }, - "case_title": { + "avatar": { "type": "string" }, - "case_title_formatted": { - "type": "string" + "media": { + "type": "array", + "items": { + "$ref": "#/components/schemas/media" + } }, - "user_viewed_at": { - "type": "string" + "birthdate": { + "type": "string", + "format": "date" }, - "case_number": { - "type": "integer" + "delegation_user_id": { + "type": "string", + "format": "id" }, - "process_id": { - "type": "integer" + "manager_id": { + "type": "string", + "format": "id" }, - "process": { - "type": "object" + "meta": { + "type": "object", + "additionalProperties": true + }, + "force_change_password": { + "type": "boolean" + }, + "email_task_notification": { + "type": "boolean" } }, "type": "object" }, - "processRequest": { + "users": { "allOf": [ { - "$ref": "#/components/schemas/processRequestEditable" + "$ref": "#/components/schemas/usersEditable" }, { "properties": { "id": { - "type": "string", - "format": "id" - }, - "process_id": { - "type": "string", - "format": "id" - }, - "process_collaboration_id": { - "type": "string", - "format": "id" - }, - "participant_id": { - "type": "string", - "format": "id" - }, - "process_category_id": { - "type": "string", - "format": "id" + "type": "integer" }, "created_at": { "type": "string", @@ -7199,81 +10775,97 @@ "type": "string", "format": "date-time" }, - "user": {}, - "participants": { - "type": "array", - "items": { - "$ref": "#/components/schemas/users" - } + "deleted_at": { + "type": "string", + "format": "date-time" } }, "type": "object" } ] }, - "processRequestTokenEditable": { + "UserToken": { "properties": { + "id": { + "type": "string" + }, "user_id": { - "description": "ProcessRequestToken is used to store the state of a token of the\nNayra engine", - "type": "string", - "format": "id" + "type": "integer" }, - "status": { + "client_id": { + "type": "integer" + }, + "name": { "type": "string" }, - "due_at": { + "scopes": { + "type": "object" + }, + "revoked": { + "type": "boolean" + }, + "client": { + "$ref": "#/components/schemas/TokenClient" + }, + "created_at": { "type": "string", "format": "date-time" }, - "initiated_at": { + "updated_at": { "type": "string", "format": "date-time" }, - "riskchanges_at": { + "expires_at": { "type": "string", "format": "date-time" + } + }, + "type": "object" + }, + "collectionsEditable": { + "properties": { + "name": { + "type": "string" }, - "subprocess_start_event_id": { + "description": { "type": "string" }, - "data": { - "type": "object" + "custom_title": { + "type": "string" + }, + "create_screen_id": { + "type": "string", + "format": "id" + }, + "read_screen_id": { + "type": "string", + "format": "id" + }, + "update_screen_id": { + "type": "string", + "format": "id" + }, + "signal_create": { + "type": "boolean" + }, + "signal_update": { + "type": "boolean" + }, + "signal_delete": { + "type": "boolean" } }, "type": "object" }, - "processRequestToken": { + "collections": { "allOf": [ { - "$ref": "#/components/schemas/processRequestTokenEditable" + "$ref": "#/components/schemas/collectionsEditable" }, { "properties": { "id": { - "type": "string", - "format": "id" - }, - "process_id": { - "type": "string", - "format": "id" - }, - "process_request_id": { - "type": "string", - "format": "id" - }, - "element_id": { - "type": "string", - "format": "id" - }, - "element_type": { - "type": "string", - "format": "id" - }, - "element_index": { - "type": "string" - }, - "element_name": { - "type": "string" + "type": "integer" }, "created_at": { "type": "string", @@ -7283,130 +10875,141 @@ "type": "string", "format": "date-time" }, - "initiated_at": { + "created_by_id": { "type": "string", - "format": "date-time" - }, - "advanceStatus": { - "type": "string" - }, - "due_notified": { - "type": "integer" - }, - "user": { - "type": "object" + "format": "id" }, - "process": { - "type": "object" + "updated_by_id": { + "type": "string", + "format": "id" }, - "process_request": { - "type": "object" + "columns": { + "type": "array", + "items": { + "type": "object" + } } }, "type": "object" } ] }, - "taskAssignmentsEditable": { + "recordsEditable": { "properties": { - "process_id": { - "description": "Represents a business process task assignment definition.", - "type": "integer", - "format": "id" - }, - "process_task_id": { - "type": "string", - "format": "id" - }, - "assignment_id": { - "type": "integer", - "format": "id" - }, - "assignment_type": { - "type": "string", - "enum": [ - "ProcessMaker\\Models\\User", - "ProcessMaker\\Models\\Group" - ] + "data": { + "type": "object" } }, "type": "object" }, - "taskAssignments": { - "type": "object", + "records": { "allOf": [ { - "$ref": "#/components/schemas/taskAssignmentsEditable" + "$ref": "#/components/schemas/recordsEditable" }, { "properties": { "id": { - "type": "integer", - "format": "id" - }, - "created_at": { - "type": "string", - "format": "date-time" + "type": "integer" }, - "updated_at": { + "collection_id": { "type": "string", - "format": "date-time" + "format": "id" } }, "type": "object" } - ] + ] + }, + "DataSourceCallParameters": { + "properties": { + "endpoint": { + "type": "string" + }, + "dataMapping": { + "type": "array", + "items": { + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "type": "object" + } + }, + "outboundConfig": { + "type": "array", + "items": { + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "type": "object" + } + } + }, + "type": "object" + }, + "DataSourceResponse": { + "properties": { + "status": { + "type": "integer" + }, + "response": { + "type": "object" + } + }, + "type": "object" }, - "screensEditable": { + "dataSourceEditable": { "properties": { - "title": { - "description": "Class Screen", - "type": "string" + "id": { + "description": "Class DataSource", + "type": "string", + "format": "id" }, - "type": { + "name": { "type": "string" }, "description": { "type": "string" }, - "config": { - "type": "array", - "items": { - "type": "object" - } + "endpoints": { + "type": "string" }, - "computed": { - "type": "array", - "items": { - "type": "object" - } + "mappings": { + "type": "string" }, - "watchers": { - "type": "array", - "items": { - "type": "object" - } + "authtype": { + "type": "string" }, - "custom_css": { + "credentials": { "type": "string" }, - "screen_category_id": { + "status": { + "type": "string" + }, + "data_source_category_id": { "type": "string" } }, "type": "object" }, - "screens": { + "dataSource": { + "type": "object", "allOf": [ { - "$ref": "#/components/schemas/screensEditable" + "$ref": "#/components/schemas/dataSourceEditable" }, { "properties": { - "id": { - "type": "string", - "format": "id" - }, "created_at": { "type": "string", "format": "date-time" @@ -7420,18 +11023,10 @@ } ] }, - "screenExported": { - "properties": { - "url": { - "type": "string" - } - }, - "type": "object" - }, - "ScreenCategoryEditable": { + "dataSourceCategoryEditable": { "properties": { "name": { - "description": "Represents a business screen category definition.", + "description": "Represents a business data Source category definition.", "type": "string" }, "status": { @@ -7444,10 +11039,11 @@ }, "type": "object" }, - "ScreenCategory": { + "DataSourceCategory": { + "type": "object", "allOf": [ { - "$ref": "#/components/schemas/ScreenCategoryEditable" + "$ref": "#/components/schemas/dataSourceCategoryEditable" }, { "properties": { @@ -7468,72 +11064,36 @@ } ] }, - "ScreenTypeEditable": { + "decisionTableEditable": { "properties": { - "name": { - "description": "Represents a business screen Type definition.", - "type": "string" - } - }, - "type": "object" - }, - "ScreenType": { - "allOf": [ - { - "$ref": "#/components/schemas/ScreenTypeEditable" + "id": { + "description": "Class Screen", + "type": "string", + "format": "id" }, - { - "properties": { - "id": { - "type": "string", - "format": "id" - } - }, - "type": "object" - } - ] - }, - "scriptsEditable": { - "properties": { - "title": { - "description": "Represents an Eloquent model of a Script", + "name": { "type": "string" }, "description": { "type": "string" }, - "language": { - "type": "string" - }, - "code": { + "definition": { "type": "string" }, - "timeout": { - "type": "integer" - }, - "run_as_user_id": { - "type": "integer" - }, - "key": { + "decision_table_categories_id": { "type": "string" - }, - "script_category_id": { - "type": "integer" } }, "type": "object" }, - "scripts": { + "decisionTable": { + "type": "object", "allOf": [ { - "$ref": "#/components/schemas/scriptsEditable" + "$ref": "#/components/schemas/decisionTableEditable" }, { "properties": { - "id": { - "type": "integer", - "format": "id" - }, "created_at": { "type": "string", "format": "date-time" @@ -7547,24 +11107,18 @@ } ] }, - "scriptsPreview": { + "DecisionTableExported": { "properties": { - "status": { - "type": "string" - }, - "key": { + "url": { "type": "string" - }, - "output": { - "type": "object" } }, "type": "object" }, - "ScriptCategoryEditable": { + "decisionTableCategoryEditable": { "properties": { "name": { - "description": "Represents a business script category definition.", + "description": "Represents a business decision Table category definition.", "type": "string" }, "status": { @@ -7577,10 +11131,11 @@ }, "type": "object" }, - "ScriptCategory": { + "DecisionTableCategory": { + "type": "object", "allOf": [ { - "$ref": "#/components/schemas/ScriptCategoryEditable" + "$ref": "#/components/schemas/decisionTableCategoryEditable" }, { "properties": { @@ -7601,36 +11156,43 @@ } ] }, - "scriptExecutorsEditable": { + "SavedSearchEditable": { "properties": { - "title": { - "description": "Represents an Eloquent model of a Script Executor", - "type": "string" + "meta": { + "description": "Represents an Eloquent model of a Saved Search.", + "type": "object", + "additionalProperties": "true" }, - "description": { + "pmql": { "type": "string" }, - "language": { + "title": { "type": "string" }, - "config": { - "type": "string" + "type": { + "type": "string", + "enum": [ + "task", + "request" + ] }, - "is_system": { - "type": "boolean" + "advanced_filter": { + "type": "object", + "additionalProperties": "true" } }, "type": "object" }, - "scriptExecutors": { + "SavedSearch": { "allOf": [ - { - "$ref": "#/components/schemas/scriptExecutorsEditable" - }, { "properties": { "id": { - "type": "integer", + "type": "string", + "format": "id" + }, + "user_id": { + "type": "string", "format": "id" }, "created_at": { @@ -7643,133 +11205,65 @@ } }, "type": "object" + }, + { + "$ref": "#/components/schemas/SavedSearchEditable" } ] }, - "availableLanguages": { + "SavedSearchIcon": { "properties": { - "text": { + "name": { "type": "string" }, "value": { "type": "string" - }, - "initDockerFile": { - "type": "string" } }, "type": "object" }, - "securityLog": { + "SavedSearchChartEditable": { "properties": { - "id": { - "description": "Class SecurityLog", - "type": "integer" - }, - "event": { - "type": "string" - }, - "ip": { + "title": { + "description": "Represents an Eloquent model of a Saved Search Chart.", "type": "string" }, - "meta": { - "type": "array", - "items": { - "properties": { - "os": { - "type": "array", - "items": { - "properties": { - "name": { - "type": "string" - }, - "version": { - "type": "string" - } - }, - "type": "object" - } - }, - "browser": { - "type": "array", - "items": { - "properties": { - "name": { - "type": "string" - }, - "version": { - "type": "string" - } - }, - "type": "object" - } - }, - "user_agent": { - "type": "string" - } - }, - "type": "object" - } - }, - "user_id": { - "type": "integer" - }, - "occured_at": { - "type": "string" - } - }, - "type": "object" - }, - "settingsEditable": { - "properties": { - "key": { - "description": "Class Settings", - "type": "string" + "type": { + "type": "string", + "enum": [ + "bar", + "bar-vertical", + "line", + "pie", + "doughnut" + ] }, "config": { - "type": "array", - "items": { - "type": "object" - } - }, - "name": { - "type": "string" - }, - "helper": { - "type": "string" - }, - "group": { - "type": "string" - }, - "format": { - "type": "string" - }, - "hidden": { - "type": "boolean" - }, - "readonly": { - "type": "boolean" - }, - "variables": { - "type": "string" + "type": "object", + "additionalProperties": "true" }, - "sansSerifFont": { - "type": "string" + "sort": { + "type": "integer" } }, "type": "object" }, - "settings": { + "SavedSearchChart": { "allOf": [ - { - "$ref": "#/components/schemas/settingsEditable" - }, { "properties": { "id": { "type": "string", "format": "id" }, + "saved_search_id": { + "type": "string", + "format": "id" + }, + "user_id": { + "type": "string", + "format": "id" + }, "created_at": { "type": "string", "format": "date-time" @@ -7777,227 +11271,133 @@ "updated_at": { "type": "string", "format": "date-time" + }, + "deleted_at": { + "type": "string", + "format": "date-time" } }, "type": "object" - } - ] - }, - "TokenClient": { - "properties": { - "id": { - "type": "integer" - }, - "user_id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "provider": { - "type": "string" - }, - "redirect": { - "type": "string" - }, - "personal_access_client": { - "type": "boolean" - }, - "password_client": { - "type": "boolean" - }, - "revoked": { - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time" }, - "updated_at": { - "type": "string", - "format": "date-time" + { + "$ref": "#/components/schemas/SavedSearchChartEditable" } - }, - "type": "object" + ] }, - "usersEditable": { + "ReportEditable": { "properties": { - "email": { - "description": "The attributes that are mass assignable.", + "type": { "type": "string", - "format": "email" - }, - "firstname": { - "type": "string" - }, - "lastname": { - "type": "string" - }, - "username": { - "type": "string" - }, - "password": { - "type": "string" - }, - "address": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "postal": { - "type": "string" - }, - "country": { - "type": "string" - }, - "phone": { - "type": "string" - }, - "fax": { - "type": "string" - }, - "cell": { - "type": "string" - }, - "title": { - "type": "string" - }, - "timezone": { - "type": "string" - }, - "datetime_format": { - "type": "string" - }, - "language": { - "type": "string" - }, - "is_administrator": { - "type": "boolean" - }, - "expires_at": { - "type": "string" - }, - "loggedin_at": { - "type": "string" - }, - "remember_token": { - "type": "string" + "enum": [ + "adhoc", + "scheduled" + ] }, - "status": { + "format": { "type": "string", "enum": [ - "ACTIVE", - "INACTIVE", - "SCHEDULED", - "OUT_OF_OFFICE", - "BLOCKED" + "csv", + "xlsx" ] }, - "fullname": { - "type": "string" + "saved_search_id": { + "type": "integer" }, - "avatar": { - "type": "string" + "config": { + "type": "object", + "additionalProperties": "true" }, - "media": { + "to": { "type": "array", "items": { - "$ref": "#/components/schemas/media" + "type": "string" } }, - "birthdate": { - "type": "string", - "format": "date" - }, - "delegation_user_id": { - "type": "string", - "format": "id" - }, - "manager_id": { - "type": "string", - "format": "id" - }, - "meta": { - "type": "object", - "additionalProperties": true - }, - "force_change_password": { - "type": "boolean" + "subject": { + "type": "string" }, - "email_task_notification": { - "type": "boolean" + "body": { + "type": "string" } }, "type": "object" }, - "users": { + "Report": { "allOf": [ - { - "$ref": "#/components/schemas/usersEditable" - }, { "properties": { "id": { - "type": "integer" + "type": "string", + "format": "id" }, - "created_at": { + "user_id": { "type": "string", - "format": "date-time" + "format": "id" }, - "updated_at": { + "created_at": { "type": "string", "format": "date-time" }, - "deleted_at": { + "updated_at": { "type": "string", "format": "date-time" } }, "type": "object" + }, + { + "$ref": "#/components/schemas/SavedSearchEditable" } ] }, - "UserToken": { + "versionHistoryEditable": { "properties": { - "id": { - "type": "string" - }, - "user_id": { + "versionable_id": { + "description": "Class VersionHistoryCollection", "type": "integer" }, - "client_id": { - "type": "integer" + "versionable_type": { + "type": "string" }, "name": { "type": "string" }, - "scopes": { - "type": "object" - }, - "revoked": { - "type": "boolean" - }, - "client": { - "$ref": "#/components/schemas/TokenClient" - }, - "created_at": { - "type": "string", - "format": "date-time" + "subject": { + "type": "string" }, - "updated_at": { - "type": "string", - "format": "date-time" + "description": { + "type": "string" }, - "expires_at": { + "status": { "type": "string", - "format": "date-time" + "enum": [ + "ACTIVE", + "INACTIVE" + ] } }, "type": "object" + }, + "versionHistory": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/versionHistoryEditable" + }, + { + "properties": { + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "type": "object" + } + ] } }, "responses": { @@ -8236,6 +11636,46 @@ { "name": "Processes Variables", "description": "Processes Variables" + }, + { + "name": "Collections", + "description": "Collections" + }, + { + "name": "Comments", + "description": "Comments" + }, + { + "name": "DataSourcesCategories", + "description": "DataSourcesCategories" + }, + { + "name": "DataSources", + "description": "DataSources" + }, + { + "name": "DecisionTableCategories", + "description": "DecisionTableCategories" + }, + { + "name": "DecisionTables", + "description": "DecisionTables" + }, + { + "name": "SavedSearchCharts", + "description": "SavedSearchCharts" + }, + { + "name": "SavedSearches", + "description": "SavedSearches" + }, + { + "name": "Reports", + "description": "Reports" + }, + { + "name": "Version History", + "description": "Version History" } ], "security": [ diff --git a/tests/Feature/Api/WizardTemplatesTest.php b/tests/Feature/Api/WizardTemplatesTest.php deleted file mode 100644 index 38e2abcd5e..0000000000 --- a/tests/Feature/Api/WizardTemplatesTest.php +++ /dev/null @@ -1,61 +0,0 @@ -count($total)->create(); - - $params = [ - 'order_by' => 'id', - 'order_direction' => 'asc', - 'per_page' => 10, - ]; - $route = route('api.wizard-templates.index', $params); - $response = $this->apiCall('GET', $route); - - $response->assertStatus(200); - $response->assertJsonCount(10, 'data'); - $response->assertJson([ - 'meta' => [ - 'per_page' => $params['per_page'], - 'total' => $total, - ], - ]); - } - - public function testItCanAddFilesFromUrlToMediaCollection() - { - // Create fake files. - Storage::fake('public'); - $directoryName = 'images'; - $filesToCreate = 3; - for ($i = 0; $i < $filesToCreate; $i++) { - UploadedFile::fake()->image("test_image{$i}.jpg")->storeAs($directoryName, "test_image{$i}.jpg", 'public'); - } - - // Add files to media collection. - $directory = Storage::disk('public')->path($directoryName); - $wizardTemplate = WizardTemplate::factory()->create(); - $wizardTemplate->addFilesToMediaCollection($directory); - - $this->assertCount($filesToCreate, $wizardTemplate->getMedia($directoryName)); - $this->assertDatabaseHas('media', [ - 'model_type' => WizardTemplate::class, - 'model_id' => $wizardTemplate->id, - 'collection_name' => $directoryName, - 'name' => 'test_image0', - ]); - } -} From 8c8295a24058d82b4c0d0777ca47173bb075918f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julio=20Cesar=20Laura=20Avenda=C3=B1o?= Date: Mon, 27 Jul 2026 15:13:28 -0400 Subject: [PATCH 2/3] FOUR-31416 Remove guided templates --- ProcessMaker/Events/ProcessCompleted.php | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/ProcessMaker/Events/ProcessCompleted.php b/ProcessMaker/Events/ProcessCompleted.php index be95f14dae..566fd59730 100644 --- a/ProcessMaker/Events/ProcessCompleted.php +++ b/ProcessMaker/Events/ProcessCompleted.php @@ -28,7 +28,10 @@ public function __construct(ProcessRequest $processRequest) { $this->payloadUrl = route('api.requests.show', ['request' => $processRequest->getKey()]); $this->processRequest = $processRequest; - $this->endEventDestination = $processRequest->getElementDestination(); + + if ($processRequest->process->asset_type !== 'GUIDED_HELPER_PROCESS') { + $this->endEventDestination = $processRequest->getElementDestination(); + } } /** From 5705c021a47981f687c7f6cce1195b4abef6f91c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julio=20Cesar=20Laura=20Avenda=C3=B1o?= Date: Mon, 27 Jul 2026 16:03:51 -0400 Subject: [PATCH 3/3] FOUR-31416 Remove guided templates --- .../components/ProcessHeader.vue | 225 + storage/api-docs/api-docs.json | 5822 ++++------------- 2 files changed, 1416 insertions(+), 4631 deletions(-) create mode 100644 resources/js/processes-catalogue/components/ProcessHeader.vue diff --git a/resources/js/processes-catalogue/components/ProcessHeader.vue b/resources/js/processes-catalogue/components/ProcessHeader.vue new file mode 100644 index 0000000000..da85136b7e --- /dev/null +++ b/resources/js/processes-catalogue/components/ProcessHeader.vue @@ -0,0 +1,225 @@ + + + + + diff --git a/storage/api-docs/api-docs.json b/storage/api-docs/api-docs.json index 832f903c0e..3b01de8d45 100644 --- a/storage/api-docs/api-docs.json +++ b/storage/api-docs/api-docs.json @@ -4069,10 +4069,16 @@ "schema": { "properties": { "data": { - "type": "object" + "type": "array", + "items": { + "type": "object" + } }, "config": { - "type": "object" + "type": "array", + "items": { + "type": "object" + } }, "code": { "type": "string" @@ -4117,10 +4123,16 @@ "schema": { "properties": { "data": { - "type": "object" + "type": "array", + "items": { + "type": "object" + } }, "config": { - "type": "object" + "type": "array", + "items": { + "type": "object" + } }, "sync": { "type": "boolean" @@ -6040,3980 +6052,412 @@ }, "servers": [ { - "url": "http://localhost/api/1.1", + "url": "http://landlord.test/api/1.1", "description": "API v1.1 Server" } ] } - }, - "/collections": { - "get": { - "tags": [ - "Collections" - ], - "summary": "Returns all collections that the user has access to", - "description": "Get a list of Collections.", - "operationId": "getCollections", - "parameters": [ - { - "$ref": "#/components/parameters/filter" - }, - { - "$ref": "#/components/parameters/order_by" - }, - { - "$ref": "#/components/parameters/order_direction" - }, - { - "$ref": "#/components/parameters/per_page" - }, - { - "$ref": "#/components/parameters/include" - } - ], - "responses": { - "200": { - "description": "list of collections", - "content": { - "application/json": { - "schema": { - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/collections" - } - }, - "meta": { - "$ref": "#/components/schemas/metadata" - } - }, - "type": "object" - } - } - } + } + }, + "components": { + "schemas": { + "DateTime": { + "properties": { + "date": { + "type": "string" } - } + }, + "type": "object" }, - "post": { - "tags": [ - "Collections" - ], - "summary": "Save a new collections", - "description": "Create a new Collection.", - "operationId": "createCollection", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/collectionsEditable" - } + "updateUserGroups": { + "properties": { + "groups": { + "type": "array", + "items": { + "type": "integer", + "example": 1 } } }, - "responses": { - "201": { - "description": "success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/collections" - } - } - } - } - } - } - }, - "/collections/{collection_id}": { - "get": { - "tags": [ - "Collections" - ], - "summary": "Get single collections by ID", - "description": "Get a single Collection.", - "operationId": "getCollectionById", - "parameters": [ - { - "name": "collection_id", - "in": "path", - "description": "ID of collection to return", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Successfully found the collections", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/collections" - } - } - } - } - } + "type": "object" }, - "put": { - "tags": [ - "Collections" - ], - "summary": "Update a collection", - "description": "Update a Collection.", - "operationId": "updateCollection", - "parameters": [ - { - "name": "collection_id", - "in": "path", - "description": "ID of collection to update", - "required": true, - "schema": { - "type": "string" - } + "restoreUser": { + "properties": { + "username": { + "description": "Username to restore", + "type": "string" } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/collectionsEditable" + }, + "type": "object" + }, + "Variable": { + "properties": { + "id": { + "type": "integer", + "example": 1 + }, + "process_id": { + "type": "integer", + "example": 1 + }, + "uuid": { + "type": "string", + "format": "uuid", + "example": "550e8400-e29b-41d4-a716-446655440000" + }, + "field": { + "type": "string", + "example": "string", + "enum": [ + "string", + "number", + "boolean", + "array" + ] + }, + "label": { + "type": "string", + "example": "Variable 1 for Process 1" + }, + "name": { + "type": "string", + "example": "var_1_1" + }, + "asset": { + "properties": { + "id": { + "type": "string", + "example": "asset_1_1" + }, + "type": { + "type": "string", + "example": "sensor", + "enum": [ + "sensor", + "actuator", + "controller", + "device" + ] + }, + "name": { + "type": "string", + "example": "Asset 1 for Process 1" + }, + "uuid": { + "type": "string", + "format": "uuid", + "example": "550e8400-e29b-41d4-a716-446655440000" } - } + }, + "type": "object" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" } }, - "responses": { - "204": { - "description": "success" - } - } + "type": "object" }, - "delete": { - "tags": [ - "Collections" - ], - "summary": "Delete a collection", - "description": "Delete a Collection.", - "operationId": "deleteCollection", - "parameters": [ - { - "name": "collection_id", - "in": "path", - "description": "ID of collection to return", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "success" - } - } - } - }, - "/collections/{collection_id}/export": { - "post": { - "tags": [ - "Screens" - ], - "summary": "Trigger export collections job", - "description": "Export the specified collection.", - "operationId": "exportCollection", - "parameters": [ - { - "name": "collection_id", - "in": "path", - "description": "ID of the collection to export", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "202": { - "description": "success" - } - } - } - }, - "/collections/import": { - "post": { - "tags": [ - "Collections" - ], - "summary": "Import a new collection", - "description": "Import the specified collection.", - "operationId": "importCollection", - "requestBody": { - "required": true, - "content": { - "multipart/form-data": { - "schema": { - "required": [ - "file" - ], - "properties": { - "file": { - "description": "file to upload", - "type": "file", - "format": "file" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "201": { - "description": "success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/collections" - } - } - } - }, - "200": { - "description": "success" - } - } - } - }, - "/collections/{collection_id}/truncate": { - "delete": { - "tags": [ - "Collections" - ], - "summary": "Deletes all records in a collection", - "description": "Truncate a Collection.", - "operationId": "truncateCollection", - "parameters": [ - { - "name": "collection_id", - "in": "path", - "description": "ID of collection to truncate", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "success" - } - } - } - }, - "/collections/{collection_id}/records": { - "get": { - "tags": [ - "Collections" - ], - "summary": "Returns paginated collection records", - "description": "Get the list of records of a collection.", - "operationId": "getRecords", - "parameters": [ - { - "name": "collection_id", - "in": "path", - "description": "ID of collection to get records for", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pmql", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "in": "query", - "description": "Number of records to return per page. Defaults to 10,000 when omitted, invalid, or non-positive.", - "schema": { - "type": "integer", - "default": 10000 - } - }, - { - "$ref": "#/components/parameters/filter" - }, - { - "$ref": "#/components/parameters/order_by" - }, - { - "$ref": "#/components/parameters/order_direction" - }, - { - "$ref": "#/components/parameters/include" - } - ], - "responses": { - "200": { - "description": "list of records of a collection", - "content": { - "application/json": { - "schema": { - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/records" - } - }, - "meta": { - "$ref": "#/components/schemas/metadata" - } - }, - "type": "object" - } - } - } - } - } - }, - "post": { - "tags": [ - "Collections" - ], - "summary": "Save a new record in a collection", - "description": "Create a new record in a Collection.", - "operationId": "createRecord", - "parameters": [ - { - "name": "collection_id", - "in": "path", - "description": "ID of the collection", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/recordsEditable" - } - } - } - }, - "responses": { - "201": { - "description": "success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/records" - } - } - } - } - } - } - }, - "/collections/{collection_id}/records/{record_id}": { - "get": { - "tags": [ - "Collections" - ], - "summary": "Get single record of a collection", - "description": "Get a single record of a Collection.", - "operationId": "getRecordById", - "parameters": [ - { - "name": "collection_id", - "in": "path", - "description": "ID of the collection", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "record_id", - "in": "path", - "description": "ID of the record to return", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Successfully found the record", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/records" - } - } - } - } - } - }, - "put": { - "tags": [ - "Collections" - ], - "summary": "Update a record", - "description": "Update a record in a Collection.", - "operationId": "updateRecord", - "parameters": [ - { - "name": "collection_id", - "in": "path", - "description": "ID of collection", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "record_id", - "in": "path", - "description": "ID of the record ", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/recordsEditable" - } - } - } - }, - "responses": { - "204": { - "description": "success" - } - } - }, - "delete": { - "tags": [ - "Collections" - ], - "summary": "Delete a collection record", - "description": "Delete a record of a Collection.", - "operationId": "deleteRecord", - "parameters": [ - { - "name": "collection_id", - "in": "path", - "description": "ID of collection", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "record_id", - "in": "path", - "description": "ID of record in collection", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "success" - } - } - }, - "patch": { - "tags": [ - "Collections" - ], - "summary": "Partial update of a record", - "description": "Implements a partial update of a record in a Collection.", - "operationId": "patchRecord", - "parameters": [ - { - "name": "collection_id", - "in": "path", - "description": "ID of collection ", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "record_id", - "in": "path", - "description": "ID of the record ", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/collectionsEditable" - } - } - } - }, - "responses": { - "200": { - "description": "success" - } - } - } - }, - "/comments/tasks": { - "get": { - "tags": [ - "Comments" - ], - "summary": "Returns all the tasks that are active.", - "description": "Display a listing of the resource.", - "operationId": "getCommentTasks", - "parameters": [ - { - "name": "process_request_id", - "in": "query", - "description": "Process request id", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "$ref": "#/components/parameters/filter" - }, - { - "$ref": "#/components/parameters/order_by" - }, - { - "$ref": "#/components/parameters/order_direction" - } - ], - "responses": { - "200": { - "description": "list all tasks taht are active", - "content": { - "application/json": { - "schema": { - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/processRequestToken" - } - }, - "meta": { - "$ref": "#/components/schemas/metadata" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "/data_source_categories": { - "get": { - "tags": [ - "DataSourcesCategories" - ], - "summary": "Returns all Data Connectors categories that the user has access to", - "description": "Display a listing of the Data Connector Categories.", - "operationId": "getDataSourceCategories", - "parameters": [ - { - "$ref": "#/components/parameters/filter" - }, - { - "$ref": "#/components/parameters/order_by" - }, - { - "$ref": "#/components/parameters/order_direction" - }, - { - "$ref": "#/components/parameters/per_page" - } - ], - "responses": { - "200": { - "description": "list of Data Connectors categories", - "content": { - "application/json": { - "schema": { - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DataSourceCategory" - } - }, - "meta": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/metadata" - } - ] - } - }, - "type": "object" - } - } - } - } - } - }, - "post": { - "tags": [ - "DataSourcesCategories" - ], - "summary": "Save a new Data Connector Category", - "description": "Store a newly created Data Connector Category in storage", - "operationId": "createDataSourceCategory", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/dataSourceCategoryEditable" - } - } - } - }, - "responses": { - "201": { - "description": "success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DataSourceCategory" - } - } - } - } - } - } - }, - "/data_source_categories/{data_source_category_id}": { - "get": { - "tags": [ - "DataSourcesCategories" - ], - "summary": "Get single Data Connector category by ID", - "description": "Display the specified data Source category.", - "operationId": "getDatasourceCategoryById", - "parameters": [ - { - "name": "data_source_category_id", - "in": "path", - "description": "ID of Data Connector category to return", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Successfully found the Data Connector", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DataSourceCategory" - } - } - } - } - } - }, - "put": { - "tags": [ - "DataSourcesCategories" - ], - "summary": "Update a Data Connector Category", - "description": "Updates the current element", - "operationId": "updateDatasourceCategory", - "parameters": [ - { - "name": "data_source_category_id", - "in": "path", - "description": "ID of Data Connector category to return", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/dataSourceCategoryEditable" - } - } - } - }, - "responses": { - "200": { - "description": "success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DataSourceCategory" - } - } - } - } - } - }, - "delete": { - "tags": [ - "DataSourcesCategories" - ], - "summary": "Delete a Data Connector category", - "description": "Remove the specified resource from storage.", - "operationId": "deleteDataSourceCategory", - "parameters": [ - { - "name": "data_source_category_id", - "in": "path", - "description": "ID of Data Connector category to return", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "success" - } - } - } - }, - "/data_sources": { - "get": { - "tags": [ - "DataSources" - ], - "summary": "Returns all Data Connectors that the user has access to", - "description": "Get the list of records of a Data Connector", - "operationId": "getDataSources", - "parameters": [ - { - "$ref": "#/components/parameters/filter" - }, - { - "$ref": "#/components/parameters/order_by" - }, - { - "$ref": "#/components/parameters/order_direction" - }, - { - "$ref": "#/components/parameters/per_page" - }, - { - "$ref": "#/components/parameters/include" - } - ], - "responses": { - "200": { - "description": "list of Data Connectors", - "content": { - "application/json": { - "schema": { - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/dataSource" - } - }, - "meta": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/metadata" - } - ] - } - }, - "type": "object" - } - } - } - } - } - }, - "post": { - "tags": [ - "DataSources" - ], - "summary": "Save a new Data Connector", - "description": "Create a new Data Connector.", - "operationId": "createDataSource", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/dataSourceEditable" - } - } - } - }, - "responses": { - "201": { - "description": "success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/dataSource" - } - } - } - } - } - } - }, - "/data_sources/{data_source_id}": { - "get": { - "tags": [ - "DataSources" - ], - "summary": "Get single Data Connector by ID", - "description": "Get a single Data Connector.", - "operationId": "getDataSourceById", - "parameters": [ - { - "name": "data_source_id", - "in": "path", - "description": "ID of Data Connector to return", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Successfully found the Data Connector", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/dataSource" - } - } - } - } - } - }, - "put": { - "tags": [ - "DataSources" - ], - "summary": "Update a Data Connector", - "description": "Update a Data Connector.", - "operationId": "updateDataSource", - "parameters": [ - { - "name": "data_source_id", - "in": "path", - "description": "ID of Data Connector to return", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/dataSourceEditable" - } - } - } - }, - "responses": { - "204": { - "description": "success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/dataSource" - } - } - } - } - } - }, - "delete": { - "tags": [ - "DataSources" - ], - "summary": "Delete a Data Connector", - "description": "Delete a Data Connector.", - "operationId": "deleteDataSource", - "parameters": [ - { - "name": "data_source_id", - "in": "path", - "description": "ID of Data Connector to return", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/dataSource" - } - } - } - } - } - } - }, - "/data_sources/{data_source_id}/test": { - "post": { - "tags": [ - "DataSources" - ], - "summary": "Send a Data Connector request", - "description": "Send a Data Connector request.", - "operationId": "sendDataSource", - "parameters": [ - { - "name": "data_source_id", - "in": "path", - "description": "ID of Data Connector to return", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/dataSourceEditable" - } - } - } - }, - "responses": { - "204": { - "description": "success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/dataSource" - } - } - } - } - } - } - }, - "/requests/{request_id}/data_sources/{data_source_id}": { - "post": { - "tags": [ - "DataSources" - ], - "summary": "execute Data Source", - "description": "Execute a data Source endpoint", - "operationId": "executeDataSourceForRequest", - "parameters": [ - { - "name": "request_id", - "in": "path", - "description": "ID of the request in whose context the datasource will be executed", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "data_source_id", - "in": "path", - "description": "ID of DataSource to be run", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "properties": { - "config": { - "$ref": "#/components/schemas/DataSourceCallParameters" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "description": "success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DataSourceResponse" - } - } - } - } - } - } - }, - "/requests/data_sources/{data_source_id}": { - "post": { - "tags": [ - "DataSources" - ], - "summary": "execute Data Source", - "operationId": "executeDataSource", - "parameters": [ - { - "name": "data_source_id", - "in": "path", - "description": "ID of DataSource to be run", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "properties": { - "config": { - "$ref": "#/components/schemas/DataSourceCallParameters" - }, - "data": { - "type": "object" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "description": "success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DataSourceResponse" - } - } - } - } - } - } - }, - "/requests/data_sources/{data_source_id}/resources/{endpoint}/data": { - "post": { - "tags": [ - "DataSources" - ], - "summary": "Get Data from Data Source", - "operationId": "getDataFromDataSource", - "parameters": [ - { - "name": "data_source_id", - "in": "path", - "description": "ID of DataSource to be run", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "endpoint", - "in": "path", - "description": "Endpoint of the data source", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DataSourceResponse" - } - } - } - } - } - } - }, - "/decision_table_categories": { - "get": { - "tags": [ - "DecisionTableCategories" - ], - "summary": "Returns all Decision Tables categories that the user has access to", - "description": "Display a listing of the Decision Tables Categories.", - "operationId": "getDecisionTableCategories", - "parameters": [ - { - "$ref": "#/components/parameters/filter" - }, - { - "$ref": "#/components/parameters/order_by" - }, - { - "$ref": "#/components/parameters/order_direction" - }, - { - "$ref": "#/components/parameters/per_page" - } - ], - "responses": { - "200": { - "description": "list of Decision Tables categories", - "content": { - "application/json": { - "schema": { - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DecisionTableCategory" - } - }, - "meta": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/metadata" - } - ] - } - }, - "type": "object" - } - } - } - } - } - }, - "post": { - "tags": [ - "DecisionTableCategories" - ], - "summary": "Save a new Decision Table Category", - "description": "Store a newly created Decision Tables Category in storage", - "operationId": "createDecisionTableCategory", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/decisionTableCategoryEditable" - } - } - } - }, - "responses": { - "201": { - "description": "success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DecisionTableCategory" - } - } - } - } - } - } - }, - "/decision_table_categories/{decision_table_categories_id}": { - "get": { - "tags": [ - "DecisionTableCategories" - ], - "summary": "Get single Decision Table category by ID", - "description": "Display the specified decision Tables category.", - "operationId": "getDecisionTableCategoryById", - "parameters": [ - { - "name": "decision_table_categories_id", - "in": "path", - "description": "ID of Decision Table category to return", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Successfully found the Decision Table", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DecisionTableCategory" - } - } - } - } - } - }, - "put": { - "tags": [ - "DecisionTableCategories" - ], - "summary": "Update a Decision Table Category", - "description": "Updates the current element", - "operationId": "updateDecisionTableCategory", - "parameters": [ - { - "name": "decision_table_categories_id", - "in": "path", - "description": "ID of Decision Table category to return", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/decisionTableCategoryEditable" - } - } - } - }, - "responses": { - "200": { - "description": "success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DecisionTableCategory" - } - } - } - } - } - }, - "delete": { - "tags": [ - "DecisionTableCategories" - ], - "summary": "Delete a Decision Table category", - "description": "Remove the specified resource from storage.", - "operationId": "deleteDecisionTableCategory", - "parameters": [ - { - "name": "decision_table_categories_id", - "in": "path", - "description": "ID of Decision Table category to return", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "success" - } - } - } - }, - "/decision_tables": { - "get": { - "tags": [ - "DecisionTables" - ], - "summary": "Returns all Decision tables that the user has access to", - "description": "Display a listing of the resource.", - "operationId": "getDecisionTables", - "parameters": [ - { - "$ref": "#/components/parameters/filter" - }, - { - "$ref": "#/components/parameters/order_by" - }, - { - "$ref": "#/components/parameters/order_direction" - }, - { - "$ref": "#/components/parameters/per_page" - }, - { - "$ref": "#/components/parameters/include" - } - ], - "responses": { - "200": { - "description": "list of Decision Tables", - "content": { - "application/json": { - "schema": { - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/decisionTable" - } - }, - "meta": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/metadata" - } - ] - } - }, - "type": "object" - } - } - } - } - } - }, - "post": { - "tags": [ - "DecisionTables" - ], - "summary": "Save a new Decision Table", - "description": "Store a newly created resource in storage.", - "operationId": "createDecisionTable", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/decisionTableEditable" - } - } - } - }, - "responses": { - "201": { - "description": "success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/decisionTable" - } - } - } - } - } - } - }, - "/decision_tables/{decision_table_id}": { - "get": { - "tags": [ - "DecisionTables" - ], - "summary": "Get single Decision Table by ID", - "description": "Display the specified resource.", - "operationId": "getDecisionTableById", - "parameters": [ - { - "name": "decision_table_id", - "in": "path", - "description": "ID of Decision Table to return", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Successfully found the Decision Table", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/decisionTable" - } - } - } - } - } - }, - "put": { - "tags": [ - "DecisionTables" - ], - "summary": "Update a Decision Table", - "description": "Update a Decision table", - "operationId": "updateDecisionTable", - "parameters": [ - { - "name": "decision_table_id", - "in": "path", - "description": "ID of Decision Table to return", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/decisionTableEditable" - } - } - } - }, - "responses": { - "204": { - "description": "success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/decisionTable" - } - } - } - } - } - }, - "delete": { - "tags": [ - "DecisionTables" - ], - "summary": "Delete a Decision Table", - "description": "Delete a Decision tables", - "operationId": "deleteDecisionTable", - "parameters": [ - { - "name": "decision_table_id", - "in": "path", - "description": "ID of Decision Table to return", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/decisionTable" - } - } - } - } - } - } - }, - "/decision_tables/{decision_table_id}/duplicate": { - "put": { - "tags": [ - "DecisionTables" - ], - "summary": "duplicate a Decision Table", - "description": "duplicate a Decision table.", - "operationId": "duplicateDecisionTable", - "parameters": [ - { - "name": "decision_table_id", - "in": "path", - "description": "ID of Decision Table to return", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/decisionTableEditable" - } - } - } - }, - "responses": { - "201": { - "description": "success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/decisionTable" - } - } - } - } - } - } - }, - "/decision_tables/{decision_table_id}/excel-import": { - "post": { - "tags": [ - "DecisionTables" - ], - "summary": "Import a new decision table", - "description": "Import a Decision table from excel", - "operationId": "importExcel", - "parameters": [ - { - "name": "decision_table_id", - "in": "path", - "description": "ID of Decision Table to return", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "multipart/form-data": { - "schema": { - "properties": { - "file": { - "description": "file to import", - "type": "string", - "format": "binary" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "201": { - "description": "success", - "content": { - "application/json": { - "schema": { - "properties": { - "status": { - "type": "object" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "/decision_tables/{decision_table_id}/export": { - "post": { - "tags": [ - "DecisionTables" - ], - "summary": "Export a single Decision Table by ID", - "description": "Export the specified screen.", - "operationId": "exportDecisionTable", - "parameters": [ - { - "name": "decision_table_id", - "in": "path", - "description": "ID of Decision Table to return", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Successfully exported the decision table", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DecisionTableExported" - } - } - } - } - } - } - }, - "/decision_tables/import": { - "post": { - "tags": [ - "DecisionTables" - ], - "summary": "Import a new Decision Table", - "description": "Import the specified Decision Table.", - "operationId": "importDecisionTable", - "requestBody": { - "required": true, - "content": { - "multipart/form-data": { - "schema": { - "properties": { - "file": { - "description": "file to import", - "type": "string", - "format": "binary" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "201": { - "description": "success", - "content": { - "application/json": { - "schema": { - "properties": { - "status": { - "type": "object" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "/decision_tables/{decision_table_id}/execute": { - "post": { - "tags": [ - "DecisionTables" - ], - "summary": "Execute a Decision Table definition", - "description": "Execute a Decision Table definition", - "operationId": "previewDecisionTable", - "parameters": [ - { - "name": "decision_table_id", - "in": "path", - "description": "Decision Table unique Identifier", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Successfully executed", - "content": { - "application/json": { - "schema": {} - } - } - } - } - } - }, - "/saved-searches/{saved_search_id}/charts": { - "get": { - "tags": [ - "SavedSearchCharts" - ], - "summary": "Returns all saved search charts that the user has access to", - "description": "Get a list of SavedSearchCharts.", - "operationId": "getSavedSearchCharts", - "parameters": [ - { - "$ref": "#/components/parameters/filter" - }, - { - "name": "type", - "in": "query", - "description": "Only return saved searches by type", - "required": false, - "schema": { - "type": "string", - "enum": [ - "request", - "task", - "collection" - ] - } - }, - { - "$ref": "#/components/parameters/order_by" - }, - { - "$ref": "#/components/parameters/order_direction" - }, - { - "$ref": "#/components/parameters/per_page" - }, - { - "$ref": "#/components/parameters/include" - } - ], - "responses": { - "200": { - "description": "list of saved search charts", - "content": { - "application/json": { - "schema": { - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SavedSearchChart" - } - }, - "meta": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/metadata" - } - ] - } - }, - "type": "object" - } - } - } - } - } - }, - "put": { - "tags": [ - "SavedSearchCharts" - ], - "summary": "Update several saved search charts at once", - "description": "Batch update several SavedSearchCharts.", - "operationId": "batchUpdateSavedSearchCharts", - "parameters": [ - { - "name": "saved_search_id", - "in": "path", - "description": "ID of saved search to which these charts will be saved", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SavedSearchChart" - } - } - } - } - }, - "responses": { - "204": { - "description": "success" - } - } - }, - "post": { - "tags": [ - "SavedSearchCharts" - ], - "summary": "Save a new saved search chart", - "description": "Create a new SavedSearchChart.", - "operationId": "createSavedSearchChart", - "parameters": [ - { - "name": "saved_search_id", - "in": "path", - "description": "ID of saved search to which this chart will be saved", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SavedSearchChartEditable" - } - } - } - }, - "responses": { - "201": { - "description": "success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SavedSearchChart" - } - } - } - } - } - } - }, - "/saved-searches/charts/{chart_id}": { - "get": { - "tags": [ - "SavedSearchCharts" - ], - "summary": "Get single saved search chart by ID", - "description": "Get a single SavedSearchChart.", - "operationId": "getSavedSearchChartById", - "parameters": [ - { - "name": "chart_id", - "in": "path", - "description": "ID of chart to return", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Successfully found the saved search chart", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SavedSearchChart" - } - } - } - } - } - }, - "put": { - "tags": [ - "SavedSearchCharts" - ], - "summary": "Update a saved search chart", - "description": "Update a SavedSearchChart.", - "operationId": "updateSavedSearchChart", - "parameters": [ - { - "name": "chart_id", - "in": "path", - "description": "ID of chart to return", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SavedSearchChartEditable" - } - } - } - }, - "responses": { - "200": { - "description": "success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SavedSearchChart" - } - } - } - } - } - }, - "delete": { - "tags": [ - "SavedSearchCharts" - ], - "summary": "Delete a saved search chart", - "description": "Delete a SavedSearchChart.", - "operationId": "deleteSavedSearchChart", - "parameters": [ - { - "name": "chart_id", - "in": "path", - "description": "ID of chart to return", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "success" - } - } - } - }, - "/saved-searches/charts/{chart_id}/fields": { - "get": { - "tags": [ - "SavedSearchCharts" - ], - "summary": "Get available chart fields for a Saved Search by ID", - "description": "Get available chart fields for a Saved Search.", - "operationId": "getSavedSearchFieldsById", - "parameters": [ - { - "name": "chart_id", - "in": "path", - "description": "ID of Saved Search to return", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Successfully found the saved search", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SavedSearch" - } - } - } - } - } - } - }, - "/saved-searches/qa/batch-create-requests": { - "post": { - "tags": [ - "SavedSearches" - ], - "summary": "Batch-create test process requests for saved search testing (QA only)", - "description": "Batch-create process requests via the seed-performance Artisan command.", - "operationId": "batchCreateRequests", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "required": [ - "cases" - ], - "properties": { - "cases": { - "description": "Number of cases to create", - "type": "integer", - "example": 1000 - }, - "process_id": { - "description": "Reuse an existing process ID", - "type": "integer", - "nullable": true - }, - "data_size": { - "description": "Target payload size in bytes (default 262144 = 256KB)", - "type": "integer", - "nullable": true - }, - "status": { - "type": "string", - "default": "ACTIVE", - "enum": [ - "ACTIVE", - "COMPLETED", - "ERROR", - "CANCELED" - ] - } - }, - "type": "object" - } - } - } - }, - "responses": { - "201": { - "description": "Requests created successfully", - "content": { - "application/json": { - "schema": { - "properties": { - "cases": { - "type": "integer" - }, - "exit_code": { - "type": "integer" - }, - "output": { - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "403": { - "description": "QA endpoint is disabled" - }, - "422": { - "description": "Command failed" - } - } - } - }, - "/saved-searches/reports": { - "post": { - "tags": [ - "Reports" - ], - "summary": "Save a new report", - "operationId": "createReport", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ReportEditable" - } - } - } - }, - "responses": { - "201": { - "description": "success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Report" - } - } - } - } - } - } - }, - "/saved-searches/reports/{reportId}": { - "put": { - "tags": [ - "SavedSearches" - ], - "summary": "Update a saved search", - "description": "Update a Report", - "operationId": "updateReport", - "parameters": [ - { - "name": "reportId", - "in": "path", - "description": "ID of report", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SavedSearchEditable" - } - } - } - }, - "responses": { - "200": { - "description": "success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SavedSearch" - } - } - } - } - } - } - }, - "/saved-searches": { - "get": { - "tags": [ - "SavedSearches" - ], - "summary": "Returns all saved searches that the user has access to", - "description": "Get a list of SavedSearches.", - "operationId": "getSavedSearches", - "parameters": [ - { - "$ref": "#/components/parameters/filter" - }, - { - "name": "type", - "in": "query", - "description": "Only return saved searches by type", - "required": false, - "schema": { - "type": "string", - "enum": [ - "request", - "task", - "collection" - ] - } - }, - { - "name": "subset", - "in": "query", - "description": "Only return saved searches that are yours or those that have been shared with you", - "required": false, - "schema": { - "type": "string", - "enum": [ - "mine", - "shared" - ] - } - }, - { - "$ref": "#/components/parameters/order_by" - }, - { - "$ref": "#/components/parameters/order_direction" - }, - { - "$ref": "#/components/parameters/per_page" - }, - { - "$ref": "#/components/parameters/include" - } - ], - "responses": { - "200": { - "description": "list of saved searches", - "content": { - "application/json": { - "schema": { - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SavedSearch" - } - }, - "meta": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/metadata" - } - ] - } - }, - "type": "object" - } - } - } - } - } - }, - "post": { - "tags": [ - "SavedSearches" - ], - "summary": "Save a new saved search", - "description": "Create a new SavedSearch.", - "operationId": "createSavedSearch", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SavedSearchEditable" - } - } - } - }, - "responses": { - "201": { - "description": "success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SavedSearch" - } - } - } - } - } - } - }, - "/saved-searches/{savedSearchId}": { - "get": { - "tags": [ - "SavedSearches" - ], - "summary": "Get single saved searches by ID", - "description": "Get a single SavedSearch.", - "operationId": "getSavedSearchById", - "parameters": [ - { - "name": "savedSearchId", - "in": "path", - "description": "ID of saved search to return", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Successfully found the saved search", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SavedSearch" - } - } - } - } - } - }, - "put": { - "tags": [ - "SavedSearches" - ], - "summary": "Update a saved search", - "description": "Update a SavedSearch.", - "operationId": "updateSavedSearch", - "parameters": [ - { - "name": "savedSearchId", - "in": "path", - "description": "ID of saved search to return", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SavedSearchEditable" - } - } - } - }, - "responses": { - "200": { - "description": "success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SavedSearch" - } - } - } - } - } - } - }, - "/saved-searches/{savedSearchId}/columns": { - "get": { - "tags": [ - "SavedSearches" - ], - "summary": "Returns all columns associated with a Saved Search", - "description": "Display a listing of columns.", - "operationId": "getSavedSearchColumns", - "parameters": [ - { - "name": "savedSearchId", - "in": "path", - "description": "ID of saved search to return", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "include", - "in": "query", - "description": "Include specific categories. Comma separated list.", - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "current", - "default", - "available", - "data" - ] - }, - "uniqueItems": false - } - } - ], - "responses": { - "200": { - "description": "Categorized list of columns", - "content": { - "application/json": { - "schema": { - "properties": { - "current": { - "type": "array", - "items": { - "$ref": "#/components/schemas/columns" - } - }, - "default": { - "type": "array", - "items": { - "$ref": "#/components/schemas/columns" - } - }, - "available": { - "type": "array", - "items": { - "$ref": "#/components/schemas/columns" - } - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/columns" - } - } - }, - "type": "object" - } - } - } - } - } - } - }, - "/saved-searches/{savedSearchId}/users": { - "get": { - "tags": [ - "Users" - ], - "summary": "Returns all users", - "description": "Display a listing of the resource.", - "operationId": "getSavedSearchUsers", - "parameters": [ - { - "name": "savedSearchId", - "in": "path", - "description": "ID of saved search to return", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "filter", - "in": "query", - "description": "Filter results by string. Searches First Name, Last Name, Email and Username.", - "schema": { - "type": "string" - } - }, - { - "$ref": "#/components/parameters/order_by" - }, - { - "$ref": "#/components/parameters/order_direction" - }, - { - "$ref": "#/components/parameters/per_page" - }, - { - "$ref": "#/components/parameters/include" - } - ], - "responses": { - "200": { - "description": "list of users", - "content": { - "application/json": { - "schema": { - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/users" - } - }, - "meta": { - "$ref": "#/components/schemas/metadata" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "/saved-searches/{savedSearchId}/groups": { - "get": { - "tags": [ - "Groups" - ], - "summary": "Returns all groups that the user has access to", - "description": "Display a listing of the resource.", - "operationId": "getSavedSearchGroups", - "parameters": [ - { - "$ref": "#/components/parameters/order_by" - }, - { - "$ref": "#/components/parameters/order_direction" - }, - { - "$ref": "#/components/parameters/per_page" - }, - { - "$ref": "#/components/parameters/include" - } - ], - "responses": { - "200": { - "description": "list of groups", - "content": { - "application/json": { - "schema": { - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/groups" - } - }, - "meta": { - "$ref": "#/components/schemas/metadata" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "/saved-searches/{saved_search_id}": { - "delete": { - "tags": [ - "SavedSearches" - ], - "summary": "Delete a saved search", - "description": "Delete a SavedSearch.", - "operationId": "deleteSavedSearch", - "parameters": [ - { - "name": "saved_search_id", - "in": "path", - "description": "ID of saved search to return", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "success" - } - } - } - }, - "/saved-searches/icons": { - "get": { - "tags": [ - "SavedSearches" - ], - "summary": "Returns all icons for saved searches", - "description": "Get a list of icons available for SavedSearches.", - "operationId": "getSavedSearchesIcons", - "parameters": [ - { - "$ref": "#/components/parameters/per_page" - } - ], - "responses": { - "200": { - "description": "list of icons for saved searches", - "content": { - "application/json": { - "schema": { - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SavedSearchIcon" - } - }, - "meta": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/metadata" - } - ] - } - }, - "type": "object" - } - } - } - } - } - } - }, - "/version_histories": { - "get": { - "tags": [ - "Version History" - ], - "summary": "Return all version History according to the model", - "description": "Get the list of records of Version History", - "operationId": "getVersionHistories", - "parameters": [ - { - "$ref": "#/components/parameters/filter" - }, - { - "$ref": "#/components/parameters/order_by" - }, - { - "$ref": "#/components/parameters/order_direction" - }, - { - "$ref": "#/components/parameters/per_page" - }, - { - "$ref": "#/components/parameters/include" - } - ], - "responses": { - "200": { - "description": "list of Version History", - "content": { - "application/json": { - "schema": { - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/versionHistory" - } - }, - "meta": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/metadata" - } - ] - } - }, - "type": "object" - } - } - } - } - } - }, - "post": { - "tags": [ - "Version History" - ], - "summary": "Save a new Version History", - "description": "Create a new Version History.", - "operationId": "createVersion", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/versionHistoryEditable" - } - } - } - }, - "responses": { - "201": { - "description": "success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/versionHistory" - } - } - } - } - } - } - }, - "/version_histories/{version_history_id}": { - "get": { - "tags": [ - "Version History" - ], - "summary": "Get single Version History by ID", - "description": "Get a single Version History.", - "operationId": "getVersionHistoryById", - "parameters": [ - { - "name": "version_history_id", - "in": "path", - "description": "ID of Version History to return", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Successfully found the Version History", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/versionHistory" - } - } - } - } - } - }, - "put": { - "tags": [ - "Version History" - ], - "summary": "Update a Version History", - "description": "Update a Version History.", - "operationId": "updateVersion", - "parameters": [ - { - "name": "version_history_id", - "in": "path", - "description": "ID of Version History to return", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/versionHistoryEditable" - } - } - } - }, - "responses": { - "204": { - "description": "success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/versionHistory" - } - } - } - } - } - }, - "delete": { - "tags": [ - "Version History" - ], - "summary": "Delete a Version History", - "description": "Delete a Version History.", - "operationId": "deleteVersion", - "parameters": [ - { - "name": "version_history_id", - "in": "path", - "description": "ID of Version History to return", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/versionHistory" - } - } - } - } - } - } - }, - "/version_histories/clone": { - "post": { - "tags": [ - "Version History" - ], - "summary": "Clone a new Version History", - "description": "Clone a new Version History.", - "operationId": "cloneVersion", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/versionHistoryEditable" - } - } - } - }, - "responses": { - "201": { - "description": "success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/versionHistory" - } - } - } - } - } - } - } - }, - "components": { - "schemas": { - "DateTime": { - "properties": { - "date": { - "type": "string" - } - }, - "type": "object" - }, - "updateUserGroups": { - "properties": { - "groups": { - "type": "array", - "items": { - "type": "integer", - "example": 1 - } - } - }, - "type": "object" - }, - "restoreUser": { - "properties": { - "username": { - "description": "Username to restore", - "type": "string" - } - }, - "type": "object" - }, - "Variable": { - "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "process_id": { - "type": "integer", - "example": 1 - }, - "uuid": { - "type": "string", - "format": "uuid", - "example": "550e8400-e29b-41d4-a716-446655440000" - }, - "field": { - "type": "string", - "example": "string", - "enum": [ - "string", - "number", - "boolean", - "array" - ] - }, - "label": { - "type": "string", - "example": "Variable 1 for Process 1" - }, - "name": { - "type": "string", - "example": "var_1_1" - }, - "asset": { - "properties": { - "id": { - "type": "string", - "example": "asset_1_1" - }, - "type": { - "type": "string", - "example": "sensor", - "enum": [ - "sensor", - "actuator", - "controller", - "device" - ] - }, - "name": { - "type": "string", - "example": "Asset 1 for Process 1" - }, - "uuid": { - "type": "string", - "format": "uuid", - "example": "550e8400-e29b-41d4-a716-446655440000" - } - }, - "type": "object" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "type": "object" - }, - "PaginationMeta": { - "properties": { - "current_page": { - "type": "integer", - "example": 1 - }, - "from": { - "type": "integer", - "example": 1 - }, - "last_page": { - "type": "integer", - "example": 5 - }, - "path": { - "type": "string", - "example": "http://processmaker.com/processes/variables" - }, - "per_page": { - "type": "integer", - "example": 20 - }, - "to": { - "type": "integer", - "example": 20 - }, - "total": { - "type": "integer", - "example": 100 - }, - "links": { - "properties": { - "first": { - "type": "string", - "example": "http://processmaker.com/processes/variables?page=1" - }, - "last": { - "type": "string", - "example": "http://processmaker.com/processes/variables?page=5" - }, - "prev": { - "type": "string", - "nullable": true - }, - "next": { - "type": "string", - "example": "http://processmaker.com/processes/variables?page=2" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "metadata": { - "properties": { - "filter": { - "type": "string" - }, - "sort_by": { - "type": "string" - }, - "sort_order": { - "type": "string", - "enum": [ - "asc", - "desc" - ] - }, - "count": { - "type": "integer" - }, - "total_pages": { - "type": "integer" - }, - "current_page": { - "type": "integer" - }, - "form": { - "type": "integer" - }, - "last_page": { - "type": "integer" - }, - "path": { - "type": "string" - }, - "per_page": { - "type": "integer" - }, - "to": { - "type": "integer" - }, - "total": { - "type": "integer" - } - }, - "type": "object" - }, - "taskMetadata": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/metadata" - }, - { - "properties": { - "filter": { - "type": "string" - }, - "sort_by": { - "type": "string" - }, - "sort_order": { - "type": "string", - "enum": [ - "asc", - "desc" - ] - }, - "count": { - "type": "integer" - }, - "total_pages": { - "type": "integer" - }, - "current_page": { - "type": "integer" - }, - "form": { - "type": "integer" - }, - "last_page": { - "type": "integer" - }, - "path": { - "type": "string" - }, - "per_page": { - "type": "integer" - }, - "to": { - "type": "integer" - }, - "total": { - "type": "integer" - }, - "in_overdue": { - "type": "integer" - } - }, - "type": "object" - } - ] - }, - "signalsEditable": { - "properties": { - "id": { - "description": "Represents a business signal definition.", - "type": "string", - "format": "id" - }, - "name": { - "type": "string" - }, - "detail": { - "type": "string" - } - }, - "type": "object" - }, - "signals": { - "allOf": [ - { - "$ref": "#/components/schemas/signalsEditable" - }, - { - "properties": { - "type": { - "type": "string" - }, - "processes": { - "type": "array", - "items": { - "properties": { - "id": { - "type": "integer", - "format": "id" - }, - "is_system": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "catches": { - "type": "array", - "items": { - "properties": { - "id": { - "type": "integer", - "format": "id" - }, - "name": { - "type": "string" - }, - "type": { - "type": "string" - } - }, - "type": "object" - } - } - }, - "type": "object" - } - } - }, - "type": "object" - } - ] - }, - "columns": { - "properties": { - "label": { - "type": "string" - }, - "field": { - "type": "string" - }, - "sortable": { - "type": "boolean" - }, - "default": { - "type": "boolean" - }, - "format": { - "type": "string" - }, - "mask": { - "type": "string" - } - }, - "type": "object" - }, - "commentsEditable": { - "properties": { - "id": { - "description": "Represents a business process definition.", - "type": "string", - "format": "id" - }, - "user_id": { - "type": "string", - "format": "id" - }, - "commentable_id": { - "type": "string", - "format": "id" - }, - "commentable_type": { - "type": "string" - }, - "up": { - "type": "integer" - }, - "down": { - "type": "integer" - }, - "subject": { - "type": "string" - }, - "body": { - "type": "string" - }, - "hidden": { - "type": "boolean" - }, - "type": { - "type": "string", - "enum": [ - "LOG", - "MESSAGE" - ] - } - }, - "type": "object" - }, - "comments": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/commentsEditable" - }, - { - "properties": { - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "type": "object" - } - ] - }, - "EnvironmentVariableEditable": { - "properties": { - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "value": { - "type": "string" - }, - "asset_type": { - "type": "string", - "nullable": true - }, - "do_not_update": { - "type": "boolean" - } - }, - "type": "object" - }, - "EnvironmentVariable": { - "allOf": [ - { - "$ref": "#/components/schemas/EnvironmentVariableEditable" - }, - { - "properties": { - "id": { - "type": "integer", - "format": "id" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "type": "object" - } - ] - }, - "groupsEditable": { - "properties": { - "name": { - "description": "Represents a group definition.", - "type": "string" - }, - "description": { - "type": "string" - }, - "manager_id": { - "type": "integer", - "format": "id" - }, - "status": { - "type": "string", - "enum": [ - "ACTIVE", - "INACTIVE" - ] - } - }, - "type": "object" - }, - "groups": { - "allOf": [ - { - "$ref": "#/components/schemas/groupsEditable" - }, - { - "properties": { - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "id": { - "type": "string", - "format": "id" - } - }, - "type": "object" - } - ] - }, - "groupMembersEditable": { - "properties": { - "group_id": { - "description": "Represents a group Members definition.", - "type": "string", - "format": "id" - }, - "member_id": { - "type": "string", - "format": "id" - }, - "member_type": { - "type": "string" - }, - "description": { - "type": "string" - } - }, - "type": "object" - }, - "groupMembers": { - "allOf": [ - { - "$ref": "#/components/schemas/groupMembersEditable" - }, - { - "properties": { - "id": { - "type": "string", - "format": "id" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "type": "object" - } - ] - }, - "createGroupMembers": { - "allOf": [ - { - "$ref": "#/components/schemas/groupMembersEditable" - }, - { - "properties": { - "id": { - "type": "string", - "format": "id" - }, - "group": { - "type": "object" - }, - "member": { - "type": "object" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "type": "object" - } - ] - }, - "getGroupMembersById": { - "allOf": [ - { - "properties": { - "group_id": { - "type": "string", - "format": "id" - }, - "member_id": { - "type": "string", - "format": "id" - }, - "member_type": { - "type": "string" - }, - "id": { - "type": "string", - "format": "id" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "type": "object" - } - ] - }, - "availableGroupMembers": { - "allOf": [ - { - "properties": { - "id": { - "type": "string", - "format": "id" - }, - "description": { - "type": "string" - }, - "name": { - "type": "string" - }, - "status": { - "type": "string", - "enum": [ - "ACTIVE", - "INACTIVE" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "type": "object" - } - ] - }, - "mediaEditable": { - "properties": { - "id": { - "description": "Represents media files stored in the database", - "type": "integer", - "format": "id" - }, - "model_id": { - "type": "integer", - "format": "id" - }, - "model_type": { - "type": "string", - "format": "id" - }, - "collection_name": { - "type": "string" - }, - "name": { - "type": "string" - }, - "file_name": { - "type": "string" - }, - "mime_type": { - "type": "string" - }, - "disk": { - "type": "string" - }, - "size": { - "type": "integer" - }, - "manipulations": { - "type": "object" - }, - "custom_properties": { - "type": "object" - }, - "responsive_images": { - "type": "object" - }, - "order_column": { - "type": "integer" - } - }, - "type": "object" - }, - "media": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/mediaEditable" - }, - { - "properties": { - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "type": "object" - } - ] - }, - "mediaExported": { - "properties": { - "url": { - "type": "string" - } - }, - "type": "object" - }, - "NotificationEditable": { - "properties": { - "type": { - "description": "Represents a notification definition.", - "type": "string" - }, - "notifiable_type": { - "type": "string" - }, - "notifiable_id": { - "type": "integer" - }, - "data": { - "type": "string" - }, - "name": { - "type": "string" - }, - "message": { - "type": "string" - }, - "processName": { - "type": "string" - }, - "userName": { - "type": "string" - }, - "request_id": { - "type": "string" - }, - "url": { - "type": "string" - } - }, - "type": "object" - }, - "Notification": { - "allOf": [ - { - "$ref": "#/components/schemas/NotificationEditable" - }, - { - "properties": { - "id": { - "type": "string" - }, - "read_at": { - "type": "string", - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "type": "object" - } - ] - }, - "ProcessEditable": { + "PaginationMeta": { "properties": { - "process_category_id": { - "description": "Represents a business process definition.", + "current_page": { "type": "integer", - "format": "id" - }, - "name": { - "type": "string" + "example": 1 }, - "case_title": { - "type": "string" + "from": { + "type": "integer", + "example": 1 }, - "description": { - "type": "string" + "last_page": { + "type": "integer", + "example": 5 }, - "status": { + "path": { "type": "string", - "enum": [ - "ACTIVE", - "INACTIVE", - "ARCHIVED" - ] - }, - "pause_timer_start": { - "type": "integer" - }, - "cancel_screen_id": { - "type": "integer" - }, - "has_timer_start_events": { - "type": "boolean" + "example": "http://processmaker.com/processes/variables" }, - "request_detail_screen_id": { + "per_page": { "type": "integer", - "format": "id" - }, - "is_valid": { - "type": "integer" - }, - "package_key": { - "type": "string" - }, - "start_events": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProcessStartEvents" - } - }, - "warnings": { - "type": "string" - }, - "self_service_tasks": { - "type": "object" - }, - "signal_events": { - "type": "array", - "items": { - "type": "object" - } + "example": 20 }, - "category": { - "type": "object" + "to": { + "type": "integer", + "example": 20 }, - "manager_id": { - "type": "array", - "items": { - "type": "integer", - "format": "id" - } - } - }, - "type": "object" - }, - "Process": { - "allOf": [ - { - "$ref": "#/components/schemas/ProcessEditable" + "total": { + "type": "integer", + "example": 100 }, - { + "links": { "properties": { - "user_id": { - "type": "integer", - "format": "id" - }, - "id": { + "first": { "type": "string", - "format": "id" + "example": "http://processmaker.com/processes/variables?page=1" }, - "deleted_at": { + "last": { "type": "string", - "format": "date-time" + "example": "http://processmaker.com/processes/variables?page=5" }, - "created_at": { + "prev": { "type": "string", - "format": "date-time" + "nullable": true }, - "updated_at": { + "next": { "type": "string", - "format": "date-time" - }, - "notifications": { - "type": "object" - }, - "task_notifications": { - "type": "object" - } - }, - "type": "object" - } - ] - }, - "ProcessStartEvents": { - "properties": { - "eventDefinitions": { - "type": "object" - }, - "parallelMultiple": { - "type": "boolean" - }, - "outgoing": { - "type": "object" - }, - "incoming": { - "type": "object" - }, - "id": { - "type": "string" - }, - "name": { - "type": "string" - } - }, - "type": "object" - }, - "ProcessWithStartEvents": { - "allOf": [ - { - "$ref": "#/components/schemas/Process" - }, - { - "properties": { - "events": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProcessStartEvents" - } + "example": "http://processmaker.com/processes/variables?page=2" } }, "type": "object" } - ] - }, - "ProcessImport": { - "allOf": [ - { - "$ref": "#/components/schemas/ProcessEditable" - }, - { - "properties": { - "status": { - "type": "array", - "items": { - "type": "object" - } - }, - "assignable": { - "type": "array", - "items": { - "type": "object" - } - }, - "process": {} - }, - "type": "object" - } - ] - }, - "ProcessAssignments": { - "properties": { - "assignable": { - "type": "array", - "items": { - "type": "object" - } - }, - "cancel_request": { - "type": "object" - }, - "edit_data": { - "type": "object" - } }, "type": "object" }, - "ProcessCategoryEditable": { + "metadata": { "properties": { - "name": { - "description": "Represents a business process category definition.", + "filter": { + "type": "string" + }, + "sort_by": { "type": "string" }, - "status": { + "sort_order": { "type": "string", "enum": [ - "ACTIVE", - "INACTIVE" + "asc", + "desc" ] + }, + "count": { + "type": "integer" + }, + "total_pages": { + "type": "integer" + }, + "current_page": { + "type": "integer" + }, + "form": { + "type": "integer" + }, + "last_page": { + "type": "integer" + }, + "path": { + "type": "string" + }, + "per_page": { + "type": "integer" + }, + "to": { + "type": "integer" + }, + "total": { + "type": "integer" } }, "type": "object" }, - "ProcessCategory": { + "taskMetadata": { + "type": "object", "allOf": [ { - "$ref": "#/components/schemas/ProcessCategoryEditable" + "$ref": "#/components/schemas/metadata" }, { "properties": { - "id": { - "type": "string", - "format": "id" + "filter": { + "type": "string" }, - "created_at": { - "type": "string", - "format": "date-time" + "sort_by": { + "type": "string" }, - "updated_at": { + "sort_order": { "type": "string", - "format": "date-time" + "enum": [ + "asc", + "desc" + ] + }, + "count": { + "type": "integer" + }, + "total_pages": { + "type": "integer" + }, + "current_page": { + "type": "integer" + }, + "form": { + "type": "integer" + }, + "last_page": { + "type": "integer" + }, + "path": { + "type": "string" + }, + "per_page": { + "type": "integer" + }, + "to": { + "type": "integer" + }, + "total": { + "type": "integer" + }, + "in_overdue": { + "type": "integer" } }, "type": "object" } ] }, - "processPermissionsEditable": { + "signalsEditable": { "properties": { "id": { - "description": "Represents a Process permission.", - "type": "integer", - "format": "id" - }, - "process_id": { - "type": "integer", - "format": "id" - }, - "permission_id": { - "type": "integer", + "description": "Represents a business signal definition.", + "type": "string", "format": "id" }, - "assignable_id": { - "type": "integer", - "format": "id" + "name": { + "type": "string" }, - "assignable_type": { + "detail": { "type": "string" } }, "type": "object" }, - "processPermissions": { - "type": "object", + "signals": { "allOf": [ { - "$ref": "#/components/schemas/processPermissionsEditable" + "$ref": "#/components/schemas/signalsEditable" }, { "properties": { - "created_at": { - "type": "string", - "format": "date-time" + "type": { + "type": "string" }, - "updated_at": { - "type": "string", - "format": "date-time" + "processes": { + "type": "array", + "items": { + "properties": { + "id": { + "type": "integer", + "format": "id" + }, + "is_system": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "catches": { + "type": "array", + "items": { + "properties": { + "id": { + "type": "integer", + "format": "id" + }, + "name": { + "type": "string" + }, + "type": { + "type": "string" + } + }, + "type": "object" + } + } + }, + "type": "object" + } } }, "type": "object" } ] }, - "processRequestEditable": { + "columns": { "properties": { - "user_id": { - "description": "Represents an Eloquent model of a Request which is an instance of a Process.", + "label": { + "type": "string" + }, + "field": { + "type": "string" + }, + "sortable": { + "type": "boolean" + }, + "default": { + "type": "boolean" + }, + "format": { + "type": "string" + }, + "mask": { + "type": "string" + } + }, + "type": "object" + }, + "commentsEditable": { + "properties": { + "id": { + "description": "Represents a business process definition.", "type": "string", "format": "id" }, - "callable_id": { + "user_id": { "type": "string", "format": "id" }, - "data": { - "type": "object" - }, - "status": { + "commentable_id": { "type": "string", - "enum": [ - "ACTIVE", - "COMPLETED", - "ERROR", - "CANCELED" - ] + "format": "id" }, - "name": { + "commentable_type": { "type": "string" }, - "case_title": { - "type": "string" + "up": { + "type": "integer" }, - "case_title_formatted": { - "type": "string" + "down": { + "type": "integer" }, - "user_viewed_at": { + "subject": { "type": "string" }, - "case_number": { - "type": "integer" + "body": { + "type": "string" }, - "process_id": { - "type": "integer" + "hidden": { + "type": "boolean" }, - "process": { - "type": "object" + "type": { + "type": "string", + "enum": [ + "LOG", + "MESSAGE" + ] } }, - "type": "object" - }, - "processRequest": { - "allOf": [ - { - "$ref": "#/components/schemas/processRequestEditable" - }, - { - "properties": { - "id": { - "type": "string", - "format": "id" - }, - "process_id": { - "type": "string", - "format": "id" - }, - "process_collaboration_id": { - "type": "string", - "format": "id" - }, - "participant_id": { - "type": "string", - "format": "id" - }, - "process_category_id": { - "type": "string", - "format": "id" - }, + "type": "object" + }, + "comments": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/commentsEditable" + }, + { + "properties": { "created_at": { "type": "string", "format": "date-time" @@ -10021,83 +6465,37 @@ "updated_at": { "type": "string", "format": "date-time" - }, - "user": {}, - "participants": { - "type": "array", - "items": { - "$ref": "#/components/schemas/users" - } } }, "type": "object" } ] }, - "processRequestTokenEditable": { + "EnvironmentVariableEditable": { "properties": { - "user_id": { - "description": "ProcessRequestToken is used to store the state of a token of the\nNayra engine", - "type": "string", - "format": "id" - }, - "status": { + "name": { "type": "string" }, - "due_at": { - "type": "string", - "format": "date-time" - }, - "initiated_at": { - "type": "string", - "format": "date-time" - }, - "riskchanges_at": { - "type": "string", - "format": "date-time" - }, - "subprocess_start_event_id": { + "description": { "type": "string" }, - "data": { - "type": "object" + "value": { + "type": "string" } }, "type": "object" }, - "processRequestToken": { + "EnvironmentVariable": { "allOf": [ { - "$ref": "#/components/schemas/processRequestTokenEditable" + "$ref": "#/components/schemas/EnvironmentVariableEditable" }, { "properties": { "id": { - "type": "string", - "format": "id" - }, - "process_id": { - "type": "string", - "format": "id" - }, - "process_request_id": { - "type": "string", - "format": "id" - }, - "element_id": { - "type": "string", - "format": "id" - }, - "element_type": { - "type": "string", + "type": "integer", "format": "id" }, - "element_index": { - "type": "string" - }, - "element_name": { - "type": "string" - }, "created_at": { "type": "string", "format": "date-time" @@ -10105,68 +6503,42 @@ "updated_at": { "type": "string", "format": "date-time" - }, - "initiated_at": { - "type": "string", - "format": "date-time" - }, - "advanceStatus": { - "type": "string" - }, - "due_notified": { - "type": "integer" - }, - "user": { - "type": "object" - }, - "process": { - "type": "object" - }, - "process_request": { - "type": "object" } }, "type": "object" } ] }, - "taskAssignmentsEditable": { + "groupsEditable": { "properties": { - "process_id": { - "description": "Represents a business process task assignment definition.", - "type": "integer", - "format": "id" + "name": { + "description": "Represents a group definition.", + "type": "string" }, - "process_task_id": { - "type": "string", - "format": "id" + "description": { + "type": "string" }, - "assignment_id": { + "manager_id": { "type": "integer", "format": "id" }, - "assignment_type": { + "status": { "type": "string", "enum": [ - "ProcessMaker\\Models\\User", - "ProcessMaker\\Models\\Group" + "ACTIVE", + "INACTIVE" ] } }, "type": "object" }, - "taskAssignments": { - "type": "object", + "groups": { "allOf": [ { - "$ref": "#/components/schemas/taskAssignmentsEditable" + "$ref": "#/components/schemas/groupsEditable" }, { "properties": { - "id": { - "type": "integer", - "format": "id" - }, "created_at": { "type": "string", "format": "date-time" @@ -10174,55 +6546,40 @@ "updated_at": { "type": "string", "format": "date-time" + }, + "id": { + "type": "string", + "format": "id" } }, "type": "object" } ] }, - "screensEditable": { + "groupMembersEditable": { "properties": { - "title": { - "description": "Class Screen", - "type": "string" - }, - "type": { - "type": "string" - }, - "description": { - "type": "string" - }, - "config": { - "type": "array", - "items": { - "type": "object" - } - }, - "computed": { - "type": "array", - "items": { - "type": "object" - } + "group_id": { + "description": "Represents a group Members definition.", + "type": "string", + "format": "id" }, - "watchers": { - "type": "array", - "items": { - "type": "object" - } + "member_id": { + "type": "string", + "format": "id" }, - "custom_css": { + "member_type": { "type": "string" }, - "screen_category_id": { + "description": { "type": "string" } }, "type": "object" }, - "screens": { + "groupMembers": { "allOf": [ { - "$ref": "#/components/schemas/screensEditable" + "$ref": "#/components/schemas/groupMembersEditable" }, { "properties": { @@ -10243,34 +6600,10 @@ } ] }, - "screenExported": { - "properties": { - "url": { - "type": "string" - } - }, - "type": "object" - }, - "ScreenCategoryEditable": { - "properties": { - "name": { - "description": "Represents a business screen category definition.", - "type": "string" - }, - "status": { - "type": "string", - "enum": [ - "ACTIVE", - "INACTIVE" - ] - } - }, - "type": "object" - }, - "ScreenCategory": { + "createGroupMembers": { "allOf": [ { - "$ref": "#/components/schemas/ScreenCategoryEditable" + "$ref": "#/components/schemas/groupMembersEditable" }, { "properties": { @@ -10278,6 +6611,12 @@ "type": "string", "format": "id" }, + "group": { + "type": "object" + }, + "member": { + "type": "object" + }, "created_at": { "type": "string", "format": "date-time" @@ -10291,72 +6630,128 @@ } ] }, - "ScreenTypeEditable": { - "properties": { - "name": { - "description": "Represents a business screen Type definition.", - "type": "string" + "getGroupMembersById": { + "allOf": [ + { + "properties": { + "group_id": { + "type": "string", + "format": "id" + }, + "member_id": { + "type": "string", + "format": "id" + }, + "member_type": { + "type": "string" + }, + "id": { + "type": "string", + "format": "id" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "type": "object" } - }, - "type": "object" + ] }, - "ScreenType": { + "availableGroupMembers": { "allOf": [ - { - "$ref": "#/components/schemas/ScreenTypeEditable" - }, { "properties": { "id": { "type": "string", - "format": "id" + "format": "id" + }, + "description": { + "type": "string" + }, + "name": { + "type": "string" + }, + "status": { + "type": "string", + "enum": [ + "ACTIVE", + "INACTIVE" + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" } }, "type": "object" } ] }, - "scriptsEditable": { + "mediaEditable": { "properties": { - "title": { - "description": "Represents an Eloquent model of a Script", + "id": { + "description": "Represents media files stored in the database", + "type": "integer", + "format": "id" + }, + "model_id": { + "type": "integer", + "format": "id" + }, + "model_type": { + "type": "string", + "format": "id" + }, + "collection_name": { "type": "string" }, - "description": { + "name": { "type": "string" }, - "language": { + "file_name": { "type": "string" }, - "code": { + "mime_type": { "type": "string" }, - "timeout": { - "type": "integer" + "disk": { + "type": "string" }, - "run_as_user_id": { + "size": { "type": "integer" }, - "key": { - "type": "string" + "manipulations": { + "type": "object" }, - "script_category_id": { + "custom_properties": { + "type": "object" + }, + "responsive_images": { + "type": "object" + }, + "order_column": { "type": "integer" } }, "type": "object" }, - "scripts": { + "media": { + "type": "object", "allOf": [ { - "$ref": "#/components/schemas/scriptsEditable" + "$ref": "#/components/schemas/mediaEditable" }, { "properties": { - "id": { - "type": "integer", - "format": "id" - }, "created_at": { "type": "string", "format": "date-time" @@ -10370,91 +6765,63 @@ } ] }, - "scriptsPreview": { + "mediaExported": { "properties": { - "status": { - "type": "string" - }, - "key": { + "url": { "type": "string" - }, - "output": { - "type": "object" } }, "type": "object" }, - "ScriptCategoryEditable": { + "NotificationEditable": { "properties": { - "name": { - "description": "Represents a business script category definition.", + "type": { + "description": "Represents a notification definition.", "type": "string" }, - "status": { - "type": "string", - "enum": [ - "ACTIVE", - "INACTIVE" - ] - } - }, - "type": "object" - }, - "ScriptCategory": { - "allOf": [ - { - "$ref": "#/components/schemas/ScriptCategoryEditable" + "notifiable_type": { + "type": "string" }, - { - "properties": { - "id": { - "type": "string", - "format": "id" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "type": "object" - } - ] - }, - "scriptExecutorsEditable": { - "properties": { - "title": { - "description": "Represents an Eloquent model of a Script Executor", + "notifiable_id": { + "type": "integer" + }, + "data": { "type": "string" }, - "description": { + "name": { "type": "string" }, - "language": { + "message": { "type": "string" }, - "config": { + "processName": { "type": "string" }, - "is_system": { - "type": "boolean" + "userName": { + "type": "string" + }, + "request_id": { + "type": "string" + }, + "url": { + "type": "string" } }, "type": "object" }, - "scriptExecutors": { + "Notification": { "allOf": [ { - "$ref": "#/components/schemas/scriptExecutorsEditable" + "$ref": "#/components/schemas/NotificationEditable" }, { "properties": { "id": { - "type": "integer", - "format": "id" + "type": "string" + }, + "read_at": { + "type": "string", + "format": "date-time" }, "created_at": { "type": "string", @@ -10469,130 +6836,99 @@ } ] }, - "availableLanguages": { + "ProcessEditable": { "properties": { - "text": { + "process_category_id": { + "description": "Represents a business process definition.", + "type": "integer", + "format": "id" + }, + "name": { "type": "string" }, - "value": { + "case_title": { "type": "string" }, - "initDockerFile": { + "description": { "type": "string" - } - }, - "type": "object" - }, - "securityLog": { - "properties": { - "id": { - "description": "Class SecurityLog", + }, + "status": { + "type": "string", + "enum": [ + "ACTIVE", + "INACTIVE", + "ARCHIVED" + ] + }, + "pause_timer_start": { "type": "integer" }, - "event": { - "type": "string" + "cancel_screen_id": { + "type": "integer" }, - "ip": { - "type": "string" + "has_timer_start_events": { + "type": "boolean" }, - "meta": { - "type": "array", - "items": { - "properties": { - "os": { - "type": "array", - "items": { - "properties": { - "name": { - "type": "string" - }, - "version": { - "type": "string" - } - }, - "type": "object" - } - }, - "browser": { - "type": "array", - "items": { - "properties": { - "name": { - "type": "string" - }, - "version": { - "type": "string" - } - }, - "type": "object" - } - }, - "user_agent": { - "type": "string" - } - }, - "type": "object" - } + "request_detail_screen_id": { + "type": "integer", + "format": "id" }, - "user_id": { + "is_valid": { "type": "integer" }, - "occured_at": { - "type": "string" - } - }, - "type": "object" - }, - "settingsEditable": { - "properties": { - "key": { - "description": "Class Settings", + "package_key": { "type": "string" }, - "config": { + "start_events": { "type": "array", "items": { - "type": "object" + "$ref": "#/components/schemas/ProcessStartEvents" } }, - "name": { - "type": "string" - }, - "helper": { - "type": "string" - }, - "group": { - "type": "string" - }, - "format": { + "warnings": { "type": "string" }, - "hidden": { - "type": "boolean" + "self_service_tasks": { + "type": "object" }, - "readonly": { - "type": "boolean" + "signal_events": { + "type": "array", + "items": { + "type": "object" + } }, - "variables": { - "type": "string" + "category": { + "type": "object" }, - "sansSerifFont": { - "type": "string" + "manager_id": { + "type": "array", + "items": { + "type": "integer", + "format": "id" + } } }, "type": "object" }, - "settings": { + "Process": { "allOf": [ { - "$ref": "#/components/schemas/settingsEditable" + "$ref": "#/components/schemas/ProcessEditable" }, { "properties": { + "user_id": { + "type": "integer", + "format": "id" + }, "id": { "type": "string", "format": "id" }, + "deleted_at": { + "type": "string", + "format": "date-time" + }, "created_at": { "type": "string", "format": "date-time" @@ -10600,173 +6936,174 @@ "updated_at": { "type": "string", "format": "date-time" + }, + "notifications": { + "type": "object" + }, + "task_notifications": { + "type": "object" } }, "type": "object" } ] }, - "TokenClient": { + "ProcessStartEvents": { "properties": { - "id": { - "type": "integer" + "eventDefinitions": { + "type": "object" }, - "user_id": { - "type": "integer" + "parallelMultiple": { + "type": "boolean" }, - "name": { - "type": "string" + "outgoing": { + "type": "object" }, - "provider": { - "type": "string" + "incoming": { + "type": "object" }, - "redirect": { + "id": { "type": "string" }, - "personal_access_client": { - "type": "boolean" + "name": { + "type": "string" + } + }, + "type": "object" + }, + "ProcessWithStartEvents": { + "allOf": [ + { + "$ref": "#/components/schemas/Process" }, - "password_client": { - "type": "boolean" + { + "properties": { + "events": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProcessStartEvents" + } + } + }, + "type": "object" + } + ] + }, + "ProcessImport": { + "allOf": [ + { + "$ref": "#/components/schemas/ProcessEditable" }, - "revoked": { - "type": "boolean" + { + "properties": { + "status": { + "type": "array", + "items": { + "type": "object" + } + }, + "assignable": { + "type": "array", + "items": { + "type": "object" + } + }, + "process": {} + }, + "type": "object" + } + ] + }, + "ProcessAssignments": { + "properties": { + "assignable": { + "type": "array", + "items": { + "type": "object" + } }, - "created_at": { - "type": "string", - "format": "date-time" + "cancel_request": { + "type": "object" }, - "updated_at": { - "type": "string", - "format": "date-time" + "edit_data": { + "type": "object" } }, "type": "object" }, - "usersEditable": { + "ProcessCategoryEditable": { "properties": { - "email": { - "description": "The attributes that are mass assignable.", - "type": "string", - "format": "email" - }, - "firstname": { - "type": "string" - }, - "lastname": { - "type": "string" - }, - "username": { - "type": "string" - }, - "password": { - "type": "string" - }, - "address": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "postal": { - "type": "string" - }, - "country": { - "type": "string" - }, - "phone": { - "type": "string" - }, - "fax": { - "type": "string" - }, - "cell": { - "type": "string" - }, - "title": { - "type": "string" - }, - "timezone": { - "type": "string" - }, - "datetime_format": { - "type": "string" - }, - "language": { - "type": "string" - }, - "is_administrator": { - "type": "boolean" - }, - "expires_at": { - "type": "string" - }, - "loggedin_at": { - "type": "string" - }, - "remember_token": { + "name": { + "description": "Represents a business process category definition.", "type": "string" }, "status": { "type": "string", "enum": [ "ACTIVE", - "INACTIVE", - "SCHEDULED", - "OUT_OF_OFFICE", - "BLOCKED" + "INACTIVE" ] + } + }, + "type": "object" + }, + "ProcessCategory": { + "allOf": [ + { + "$ref": "#/components/schemas/ProcessCategoryEditable" }, - "fullname": { - "type": "string" - }, - "avatar": { - "type": "string" - }, - "media": { - "type": "array", - "items": { - "$ref": "#/components/schemas/media" - } - }, - "birthdate": { - "type": "string", - "format": "date" + { + "properties": { + "id": { + "type": "string", + "format": "id" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "type": "object" + } + ] + }, + "processPermissionsEditable": { + "properties": { + "id": { + "description": "Represents a Process permission.", + "type": "integer", + "format": "id" }, - "delegation_user_id": { - "type": "string", + "process_id": { + "type": "integer", "format": "id" }, - "manager_id": { - "type": "string", + "permission_id": { + "type": "integer", "format": "id" }, - "meta": { - "type": "object", - "additionalProperties": true - }, - "force_change_password": { - "type": "boolean" + "assignable_id": { + "type": "integer", + "format": "id" }, - "email_task_notification": { - "type": "boolean" + "assignable_type": { + "type": "string" } }, "type": "object" }, - "users": { + "processPermissions": { + "type": "object", "allOf": [ { - "$ref": "#/components/schemas/usersEditable" + "$ref": "#/components/schemas/processPermissionsEditable" }, { "properties": { - "id": { - "type": "integer" - }, "created_at": { "type": "string", "format": "date-time" @@ -10774,119 +7111,99 @@ "updated_at": { "type": "string", "format": "date-time" - }, - "deleted_at": { - "type": "string", - "format": "date-time" } }, "type": "object" } ] }, - "UserToken": { + "processRequestEditable": { "properties": { - "id": { - "type": "string" - }, "user_id": { - "type": "integer" - }, - "client_id": { - "type": "integer" + "description": "Represents an Eloquent model of a Request which is an instance of a Process.", + "type": "string", + "format": "id" }, - "name": { - "type": "string" + "callable_id": { + "type": "string", + "format": "id" }, - "scopes": { + "data": { "type": "object" }, - "revoked": { - "type": "boolean" - }, - "client": { - "$ref": "#/components/schemas/TokenClient" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { + "status": { "type": "string", - "format": "date-time" + "enum": [ + "ACTIVE", + "COMPLETED", + "ERROR", + "CANCELED" + ] }, - "expires_at": { - "type": "string", - "format": "date-time" - } - }, - "type": "object" - }, - "collectionsEditable": { - "properties": { "name": { "type": "string" }, - "description": { + "case_title": { "type": "string" }, - "custom_title": { + "case_title_formatted": { "type": "string" }, - "create_screen_id": { - "type": "string", - "format": "id" - }, - "read_screen_id": { - "type": "string", - "format": "id" - }, - "update_screen_id": { - "type": "string", - "format": "id" + "user_viewed_at": { + "type": "string" }, - "signal_create": { - "type": "boolean" + "case_number": { + "type": "integer" }, - "signal_update": { - "type": "boolean" + "process_id": { + "type": "integer" }, - "signal_delete": { - "type": "boolean" + "process": { + "type": "object" } }, "type": "object" }, - "collections": { + "processRequest": { "allOf": [ { - "$ref": "#/components/schemas/collectionsEditable" + "$ref": "#/components/schemas/processRequestEditable" }, { "properties": { "id": { - "type": "integer" + "type": "string", + "format": "id" }, - "created_at": { + "process_id": { "type": "string", - "format": "date-time" + "format": "id" }, - "updated_at": { + "process_collaboration_id": { "type": "string", - "format": "date-time" + "format": "id" }, - "created_by_id": { + "participant_id": { "type": "string", "format": "id" }, - "updated_by_id": { + "process_category_id": { "type": "string", "format": "id" }, - "columns": { + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "user": {}, + "participants": { "type": "array", "items": { - "type": "object" + "$ref": "#/components/schemas/users" } } }, @@ -10894,122 +7211,202 @@ } ] }, - "recordsEditable": { + "processRequestTokenEditable": { "properties": { + "user_id": { + "description": "ProcessRequestToken is used to store the state of a token of the\nNayra engine", + "type": "string", + "format": "id" + }, + "status": { + "type": "string" + }, + "due_at": { + "type": "string", + "format": "date-time" + }, + "initiated_at": { + "type": "string", + "format": "date-time" + }, + "riskchanges_at": { + "type": "string", + "format": "date-time" + }, + "subprocess_start_event_id": { + "type": "string" + }, "data": { "type": "object" } }, "type": "object" }, - "records": { + "processRequestToken": { "allOf": [ { - "$ref": "#/components/schemas/recordsEditable" + "$ref": "#/components/schemas/processRequestTokenEditable" }, { "properties": { "id": { - "type": "integer" + "type": "string", + "format": "id" + }, + "process_id": { + "type": "string", + "format": "id" + }, + "process_request_id": { + "type": "string", + "format": "id" + }, + "element_id": { + "type": "string", + "format": "id" }, - "collection_id": { + "element_type": { "type": "string", "format": "id" + }, + "element_index": { + "type": "string" + }, + "element_name": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "initiated_at": { + "type": "string", + "format": "date-time" + }, + "advanceStatus": { + "type": "string" + }, + "due_notified": { + "type": "integer" + }, + "user": { + "type": "object" + }, + "process": { + "type": "object" + }, + "process_request": { + "type": "object" } }, "type": "object" } ] }, - "DataSourceCallParameters": { + "taskAssignmentsEditable": { "properties": { - "endpoint": { - "type": "string" + "process_id": { + "description": "Represents a business process task assignment definition.", + "type": "integer", + "format": "id" }, - "dataMapping": { - "type": "array", - "items": { - "properties": { - "key": { - "type": "string" - }, - "value": { - "type": "string" - } - }, - "type": "object" - } + "process_task_id": { + "type": "string", + "format": "id" }, - "outboundConfig": { - "type": "array", - "items": { - "properties": { - "key": { - "type": "string" - }, - "value": { - "type": "string" - } - }, - "type": "object" - } + "assignment_id": { + "type": "integer", + "format": "id" + }, + "assignment_type": { + "type": "string", + "enum": [ + "ProcessMaker\\Models\\User", + "ProcessMaker\\Models\\Group" + ] } }, "type": "object" }, - "DataSourceResponse": { - "properties": { - "status": { - "type": "integer" + "taskAssignments": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/taskAssignmentsEditable" }, - "response": { + { + "properties": { + "id": { + "type": "integer", + "format": "id" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, "type": "object" } - }, - "type": "object" + ] }, - "dataSourceEditable": { + "screensEditable": { "properties": { - "id": { - "description": "Class DataSource", - "type": "string", - "format": "id" - }, - "name": { + "title": { + "description": "Class Screen", "type": "string" }, - "description": { + "type": { "type": "string" }, - "endpoints": { + "description": { "type": "string" }, - "mappings": { - "type": "string" + "config": { + "type": "array", + "items": { + "type": "object" + } }, - "authtype": { - "type": "string" + "computed": { + "type": "array", + "items": { + "type": "object" + } }, - "credentials": { - "type": "string" + "watchers": { + "type": "array", + "items": { + "type": "object" + } }, - "status": { + "custom_css": { "type": "string" }, - "data_source_category_id": { + "screen_category_id": { "type": "string" } }, "type": "object" }, - "dataSource": { - "type": "object", + "screens": { "allOf": [ { - "$ref": "#/components/schemas/dataSourceEditable" + "$ref": "#/components/schemas/screensEditable" }, { "properties": { + "id": { + "type": "string", + "format": "id" + }, "created_at": { "type": "string", "format": "date-time" @@ -11023,10 +7420,18 @@ } ] }, - "dataSourceCategoryEditable": { + "screenExported": { + "properties": { + "url": { + "type": "string" + } + }, + "type": "object" + }, + "ScreenCategoryEditable": { "properties": { "name": { - "description": "Represents a business data Source category definition.", + "description": "Represents a business screen category definition.", "type": "string" }, "status": { @@ -11039,11 +7444,10 @@ }, "type": "object" }, - "DataSourceCategory": { - "type": "object", + "ScreenCategory": { "allOf": [ { - "$ref": "#/components/schemas/dataSourceCategoryEditable" + "$ref": "#/components/schemas/ScreenCategoryEditable" }, { "properties": { @@ -11064,36 +7468,72 @@ } ] }, - "decisionTableEditable": { + "ScreenTypeEditable": { "properties": { - "id": { - "description": "Class Screen", - "type": "string", - "format": "id" - }, "name": { + "description": "Represents a business screen Type definition.", + "type": "string" + } + }, + "type": "object" + }, + "ScreenType": { + "allOf": [ + { + "$ref": "#/components/schemas/ScreenTypeEditable" + }, + { + "properties": { + "id": { + "type": "string", + "format": "id" + } + }, + "type": "object" + } + ] + }, + "scriptsEditable": { + "properties": { + "title": { + "description": "Represents an Eloquent model of a Script", "type": "string" }, "description": { "type": "string" }, - "definition": { + "language": { + "type": "string" + }, + "code": { "type": "string" }, - "decision_table_categories_id": { + "timeout": { + "type": "integer" + }, + "run_as_user_id": { + "type": "integer" + }, + "key": { "type": "string" + }, + "script_category_id": { + "type": "integer" } }, "type": "object" }, - "decisionTable": { - "type": "object", + "scripts": { "allOf": [ { - "$ref": "#/components/schemas/decisionTableEditable" + "$ref": "#/components/schemas/scriptsEditable" }, { "properties": { + "id": { + "type": "integer", + "format": "id" + }, "created_at": { "type": "string", "format": "date-time" @@ -11107,18 +7547,24 @@ } ] }, - "DecisionTableExported": { + "scriptsPreview": { "properties": { - "url": { + "status": { "type": "string" + }, + "key": { + "type": "string" + }, + "output": { + "type": "object" } }, "type": "object" }, - "decisionTableCategoryEditable": { + "ScriptCategoryEditable": { "properties": { "name": { - "description": "Represents a business decision Table category definition.", + "description": "Represents a business script category definition.", "type": "string" }, "status": { @@ -11131,11 +7577,10 @@ }, "type": "object" }, - "DecisionTableCategory": { - "type": "object", + "ScriptCategory": { "allOf": [ { - "$ref": "#/components/schemas/decisionTableCategoryEditable" + "$ref": "#/components/schemas/ScriptCategoryEditable" }, { "properties": { @@ -11156,43 +7601,36 @@ } ] }, - "SavedSearchEditable": { + "scriptExecutorsEditable": { "properties": { - "meta": { - "description": "Represents an Eloquent model of a Saved Search.", - "type": "object", - "additionalProperties": "true" + "title": { + "description": "Represents an Eloquent model of a Script Executor", + "type": "string" }, - "pmql": { + "description": { "type": "string" }, - "title": { + "language": { "type": "string" }, - "type": { - "type": "string", - "enum": [ - "task", - "request" - ] + "config": { + "type": "string" }, - "advanced_filter": { - "type": "object", - "additionalProperties": "true" + "is_system": { + "type": "boolean" } }, "type": "object" }, - "SavedSearch": { + "scriptExecutors": { "allOf": [ + { + "$ref": "#/components/schemas/scriptExecutorsEditable" + }, { "properties": { "id": { - "type": "string", - "format": "id" - }, - "user_id": { - "type": "string", + "type": "integer", "format": "id" }, "created_at": { @@ -11205,65 +7643,133 @@ } }, "type": "object" - }, - { - "$ref": "#/components/schemas/SavedSearchEditable" } ] }, - "SavedSearchIcon": { + "availableLanguages": { "properties": { - "name": { + "text": { "type": "string" }, "value": { "type": "string" + }, + "initDockerFile": { + "type": "string" } }, "type": "object" }, - "SavedSearchChartEditable": { + "securityLog": { "properties": { - "title": { - "description": "Represents an Eloquent model of a Saved Search Chart.", + "id": { + "description": "Class SecurityLog", + "type": "integer" + }, + "event": { "type": "string" }, - "type": { - "type": "string", - "enum": [ - "bar", - "bar-vertical", - "line", - "pie", - "doughnut" - ] + "ip": { + "type": "string" + }, + "meta": { + "type": "array", + "items": { + "properties": { + "os": { + "type": "array", + "items": { + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string" + } + }, + "type": "object" + } + }, + "browser": { + "type": "array", + "items": { + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string" + } + }, + "type": "object" + } + }, + "user_agent": { + "type": "string" + } + }, + "type": "object" + } + }, + "user_id": { + "type": "integer" + }, + "occured_at": { + "type": "string" + } + }, + "type": "object" + }, + "settingsEditable": { + "properties": { + "key": { + "description": "Class Settings", + "type": "string" }, "config": { - "type": "object", - "additionalProperties": "true" + "type": "array", + "items": { + "type": "object" + } + }, + "name": { + "type": "string" + }, + "helper": { + "type": "string" + }, + "group": { + "type": "string" + }, + "format": { + "type": "string" + }, + "hidden": { + "type": "boolean" + }, + "readonly": { + "type": "boolean" + }, + "variables": { + "type": "string" }, - "sort": { - "type": "integer" + "sansSerifFont": { + "type": "string" } }, "type": "object" }, - "SavedSearchChart": { + "settings": { "allOf": [ + { + "$ref": "#/components/schemas/settingsEditable" + }, { "properties": { "id": { "type": "string", "format": "id" }, - "saved_search_id": { - "type": "string", - "format": "id" - }, - "user_id": { - "type": "string", - "format": "id" - }, "created_at": { "type": "string", "format": "date-time" @@ -11271,68 +7777,172 @@ "updated_at": { "type": "string", "format": "date-time" - }, - "deleted_at": { - "type": "string", - "format": "date-time" } }, "type": "object" - }, - { - "$ref": "#/components/schemas/SavedSearchChartEditable" } ] }, - "ReportEditable": { + "TokenClient": { "properties": { - "type": { + "id": { + "type": "integer" + }, + "user_id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "provider": { + "type": "string" + }, + "redirect": { + "type": "string" + }, + "personal_access_client": { + "type": "boolean" + }, + "password_client": { + "type": "boolean" + }, + "revoked": { + "type": "boolean" + }, + "created_at": { "type": "string", - "enum": [ - "adhoc", - "scheduled" - ] + "format": "date-time" }, - "format": { + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "type": "object" + }, + "usersEditable": { + "properties": { + "email": { + "description": "The attributes that are mass assignable.", + "type": "string", + "format": "email" + }, + "firstname": { + "type": "string" + }, + "lastname": { + "type": "string" + }, + "username": { + "type": "string" + }, + "password": { + "type": "string" + }, + "address": { + "type": "string" + }, + "city": { + "type": "string" + }, + "state": { + "type": "string" + }, + "postal": { + "type": "string" + }, + "country": { + "type": "string" + }, + "phone": { + "type": "string" + }, + "fax": { + "type": "string" + }, + "cell": { + "type": "string" + }, + "title": { + "type": "string" + }, + "timezone": { + "type": "string" + }, + "datetime_format": { + "type": "string" + }, + "language": { + "type": "string" + }, + "is_administrator": { + "type": "boolean" + }, + "expires_at": { + "type": "string" + }, + "loggedin_at": { + "type": "string" + }, + "remember_token": { + "type": "string" + }, + "status": { "type": "string", "enum": [ - "csv", - "xlsx" + "ACTIVE", + "INACTIVE", + "SCHEDULED", + "OUT_OF_OFFICE", + "BLOCKED" ] }, - "saved_search_id": { - "type": "integer" + "fullname": { + "type": "string" }, - "config": { - "type": "object", - "additionalProperties": "true" + "avatar": { + "type": "string" }, - "to": { + "media": { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/media" } }, - "subject": { - "type": "string" + "birthdate": { + "type": "string", + "format": "date" }, - "body": { - "type": "string" + "delegation_user_id": { + "type": "string", + "format": "id" + }, + "manager_id": { + "type": "string", + "format": "id" + }, + "meta": { + "type": "object", + "additionalProperties": true + }, + "force_change_password": { + "type": "boolean" + }, + "email_task_notification": { + "type": "boolean" } }, "type": "object" }, - "Report": { + "users": { "allOf": [ + { + "$ref": "#/components/schemas/usersEditable" + }, { "properties": { "id": { - "type": "string", - "format": "id" - }, - "user_id": { - "type": "string", - "format": "id" + "type": "integer" }, "created_at": { "type": "string", @@ -11341,63 +7951,53 @@ "updated_at": { "type": "string", "format": "date-time" + }, + "deleted_at": { + "type": "string", + "format": "date-time" } }, "type": "object" - }, - { - "$ref": "#/components/schemas/SavedSearchEditable" } ] }, - "versionHistoryEditable": { + "UserToken": { "properties": { - "versionable_id": { - "description": "Class VersionHistoryCollection", + "id": { + "type": "string" + }, + "user_id": { "type": "integer" }, - "versionable_type": { - "type": "string" + "client_id": { + "type": "integer" }, "name": { "type": "string" }, - "subject": { - "type": "string" + "scopes": { + "type": "object" }, - "description": { - "type": "string" + "revoked": { + "type": "boolean" }, - "status": { + "client": { + "$ref": "#/components/schemas/TokenClient" + }, + "created_at": { "type": "string", - "enum": [ - "ACTIVE", - "INACTIVE" - ] + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "expires_at": { + "type": "string", + "format": "date-time" } }, "type": "object" - }, - "versionHistory": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/versionHistoryEditable" - }, - { - "properties": { - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "type": "object" - } - ] } }, "responses": { @@ -11636,46 +8236,6 @@ { "name": "Processes Variables", "description": "Processes Variables" - }, - { - "name": "Collections", - "description": "Collections" - }, - { - "name": "Comments", - "description": "Comments" - }, - { - "name": "DataSourcesCategories", - "description": "DataSourcesCategories" - }, - { - "name": "DataSources", - "description": "DataSources" - }, - { - "name": "DecisionTableCategories", - "description": "DecisionTableCategories" - }, - { - "name": "DecisionTables", - "description": "DecisionTables" - }, - { - "name": "SavedSearchCharts", - "description": "SavedSearchCharts" - }, - { - "name": "SavedSearches", - "description": "SavedSearches" - }, - { - "name": "Reports", - "description": "Reports" - }, - { - "name": "Version History", - "description": "Version History" } ], "security": [