From 21183d209dc464b57b34b722e5bc8ff0c3e7bfc9 Mon Sep 17 00:00:00 2001 From: Aneesh Khandekar Date: Fri, 23 Feb 2024 00:14:14 -0500 Subject: [PATCH] Add support for GPO --- LICENSE | 4 +- README.md | 4 +- citrixorchestration/.openapi-generator/FILES | 31 + citrixorchestration/README.md | 51 + citrixorchestration/api/openapi.yaml | 71003 +++++++++++----- citrixorchestration/api_applications_apis.go | 6 +- citrixorchestration/api_gpo.go | 10693 +++ citrixorchestration/client.go | 3 + ...chineToMachineCatalogDetailRequestModel.md | 36 + .../AddMachineToMachineCatalogRequestModel.md | 36 + ...pLibPackageDiscoveryProfileRequestModel.md | 36 + ...LibPackageDiscoveryProfileResponseModel.md | 26 + .../AppLibPackageDiscoveryRequestModel.md | 36 + citrixorchestration/docs/AppSearchProperty.md | 2 + .../docs/ApplicationDetailResponseModel.md | 105 + .../ApplicationGroupDetailResponseModel.md | 75 + .../docs/ApplicationGroupResponseModel.md | 75 + .../docs/ApplicationResponseModel.md | 105 + citrixorchestration/docs/ApplicationType.md | 2 + .../docs/BackupRestoreStatusRequestModel.md | 36 + .../docs/CatalogSearchResponseModel.md | 115 + ...sionedVirtualMachineSearchResponseModel.md | 123 + .../docs/ControllerServiceType.md | 4 + .../docs/CreateDeliveryGroupRequestModel.md | 100 + .../docs/DeliveryGroupsAPIsDAAS.md | 2 +- ...pLibPackageDiscoveryProfileRequestModel.md | 36 + citrixorchestration/docs/GpoDAAS.md | 3027 + .../HypervisorMachineCatalogResponseModel.md | 115 + .../HypervisorResourceSearchResourceType.md | 2 + citrixorchestration/docs/JobType.md | 4 + .../docs/MachineApplicationResponseModel.md | 105 + .../docs/MachineCatalogDetailResponseModel.md | 115 + .../docs/MachineCatalogResponseModel.md | 115 + .../docs/MachineDetailResponseModel.md | 36 + .../docs/MachineResponseModel.md | 36 + .../docs/PackagedApplicationType.md | 2 + ...VirtualMachineCustomVmDataResponseModel.md | 972 + ...ionedVirtualMachineDetailsResponseModel.md | 1154 + ...irtualMachineDetailsWarningReponseModel.md | 92 + ...isionedVirtualMachineDetailsWarningType.md | 15 + ...ualMachineSearchFilterGroupRequestModel.md | 154 + ...onedVirtualMachineSearchFilterGroupType.md | 13 + ...nedVirtualMachineSearchFilterGroupsType.md | 13 + ...dVirtualMachineSearchFilterRequestModel.md | 108 + ...ProvisionedVirtualMachineSearchProperty.md | 45 + ...isionedVirtualMachineSearchRequestModel.md | 200 + ...sionedVirtualMachineSearchResponseModel.md | 578 + ...ualMachineSearchResponseModelCollection.md | 123 + ...dVirtualMachineSortCriteriaRequestModel.md | 72 + ...ovisioningSchemeVmMetadataResponseModel.md | 180 + .../docs/UpdateMachineRequestModel.md | 36 + ...to_machine_catalog_detail_request_model.go | 38 + ...achine_to_machine_catalog_request_model.go | 38 + ...package_discovery_profile_request_model.go | 51 + ...ackage_discovery_profile_response_model.go | 37 + ...app_lib_package_discovery_request_model.go | 51 + .../model_app_search_property.go | 2 + ...model_application_detail_response_model.go | 390 +- ...application_group_detail_response_model.go | 220 +- .../model_application_group_response_model.go | 220 +- .../model_application_response_model.go | 390 +- citrixorchestration/model_application_type.go | 2 + ...del_backup_restore_status_request_model.go | 47 + ...d_virtual_machine_search_response_model.go | 212 + .../model_controller_service_type.go | 4 + ...package_discovery_profile_request_model.go | 47 + ...ypervisor_resource_search_resource_type.go | 2 + citrixorchestration/model_job_type.go | 4 + .../model_machine_detail_response_model.go | 38 + .../model_machine_response_model.go | 38 + .../model_packaged_application_type.go | 2 + ...l_machine_custom_vm_data_response_model.go | 1320 + ..._virtual_machine_details_response_model.go | 1569 + ...l_machine_details_warning_reponse_model.go | 173 + ...ed_virtual_machine_details_warning_type.go | 113 + ...chine_search_filter_group_request_model.go | 238 + ...irtual_machine_search_filter_group_type.go | 111 + ...rtual_machine_search_filter_groups_type.go | 111 + ...ual_machine_search_filter_request_model.go | 191 + ...isioned_virtual_machine_search_property.go | 143 + ...ed_virtual_machine_search_request_model.go | 287 + ...d_virtual_machine_search_response_model.go | 836 + ...achine_search_response_model_collection.go | 212 + ...ual_machine_sort_criteria_request_model.go | 144 + ...oning_scheme_vm_metadata_response_model.go | 235 + .../model_update_machine_request_model.go | 38 + citrixorchestration/test/api_gpo_test.go | 483 + 87 files changed, 76277 insertions(+), 21817 deletions(-) create mode 100644 citrixorchestration/api_gpo.go create mode 100644 citrixorchestration/docs/CollectionModelOfProvisionedVirtualMachineSearchResponseModel.md create mode 100644 citrixorchestration/docs/GpoDAAS.md create mode 100644 citrixorchestration/docs/ProvisionedVirtualMachineCustomVmDataResponseModel.md create mode 100644 citrixorchestration/docs/ProvisionedVirtualMachineDetailsResponseModel.md create mode 100644 citrixorchestration/docs/ProvisionedVirtualMachineDetailsWarningReponseModel.md create mode 100644 citrixorchestration/docs/ProvisionedVirtualMachineDetailsWarningType.md create mode 100644 citrixorchestration/docs/ProvisionedVirtualMachineSearchFilterGroupRequestModel.md create mode 100644 citrixorchestration/docs/ProvisionedVirtualMachineSearchFilterGroupType.md create mode 100644 citrixorchestration/docs/ProvisionedVirtualMachineSearchFilterGroupsType.md create mode 100644 citrixorchestration/docs/ProvisionedVirtualMachineSearchFilterRequestModel.md create mode 100644 citrixorchestration/docs/ProvisionedVirtualMachineSearchProperty.md create mode 100644 citrixorchestration/docs/ProvisionedVirtualMachineSearchRequestModel.md create mode 100644 citrixorchestration/docs/ProvisionedVirtualMachineSearchResponseModel.md create mode 100644 citrixorchestration/docs/ProvisionedVirtualMachineSearchResponseModelCollection.md create mode 100644 citrixorchestration/docs/ProvisionedVirtualMachineSortCriteriaRequestModel.md create mode 100644 citrixorchestration/model_collection_model_of_provisioned_virtual_machine_search_response_model.go create mode 100644 citrixorchestration/model_provisioned_virtual_machine_custom_vm_data_response_model.go create mode 100644 citrixorchestration/model_provisioned_virtual_machine_details_response_model.go create mode 100644 citrixorchestration/model_provisioned_virtual_machine_details_warning_reponse_model.go create mode 100644 citrixorchestration/model_provisioned_virtual_machine_details_warning_type.go create mode 100644 citrixorchestration/model_provisioned_virtual_machine_search_filter_group_request_model.go create mode 100644 citrixorchestration/model_provisioned_virtual_machine_search_filter_group_type.go create mode 100644 citrixorchestration/model_provisioned_virtual_machine_search_filter_groups_type.go create mode 100644 citrixorchestration/model_provisioned_virtual_machine_search_filter_request_model.go create mode 100644 citrixorchestration/model_provisioned_virtual_machine_search_property.go create mode 100644 citrixorchestration/model_provisioned_virtual_machine_search_request_model.go create mode 100644 citrixorchestration/model_provisioned_virtual_machine_search_response_model.go create mode 100644 citrixorchestration/model_provisioned_virtual_machine_search_response_model_collection.go create mode 100644 citrixorchestration/model_provisioned_virtual_machine_sort_criteria_request_model.go create mode 100644 citrixorchestration/test/api_gpo_test.go diff --git a/LICENSE b/LICENSE index 74d0f28..2bb9ad2 100644 --- a/LICENSE +++ b/LICENSE @@ -173,6 +173,4 @@ incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. - END OF TERMS AND CONDITIONS - - Copyright © 2023. Citrix Systems, Inc. All Rights Reserved. \ No newline at end of file + END OF TERMS AND CONDITIONS \ No newline at end of file diff --git a/README.md b/README.md index c1fd241..e03da50 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ Instantiate a client using `NewCitrixDaasClient`. The following variables are re | | Cloud | On-Premises | |--------------|------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------| -| authUrl | Citrix Cloud authentication URL, i.e. `https://api-us.cloud.com/cctrustoauth2/{customerId}/tokens/clients` for US customers. | On-premises trust service URL, i.e. `https://{deliveryControllerHostname}/citrix/orchestration/api/techpreview/tokens` | +| authUrl | Citrix Cloud authentication URL, i.e. `https://api-us.cloud.com/cctrustoauth2/{customerId}/tokens/clients` for US customers. | On-Premises trust service URL, i.e. `https://{deliveryControllerHostname}/citrix/orchestration/api/techpreview/tokens` | | hostname | Citrix Cloud DaaS service hostname, i.e. `{customerId}.xendesktop.net` | Delivery Controller Hostname / IP address | | customerId | Cloud Customer Id | `CitrixOnPremises` | | clientId | Citrix Cloud API Key clientId | Domain Admin Username | @@ -80,4 +80,4 @@ This project is Licensed under the Apache License, Version 2.0 (the "License"); Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. -Copyright © 2023. Citrix Systems, Inc. All Rights Reserved. \ No newline at end of file +Copyright © 2023. Citrix Systems, Inc. \ No newline at end of file diff --git a/citrixorchestration/.openapi-generator/FILES b/citrixorchestration/.openapi-generator/FILES index 6ca3b8d..0801c56 100644 --- a/citrixorchestration/.openapi-generator/FILES +++ b/citrixorchestration/.openapi-generator/FILES @@ -17,6 +17,7 @@ api_applications_apis.go api_batch_apis.go api_config_log_apis.go api_delivery_groups_apis.go +api_gpo.go api_health_check_apis.go api_hypervisors_apis.go api_icons_apis.go @@ -293,6 +294,7 @@ docs/CollectionModelOfPowerShellHistoryResponseModel.md docs/CollectionModelOfPowerTimeSchemeResponseModel.md docs/CollectionModelOfPredefinedPermissionGroupResponseModel.md docs/CollectionModelOfPredefinedPermissionResponseModel.md +docs/CollectionModelOfProvisionedVirtualMachineSearchResponseModel.md docs/CollectionModelOfProvisioningSchemeMachineAccountResponseModel.md docs/CollectionModelOfProvisioningSchemeResponseModel.md docs/CollectionModelOfPvsCollectionResponseModel.md @@ -479,6 +481,7 @@ docs/FtaRequestModel.md docs/FtaResponseModel.md docs/FtaResponseModelCollection.md docs/FunctionalLevel.md +docs/GpoDAAS.md docs/HealthCheckAPIsDAAS.md docs/HomeZoneMode.md docs/HypervisorAWSConnectionDetailRequestModel.md @@ -752,6 +755,19 @@ docs/ProjectedMachinesPerDayResponseModel.md docs/ProjectedMachinesTimeSlotResponseModel.md docs/ProtocolType.md docs/ProvSchemeWarningType.md +docs/ProvisionedVirtualMachineCustomVmDataResponseModel.md +docs/ProvisionedVirtualMachineDetailsResponseModel.md +docs/ProvisionedVirtualMachineDetailsWarningReponseModel.md +docs/ProvisionedVirtualMachineDetailsWarningType.md +docs/ProvisionedVirtualMachineSearchFilterGroupRequestModel.md +docs/ProvisionedVirtualMachineSearchFilterGroupType.md +docs/ProvisionedVirtualMachineSearchFilterGroupsType.md +docs/ProvisionedVirtualMachineSearchFilterRequestModel.md +docs/ProvisionedVirtualMachineSearchProperty.md +docs/ProvisionedVirtualMachineSearchRequestModel.md +docs/ProvisionedVirtualMachineSearchResponseModel.md +docs/ProvisionedVirtualMachineSearchResponseModelCollection.md +docs/ProvisionedVirtualMachineSortCriteriaRequestModel.md docs/ProvisioningProgressResponseModel.md docs/ProvisioningSchemeMachineAccountResponseModel.md docs/ProvisioningSchemeMachineAccountResponseModelCollection.md @@ -1200,6 +1216,7 @@ model_collection_model_of_power_shell_history_response_model.go model_collection_model_of_power_time_scheme_response_model.go model_collection_model_of_predefined_permission_group_response_model.go model_collection_model_of_predefined_permission_response_model.go +model_collection_model_of_provisioned_virtual_machine_search_response_model.go model_collection_model_of_provisioning_scheme_machine_account_response_model.go model_collection_model_of_provisioning_scheme_response_model.go model_collection_model_of_pvs_collection_response_model.go @@ -1650,6 +1667,19 @@ model_projected_machines_per_day_response_model.go model_projected_machines_time_slot_response_model.go model_protocol_type.go model_prov_scheme_warning_type.go +model_provisioned_virtual_machine_custom_vm_data_response_model.go +model_provisioned_virtual_machine_details_response_model.go +model_provisioned_virtual_machine_details_warning_reponse_model.go +model_provisioned_virtual_machine_details_warning_type.go +model_provisioned_virtual_machine_search_filter_group_request_model.go +model_provisioned_virtual_machine_search_filter_group_type.go +model_provisioned_virtual_machine_search_filter_groups_type.go +model_provisioned_virtual_machine_search_filter_request_model.go +model_provisioned_virtual_machine_search_property.go +model_provisioned_virtual_machine_search_request_model.go +model_provisioned_virtual_machine_search_response_model.go +model_provisioned_virtual_machine_search_response_model_collection.go +model_provisioned_virtual_machine_sort_criteria_request_model.go model_provisioning_progress_response_model.go model_provisioning_scheme_machine_account_response_model.go model_provisioning_scheme_machine_account_response_model_collection.go @@ -1855,6 +1885,7 @@ test/api_applications_apis_test.go test/api_batch_apis_test.go test/api_config_log_apis_test.go test/api_delivery_groups_apis_test.go +test/api_gpo_test.go test/api_health_check_apis_test.go test/api_hypervisors_apis_test.go test/api_icons_apis_test.go diff --git a/citrixorchestration/README.md b/citrixorchestration/README.md index 5e3043d..57338b1 100644 --- a/citrixorchestration/README.md +++ b/citrixorchestration/README.md @@ -255,6 +255,43 @@ Class | Method | HTTP request | Description *DeliveryGroupsAPIsDAAS* | [**DeliveryGroupsStartDeliveryGroupRebootCycle**](docs/DeliveryGroupsAPIsDAAS.md#deliverygroupsstartdeliverygrouprebootcycle) | **Post** /DeliveryGroups/{nameOrId}/$StartRebootCycle | Start a reboot cycle for machines in a delivery group. *DeliveryGroupsAPIsDAAS* | [**DeliveryGroupsTestDeliveryGroup**](docs/DeliveryGroupsAPIsDAAS.md#deliverygroupstestdeliverygroup) | **Post** /DeliveryGroups/{nameOrId}/$test | Run tests on a delivery group and create a test report. *DeliveryGroupsAPIsDAAS* | [**DeliveryGroupsTestDeliveryGroupExists**](docs/DeliveryGroupsAPIsDAAS.md#deliverygroupstestdeliverygroupexists) | **Post** /DeliveryGroups/$checkName | Test the existence of a delivery group by name. +*GpoDAAS* | [**GpoComparePolicies**](docs/GpoDAAS.md#gpocomparepolicies) | **Post** /gpo/comparePolicies | Compare policies. The policies can be from different policy sets. +*GpoDAAS* | [**GpoCopyGpoPolicies**](docs/GpoDAAS.md#gpocopygpopolicies) | **Post** /gpo/policies/$copy | Copy some policies of a policy set to other policy sets. +*GpoDAAS* | [**GpoCopyGpoPolicySet**](docs/GpoDAAS.md#gpocopygpopolicyset) | **Post** /gpo/policySets/{policySetGuid} | Create a new GPO policy set by copying an existing policy set. The policies and settings in each policy are copied to the new policy set. Optionally, the filters in the policies may be copied. Regardless of the type of the source policy set, the resulting policy set is always of type DeliveryGroupPolicies. +*GpoDAAS* | [**GpoCreateGpoFilter**](docs/GpoDAAS.md#gpocreategpofilter) | **Post** /gpo/filters | Create a filter in a policy. Filters cannot be created in a policy in a policy set of type SiteTemplates or CustomTemplates. +*GpoDAAS* | [**GpoCreateGpoPolicy**](docs/GpoDAAS.md#gpocreategpopolicy) | **Post** /gpo/policies | Create a new policy. Policies cannot be created in the policy set of type SiteTemplates. +*GpoDAAS* | [**GpoCreateGpoPolicySet**](docs/GpoDAAS.md#gpocreategpopolicyset) | **Post** /gpo/policySets | Create a new GPO policy set. Only a policy set of type DeliveryGroupPolicies can be created. +*GpoDAAS* | [**GpoCreateGpoSetting**](docs/GpoDAAS.md#gpocreategposetting) | **Post** /gpo/settings | Create a setting in a policy. Settings cannot be created in the policy set of type SiteTemplates. +*GpoDAAS* | [**GpoDeleteGpoFilter**](docs/GpoDAAS.md#gpodeletegpofilter) | **Delete** /gpo/filters/{filterGuid} | Delete an existing filter. +*GpoDAAS* | [**GpoDeleteGpoPolicy**](docs/GpoDAAS.md#gpodeletegpopolicy) | **Delete** /gpo/policies/{policyGuid} | Delete an existing GPO policy. A policy in the policy set of type SiteTemplates cannot be deleted. The Unfiltered policy in the policy set of type SitePolicies cannot be deleted. +*GpoDAAS* | [**GpoDeleteGpoPolicySet**](docs/GpoDAAS.md#gpodeletegpopolicyset) | **Delete** /gpo/policySets/{policySetGuid} | Delete an existing GPO policy set. Only policy sets of type DeliveryGroupPolicies can be deleted. Policies in the policy set are deleted if a policy set is deleted. +*GpoDAAS* | [**GpoDeleteGpoSetting**](docs/GpoDAAS.md#gpodeletegposetting) | **Delete** /gpo/settings/{settingGuid} | Delete a setting. Settings in the policy set of type SiteTemplates cannot be deleted. +*GpoDAAS* | [**GpoDisableGpoPolicies**](docs/GpoDAAS.md#gpodisablegpopolicies) | **Post** /gpo/policies/$disable | Disable some policies of a policy set. +*GpoDAAS* | [**GpoEnableGpoPolicies**](docs/GpoDAAS.md#gpoenablegpopolicies) | **Post** /gpo/policies/$enable | Enable some policies of a policy set. +*GpoDAAS* | [**GpoGetFilterDefinitions**](docs/GpoDAAS.md#gpogetfilterdefinitions) | **Get** /gpo/filterDefinitions | Get all filter definitions. +*GpoDAAS* | [**GpoGetSettingDefinitions**](docs/GpoDAAS.md#gpogetsettingdefinitions) | **Get** /gpo/settingDefinitions | Get setting definitions. If isLean is set to true, only basic session information is returned. EnumType, VdaVersions, VersionDetails, and Explanation are not retrieved. If limit is set to -1 or a number larger than the number of settings available, all entries are retrieved. If limit is set to a positive integer smaller than the number of settings available, the specified number of settings are retrieved. +*GpoDAAS* | [**GpoGetSettingFullDetail**](docs/GpoDAAS.md#gpogetsettingfulldetail) | **Get** /gpo/settingFullDetail | Get full detail of a setting definition. +*GpoDAAS* | [**GpoMoveGpoPolicies**](docs/GpoDAAS.md#gpomovegpopolicies) | **Post** /gpo/policies/$move | Move some policies of a policy set to another policy set. +*GpoDAAS* | [**GpoRankGpoPolicies**](docs/GpoDAAS.md#gporankgpopolicies) | **Post** /gpo/policyPriorities | Specify new priority order for all existing policies in a policy set. All the policies in the policy set must be specified, even if the priorities of only some of the policies are changed. +*GpoDAAS* | [**GpoReadGpoFilter**](docs/GpoDAAS.md#gporeadgpofilter) | **Get** /gpo/filters/{filterGuid} | Read a specific filter. +*GpoDAAS* | [**GpoReadGpoFilters**](docs/GpoDAAS.md#gporeadgpofilters) | **Get** /gpo/filters | Read filters defined in a policy. A policy in a policy set of type SiteTemplates or CustomTemplates does not have filters. +*GpoDAAS* | [**GpoReadGpoPolicies**](docs/GpoDAAS.md#gporeadgpopolicies) | **Get** /gpo/policies | Read all policies defined in a policy set. Policy templates don't have filters. +*GpoDAAS* | [**GpoReadGpoPolicy**](docs/GpoDAAS.md#gporeadgpopolicy) | **Get** /gpo/policies/{policyGuid} | Read a policy. A policy template doesn't have filters. +*GpoDAAS* | [**GpoReadGpoPolicySet**](docs/GpoDAAS.md#gporeadgpopolicyset) | **Get** /gpo/policySets/{policySetGuid} | Read a GPO policy set. +*GpoDAAS* | [**GpoReadGpoPolicySets**](docs/GpoDAAS.md#gporeadgpopolicysets) | **Get** /gpo/policySets | Get all GPO policy sets in the site. +*GpoDAAS* | [**GpoReadGpoSetting**](docs/GpoDAAS.md#gporeadgposetting) | **Get** /gpo/settings/{settingGuid} | Read a specific setting. +*GpoDAAS* | [**GpoReadGpoSettings**](docs/GpoDAAS.md#gporeadgposettings) | **Get** /gpo/settings | Read settings defined in a policy. +*GpoDAAS* | [**GpoRemoveGpoPolicies**](docs/GpoDAAS.md#gporemovegpopolicies) | **Post** /gpo/policies/$remove | Remove some policies of a policy set. +*GpoDAAS* | [**GpoRunSimulation**](docs/GpoDAAS.md#gporunsimulation) | **Post** /gpo/simulation | Simulate policy application. +*GpoDAAS* | [**GpoSearchFilters**](docs/GpoDAAS.md#gposearchfilters) | **Post** /gpo/filters/$search | Perform an advanced search for GPO filters. +*GpoDAAS* | [**GpoSearchPolicies**](docs/GpoDAAS.md#gposearchpolicies) | **Post** /gpo/policies/$search | Perform an advanced search for GPO policies. +*GpoDAAS* | [**GpoSearchPolicySets**](docs/GpoDAAS.md#gposearchpolicysets) | **Post** /gpo/policySets/$search | Perform an advanced search for GPO policy sets. +*GpoDAAS* | [**GpoSearchSettings**](docs/GpoDAAS.md#gposearchsettings) | **Post** /gpo/settings/$search | Perform an advanced search for GPO settings. +*GpoDAAS* | [**GpoUpdateGpoFilter**](docs/GpoDAAS.md#gpoupdategpofilter) | **Patch** /gpo/filters/{filterGuid} | Update an existing filter. +*GpoDAAS* | [**GpoUpdateGpoPolicy**](docs/GpoDAAS.md#gpoupdategpopolicy) | **Patch** /gpo/policies/{policyGuid} | Update a policy. Only the policy body is updated. +*GpoDAAS* | [**GpoUpdateGpoPolicySet**](docs/GpoDAAS.md#gpoupdategpopolicyset) | **Patch** /gpo/policySets/{policySetGuid} | Update an existing GPO policy set. +*GpoDAAS* | [**GpoUpdateGpoSetting**](docs/GpoDAAS.md#gpoupdategposetting) | **Patch** /gpo/settings/{settingGuid} | Update a setting. Settings in the policy set of type SiteTemplates cannot be updated. +*GpoDAAS* | [**GpoUpdatePolicySetBlob**](docs/GpoDAAS.md#gpoupdatepolicysetblob) | **Put** /gpo/policySets/{policySetGuid} | Force serialization of policy set. The data of a policy set is serialized into a byte stream before it is sent to VDAs. The serialization is done automatically in the background at 5 minute intervals. A change made to the data in a policy set may not be in the serialized data for up to 5 minutes. This call tells the background thread to serialize the data immediately. No serialization is done if there have been no changes to the policy set data since the last time the data was serialized. *HealthCheckAPIsDAAS* | [**HealthCheckHealthCheck**](docs/HealthCheckAPIsDAAS.md#healthcheckhealthcheck) | **Get** /HealthCheck | The health check endpoint. *HypervisorsAPIsDAAS* | [**HypervisorsCheckHypervisorExists**](docs/HypervisorsAPIsDAAS.md#hypervisorscheckhypervisorexists) | **Head** /hypervisors/{name} | Check for the existence of a hypervisor by name. *HypervisorsAPIsDAAS* | [**HypervisorsCheckHypervisorResourcePoolExists**](docs/HypervisorsAPIsDAAS.md#hypervisorscheckhypervisorresourcepoolexists) | **Head** /hypervisors/{nameOrId}/resourcePools/{name} | Check for the existence of a resource pool by name. @@ -697,6 +734,7 @@ Class | Method | HTTP request | Description - [CollectionModelOfPowerTimeSchemeResponseModel](docs/CollectionModelOfPowerTimeSchemeResponseModel.md) - [CollectionModelOfPredefinedPermissionGroupResponseModel](docs/CollectionModelOfPredefinedPermissionGroupResponseModel.md) - [CollectionModelOfPredefinedPermissionResponseModel](docs/CollectionModelOfPredefinedPermissionResponseModel.md) + - [CollectionModelOfProvisionedVirtualMachineSearchResponseModel](docs/CollectionModelOfProvisionedVirtualMachineSearchResponseModel.md) - [CollectionModelOfProvisioningSchemeMachineAccountResponseModel](docs/CollectionModelOfProvisioningSchemeMachineAccountResponseModel.md) - [CollectionModelOfProvisioningSchemeResponseModel](docs/CollectionModelOfProvisioningSchemeResponseModel.md) - [CollectionModelOfPvsCollectionResponseModel](docs/CollectionModelOfPvsCollectionResponseModel.md) @@ -1147,6 +1185,19 @@ Class | Method | HTTP request | Description - [ProjectedMachinesTimeSlotResponseModel](docs/ProjectedMachinesTimeSlotResponseModel.md) - [ProtocolType](docs/ProtocolType.md) - [ProvSchemeWarningType](docs/ProvSchemeWarningType.md) + - [ProvisionedVirtualMachineCustomVmDataResponseModel](docs/ProvisionedVirtualMachineCustomVmDataResponseModel.md) + - [ProvisionedVirtualMachineDetailsResponseModel](docs/ProvisionedVirtualMachineDetailsResponseModel.md) + - [ProvisionedVirtualMachineDetailsWarningReponseModel](docs/ProvisionedVirtualMachineDetailsWarningReponseModel.md) + - [ProvisionedVirtualMachineDetailsWarningType](docs/ProvisionedVirtualMachineDetailsWarningType.md) + - [ProvisionedVirtualMachineSearchFilterGroupRequestModel](docs/ProvisionedVirtualMachineSearchFilterGroupRequestModel.md) + - [ProvisionedVirtualMachineSearchFilterGroupType](docs/ProvisionedVirtualMachineSearchFilterGroupType.md) + - [ProvisionedVirtualMachineSearchFilterGroupsType](docs/ProvisionedVirtualMachineSearchFilterGroupsType.md) + - [ProvisionedVirtualMachineSearchFilterRequestModel](docs/ProvisionedVirtualMachineSearchFilterRequestModel.md) + - [ProvisionedVirtualMachineSearchProperty](docs/ProvisionedVirtualMachineSearchProperty.md) + - [ProvisionedVirtualMachineSearchRequestModel](docs/ProvisionedVirtualMachineSearchRequestModel.md) + - [ProvisionedVirtualMachineSearchResponseModel](docs/ProvisionedVirtualMachineSearchResponseModel.md) + - [ProvisionedVirtualMachineSearchResponseModelCollection](docs/ProvisionedVirtualMachineSearchResponseModelCollection.md) + - [ProvisionedVirtualMachineSortCriteriaRequestModel](docs/ProvisionedVirtualMachineSortCriteriaRequestModel.md) - [ProvisioningProgressResponseModel](docs/ProvisioningProgressResponseModel.md) - [ProvisioningSchemeMachineAccountResponseModel](docs/ProvisioningSchemeMachineAccountResponseModel.md) - [ProvisioningSchemeMachineAccountResponseModelCollection](docs/ProvisioningSchemeMachineAccountResponseModelCollection.md) diff --git a/citrixorchestration/api/openapi.yaml b/citrixorchestration/api/openapi.yaml index fa7b89c..0b0d897 100644 --- a/citrixorchestration/api/openapi.yaml +++ b/citrixorchestration/api/openapi.yaml @@ -60215,7 +60215,8 @@ paths: AppV, or AppLibraryAppV, or Msix, or - AppAttach + AppAttach, or + FlexApp operationId: Applications_GetApplicationFtas parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' @@ -63613,7 +63614,8 @@ paths: AppV, or AppLibraryAppV, or Msix, or - AppAttach + AppAttach, or + FlexApp operationId: Applications_GetApplicationFta parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' @@ -131830,9 +131832,9 @@ paths: summary: Get usage data about a delivery group. tags: - DeliveryGroups APIs - /HealthCheck: - get: - operationId: HealthCheck_HealthCheck + /gpo/comparePolicies: + post: + operationId: Gpo_ComparePolicies parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -131843,6 +131845,23 @@ paths: schema: type: string style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple - description: "Citrix authorization header: CWSAuth Bearer={token}" explode: false in: header @@ -131878,14 +131897,39 @@ paths: schema: type: string style: simple + - description: Include defaults in comparison + explode: true + in: query + name: withDefaults + required: true + schema: + nullable: true + title: Boolean + type: boolean + style: form + x-position: 4 + requestBody: + content: + application/json: + schema: + items: + format: guid + title: Guid + type: string + nullable: true + title: "Guid[]" + type: array + description: GUIDs of policies + required: true + x-name: targets + x-position: 3 responses: "200": content: application/json: schema: - title: Boolean - type: boolean - description: true or false + $ref: '#/components/schemas/ComparisonResponseContract' + description: Comparison result headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -132204,21 +132248,18 @@ paths: schema: type: string style: simple - "429": + "409": content: application/json: example: - https://errors-api.cloud.com/common/rateLimitExceeded: + https://errors-api.cloud.com/common/optimisticConcurrency: value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds - parameters: - - name: retryDelay - value: "4" + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. + description: Caller requested an invalid relation to be created or deleted. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -132271,21 +132312,21 @@ paths: schema: type: string style: simple - "503": + "415": content: application/json: example: - https://errors-api.cloud.com/common/serviceUnavailable: + https://errors-api.cloud.com/common/unsupportedMediaType: value: - type: https://errors-api.cloud.com/common/serviceUnavailable - detail: Service is unavailable; try again in 4 seconds + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type parameters: - - name: retryDelay - value: "4" + - name: mediaType + value: application/xml schema: $ref: '#/components/schemas/ErrorResponse' - description: "Service is temporarily unable to process the request. Caller\ - \ may attempt the operation again, with exponential back-off." + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -132338,21 +132379,21 @@ paths: schema: type: string style: simple - "500": + "429": content: application/json: example: - https://errors-api.cloud.com/common/internalServerError: + https://errors-api.cloud.com/common/rateLimitExceeded: value: - type: https://errors-api.cloud.com/common/internalServerError - detail: An internal server error has occurred; try again in 4 - seconds + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds parameters: - name: retryDelay value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: An unexpected server error occurred. + description: Caller has made too many requests in a short period of time + and is being rate-limited. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -132405,157 +132446,22 @@ paths: schema: type: string style: simple - summary: The health check endpoint. - tags: - - HealthCheck APIs - /hypervisors: - get: - description: |- - Get all hypervisors configured in the site. - URI with ?noCache=true can ignore the cache and fetch the data directly. - operationId: Hypervisors_GetHypervisors - parameters: - - description: Citrix Customer ID. Default is 'CitrixOnPremises' - example: CitrixOnPremises - explode: false - in: header - name: Citrix-CustomerId - required: true - schema: - type: string - style: simple - - description: Citrix Instance (Site) ID. - explode: false - in: header - name: Citrix-InstanceId - required: true - schema: - type: string - style: simple - - description: User Agent type of the request. - example: Mozilla/5.0 - explode: false - in: header - name: User-Agent - required: false - schema: - type: string - style: simple - - description: "Citrix authorization header: CWSAuth Bearer={token}" - explode: false - in: header - name: Authorization - required: false - schema: - type: string - style: simple - - description: "Transaction ID that will be used to track this request. If not\ - \ provided, a new GUID will be generated and returned." - explode: false - in: header - name: Citrix-TransactionId - required: false - schema: - type: string - style: simple - - description: Must accept application/json. - example: application/json - explode: false - in: header - name: Accept - required: false - schema: - type: string - style: simple - - description: Locale of the request. - example: en-US - explode: false - in: header - name: Citrix-Locale - required: false - schema: - type: string - style: simple - - description: 'Async request to hypervisor. ' - explode: true - in: query - name: async - required: false - schema: - default: false - title: Boolean - type: boolean - style: form - x-position: 1 - responses: - "200": + "503": content: application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" schema: - $ref: '#/components/schemas/HypervisorResponseModelCollection' - description: List of hypervisors. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "202": - description: Async request was accepted and is being processed. + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false - schema: - type: string - style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -132607,20 +132513,214 @@ paths: schema: type: string style: simple - "400": + "500": content: application/json: example: - https://errors-api.cloud.com/common/outOfRange: + https://errors-api.cloud.com/common/internalServerError: value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds parameters: - - name: property - value: startTime + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + description: An unexpected server error occurred. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + summary: Compare policies. The policies can be from different policy sets. + tags: + - Gpo + /gpo/filterDefinitions: + get: + operationId: Gpo_GetFilterDefinitions + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/CollectionEnvelopeOfFilterDefinition' + description: Filter definitions + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -133074,12 +133174,12 @@ paths: schema: type: string style: simple - summary: Get the hypervisors. + summary: Get all filter definitions. tags: - - Hypervisors APIs - post: - description: "Create a hypervisor, and optionally a resource pool on the hypervisor." - operationId: Hypervisors_CreateHypervisor + - Gpo + /gpo/filters: + get: + operationId: Gpo_ReadGpoFilters parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -133142,49 +133242,25 @@ paths: schema: type: string style: simple - - description: |- - If `true`, the hypervisor (and associated objects) will be created as a - background task. - The task will have JobType CreateHypervisor. - When the task is complete it will redirect to - GetHypervisor. - The job's Parameters will contain properties: - * _Name_ - Name of the hypervisor being created. + - description: The GUID of the policy from which filters are read explode: true in: query - name: async - required: false + name: policyGuid + required: true schema: - default: false - nullable: true - title: Boolean - type: boolean + format: guid + title: Guid + type: string style: form - x-position: 2 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CreateHypervisorRequestModel' - description: Details of the hypervisor to create. - required: true - x-name: model - x-position: 1 + x-position: 3 responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/HypervisorDetailResponseModel' - description: Resource was created. + $ref: '#/components/schemas/CollectionEnvelopeOfFilterResponse' + description: The filters read headers: - Location: - description: Location where the newly created resource resides. - example: /services/myservice/widgets/1 - explode: false - schema: - type: string - style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -133236,165 +133312,21 @@ paths: schema: type: string style: simple - x-expectedSchemas: - - description: Details of the hypervisor that was created. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorDetailAWSResponseModel' - - description: Details of the hypervisor that was created. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorDetailAzureResponseModel' - - description: Details of the hypervisor that was created. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorDetailGCPResponseModel' - - description: Details of the hypervisor that was created. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorDetailWOLResponseModel' - - description: Details of the hypervisor that was created. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorDetailTraditionalResponseModel' - - description: Details of the hypervisor that was created. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorDetailOciResponseModel' - - description: Details of the hypervisor that was created. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorDetailResponseModel' - "202": - description: Async request was accepted and is being processed. - headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime schema: - type: string - style: simple - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "204": - description: Operation is successful with no response content. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "400": - content: - application/json: - example: - https://errors-api.cloud.com/common/outOfRange: - value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range - parameters: - - name: property - value: startTime - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. - headers: + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -133646,18 +133578,21 @@ paths: schema: type: string style: simple - "409": + "429": content: application/json: example: - https://errors-api.cloud.com/common/optimisticConcurrency: + https://errors-api.cloud.com/common/rateLimitExceeded: value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. + description: Caller has made too many requests in a short period of time + and is being rate-limited. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -133710,21 +133645,21 @@ paths: schema: type: string style: simple - "415": + "503": content: application/json: example: - https://errors-api.cloud.com/common/unsupportedMediaType: + https://errors-api.cloud.com/common/serviceUnavailable: value: - type: https://errors-api.cloud.com/common/unsupportedMediaType - detail: Must use application/json;charset=utf-8 media type + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds parameters: - - name: mediaType - value: application/xml + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must send request body in utf-8 and specify request - Content-Type as utf-8. + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -133777,21 +133712,21 @@ paths: schema: type: string style: simple - "429": + "500": content: application/json: example: - https://errors-api.cloud.com/common/rateLimitExceeded: + https://errors-api.cloud.com/common/internalServerError: value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds parameters: - name: retryDelay value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. + description: An unexpected server error occurred. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -133844,21 +133779,102 @@ paths: schema: type: string style: simple - "503": + summary: |- + Read filters defined in a policy. A policy in a policy set of type SiteTemplates or CustomTemplates does not + have filters. + tags: + - Gpo + post: + operationId: Gpo_CreateGpoFilter + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + - description: The GUID of the policy to which the new filter belongs + explode: true + in: query + name: policyGuid + required: true + schema: + format: guid + title: Guid + type: string + style: form + x-position: 3 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FilterRequest' + description: Filter data + required: true + x-name: request + x-position: 4 + responses: + "200": content: application/json: - example: - https://errors-api.cloud.com/common/serviceUnavailable: - value: - type: https://errors-api.cloud.com/common/serviceUnavailable - detail: Service is unavailable; try again in 4 seconds - parameters: - - name: retryDelay - value: "4" schema: - $ref: '#/components/schemas/ErrorResponse' - description: "Service is temporarily unable to process the request. Caller\ - \ may attempt the operation again, with exponential back-off." + $ref: '#/components/schemas/FilterResponse' + description: The filter created headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -133911,449 +133927,6 @@ paths: schema: type: string style: simple - "500": - content: - application/json: - example: - https://errors-api.cloud.com/common/internalServerError: - value: - type: https://errors-api.cloud.com/common/internalServerError - detail: An internal server error has occurred; try again in 4 - seconds - parameters: - - name: retryDelay - value: "4" - schema: - $ref: '#/components/schemas/ErrorResponse' - description: An unexpected server error occurred. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - summary: "Create a hypervisor, and optionally a resource pool on the hypervisor." - tags: - - Hypervisors APIs - /hypervisors/$GetResources: - post: - description: |- - Get the resources within a hypervisor, _without_ creating a - persistent connection to the hypervisor. Note: in previous versions - of the API, a "Hypervisor" was referred to as a "Connection". - This method is useful while determining the details required to - create both a hypervisor and a resource pool, but without finalizing - the creation of either. The caller is free to browse resources that - are available before deciding whether and how to proceed. - A caller can recursively enumerate by: - * Call with no `path`, and `children` equal to `1`. - * For each of the result's - Children where - IsContainer is - `true`, call with `path` equal to that item's - RelativePath and - `children` equal to `1`. - * Repeat recursively. - URI with ?force=true can get the VMs which provisioned by MCS. - URI with ?recurse=true can recurse fetch all resources under this folder. - operationId: Hypervisors_GetHypervisorAllResourcesWithoutConnection - parameters: - - description: Citrix Customer ID. Default is 'CitrixOnPremises' - example: CitrixOnPremises - explode: false - in: header - name: Citrix-CustomerId - required: true - schema: - type: string - style: simple - - description: Citrix Instance (Site) ID. - explode: false - in: header - name: Citrix-InstanceId - required: true - schema: - type: string - style: simple - - description: User Agent type of the request. - example: Mozilla/5.0 - explode: false - in: header - name: User-Agent - required: false - schema: - type: string - style: simple - - description: "Citrix authorization header: CWSAuth Bearer={token}" - explode: false - in: header - name: Authorization - required: false - schema: - type: string - style: simple - - description: "Transaction ID that will be used to track this request. If not\ - \ provided, a new GUID will be generated and returned." - explode: false - in: header - name: Citrix-TransactionId - required: false - schema: - type: string - style: simple - - description: Must accept application/json. - example: application/json - explode: false - in: header - name: Accept - required: false - schema: - type: string - style: simple - - description: Locale of the request. - example: en-US - explode: false - in: header - name: Citrix-Locale - required: false - schema: - type: string - style: simple - - description: |- - Path to the resource container within the hypervisor. The path may - either be a relative path as specified by - RelativePath, or - may be a URL-encoded Virtual Apps & Desktops resource path - starting with `XDHyp:`; for example, as specified by - XDPath. - explode: true - in: query - name: path - required: false - schema: - nullable: true - title: String - type: string - style: form - x-position: 2 - - description: |- - Specifies the number of levels of children to enumerate. - Default is `0`, meaning that only the object referred to by `path` - is returned and its - Children array will be - left null. - A special value of `-1` indicates that the entire resource hierarchy - should be enumerated. Use with care! It may take a very long time - to enumerate a large number of resources from a hypervisor, and the - call may time out before completing. - explode: true - in: query - name: children - required: false - schema: - format: int32 - nullable: true - title: Int32 - type: integer - style: form - x-position: 3 - - description: "If specified, limits the results to the specified resource type(s)." - explode: true - in: query - name: type - required: false - schema: - items: - title: String - type: string - nullable: true - title: "String[]" - type: array - style: form - x-position: 4 - - description: |- - By default, items which are tagged by XenDesktop are not shown. Set - this to `true` to override that behavior. - explode: true - in: query - name: showTagged - required: false - schema: - nullable: true - title: Boolean - type: boolean - style: form - x-position: 5 - - description: |- - If `true`, full details of VMs, snapshots, and templates will be - retrieved. This can be very time consuming and will reduce the - performance of the call. May only be used if `path` refers to a VM, - snapshot, or template resource. - - explode: true - in: query - name: detail - required: false - schema: - nullable: true - title: Boolean - type: boolean - style: form - x-position: 6 - - description: Async request to get the resources with *path. - explode: true - in: query - name: async - required: false - schema: - default: false - title: Boolean - type: boolean - style: form - x-position: 7 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/HypervisorConnectionDetailRequestModel' - description: |- - Details of how to connect to the hypervisor to enumerate resources - from it. - required: true - x-name: connectionDetail - x-position: 1 - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/HypervisorResourceResponseModel' - description: |- - A list of hypervisor resources. - or - A list of hypervisor resources. - or - A list of hypervisor resources. - or - A list of hypervisor resources. - or - A list of hypervisor resources. - or - A list of hypervisor resources. - or - A list of hypervisor resources. - or - A list of hypervisor resources. - or - A list of hypervisor resources. - or - A list of hypervisor resources. - or - A list of hypervisor resources. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - x-expectedSchemas: - - description: A list of hypervisor resources. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorAvailabilityZoneResourceResponseModel' - - description: A list of hypervisor resources. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorGpuTypeResourceResponseModel' - - description: A list of hypervisor resources. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorSecurityGroupResourceResponseModel' - - description: A list of hypervisor resources. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorServiceOfferingResourceResponseModel' - - description: A list of hypervisor resources. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorStorageResourceResponseModel' - - description: A list of hypervisor resources. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorTemplateResourceResponseModel' - - description: A list of hypervisor resources. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorVmResourceResponseModel' - - description: A list of hypervisor resources. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorVmSnapshotResourceResponseModel' - - description: A list of hypervisor resources. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorVpcResourceResponseModel' - - description: A list of hypervisor resources. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorCloudRegionResourceResponseModel' - - description: A list of hypervisor resources. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorResourceResponseModel' - "202": - description: Async request was accepted and is being processed. - headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false - schema: - type: string - style: simple - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple "400": content: application/json: @@ -134953,14 +134526,13 @@ paths: type: string style: simple summary: |- - Get all resources within a hypervisor, _without_ creating a - persistent connection to the hypervisor. + Create a filter in a policy. Filters cannot be created in a policy in a policy set of type SiteTemplates or + CustomTemplates. tags: - - Hypervisors APIs - /hypervisors/$ValidateVm: + - Gpo + /gpo/filters/$search: post: - description: Validate a list of hypervisor Vm Path. - operationId: Hypervisors_ValidateVmPath + operationId: Gpo_SearchFilters parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -135023,9 +134595,34 @@ paths: schema: type: string style: simple + - description: "Maximum number of objects, which must not exceed 1000, to return.\ + \ If not specified, the default value is 250." + explode: true + in: query + name: limit + required: false + schema: + format: int32 + nullable: true + title: Int32 + type: integer + style: form + x-position: 2 - description: |- - If `true`, the resource pool will be updated as a background task. - The task will have JobType HypervisorVmValidation. + If a previous call didn't return all the records expected, pass the continuation token returned from the + previous response to this current query to continue retrieving the remaining objects. + explode: true + in: query + name: continuationToken + required: false + schema: + nullable: true + title: String + type: string + style: form + x-position: 3 + - description: "If `true`, the search operations will be executed as a background\ + \ task." explode: true in: query name: async @@ -135036,23 +134633,23 @@ paths: title: Boolean type: boolean style: form - x-position: 2 + x-position: 4 requestBody: content: application/json: schema: - $ref: '#/components/schemas/HypervisorVmValidationRequestModel' - description: A list of Vm path. + $ref: '#/components/schemas/FilterSearch' + description: Specifies the advanced search parameters. required: true - x-name: VmPaths + x-name: request x-position: 1 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/HypervisorVmValidationResponseModelCollection' - description: 'Details of the vm path validation results. ' + $ref: '#/components/schemas/CollectionEnvelopeOfFilterResponse' + description: List of policy sets that match the search criteria. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -135764,13 +135361,12 @@ paths: schema: type: string style: simple - summary: Validate a list of hypervisor Vm Path. + summary: Perform an advanced search for GPO filters. tags: - - Hypervisors APIs - /hypervisors/{name}: - head: - description: Check for the existence of a hypervisor by name. - operationId: Hypervisors_CheckHypervisorExists + - Gpo + /gpo/filters/{filterGuid}: + delete: + operationId: Gpo_DeleteGpoFilter parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -135833,17 +135429,17 @@ paths: schema: type: string style: simple - - description: Name of the hypervisor. + - description: The GUID of the filter to be deleted explode: false in: path - name: name + name: filterGuid required: true schema: - nullable: true - title: String + format: guid + title: Guid type: string style: simple - x-position: 1 + x-position: 3 responses: "204": description: Operation is successful with no response content. @@ -136100,20 +135696,6 @@ paths: type: string style: simple "404": - content: - application/json: - example: - https://errors-api.cloud.com/common/notFound: - value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found - parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 - schema: - $ref: '#/components/schemas/ErrorResponse' description: A referenced entity was not found. headers: Citrix-TransactionId: @@ -136233,6 +135815,70 @@ paths: schema: type: string style: simple + "409": + content: + application/json: + example: + https://errors-api.cloud.com/common/optimisticConcurrency: + value: + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller requested an invalid relation to be created or deleted. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple "429": content: application/json: @@ -136434,12 +136080,11 @@ paths: schema: type: string style: simple - summary: Check for the existence of a hypervisor by name. + summary: Delete an existing filter. tags: - - Hypervisors APIs - /hypervisors/{nameOrId}: - delete: - operationId: Hypervisors_DeleteHypervisor + - Gpo + get: + operationId: Gpo_ReadGpoFilter parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -136502,94 +136147,25 @@ paths: schema: type: string style: simple - - description: 'The hypervisor connection name or id. ' + - description: The GUID of the filter to be read explode: false in: path - name: nameOrId + name: filterGuid required: true schema: - nullable: true - title: String + format: guid + title: Guid type: string style: simple - x-position: 1 - - description: 'If the api call with async type. ' - explode: true - in: query - name: async - required: false - schema: - default: false - nullable: true - title: Boolean - type: boolean - style: form - x-position: 2 + x-position: 3 responses: - "204": - description: Operation is successful with no response content. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false + "200": + content: + application/json: schema: - type: string - style: simple - "202": - description: Async request was accepted and is being processed. + $ref: '#/components/schemas/FilterResponse' + description: The filter read headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false - schema: - type: string - style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -136842,6 +136418,20 @@ paths: type: string style: simple "404": + content: + application/json: + example: + https://errors-api.cloud.com/common/notFound: + value: + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' description: A referenced entity was not found. headers: Citrix-TransactionId: @@ -136961,70 +136551,6 @@ paths: schema: type: string style: simple - "409": - content: - application/json: - example: - https://errors-api.cloud.com/common/optimisticConcurrency: - value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple "429": content: application/json: @@ -137226,14 +136752,11 @@ paths: schema: type: string style: simple - summary: Delete a hypervisor and related resource pools. + summary: Read a specific filter. tags: - - Hypervisors APIs - get: - description: |- - Get the details for a single hypervisor. - URI with ?noCache=true can ignore the cache and fetch the data directly. - operationId: Hypervisors_GetHypervisor + - Gpo + patch: + operationId: Gpo_UpdateGpoFilter parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -137296,48 +136819,29 @@ paths: schema: type: string style: simple - - description: Name or ID of the hypervisor. + - description: The GUID of the filter to be updated explode: false in: path - name: nameOrId + name: filterGuid required: true schema: - nullable: true - title: String + format: guid + title: Guid type: string style: simple - x-position: 1 - - description: 'Async request to hypervisor. ' - explode: true - in: query - name: async - required: false - schema: - default: false - title: Boolean - type: boolean - style: form - x-position: 2 + x-position: 3 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FilterRequest' + description: Filter data. The filter type is ignored + required: true + x-name: request + x-position: 4 responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/HypervisorDetailResponseModel' - description: |- - Hypervisor details. - or - Hypervisor details. - or - Hypervisor details. - or - Hypervisor details. - or - Hypervisor details. - or - Hypervisor details. - or - Hypervisor details. + "204": + description: Operation is successful with no response content. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -137390,45 +136894,21 @@ paths: schema: type: string style: simple - x-expectedSchemas: - - description: Hypervisor details. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorDetailAWSResponseModel' - - description: Hypervisor details. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorDetailAzureResponseModel' - - description: Hypervisor details. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorDetailGCPResponseModel' - - description: Hypervisor details. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorDetailWOLResponseModel' - - description: Hypervisor details. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorDetailTraditionalResponseModel' - - description: Hypervisor details. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorDetailOciResponseModel' - - description: Hypervisor details. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorDetailResponseModel' - "202": - description: Async request was accepted and is being processed. - headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime schema: - type: string - style: simple + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -137480,20 +136960,20 @@ paths: schema: type: string style: simple - "400": + "401": content: application/json: example: - https://errors-api.cloud.com/common/outOfRange: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: property - value: startTime + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -137546,20 +137026,22 @@ paths: schema: type: string style: simple - "401": + "403": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - - name: reason - value: missing + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -137612,14 +137094,14 @@ paths: schema: type: string style: simple - "403": + "404": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/notFound: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found parameters: - name: entityType value: https://identifiers-api.cloud.com/example/widget @@ -137627,7 +137109,7 @@ paths: value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: A referenced entity was not found. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -137680,22 +137162,20 @@ paths: schema: type: string style: simple - "404": + "406": content: application/json: example: - https://errors-api.cloud.com/common/notFound: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -137748,20 +137228,21 @@ paths: schema: type: string style: simple - "406": + "415": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/unsupportedMediaType: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type parameters: - - name: contentType - value: application/json + - name: mediaType + value: application/xml schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -138015,12 +137496,12 @@ paths: schema: type: string style: simple - summary: Get the details for a single hypervisor. + summary: Update an existing filter. tags: - - Hypervisors APIs - patch: - description: Update a hypervisor. - operationId: Hypervisors_PatchHypervisor + - Gpo + /gpo/policies: + get: + operationId: Gpo_ReadGpoPolicies parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -138083,62 +137564,46 @@ paths: schema: type: string style: simple - - description: Name or ID of the hypervisor. - explode: false - in: path - name: nameOrId + - description: The GUID of the policy set from which policies are read + explode: true + in: query + name: policySetGuid required: true schema: - nullable: true - title: String + format: guid + title: Guid type: string - style: simple - x-position: 2 - - description: |- - If `true`, the hypervisor will be updated as a background task. - The task will have JobType UpdateHypervisor. - When the task is complete it will redirect to - GetHypervisor. - The job's Parameters will contain properties: - * _Name_ - Name of the hypervisor being updated. - * _Id_ - ID of the hypervisor being updated. + style: form + x-position: 3 + - description: "If set to true, settings in the policy are read" explode: true in: query - name: async + name: withSettings required: false schema: - default: false nullable: true title: Boolean type: boolean style: form - x-position: 3 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/EditHypervisorConnectionRequestModel' - description: |- - Details of the hypervisor to update. Note that each type of - hypervisor requires a different update model: - * AWS requires a model of - type EditHypervisorAWSConnectionRequestModel. - * AzureRM requires a model of - type EditHypervisorAzureConnectionRequestModel. - * GoogleCloudPlatform - requires a model of type - EditHypervisorGCPConnectionRequestModel. - * OracleCloudInfrastructure - requires a model of type - EditHypervisorOciConnectionRequestModel. - * All other hypervisor types require a model of type - EditHypervisorTraditionalConnectionRequestModel. - required: true - x-name: model - x-position: 1 + x-position: 4 + - description: "If set to true, filters in the policy are read" + explode: true + in: query + name: withFilters + required: false + schema: + nullable: true + title: Boolean + type: boolean + style: form + x-position: 5 responses: - "204": - description: Operation is successful with no response content. + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/CollectionEnvelopeOfPolicyResponse' + description: Collection of policies headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -138191,16 +137656,21 @@ paths: schema: type: string style: simple - "202": - description: Async request was accepted and is being processed. - headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime schema: - type: string - style: simple + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -138252,20 +137722,20 @@ paths: schema: type: string style: simple - "400": + "401": content: application/json: example: - https://errors-api.cloud.com/common/outOfRange: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: property - value: startTime + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -138318,20 +137788,22 @@ paths: schema: type: string style: simple - "401": + "403": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - - name: reason - value: missing + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -138384,22 +137856,20 @@ paths: schema: type: string style: simple - "403": + "406": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -138452,22 +137922,21 @@ paths: schema: type: string style: simple - "404": + "429": content: application/json: example: - https://errors-api.cloud.com/common/notFound: + https://errors-api.cloud.com/common/rateLimitExceeded: value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. + description: Caller has made too many requests in a short period of time + and is being rate-limited. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -138520,20 +137989,21 @@ paths: schema: type: string style: simple - "406": + "503": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/serviceUnavailable: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds parameters: - - name: contentType - value: application/json + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -138586,21 +138056,21 @@ paths: schema: type: string style: simple - "415": + "500": content: application/json: example: - https://errors-api.cloud.com/common/unsupportedMediaType: + https://errors-api.cloud.com/common/internalServerError: value: - type: https://errors-api.cloud.com/common/unsupportedMediaType - detail: Must use application/json;charset=utf-8 media type + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds parameters: - - name: mediaType - value: application/xml + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must send request body in utf-8 and specify request - Content-Type as utf-8. + description: An unexpected server error occurred. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -138653,21 +138123,167 @@ paths: schema: type: string style: simple - "429": + summary: Read all policies defined in a policy set. Policy templates don't have + filters. + tags: + - Gpo + post: + operationId: Gpo_CreateGpoPolicy + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + - description: GUID of the policy set in which the new policy is created + explode: true + in: query + name: policySetGuid + required: true + schema: + format: guid + title: Guid + type: string + style: form + x-position: 3 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyRequest' + description: Data for the new policy + required: true + x-name: request + x-position: 4 + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyResponse' + description: The newly created policy + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "400": content: application/json: example: - https://errors-api.cloud.com/common/rateLimitExceeded: + https://errors-api.cloud.com/common/outOfRange: value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range parameters: - - name: retryDelay - value: "4" + - name: property + value: startTime schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. + description: Caller passed an invalid input. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -138720,21 +138336,20 @@ paths: schema: type: string style: simple - "503": + "401": content: application/json: example: - https://errors-api.cloud.com/common/serviceUnavailable: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/serviceUnavailable - detail: Service is unavailable; try again in 4 seconds + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: retryDelay - value: "4" + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: "Service is temporarily unable to process the request. Caller\ - \ may attempt the operation again, with exponential back-off." + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -138787,21 +138402,22 @@ paths: schema: type: string style: simple - "500": + "403": content: application/json: example: - https://errors-api.cloud.com/common/internalServerError: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/internalServerError - detail: An internal server error has occurred; try again in 4 - seconds + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - - name: retryDelay - value: "4" + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: An unexpected server error occurred. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -138854,100 +138470,20 @@ paths: schema: type: string style: simple - summary: Update a hypervisor. - tags: - - Hypervisors APIs - /hypervisors/{nameOrId}/$resetConnection: - post: - operationId: Hypervisors_ResetBrokerHypervisorConnection - parameters: - - description: Citrix Customer ID. Default is 'CitrixOnPremises' - example: CitrixOnPremises - explode: false - in: header - name: Citrix-CustomerId - required: true - schema: - type: string - style: simple - - description: Citrix Instance (Site) ID. - explode: false - in: header - name: Citrix-InstanceId - required: true - schema: - type: string - style: simple - - description: User Agent type of the request. - example: Mozilla/5.0 - explode: false - in: header - name: User-Agent - required: false - schema: - type: string - style: simple - - description: "Citrix authorization header: CWSAuth Bearer={token}" - explode: false - in: header - name: Authorization - required: false - schema: - type: string - style: simple - - description: "Transaction ID that will be used to track this request. If not\ - \ provided, a new GUID will be generated and returned." - explode: false - in: header - name: Citrix-TransactionId - required: false - schema: - type: string - style: simple - - description: Must accept application/json. - example: application/json - explode: false - in: header - name: Accept - required: false - schema: - type: string - style: simple - - description: Locale of the request. - example: en-US - explode: false - in: header - name: Citrix-Locale - required: false - schema: - type: string - style: simple - - description: 'Hypervisor connection name or id. ' - explode: false - in: path - name: nameOrId - required: true - schema: - nullable: true - title: String - type: string - style: simple - x-position: 1 - - description: 'If async calling. ' - explode: true - in: query - name: async - required: false - schema: - default: false - nullable: true - title: Boolean - type: boolean - style: form - x-position: 2 - responses: - "204": - description: Operation is successful with no response content. + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -139000,16 +138536,19 @@ paths: schema: type: string style: simple - "202": - description: Async request was accepted and is being processed. - headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false + "409": + content: + application/json: + example: + https://errors-api.cloud.com/common/optimisticConcurrency: + value: + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null schema: - type: string - style: simple + $ref: '#/components/schemas/ErrorResponse' + description: Caller requested an invalid relation to be created or deleted. + headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -139061,20 +138600,21 @@ paths: schema: type: string style: simple - "400": + "415": content: application/json: example: - https://errors-api.cloud.com/common/outOfRange: + https://errors-api.cloud.com/common/unsupportedMediaType: value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type parameters: - - name: property - value: startTime + - name: mediaType + value: application/xml schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -139127,20 +138667,21 @@ paths: schema: type: string style: simple - "401": + "429": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/rateLimitExceeded: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds parameters: - - name: reason - value: missing + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: Caller has made too many requests in a short period of time + and is being rate-limited. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -139193,22 +138734,21 @@ paths: schema: type: string style: simple - "403": + "503": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/serviceUnavailable: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -139261,22 +138801,21 @@ paths: schema: type: string style: simple - "404": + "500": content: application/json: example: - https://errors-api.cloud.com/common/notFound: + https://errors-api.cloud.com/common/internalServerError: value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. + description: An unexpected server error occurred. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -139329,20 +138868,96 @@ paths: schema: type: string style: simple - "406": - content: - application/json: - example: - https://errors-api.cloud.com/common/notAcceptable: - value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type - parameters: - - name: contentType - value: application/json - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + summary: Create a new policy. Policies cannot be created in the policy set of + type SiteTemplates. + tags: + - Gpo + /gpo/policies/$copy: + post: + operationId: Gpo_CopyGpoPolicies + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + - description: Specify if policy filters should be included + explode: true + in: query + name: withFilters + required: true + schema: + title: Boolean + type: boolean + style: form + x-position: 3 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CopyPoliciesRequest' + required: true + x-name: request + x-position: 4 + responses: + "204": + description: Operation is successful with no response content. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -139395,18 +139010,20 @@ paths: schema: type: string style: simple - "409": + "400": content: application/json: example: - https://errors-api.cloud.com/common/optimisticConcurrency: + https://errors-api.cloud.com/common/outOfRange: value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. + description: Caller passed an invalid input. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -139459,21 +139076,20 @@ paths: schema: type: string style: simple - "429": + "401": content: application/json: example: - https://errors-api.cloud.com/common/rateLimitExceeded: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: retryDelay - value: "4" + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -139526,21 +139142,22 @@ paths: schema: type: string style: simple - "503": + "403": content: application/json: example: - https://errors-api.cloud.com/common/serviceUnavailable: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/serviceUnavailable - detail: Service is unavailable; try again in 4 seconds + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - - name: retryDelay - value: "4" + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: "Service is temporarily unable to process the request. Caller\ - \ may attempt the operation again, with exponential back-off." + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -139593,21 +139210,20 @@ paths: schema: type: string style: simple - "500": + "406": content: application/json: example: - https://errors-api.cloud.com/common/internalServerError: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/internalServerError - detail: An internal server error has occurred; try again in 4 - seconds + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type parameters: - - name: retryDelay - value: "4" + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: An unexpected server error occurred. + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -139660,122 +139276,18 @@ paths: schema: type: string style: simple - summary: |- - Requests the broker hypervisor connection to be reset. - The connection is dropped, details including credentials refreshed and - the connection reestablished. The reset request is asynchronous and - may take a moment to occur. - tags: - - Hypervisors APIs - /Hypervisors/{nameOrId}/$test: - post: - description: |- - Run tests on a hypervisor and create a test report. Obtain the most - recent report from - GetHypervisorTestReport. - operationId: Hypervisors_TestHypervisor - parameters: - - description: Citrix Customer ID. Default is 'CitrixOnPremises' - example: CitrixOnPremises - explode: false - in: header - name: Citrix-CustomerId - required: true - schema: - type: string - style: simple - - description: Citrix Instance (Site) ID. - explode: false - in: header - name: Citrix-InstanceId - required: true - schema: - type: string - style: simple - - description: User Agent type of the request. - example: Mozilla/5.0 - explode: false - in: header - name: User-Agent - required: false - schema: - type: string - style: simple - - description: "Citrix authorization header: CWSAuth Bearer={token}" - explode: false - in: header - name: Authorization - required: false - schema: - type: string - style: simple - - description: "Transaction ID that will be used to track this request. If not\ - \ provided, a new GUID will be generated and returned." - explode: false - in: header - name: Citrix-TransactionId - required: false - schema: - type: string - style: simple - - description: Must accept application/json. - example: application/json - explode: false - in: header - name: Accept - required: false - schema: - type: string - style: simple - - description: Locale of the request. - example: en-US - explode: false - in: header - name: Citrix-Locale - required: false - schema: - type: string - style: simple - - description: Name or ID of the hypervisor to test. - explode: false - in: path - name: nameOrId - required: true - schema: - nullable: true - title: String - type: string - style: simple - x-position: 1 - - description: |- - If `true`, the tests will run as a background task. This is recommended as the - tests may take some time to run, and if it exceeds 90 seconds the request may - time out. - The task will have JobType TestHypervisor. - When the task is complete it will redirect to - GetJobResults. - The job's Parameters will contain properties: - - * _Id_ - ID of the hypervisor being tested, - * _Name_ - Name of the hypervisor being tested. - explode: true - in: query - name: async - required: false - schema: - default: false - nullable: true - title: Boolean - type: boolean - style: form - x-position: 2 - responses: - "200": + "409": content: application/json: + example: + https://errors-api.cloud.com/common/optimisticConcurrency: + value: + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null schema: - $ref: '#/components/schemas/HypervisorTestResponseModel' - description: Test response. + $ref: '#/components/schemas/ErrorResponse' + description: Caller requested an invalid relation to be created or deleted. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -139828,16 +139340,22 @@ paths: schema: type: string style: simple - "202": - description: Async request was accepted and is being processed. - headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false + "415": + content: + application/json: + example: + https://errors-api.cloud.com/common/unsupportedMediaType: + value: + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type + parameters: + - name: mediaType + value: application/xml schema: - type: string - style: simple + $ref: '#/components/schemas/ErrorResponse' + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. + headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -139889,20 +139407,21 @@ paths: schema: type: string style: simple - "400": + "429": content: application/json: example: - https://errors-api.cloud.com/common/outOfRange: + https://errors-api.cloud.com/common/rateLimitExceeded: value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds parameters: - - name: property - value: startTime + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + description: Caller has made too many requests in a short period of time + and is being rate-limited. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -139955,20 +139474,21 @@ paths: schema: type: string style: simple - "401": + "503": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/serviceUnavailable: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds parameters: - - name: reason - value: missing + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -140021,22 +139541,21 @@ paths: schema: type: string style: simple - "403": + "500": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/internalServerError: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: An unexpected server error occurred. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -140089,22 +139608,92 @@ paths: schema: type: string style: simple - "404": - content: - application/json: - example: - https://errors-api.cloud.com/common/notFound: - value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found - parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 - schema: - $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. + summary: Copy some policies of a policy set to other policy sets. + tags: + - Gpo + /gpo/policies/$disable: + post: + operationId: Gpo_DisableGpoPolicies + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + requestBody: + content: + application/json: + schema: + items: + format: guid + title: Guid + type: string + nullable: true + title: "Guid[]" + type: array + description: GUIDs of the policies to be disabled + required: true + x-name: policyGuids + x-position: 3 + responses: + "204": + description: Operation is successful with no response content. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -140157,20 +139746,20 @@ paths: schema: type: string style: simple - "406": + "400": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/outOfRange: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range parameters: - - name: contentType - value: application/json + - name: property + value: startTime schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + description: Caller passed an invalid input. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -140223,18 +139812,20 @@ paths: schema: type: string style: simple - "409": + "401": content: application/json: example: - https://errors-api.cloud.com/common/optimisticConcurrency: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -140287,21 +139878,22 @@ paths: schema: type: string style: simple - "429": + "403": content: application/json: example: - https://errors-api.cloud.com/common/rateLimitExceeded: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - - name: retryDelay - value: "4" + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -140354,21 +139946,20 @@ paths: schema: type: string style: simple - "503": + "406": content: application/json: example: - https://errors-api.cloud.com/common/serviceUnavailable: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/serviceUnavailable - detail: Service is unavailable; try again in 4 seconds + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type parameters: - - name: retryDelay - value: "4" + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: "Service is temporarily unable to process the request. Caller\ - \ may attempt the operation again, with exponential back-off." + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -140421,21 +140012,18 @@ paths: schema: type: string style: simple - "500": + "409": content: application/json: example: - https://errors-api.cloud.com/common/internalServerError: + https://errors-api.cloud.com/common/optimisticConcurrency: value: - type: https://errors-api.cloud.com/common/internalServerError - detail: An internal server error has occurred; try again in 4 - seconds - parameters: - - name: retryDelay - value: "4" + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null schema: $ref: '#/components/schemas/ErrorResponse' - description: An unexpected server error occurred. + description: Caller requested an invalid relation to be created or deleted. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -140488,137 +140076,21 @@ paths: schema: type: string style: simple - summary: Run tests on a hypervisor and create a test report. - tags: - - Hypervisors APIs - /hypervisors/{nameOrId}/administrators: - get: - description: Get administrators who can administer a hypervisor. - operationId: Hypervisors_GetHypervisorAdministrators - parameters: - - description: Citrix Customer ID. Default is 'CitrixOnPremises' - example: CitrixOnPremises - explode: false - in: header - name: Citrix-CustomerId - required: true - schema: - type: string - style: simple - - description: Citrix Instance (Site) ID. - explode: false - in: header - name: Citrix-InstanceId - required: true - schema: - type: string - style: simple - - description: User Agent type of the request. - example: Mozilla/5.0 - explode: false - in: header - name: User-Agent - required: false - schema: - type: string - style: simple - - description: "Citrix authorization header: CWSAuth Bearer={token}" - explode: false - in: header - name: Authorization - required: false - schema: - type: string - style: simple - - description: "Transaction ID that will be used to track this request. If not\ - \ provided, a new GUID will be generated and returned." - explode: false - in: header - name: Citrix-TransactionId - required: false - schema: - type: string - style: simple - - description: Must accept application/json. - example: application/json - explode: false - in: header - name: Accept - required: false - schema: - type: string - style: simple - - description: Locale of the request. - example: en-US - explode: false - in: header - name: Citrix-Locale - required: false - schema: - type: string - style: simple - - description: Name or ID of the hypervisor. - explode: false - in: path - name: nameOrId - required: true - schema: - nullable: true - title: String - type: string - style: simple - x-position: 1 - - description: 'If async execute. ' - explode: true - in: query - name: async - required: false - schema: - default: false - nullable: true - title: Boolean - type: boolean - style: form - x-position: 2 - - description: |- - The max number of administrators returned by this query. - If not specified, the server might use a default limit of 250 items. - If the specified value is larger than 1000, the server might reject the call. - The default and maximum values depend on server settings. - explode: true - in: query - name: limit - required: false - schema: - format: int32 - nullable: true - title: Int32 - type: integer - style: form - x-position: 3 - - description: |- - If a query cannot be completed, the response will have a - ContinuationToken set. - To obtain more results from the query, pass the - continuation token back into the query to get the next - batch of results. - explode: true - in: query - name: continuationToken - required: false - schema: - nullable: true - title: String - type: string - style: form - x-position: 4 - responses: - "200": + "415": content: application/json: + example: + https://errors-api.cloud.com/common/unsupportedMediaType: + value: + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type + parameters: + - name: mediaType + value: application/xml schema: - $ref: '#/components/schemas/AdministratorResponseModelCollection' - description: List of administrators. + $ref: '#/components/schemas/ErrorResponse' + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -140671,16 +140143,22 @@ paths: schema: type: string style: simple - "202": - description: Async request was accepted and is being processed. - headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false + "429": + content: + application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" schema: - type: string - style: simple + $ref: '#/components/schemas/ErrorResponse' + description: Caller has made too many requests in a short period of time + and is being rate-limited. + headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -140732,20 +140210,21 @@ paths: schema: type: string style: simple - "400": + "503": content: application/json: example: - https://errors-api.cloud.com/common/outOfRange: + https://errors-api.cloud.com/common/serviceUnavailable: value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds parameters: - - name: property - value: startTime + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -140798,20 +140277,21 @@ paths: schema: type: string style: simple - "401": + "500": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/internalServerError: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds parameters: - - name: reason - value: missing + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: An unexpected server error occurred. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -140864,22 +140344,92 @@ paths: schema: type: string style: simple - "403": - content: - application/json: - example: - https://errors-api.cloud.com/common/authorization: - value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied - parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + summary: Disable some policies of a policy set. + tags: + - Gpo + /gpo/policies/$enable: + post: + operationId: Gpo_EnableGpoPolicies + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + requestBody: + content: + application/json: + schema: + items: + format: guid + title: Guid + type: string + nullable: true + title: "Guid[]" + type: array + description: GUIDs of the policies to be enabled + required: true + x-name: policyGuids + x-position: 3 + responses: + "204": + description: Operation is successful with no response content. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -140932,22 +140482,154 @@ paths: schema: type: string style: simple - "404": + "400": content: application/json: example: - https://errors-api.cloud.com/common/notFound: + https://errors-api.cloud.com/common/outOfRange: value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: property + value: startTime schema: $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. + description: Caller passed an invalid input. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "401": + content: + application/json: + example: + https://errors-api.cloud.com/common/authentication: + value: + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller did not present a valid bearer token. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "403": + content: + application/json: + example: + https://errors-api.cloud.com/common/authorization: + value: + type: https://errors-api.cloud.com/common/authorization + detail: Access denied + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -141066,6 +140748,137 @@ paths: schema: type: string style: simple + "409": + content: + application/json: + example: + https://errors-api.cloud.com/common/optimisticConcurrency: + value: + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller requested an invalid relation to be created or deleted. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "415": + content: + application/json: + example: + https://errors-api.cloud.com/common/unsupportedMediaType: + value: + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type + parameters: + - name: mediaType + value: application/xml + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple "429": content: application/json: @@ -141267,27 +141080,12 @@ paths: schema: type: string style: simple - summary: Get administrators who can administer a hypervisor. + summary: Enable some policies of a policy set. tags: - - Hypervisors APIs - /hypervisors/{nameOrId}/allResources: - get: - description: |- - Get the resources within a hypervisor. Note: in previous versions - of the API, this was referred to as a "Connection". - A caller can recursively enumerate by: - * Call with no `path`, and `children` equal to `1`. - * For each of the result's - Children where - IsContainer is - `true`, call with `path` equal to that item's - RelativePath and - `children` equal to `1`. - * Repeat recursively. - URI with ?noCache=true can ignore the cache and fetch the data directly. - URI with ?force=true can get the VMs which provisioned by MCS. - URI with ?recurse=true can recurse fetch all resources under this folder. - operationId: Hypervisors_GetHypervisorAllResources + - Gpo + /gpo/policies/$move: + post: + operationId: Gpo_MoveGpoPolicies parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -141350,138 +141148,35 @@ paths: schema: type: string style: simple - - description: Name or ID of the hypervisor. - explode: false - in: path - name: nameOrId - required: true - schema: - nullable: true - title: String - type: string - style: simple - x-position: 1 - - description: |- - Path to the resource container within the hypervisor. The path may - either be a relative path as specified by - RelativePath, or - may be a URL-encoded XenApp & XenDesktop resource path starting - with `XDHyp:`; for example, as specified by - XDPath. + - description: GUID of the destination policy set explode: true in: query - name: path - required: false + name: toPolicySet + required: true schema: - nullable: true - title: String + format: guid + title: Guid type: string style: form - x-position: 2 - - description: |- - Specifies the number of levels of children to enumerate. - Default is `0`, meaning that only the object referred to by `path` - is returned and its - Children array will be left - null. - A special value of `-1` indicates that the entire resource hierarchy - should be enumerated. Use with care! It may take a very long time - to enumerate a large number of resources from a hypervisor, and the - call may time out before completing. - explode: true - in: query - name: children - required: false - schema: - format: int32 - nullable: true - title: Int32 - type: integer - style: form x-position: 3 - - description: "If specified, limits the results to the specified resource type(s)." - explode: true - in: query - name: type - required: false - schema: - items: - title: String - type: string - nullable: true - title: "String[]" - type: array - style: form + requestBody: + content: + application/json: + schema: + items: + format: guid + title: Guid + type: string + nullable: true + title: "Guid[]" + type: array + description: GUIDs of the policies to be removed + required: true + x-name: policyGuids x-position: 4 - - description: |- - By default, items which are tagged by XenDesktop are not shown. Set - this to `true` to override that behavior. - explode: true - in: query - name: showTagged - required: false - schema: - nullable: true - title: Boolean - type: boolean - style: form - x-position: 5 - - description: |- - If `true`, full details of VMs, snapshots, and templates will be - retrieved. This can be very time consuming and will reduce the - performance of the call. May only be used if `path` refers to a VM, - snapshot, or template resource. - - explode: true - in: query - name: detail - required: false - schema: - nullable: true - title: Boolean - type: boolean - style: form - x-position: 6 - - description: Async request to get the resources with *path. - explode: true - in: query - name: async - required: false - schema: - default: false - nullable: true - title: Boolean - type: boolean - style: form - x-position: 7 responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/HypervisorResourceResponseModel' - description: |- - A list of hypervisor resources. - or - A list of hypervisor resources. - or - A list of hypervisor resources. - or - A list of hypervisor resources. - or - A list of hypervisor resources. - or - A list of hypervisor resources. - or - A list of hypervisor resources. - or - A list of hypervisor resources. - or - A list of hypervisor resources. - or - A list of hypervisor resources. - or - A list of hypervisor resources. + "204": + description: Operation is successful with no response content. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -141534,61 +141229,21 @@ paths: schema: type: string style: simple - x-expectedSchemas: - - description: A list of hypervisor resources. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorAvailabilityZoneResourceResponseModel' - - description: A list of hypervisor resources. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorGpuTypeResourceResponseModel' - - description: A list of hypervisor resources. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorSecurityGroupResourceResponseModel' - - description: A list of hypervisor resources. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorServiceOfferingResourceResponseModel' - - description: A list of hypervisor resources. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorStorageResourceResponseModel' - - description: A list of hypervisor resources. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorTemplateResourceResponseModel' - - description: A list of hypervisor resources. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorVmResourceResponseModel' - - description: A list of hypervisor resources. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorVmSnapshotResourceResponseModel' - - description: A list of hypervisor resources. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorVpcResourceResponseModel' - - description: A list of hypervisor resources. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorCloudRegionResourceResponseModel' - - description: A list of hypervisor resources. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorResourceResponseModel' - "202": - description: Async request was accepted and is being processed. - headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime schema: - type: string - style: simple + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -141640,20 +141295,20 @@ paths: schema: type: string style: simple - "400": + "401": content: application/json: example: - https://errors-api.cloud.com/common/outOfRange: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: property - value: startTime + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -141706,20 +141361,22 @@ paths: schema: type: string style: simple - "401": + "403": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - - name: reason - value: missing + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -141772,22 +141429,20 @@ paths: schema: type: string style: simple - "403": + "406": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -141840,22 +141495,18 @@ paths: schema: type: string style: simple - "404": + "409": content: application/json: example: - https://errors-api.cloud.com/common/notFound: + https://errors-api.cloud.com/common/optimisticConcurrency: value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found - parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null schema: $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. + description: Caller requested an invalid relation to be created or deleted. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -141908,20 +141559,21 @@ paths: schema: type: string style: simple - "406": + "415": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/unsupportedMediaType: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type parameters: - - name: contentType - value: application/json + - name: mediaType + value: application/xml schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -142175,12 +141827,12 @@ paths: schema: type: string style: simple - summary: Get all resources within a hypervisor. + summary: Move some policies of a policy set to another policy set. tags: - - Hypervisors APIs - /hypervisors/{nameOrId}/connection: - put: - operationId: Hypervisors_PutBrokerHypervisorConnection + - Gpo + /gpo/policies/$remove: + post: + operationId: Gpo_RemoveGpoPolicies parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -142243,38 +141895,21 @@ paths: schema: type: string style: simple - - description: 'Hypervisor connection name or id. ' - explode: false - in: path - name: nameOrId - required: true - schema: - nullable: true - title: String - type: string - style: simple - x-position: 2 - - description: 'If async calling. ' - explode: true - in: query - name: async - required: false - schema: - default: false - nullable: true - title: Boolean - type: boolean - style: form - x-position: 3 requestBody: content: application/json: schema: - $ref: '#/components/schemas/EditBrokerHypervisorConnectionRequestModel' - description: 'EditBrokerHypervisorConnectionRequestModel or derived objects. ' + items: + format: guid + title: Guid + type: string + nullable: true + title: "Guid[]" + type: array + description: GUIDs of the policies to be removed required: true - x-name: model - x-position: 1 + x-name: policyGuids + x-position: 3 responses: "204": description: Operation is successful with no response content. @@ -142330,16 +141965,87 @@ paths: schema: type: string style: simple - "202": - description: Async request was accepted and is being processed. + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json explode: false schema: type: string style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "401": + content: + application/json: + example: + https://errors-api.cloud.com/common/authentication: + value: + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller did not present a valid bearer token. + headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -142391,20 +142097,22 @@ paths: schema: type: string style: simple - "400": + "403": content: application/json: example: - https://errors-api.cloud.com/common/outOfRange: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - - name: property - value: startTime + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -142457,20 +142165,20 @@ paths: schema: type: string style: simple - "401": + "406": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type parameters: - - name: reason - value: missing + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -142523,22 +142231,85 @@ paths: schema: type: string style: simple - "403": + "409": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/optimisticConcurrency: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller requested an invalid relation to be created or deleted. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "415": + content: + application/json: + example: + https://errors-api.cloud.com/common/unsupportedMediaType: + value: + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: mediaType + value: application/xml schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -142591,22 +142362,21 @@ paths: schema: type: string style: simple - "404": + "429": content: application/json: example: - https://errors-api.cloud.com/common/notFound: + https://errors-api.cloud.com/common/rateLimitExceeded: value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. + description: Caller has made too many requests in a short period of time + and is being rate-limited. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -142659,221 +142429,21 @@ paths: schema: type: string style: simple - "406": + "503": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/serviceUnavailable: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds parameters: - - name: contentType - value: application/json + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "415": - content: - application/json: - example: - https://errors-api.cloud.com/common/unsupportedMediaType: - value: - type: https://errors-api.cloud.com/common/unsupportedMediaType - detail: Must use application/json;charset=utf-8 media type - parameters: - - name: mediaType - value: application/xml - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller must send request body in utf-8 and specify request - Content-Type as utf-8. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "429": - content: - application/json: - example: - https://errors-api.cloud.com/common/rateLimitExceeded: - value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds - parameters: - - name: retryDelay - value: "4" - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "503": - content: - application/json: - example: - https://errors-api.cloud.com/common/serviceUnavailable: - value: - type: https://errors-api.cloud.com/common/serviceUnavailable - detail: Service is unavailable; try again in 4 seconds - parameters: - - name: retryDelay - value: "4" - schema: - $ref: '#/components/schemas/ErrorResponse' - description: "Service is temporarily unable to process the request. Caller\ - \ may attempt the operation again, with exponential back-off." + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -142993,13 +142563,12 @@ paths: schema: type: string style: simple - summary: Set the properties on a broker hypervisor connection. + summary: Remove some policies of a policy set. tags: - - Hypervisors APIs - /hypervisors/{nameOrId}/deletePreview: - get: - description: Get the machine catalogs and related info that are using a hypervisor. - operationId: Hypervisors_GetHypervisorDeletePreview + - Gpo + /gpo/policies/$search: + post: + operationId: Gpo_SearchPolicies parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -143062,18 +142631,34 @@ paths: schema: type: string style: simple - - description: Name or ID of the hypervisor. - explode: false - in: path - name: nameOrId - required: true + - description: "Maximum number of objects, which must not exceed 1000, to return.\ + \ If not specified, the default value is 250." + explode: true + in: query + name: limit + required: false + schema: + format: int32 + nullable: true + title: Int32 + type: integer + style: form + x-position: 2 + - description: |- + If a previous call didn't return all the records expected, pass the continuation token returned from the + previous response to this current query to continue retrieving the remaining objects. + explode: true + in: query + name: continuationToken + required: false schema: nullable: true title: String type: string - style: simple - x-position: 1 - - description: 'If execute this API asynchronous. ' + style: form + x-position: 3 + - description: "If `true`, the search operations will be executed as a background\ + \ task." explode: true in: query name: async @@ -143084,14 +142669,23 @@ paths: title: Boolean type: boolean style: form - x-position: 2 + x-position: 4 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PolicySearch' + description: Specifies the advanced search parameters. + required: true + x-name: request + x-position: 1 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/HypervisorDeletePreviewResponseModel' - description: HypervisorDeletePreviewResponseModel object. + $ref: '#/components/schemas/CollectionEnvelopeOfPolicyResponse' + description: List of policy sets that match the search criteria. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -143405,22 +142999,20 @@ paths: schema: type: string style: simple - "404": + "406": content: application/json: example: - https://errors-api.cloud.com/common/notFound: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -143473,20 +143065,85 @@ paths: schema: type: string style: simple - "406": + "409": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/optimisticConcurrency: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller requested an invalid relation to be created or deleted. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "415": + content: + application/json: + example: + https://errors-api.cloud.com/common/unsupportedMediaType: + value: + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type parameters: - - name: contentType - value: application/json + - name: mediaType + value: application/xml schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -143740,13 +143397,12 @@ paths: schema: type: string style: simple - summary: Get the hypervisor delete preview. + summary: Perform an advanced search for GPO policies. tags: - - Hypervisors APIs - /hypervisors/{nameOrId}/jobs: - get: - description: Get the currently active provisioning jobs that are using a hypervisor. - operationId: Hypervisors_GetHypervisorJobs + - Gpo + /gpo/policies/{policyGuid}: + delete: + operationId: Gpo_DeleteGpoPolicy parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -143809,24 +143465,20 @@ paths: schema: type: string style: simple - - description: Name or ID of the hypervisor. + - description: GUID of the policy to be deleted explode: false in: path - name: nameOrId + name: policyGuid required: true schema: - nullable: true - title: String + format: guid + title: Guid type: string style: simple - x-position: 1 + x-position: 3 responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/JobResponseModelCollection' - description: List of machine catalogs that are using a hypervisor. + "204": + description: Operation is successful with no response content. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -144080,20 +143732,6 @@ paths: type: string style: simple "404": - content: - application/json: - example: - https://errors-api.cloud.com/common/notFound: - value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found - parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 - schema: - $ref: '#/components/schemas/ErrorResponse' description: A referenced entity was not found. headers: Citrix-TransactionId: @@ -144213,6 +143851,70 @@ paths: schema: type: string style: simple + "409": + content: + application/json: + example: + https://errors-api.cloud.com/common/optimisticConcurrency: + value: + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller requested an invalid relation to be created or deleted. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple "429": content: application/json: @@ -144414,13 +144116,13 @@ paths: schema: type: string style: simple - summary: Get the currently active jobs that are using a hypervisor. + summary: |- + Delete an existing GPO policy. A policy in the policy set of type SiteTemplates cannot be deleted. The + Unfiltered policy in the policy set of type SitePolicies cannot be deleted. tags: - - Hypervisors APIs - /hypervisors/{nameOrId}/machineCatalogs: + - Gpo get: - description: Get the machine catalogs that are using a hypervisor. - operationId: Hypervisors_GetHypervisorMachineCatalogs + operationId: Gpo_ReadGpoPolicy parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -144483,68 +144185,46 @@ paths: schema: type: string style: simple - - description: Name or ID of the hypervisor. + - description: GUID of the policy to be read explode: false in: path - name: nameOrId + name: policyGuid required: true schema: - nullable: true - title: String + format: guid + title: Guid type: string style: simple - x-position: 1 - - description: 'If async execute. ' + x-position: 3 + - description: "If set to true, read policy settings" explode: true in: query - name: async + name: withSettings required: false schema: - default: false nullable: true title: Boolean type: boolean style: form - x-position: 2 - - description: |- - The max number of machine catalogs returned by this query. - If not specified, the server might use a default limit of 250 items. - If the specified value is larger than 1000, the server might reject the call. - The default and maximum values depend on server settings. - explode: true - in: query - name: limit - required: false - schema: - format: int32 - nullable: true - title: Int32 - type: integer - style: form - x-position: 3 - - description: |- - If a query cannot be completed, the response will have a - ContinuationToken set. - To obtain more results from the query, pass the - continuation token back into the query to get the next - batch of results. + x-position: 4 + - description: "If set to true, read policy filters" explode: true in: query - name: continuationToken + name: withFilters required: false schema: nullable: true - title: String - type: string + title: Boolean + type: boolean style: form - x-position: 4 + x-position: 5 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/HypervisorMachineCatalogResponseModelCollection' - description: List of machine catalogs that are using a hypervisor. + $ref: '#/components/schemas/PolicyResponse' + description: The policy read headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -144597,16 +144277,21 @@ paths: schema: type: string style: simple - "202": - description: Async request was accepted and is being processed. - headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime schema: - type: string - style: simple + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -144658,86 +144343,20 @@ paths: schema: type: string style: simple - "400": + "401": content: application/json: example: - https://errors-api.cloud.com/common/outOfRange: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: property - value: startTime + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "401": - content: - application/json: - example: - https://errors-api.cloud.com/common/authentication: - value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details - parameters: - - name: reason - value: missing - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -145193,13 +144812,11 @@ paths: schema: type: string style: simple - summary: Get the machine catalogs that are using a hypervisor. + summary: Read a policy. A policy template doesn't have filters. tags: - - Hypervisors APIs - /Hypervisors/{nameOrId}/OrphanedResources: - get: - description: Run detect on a hypervisor and get a orphaned resources result. - operationId: Hypervisors_GetHypervisorOrphanedResources + - Gpo + patch: + operationId: Gpo_UpdateGpoPolicy parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -145262,42 +144879,95 @@ paths: schema: type: string style: simple - - description: Name or ID of the hypervisor to detect. + - description: GUID of the policy to be updated explode: false in: path - name: nameOrId + name: policyGuid required: true schema: - nullable: true - title: String + format: guid + title: Guid type: string style: simple - x-position: 1 - - description: |- - If `true`, the tests will run as a background task. This is recommended as the - tests may take some time to run, and if it exceeds 90 seconds the request may - time out. - - * _Id_ - ID of the hypervisor being detected, - * _Name_ - Name of the hypervisor being detected. - explode: true - in: query - name: async - required: false - schema: - default: false - nullable: true - title: Boolean - type: boolean - style: form - x-position: 2 + x-position: 3 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyBodyRequest' + description: New policy data + required: true + x-name: request + x-position: 4 responses: - "200": + "204": + description: Operation is successful with no response content. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "400": content: application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime schema: - $ref: '#/components/schemas/DetectOrphanedResourcesResponseModel' - description: Detect orphaned resource response. + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -145350,16 +145020,89 @@ paths: schema: type: string style: simple - "202": - description: Async request was accepted and is being processed. + "401": + content: + application/json: + example: + https://errors-api.cloud.com/common/authentication: + value: + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller did not present a valid bearer token. headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache explode: false schema: type: string style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "403": + content: + application/json: + example: + https://errors-api.cloud.com/common/authorization: + value: + type: https://errors-api.cloud.com/common/authorization + detail: Access denied + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller is not authorized to perform the operation. + headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -145411,146 +145154,14 @@ paths: schema: type: string style: simple - "400": - content: - application/json: - example: - https://errors-api.cloud.com/common/outOfRange: - value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range - parameters: - - name: property - value: startTime - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "401": - content: - application/json: - example: - https://errors-api.cloud.com/common/authentication: - value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details - parameters: - - name: reason - value: missing - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "403": + "404": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/notFound: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found parameters: - name: entityType value: https://identifiers-api.cloud.com/example/widget @@ -145558,7 +145169,7 @@ paths: value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: A referenced entity was not found. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -145611,22 +145222,20 @@ paths: schema: type: string style: simple - "404": + "406": content: application/json: example: - https://errors-api.cloud.com/common/notFound: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -145679,20 +145288,21 @@ paths: schema: type: string style: simple - "406": + "415": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/unsupportedMediaType: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type parameters: - - name: contentType - value: application/json + - name: mediaType + value: application/xml schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -145946,16 +145556,12 @@ paths: schema: type: string style: simple - summary: Run detect on a hypervisor and retrieve orphaned resources. + summary: Update a policy. Only the policy body is updated. tags: - - Hypervisors APIs - /hypervisors/{nameOrId}/resourcePools: - get: - description: |- - Get the list of hypervisor resource pools. Note: in previous versions of the API, - resource pools were referred to as "HostingUnits". - URI with ?noCache=true can ignore the cache and fetch the data directly. - operationId: Hypervisors_GetHypervisorResourcePools + - Gpo + /gpo/policyPriorities: + post: + operationId: Gpo_RankGpoPolicies parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -146018,35 +145624,39 @@ paths: schema: type: string style: simple - - description: Name or ID of the hypervisor. - explode: false - in: path - name: nameOrId - required: true - schema: - nullable: true - title: String - type: string - style: simple - x-position: 1 - - description: 'Async request to get the resource pool. ' + - description: Guid of the policy set that contains the policies explode: true in: query - name: async - required: false + name: policySetGuid + required: true schema: - default: false - title: Boolean - type: boolean + format: guid + title: Guid + type: string style: form - x-position: 2 + x-position: 3 + requestBody: + content: + application/json: + schema: + items: + title: String + type: string + nullable: true + title: List`1 + type: array + description: GUIDs of the policies to be re-prioritized + required: true + x-name: policyGuids + x-position: 4 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/HypervisorResourcePoolResponseModelCollection' - description: List of hypervisor resource pools. + title: Boolean + type: boolean + description: "" headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -146099,16 +145709,21 @@ paths: schema: type: string style: simple - "202": - description: Async request was accepted and is being processed. - headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime schema: - type: string - style: simple + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -146160,20 +145775,20 @@ paths: schema: type: string style: simple - "400": + "401": content: application/json: example: - https://errors-api.cloud.com/common/outOfRange: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: property - value: startTime + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -146226,20 +145841,22 @@ paths: schema: type: string style: simple - "401": + "403": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - - name: reason - value: missing + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -146292,22 +145909,20 @@ paths: schema: type: string style: simple - "403": + "406": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -146360,22 +145975,18 @@ paths: schema: type: string style: simple - "404": + "409": content: application/json: example: - https://errors-api.cloud.com/common/notFound: + https://errors-api.cloud.com/common/optimisticConcurrency: value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found - parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null schema: $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. + description: Caller requested an invalid relation to be created or deleted. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -146428,20 +146039,21 @@ paths: schema: type: string style: simple - "406": + "415": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/unsupportedMediaType: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type parameters: - - name: contentType - value: application/json + - name: mediaType + value: application/xml schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -146695,12 +146307,14 @@ paths: schema: type: string style: simple - summary: Get the list of hypervisor resource pools. + summary: |- + Specify new priority order for all existing policies in a policy set. All the policies in the policy set must + be specified, even if the priorities of only some of the policies are changed. tags: - - Hypervisors APIs - post: - description: Create a new resource pool on an existing hypervisor. - operationId: Hypervisors_CreateResourcePool + - Gpo + /gpo/policySets: + get: + operationId: Gpo_ReadGpoPolicySets parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -146763,60 +146377,14 @@ paths: schema: type: string style: simple - - description: Name or ID of the hypervisor. - explode: false - in: path - name: nameOrId - required: true - schema: - nullable: true - title: String - type: string - style: simple - x-position: 2 - - description: |- - If `true`, the resource pool (and associated objects) will be created as a - background task. - The task will have JobType CreateHypervisorResourcePool. - When the task is complete it will redirect to - GetHypervisorResourcePool. - The job's Parameters will contain properties: - * _Name_ - Name of the resource pool being created. - explode: true - in: query - name: async - required: false - schema: - default: false - nullable: true - title: Boolean - type: boolean - style: form - x-position: 3 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CreateHypervisorResourcePoolRequestModel' - description: Details of the resource pool to create. - required: true - x-name: model - x-position: 1 responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/HypervisorResourcePoolDetailResponseModel' - description: Resource was created. + $ref: '#/components/schemas/CollectionEnvelopeOfPolicySetResponse' + description: The policy sets in the site headers: - Location: - description: Location where the newly created resource resides. - example: /services/myservice/widgets/1 - explode: false - schema: - type: string - style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -146868,37 +146436,21 @@ paths: schema: type: string style: simple - x-expectedSchemas: - - description: Details of the resource pool that was created. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorResourcePoolAWSDetailResponseModel' - - description: Details of the resource pool that was created. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorResourcePoolAzureDetailResponseModel' - - description: Details of the resource pool that was created. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorResourcePoolGcpDetailResponseModel' - - description: Details of the resource pool that was created. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorResourcePoolTraditionalDetailResponseModel' - - description: Details of the resource pool that was created. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorResourcePoolDetailResponseModel' - "202": - description: Async request was accepted and is being processed. - headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime schema: - type: string - style: simple + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -146950,8 +146502,20 @@ paths: schema: type: string style: simple - "204": - description: Operation is successful with no response content. + "401": + content: + application/json: + example: + https://errors-api.cloud.com/common/authentication: + value: + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -147004,20 +146568,22 @@ paths: schema: type: string style: simple - "400": + "403": content: application/json: example: - https://errors-api.cloud.com/common/outOfRange: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - - name: property - value: startTime + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -147070,20 +146636,20 @@ paths: schema: type: string style: simple - "401": + "406": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type parameters: - - name: reason - value: missing + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -147136,22 +146702,21 @@ paths: schema: type: string style: simple - "403": + "429": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/rateLimitExceeded: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: Caller has made too many requests in a short period of time + and is being rate-limited. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -147204,22 +146769,21 @@ paths: schema: type: string style: simple - "404": + "503": content: application/json: example: - https://errors-api.cloud.com/common/notFound: + https://errors-api.cloud.com/common/serviceUnavailable: value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -147272,20 +146836,21 @@ paths: schema: type: string style: simple - "406": + "500": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/internalServerError: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds parameters: - - name: contentType - value: application/json + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + description: An unexpected server error occurred. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -147338,18 +146903,89 @@ paths: schema: type: string style: simple - "409": + summary: Get all GPO policy sets in the site. + tags: + - Gpo + post: + operationId: Gpo_CreateGpoPolicySet + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PolicySetRequest' + description: Parameters for the new policy set + required: true + x-name: request + x-position: 3 + responses: + "200": content: application/json: - example: - https://errors-api.cloud.com/common/optimisticConcurrency: - value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. + $ref: '#/components/schemas/PolicySetResponse' + description: The newly created policy set headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -147402,21 +147038,20 @@ paths: schema: type: string style: simple - "415": + "400": content: application/json: example: - https://errors-api.cloud.com/common/unsupportedMediaType: + https://errors-api.cloud.com/common/outOfRange: value: - type: https://errors-api.cloud.com/common/unsupportedMediaType - detail: Must use application/json;charset=utf-8 media type + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range parameters: - - name: mediaType - value: application/xml + - name: property + value: startTime schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must send request body in utf-8 and specify request - Content-Type as utf-8. + description: Caller passed an invalid input. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -147469,21 +147104,20 @@ paths: schema: type: string style: simple - "429": + "401": content: application/json: example: - https://errors-api.cloud.com/common/rateLimitExceeded: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: retryDelay - value: "4" + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -147536,21 +147170,22 @@ paths: schema: type: string style: simple - "503": + "403": content: application/json: example: - https://errors-api.cloud.com/common/serviceUnavailable: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/serviceUnavailable - detail: Service is unavailable; try again in 4 seconds + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - - name: retryDelay - value: "4" + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: "Service is temporarily unable to process the request. Caller\ - \ may attempt the operation again, with exponential back-off." + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -147603,21 +147238,20 @@ paths: schema: type: string style: simple - "500": + "406": content: application/json: example: - https://errors-api.cloud.com/common/internalServerError: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/internalServerError - detail: An internal server error has occurred; try again in 4 - seconds + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type parameters: - - name: retryDelay - value: "4" + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: An unexpected server error occurred. + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -147670,110 +147304,18 @@ paths: schema: type: string style: simple - summary: Create a new resource pool on an existing hypervisor. - tags: - - Hypervisors APIs - /hypervisors/{nameOrId}/resourcePools/{name}: - head: - description: |- - Check for the existence of a resource pool by name. Note that - resource pool names must be unique within the site, so the - `nameOrId` parameter does not affect whether the resource pool name - is found. - If the name is found to be available, this returns 404 Not Found. - If a resource pool by that name exists and is associated with the - specified hypervisor, this returns 204 No Content. If a resource - pool by that name exists and is associated with a different - hypervisor, this returns 303 See Other, and the `Location` response - header refers to location of the resource pool with that name. - operationId: Hypervisors_CheckHypervisorResourcePoolExists - parameters: - - description: Citrix Customer ID. Default is 'CitrixOnPremises' - example: CitrixOnPremises - explode: false - in: header - name: Citrix-CustomerId - required: true - schema: - type: string - style: simple - - description: Citrix Instance (Site) ID. - explode: false - in: header - name: Citrix-InstanceId - required: true - schema: - type: string - style: simple - - description: User Agent type of the request. - example: Mozilla/5.0 - explode: false - in: header - name: User-Agent - required: false - schema: - type: string - style: simple - - description: "Citrix authorization header: CWSAuth Bearer={token}" - explode: false - in: header - name: Authorization - required: false - schema: - type: string - style: simple - - description: "Transaction ID that will be used to track this request. If not\ - \ provided, a new GUID will be generated and returned." - explode: false - in: header - name: Citrix-TransactionId - required: false - schema: - type: string - style: simple - - description: Must accept application/json. - example: application/json - explode: false - in: header - name: Accept - required: false - schema: - type: string - style: simple - - description: Locale of the request. - example: en-US - explode: false - in: header - name: Citrix-Locale - required: false - schema: - type: string - style: simple - - description: Name or ID of the hypervisor. - explode: false - in: path - name: nameOrId - required: true - schema: - nullable: true - title: String - type: string - style: simple - x-position: 1 - - description: Name of the resource pool. - explode: false - in: path - name: name - required: true - schema: - nullable: true - title: String - type: string - style: simple - x-position: 2 - responses: - "204": - description: Operation is successful with no response content. + "409": + content: + application/json: + example: + https://errors-api.cloud.com/common/optimisticConcurrency: + value: + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller requested an invalid relation to be created or deleted. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -147826,20 +147368,21 @@ paths: schema: type: string style: simple - "400": + "415": content: application/json: example: - https://errors-api.cloud.com/common/outOfRange: + https://errors-api.cloud.com/common/unsupportedMediaType: value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type parameters: - - name: property - value: startTime + - name: mediaType + value: application/xml schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -147892,289 +147435,21 @@ paths: schema: type: string style: simple - "401": + "429": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/rateLimitExceeded: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds parameters: - - name: reason - value: missing + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "403": - content: - application/json: - example: - https://errors-api.cloud.com/common/authorization: - value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied - parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "404": - content: - application/json: - example: - https://errors-api.cloud.com/common/notFound: - value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found - parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 - schema: - $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "406": - content: - application/json: - example: - https://errors-api.cloud.com/common/notAcceptable: - value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type - parameters: - - name: contentType - value: application/json - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "429": - content: - application/json: - example: - https://errors-api.cloud.com/common/rateLimitExceeded: - value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds - parameters: - - name: retryDelay - value: "4" - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. + description: Caller has made too many requests in a short period of time + and is being rate-limited. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -148361,12 +147636,13 @@ paths: schema: type: string style: simple - summary: Check for the existence of a resource pool by name. + summary: Create a new GPO policy set. Only a policy set of type DeliveryGroupPolicies + can be created. tags: - - Hypervisors APIs - /hypervisors/{nameOrId}/resourcePools/{poolId}: - delete: - operationId: Hypervisors_DeleteHypervisorResourcePool + - Gpo + /gpo/policySets/$search: + post: + operationId: Gpo_SearchPolicySets parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -148429,42 +147705,61 @@ paths: schema: type: string style: simple - - description: 'The name or id of hypervisor. ' - explode: false - in: path - name: nameOrId - required: true + - description: "Maximum number of objects, which must not exceed 1000, to return.\ + \ If not specified, the default value is 250." + explode: true + in: query + name: limit + required: false schema: + format: int32 nullable: true - title: String - type: string - style: simple - x-position: 1 - - description: 'The hypervisor resource pool id. ' - explode: false - in: path - name: poolId - required: true + title: Int32 + type: integer + style: form + x-position: 2 + - description: |- + If a previous call didn't return all the records expected, pass the continuation token returned from the + previous response to this current query to continue retrieving the remaining objects. + explode: true + in: query + name: continuationToken + required: false schema: nullable: true title: String type: string - style: simple - x-position: 2 - - description: 'If the api call with async type. ' + style: form + x-position: 3 + - description: "If `true`, the search operations will be executed as a background\ + \ task." explode: true in: query name: async required: false schema: default: false + nullable: true title: Boolean type: boolean style: form - x-position: 3 + x-position: 4 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PolicySetSearch' + description: Specifies the advanced search parameters. + required: true + x-name: request + x-position: 1 responses: - "204": - description: Operation is successful with no response content. + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/CollectionEnvelopeOfPolicySetResponse' + description: List of policy sets that match the search criteria. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -148778,8 +148073,20 @@ paths: schema: type: string style: simple - "404": - description: A referenced entity was not found. + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -148832,20 +148139,18 @@ paths: schema: type: string style: simple - "406": + "409": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/optimisticConcurrency: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type - parameters: - - name: contentType - value: application/json + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + description: Caller requested an invalid relation to be created or deleted. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -148898,18 +148203,21 @@ paths: schema: type: string style: simple - "409": + "415": content: application/json: example: - https://errors-api.cloud.com/common/optimisticConcurrency: + https://errors-api.cloud.com/common/unsupportedMediaType: value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type + parameters: + - name: mediaType + value: application/xml schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -149163,15 +148471,12 @@ paths: schema: type: string style: simple - summary: Delete a hypervisor resource pool. + summary: Perform an advanced search for GPO policy sets. tags: - - Hypervisors APIs - get: - description: |- - Get details about a hypervisor resource pool. Note: in previous versions of - the API, resource pools were referred to as "HostingUnits". - URI with ?noCache=true can ignore the cache and fetch the data directly. - operationId: Hypervisors_GetHypervisorResourcePool + - Gpo + /gpo/policySets/{policySetGuid}: + delete: + operationId: Gpo_DeleteGpoPolicySet parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -149234,55 +148539,20 @@ paths: schema: type: string style: simple - - description: Name or ID of the hypervisor. + - description: The GUID of the policy set to be deleted explode: false in: path - name: nameOrId + name: policySetGuid required: true schema: - nullable: true - title: String - type: string - style: simple - x-position: 1 - - description: Name or ID of the resource pool. - explode: false - in: path - name: poolId - required: true - schema: - nullable: true - title: String + format: guid + title: Guid type: string style: simple - x-position: 2 - - description: 'Async request to get the resource pool. ' - explode: true - in: query - name: async - required: false - schema: - default: false - title: Boolean - type: boolean - style: form x-position: 3 responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/HypervisorResourcePoolDetailResponseModel' - description: |- - Details about the hypervisor resource pool. - or - Details about the hypervisor resource pool. - or - Details about the hypervisor resource pool. - or - Details about the hypervisor resource pool. - or - Details about the hypervisor resource pool. + "204": + description: Operation is successful with no response content. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -149335,37 +148605,21 @@ paths: schema: type: string style: simple - x-expectedSchemas: - - description: Details about the hypervisor resource pool. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorResourcePoolAWSDetailResponseModel' - - description: Details about the hypervisor resource pool. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorResourcePoolAzureDetailResponseModel' - - description: Details about the hypervisor resource pool. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorResourcePoolGcpDetailResponseModel' - - description: Details about the hypervisor resource pool. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorResourcePoolTraditionalDetailResponseModel' - - description: Details about the hypervisor resource pool. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorResourcePoolDetailResponseModel' - "202": - description: Async request was accepted and is being processed. - headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime schema: - type: string - style: simple + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -149417,20 +148671,20 @@ paths: schema: type: string style: simple - "400": + "401": content: application/json: example: - https://errors-api.cloud.com/common/outOfRange: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: property - value: startTime + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -149483,20 +148737,22 @@ paths: schema: type: string style: simple - "401": + "403": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - - name: reason - value: missing + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -149549,22 +148805,8 @@ paths: schema: type: string style: simple - "403": - content: - application/json: - example: - https://errors-api.cloud.com/common/authorization: - value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied - parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + "404": + description: A referenced entity was not found. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -149617,22 +148859,20 @@ paths: schema: type: string style: simple - "404": + "406": content: application/json: example: - https://errors-api.cloud.com/common/notFound: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -149685,20 +148925,18 @@ paths: schema: type: string style: simple - "406": + "409": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/optimisticConcurrency: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type - parameters: - - name: contentType - value: application/json + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + description: Caller requested an invalid relation to be created or deleted. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -149952,12 +149190,13 @@ paths: schema: type: string style: simple - summary: Get details about a hypervisor resource pool. + summary: |- + Delete an existing GPO policy set. Only policy sets of type DeliveryGroupPolicies can be deleted. Policies in + the policy set are deleted if a policy set is deleted. tags: - - Hypervisors APIs - patch: - description: Update a hypervisor resource pool. - operationId: Hypervisors_PatchHypervisorResourcePool + - Gpo + get: + operationId: Gpo_ReadGpoPolicySet parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -150020,59 +149259,35 @@ paths: schema: type: string style: simple - - description: Name or ID of the hypervisor. - explode: false - in: path - name: nameOrId - required: true - schema: - nullable: true - title: String - type: string - style: simple - x-position: 2 - - description: Name or ID of the resource pool. + - description: GUID of the policy set to read explode: false in: path - name: poolId + name: policySetGuid required: true schema: - nullable: true - title: String + format: guid + title: Guid type: string style: simple x-position: 3 - - description: |- - If `true`, the resource pool will be updated as a background task. - The task will have JobType UpdateHypervisorResourcePool. - When the task is complete it will redirect to - GetHypervisorResourcePool. - The job's Parameters will contain properties: - * _Name_ - Name of the resource pool being updated. - * _Id_ - ID of the resource pool being updated. + - description: "If set to true, read the policies in the policy set" explode: true in: query - name: async + name: withPolicies required: false schema: - default: false nullable: true title: Boolean type: boolean style: form x-position: 4 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/EditHypervisorResourcePoolRequestModel' - description: Details of the resource pool to update. - required: true - x-name: model - x-position: 1 responses: - "204": - description: Operation is successful with no response content. + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/PolicySetResponse' + description: The policy set read headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -150125,16 +149340,21 @@ paths: schema: type: string style: simple - "202": - description: Async request was accepted and is being processed. - headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime schema: - type: string - style: simple + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -150186,86 +149406,20 @@ paths: schema: type: string style: simple - "400": + "401": content: application/json: example: - https://errors-api.cloud.com/common/outOfRange: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: property - value: startTime + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "401": - content: - application/json: - example: - https://errors-api.cloud.com/common/authentication: - value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details - parameters: - - name: reason - value: missing - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -150520,73 +149674,6 @@ paths: schema: type: string style: simple - "415": - content: - application/json: - example: - https://errors-api.cloud.com/common/unsupportedMediaType: - value: - type: https://errors-api.cloud.com/common/unsupportedMediaType - detail: Must use application/json;charset=utf-8 media type - parameters: - - name: mediaType - value: application/xml - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller must send request body in utf-8 and specify request - Content-Type as utf-8. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple "429": content: application/json: @@ -150788,12 +149875,11 @@ paths: schema: type: string style: simple - summary: Update a hypervisor resource pool. + summary: Read a GPO policy set. tags: - - Hypervisors APIs - /hypervisors/{nameOrId}/resourcePools/{poolId}/$getPatchPreview: - post: - operationId: Hypervisors_GetHypervisorResourcePoolPatchPreview + - Gpo + patch: + operationId: Gpo_UpdateGpoPolicySet parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -150856,118 +149942,30 @@ paths: schema: type: string style: simple - - description: Name or ID of the hypervisor. + - description: The GUID of the policy set to update explode: false in: path - name: nameOrId + name: policySetGuid required: true schema: - nullable: true - title: String - type: string - style: simple - x-position: 2 - - description: Name or ID of the resource pool. - explode: false - in: path - name: poolId - required: true - schema: - nullable: true - title: String + format: guid + title: Guid type: string style: simple x-position: 3 - - description: "If `true`, the preview job will run as a background task." - explode: true - in: query - name: async - required: false - schema: - default: false - nullable: true - title: Boolean - type: boolean - style: form - x-position: 4 requestBody: content: application/json: schema: - $ref: '#/components/schemas/HypervisorResourcePoolPatchPreviewRequestModel' - description: New networks of the resource pool. + $ref: '#/components/schemas/PolicySetRequest' + description: New description of the policy set required: true - x-name: model - x-position: 1 + x-name: request + x-position: 4 responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/HypervisorResourcePoolPatchPreviewResponseModel' - description: Reference of the networks. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "202": - description: Async request was accepted and is being processed. + "204": + description: Operation is successful with no response content. headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false - schema: - type: string - style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -151353,85 +150351,21 @@ paths: schema: type: string style: simple - "409": + "415": content: application/json: example: - https://errors-api.cloud.com/common/optimisticConcurrency: + https://errors-api.cloud.com/common/unsupportedMediaType: value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type + parameters: + - name: mediaType + value: application/xml schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "415": - content: - application/json: - example: - https://errors-api.cloud.com/common/unsupportedMediaType: - value: - type: https://errors-api.cloud.com/common/unsupportedMediaType - detail: Must use application/json;charset=utf-8 media type - parameters: - - name: mediaType - value: application/xml - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller must send request body in utf-8 and specify request - Content-Type as utf-8. + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -151685,16 +150619,11 @@ paths: schema: type: string style: simple - summary: Get the hypervisor resource pool patch preview. + summary: Update an existing GPO policy set. tags: - - Hypervisors APIs - /Hypervisors/{nameOrId}/ResourcePools/{poolId}/$test: + - Gpo post: - description: |- - Run tests on a resource pool and create a test report. Obtain the most - recent report from - GetHypervisorResourcePoolTestReport. - operationId: Hypervisors_TestHypervisorResourcePool + operationId: Gpo_CopyGpoPolicySet parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -151757,57 +150686,45 @@ paths: schema: type: string style: simple - - description: Name or ID of the hypervisor containing the resource pool. + - description: GUID of the existing policy set explode: false in: path - name: nameOrId + name: policySetGuid required: true schema: - nullable: true - title: String + format: guid + title: Guid type: string style: simple - x-position: 1 - - description: Name or ID of the resource pool to test. - explode: false - in: path - name: poolId + x-position: 3 + - description: The name of the new policy set + explode: true + in: query + name: name required: true schema: nullable: true title: String type: string - style: simple - x-position: 2 - - description: |- - If `true`, the tests will run as a background task. This is recommended as the - tests may take some time to run, and if it exceeds 90 seconds the request may - time out. - The task will have JobType TestHypervisorResourcePool. - When the task is complete it will redirect to - GetJobResults. - The job's Parameters will contain properties: - - * _Id_ - ID of the resource pool being tested, - * _Name_ - Name of the resource pool being tested. + style: form + x-position: 4 + - description: Indicate if filters in the policies should be copied explode: true in: query - name: async - required: false + name: withFilters + required: true schema: - default: false - nullable: true title: Boolean type: boolean style: form - x-position: 3 + x-position: 5 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/HypervisorResourcePoolTestResponseModel' - description: Test response. + $ref: '#/components/schemas/PolicySetResponse' + description: The newly created policy set headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -151860,16 +150777,21 @@ paths: schema: type: string style: simple - "202": - description: Async request was accepted and is being processed. - headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime schema: - type: string - style: simple + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -151921,20 +150843,20 @@ paths: schema: type: string style: simple - "400": + "401": content: application/json: example: - https://errors-api.cloud.com/common/outOfRange: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: property - value: startTime + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -151987,20 +150909,22 @@ paths: schema: type: string style: simple - "401": + "403": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - - name: reason - value: missing + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -152053,14 +150977,14 @@ paths: schema: type: string style: simple - "403": + "404": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/notFound: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found parameters: - name: entityType value: https://identifiers-api.cloud.com/example/widget @@ -152068,7 +150992,7 @@ paths: value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: A referenced entity was not found. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -152121,22 +151045,20 @@ paths: schema: type: string style: simple - "404": + "406": content: application/json: example: - https://errors-api.cloud.com/common/notFound: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -152189,151 +151111,85 @@ paths: schema: type: string style: simple - "406": + "409": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/optimisticConcurrency: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller requested an invalid relation to be created or deleted. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "429": + content: + application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds parameters: - - name: contentType - value: application/json + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "409": - content: - application/json: - example: - https://errors-api.cloud.com/common/optimisticConcurrency: - value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "429": - content: - application/json: - example: - https://errors-api.cloud.com/common/rateLimitExceeded: - value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds - parameters: - - name: retryDelay - value: "4" - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. + description: Caller has made too many requests in a short period of time + and is being rate-limited. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -152520,13 +151376,14 @@ paths: schema: type: string style: simple - summary: Run tests on a resource pool and create a test report. + summary: |- + Create a new GPO policy set by copying an existing policy set. The policies and settings in each policy are + copied to the new policy set. Optionally, the filters in the policies may be copied. Regardless of the type + of the source policy set, the resulting policy set is always of type DeliveryGroupPolicies. tags: - - Hypervisors APIs - /hypervisors/{nameOrId}/resourcePools/{poolId}/administrators: - get: - description: Get administrators who can administer a resource pool. - operationId: Hypervisors_GetHypervisorResourcePoolAdministrators + - Gpo + put: + operationId: Gpo_UpdatePolicySetBlob parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -152589,141 +151446,21 @@ paths: schema: type: string style: simple - - description: Name or ID of the hypervisor. + - description: The GUID of the policy set whose data is to be serialized explode: false in: path - name: nameOrId - required: true - schema: - nullable: true - title: String - type: string - style: simple - x-position: 1 - - description: Name or ID of the resource pool. - explode: false - in: path - name: poolId + name: policySetGuid required: true schema: - nullable: true - title: String + format: guid + title: Guid type: string style: simple - x-position: 2 - - description: 'If async execute. ' - explode: true - in: query - name: async - required: false - schema: - default: false - nullable: true - title: Boolean - type: boolean - style: form x-position: 3 - - description: |- - The max number of administrators returned by this query. - If not specified, the server might use a default limit of 250 items. - If the specified value is larger than 1000, the server might reject the call. - The default and maximum values depend on server settings. - explode: true - in: query - name: limit - required: false - schema: - format: int32 - nullable: true - title: Int32 - type: integer - style: form - x-position: 4 - - description: |- - If a query cannot be completed, the response will have a - ContinuationToken set. - To obtain more results from the query, pass the - continuation token back into the query to get the next - batch of results. - explode: true - in: query - name: continuationToken - required: false - schema: - nullable: true - title: String - type: string - style: form - x-position: 5 responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/AdministratorResponseModelCollection' - description: List of administrators. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "202": - description: Async request was accepted and is being processed. + "204": + description: Operation is successful with no response content. headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false - schema: - type: string - style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -153310,14 +152047,17 @@ paths: schema: type: string style: simple - summary: Get administrators who can administer a resource pool. + summary: |- + Force serialization of policy set. The data of a policy set is serialized into a byte stream before it is + sent to VDAs. The serialization is done automatically in the background at 5 minute intervals. A change made + to the data in a policy set may not be in the serialized data for up to 5 minutes. This call tells the + background thread to serialize the data immediately. No serialization is done if there have been no changes + to the policy set data since the last time the data was serialized. tags: - - Hypervisors APIs - /hypervisors/{nameOrId}/resourcePools/{poolId}/deletePreview: + - Gpo + /gpo/settingDefinitions: get: - description: Get the machine catalogs and related resources that are using by - a resource pool. - operationId: Hypervisors_GetHypervisorResourcePoolDeletePreview + operationId: Gpo_GetSettingDefinitions parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -153380,47 +152120,90 @@ paths: schema: type: string style: simple - - description: Name or ID of the hypervisor. - explode: false - in: path - name: nameOrId - required: true + - description: "Get lean parts of setting definitions, the default is set to\ + \ true" + explode: true + in: query + name: isLean + required: false schema: + default: true nullable: true - title: String - type: string - style: simple - x-position: 1 - - description: Name or ID of the resource pool. - explode: false - in: path - name: poolId - required: true + title: Boolean + type: boolean + style: form + x-position: 3 + - description: "Specify the number of entries to retrieve, the default is all\ + \ entries" + explode: true + in: query + name: limit + required: false + schema: + default: -1 + format: int32 + nullable: true + title: Int32 + type: integer + style: form + x-position: 4 + - description: "Specify sort order, default is true" + explode: true + in: query + name: isAscending + required: false + schema: + default: true + nullable: true + title: Boolean + type: boolean + style: form + x-position: 5 + - description: "Specify a regular expression to match the internal setting name.\ + \ The default is match all names.\n " + explode: true + in: query + name: namePattern + required: false schema: nullable: true title: String type: string - style: simple - x-position: 2 - - description: 'If execute this API asynchronous. ' + style: form + x-position: 6 + - description: "Specify the target of applying the settings. If it's set to\ + \ true, only user settings are retrieved.\nIf it's set to false, only computer\ + \ settings are retrieved. If not specified, both kinds of settings\nare\ + \ retrieved. The default is to retrieve both kinds of settings.\n \ + \ " explode: true in: query - name: async + name: isUserSetting required: false schema: - default: false nullable: true title: Boolean type: boolean style: form - x-position: 3 + x-position: 7 + - description: Continuation token from a previous retrieval + explode: true + in: query + name: continuationToken + required: false + schema: + nullable: true + title: String + type: string + style: form + x-position: 8 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/HypervisorDeletePreviewResponseModel' - description: 'HypervisorDeletePreviewResponseModel object. ' + $ref: '#/components/schemas/SettingDefinitionEnvelope' + description: Setting definitions headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -153473,67 +152256,6 @@ paths: schema: type: string style: simple - "202": - description: Async request was accepted and is being processed. - headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false - schema: - type: string - style: simple - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple "400": content: application/json: @@ -153734,74 +152456,6 @@ paths: schema: type: string style: simple - "404": - content: - application/json: - example: - https://errors-api.cloud.com/common/notFound: - value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found - parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 - schema: - $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple "406": content: application/json: @@ -154069,14 +152723,16 @@ paths: schema: type: string style: simple - summary: Get the hypervisor resource pool delete preview. + summary: |- + Get setting definitions. If isLean is set to true, only basic session information is returned. EnumType, + VdaVersions, VersionDetails, and Explanation are not retrieved. If limit is set to -1 or a number larger + than the number of settings available, all entries are retrieved. If limit is set to a positive integer + smaller than the number of settings available, the specified number of settings are retrieved. tags: - - Hypervisors APIs - /hypervisors/{nameOrId}/resourcePools/{poolId}/jobs: + - Gpo + /gpo/settingFullDetail: get: - description: Get the currently active provisioning jobs that are using a resource - pool. - operationId: Hypervisors_GetHypervisorResourcePoolJobs + operationId: Gpo_GetSettingFullDetail parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -154139,35 +152795,24 @@ paths: schema: type: string style: simple - - description: Name or ID of the hypervisor. - explode: false - in: path - name: nameOrId - required: true - schema: - nullable: true - title: String - type: string - style: simple - x-position: 1 - - description: Name or ID of the resource pool. - explode: false - in: path - name: poolId + - description: The internal name of the setting + explode: true + in: query + name: settingName required: true schema: nullable: true title: String type: string - style: simple - x-position: 2 + style: form + x-position: 3 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/JobResponseModelCollection' - description: List of machine catalogs that are using a hypervisor. + $ref: '#/components/schemas/SettingDefinition' + description: All details of the setting definition headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -154420,22 +153065,20 @@ paths: schema: type: string style: simple - "404": + "406": content: application/json: example: - https://errors-api.cloud.com/common/notFound: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -154488,87 +153131,21 @@ paths: schema: type: string style: simple - "406": + "429": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/rateLimitExceeded: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds parameters: - - name: contentType - value: application/json + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "429": - content: - application/json: - example: - https://errors-api.cloud.com/common/rateLimitExceeded: - value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds - parameters: - - name: retryDelay - value: "4" - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. + description: Caller has made too many requests in a short period of time + and is being rate-limited. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -154755,13 +153332,12 @@ paths: schema: type: string style: simple - summary: Get the currently active jobs that are using a resource pool. + summary: Get full detail of a setting definition. tags: - - Hypervisors APIs - /hypervisors/{nameOrId}/resourcePools/{poolId}/machineCatalogs: + - Gpo + /gpo/settings: get: - description: Get the machine catalogs that are using a resource pool. - operationId: Hypervisors_GetHypervisorResourcePoolMachineCatalogs + operationId: Gpo_ReadGpoSettings parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -154824,79 +153400,24 @@ paths: schema: type: string style: simple - - description: Name or ID of the hypervisor. - explode: false - in: path - name: nameOrId - required: true - schema: - nullable: true - title: String - type: string - style: simple - x-position: 1 - - description: Name or ID of the resource pool. - explode: false - in: path - name: poolId - required: true - schema: - nullable: true - title: String - type: string - style: simple - x-position: 2 - - description: 'If async execute. ' + - description: GUID of the policy from which settings are read explode: true in: query - name: async - required: false - schema: - default: false - nullable: true - title: Boolean - type: boolean - style: form - x-position: 3 - - description: |- - The max number of machine catalogs returned by this query. - If not specified, the server might use a default limit of 250 items. - If the specified value is larger than 1000, the server might reject the call. - The default and maximum values depend on server settings. - explode: true - in: query - name: limit - required: false - schema: - format: int32 - nullable: true - title: Int32 - type: integer - style: form - x-position: 4 - - description: |- - If a query cannot be completed, the response will have a - ContinuationToken set. - To obtain more results from the query, pass the - continuation token back into the query to get the next - batch of results. - explode: true - in: query - name: continuationToken - required: false + name: policyGuid + required: true schema: - nullable: true - title: String + format: guid + title: Guid type: string style: form - x-position: 5 + x-position: 3 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/HypervisorMachineCatalogResponseModelCollection' - description: List of machine catalogs that are using a hypervisor. + $ref: '#/components/schemas/CollectionEnvelopeOfSettingResponse' + description: The settings read headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -154949,16 +153470,87 @@ paths: schema: type: string style: simple - "202": - description: Async request was accepted and is being processed. + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 explode: false schema: type: string style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "401": + content: + application/json: + example: + https://errors-api.cloud.com/common/authentication: + value: + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller did not present a valid bearer token. + headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -155010,20 +153602,22 @@ paths: schema: type: string style: simple - "400": + "403": content: application/json: example: - https://errors-api.cloud.com/common/outOfRange: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - - name: property - value: startTime + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -155076,20 +153670,20 @@ paths: schema: type: string style: simple - "401": + "406": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type parameters: - - name: reason - value: missing + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -155142,223 +153736,21 @@ paths: schema: type: string style: simple - "403": + "429": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/rateLimitExceeded: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "404": - content: - application/json: - example: - https://errors-api.cloud.com/common/notFound: - value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found - parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 - schema: - $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "406": - content: - application/json: - example: - https://errors-api.cloud.com/common/notAcceptable: - value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type - parameters: - - name: contentType - value: application/json - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "429": - content: - application/json: - example: - https://errors-api.cloud.com/common/rateLimitExceeded: - value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds - parameters: - - name: retryDelay - value: "4" - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. + description: Caller has made too many requests in a short period of time + and is being rate-limited. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -155545,27 +153937,11 @@ paths: schema: type: string style: simple - summary: Get the machine catalogs that are using a resource pool. + summary: Read settings defined in a policy. tags: - - Hypervisors APIs - /hypervisors/{nameOrId}/resourcePools/{poolId}/resources: - get: - description: |- - Get the resources within a hypervisor resource pool. Note: in previous - versions of the API, resource pools were referred to as "HostingUnits". - A caller can recursively enumerate by: - * Call with no `path`, and `children` equal to `1`. - * For each of the result's - Children where - IsContainer is `true`, call - with `path` equal to that item's - RelativePath and `children` - equal to `1`. - * Repeat recursively. - URI with ?noCache=true can ignore the cache and fetch the data directly. - URI with ?force=true can get the VMs which provisioned by MCS. - URI with ?recurse=true can recurse fetch all resources under this folder. - operationId: Hypervisors_GetHypervisorResourcePoolResources + - Gpo + post: + operationId: Gpo_CreateGpoSetting parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -155628,147 +154004,33 @@ paths: schema: type: string style: simple - - description: Name or ID of the hypervisor. - explode: false - in: path - name: nameOrId - required: true - schema: - nullable: true - title: String - type: string - style: simple - x-position: 1 - - description: Name or ID of the resource pool. - explode: false - in: path - name: poolId - required: true - schema: - nullable: true - title: String - type: string - style: simple - x-position: 2 - - description: |- - Path to the resource container within the resource pool. The path may either - be a relative path as specified by - RelativePath, or may be a - URL-encoded XenApp & XenDesktop resource path starting with `XDHyp:`; for - example, as specified by - XDPath. + - description: GUID of the policy to which the setting belongs explode: true in: query - name: path - required: false + name: policyGuid + required: true schema: - nullable: true - title: String + format: guid + title: Guid type: string style: form x-position: 3 - - description: |- - Specifies the number of levels of children to enumerate. - Default is `0`, meaning that only the object referred to by `path` is returned - and its Children array will be - left null. - A special value of `-1` indicates that the entire resource hierarchy should be - enumerated. Use with care! It may take a very long time to enumerate a large - number of resources from a hypervisor, and the call may time out before - completing. - explode: true - in: query - name: children - required: false - schema: - format: int32 - nullable: true - title: Int32 - type: integer - style: form + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SettingRequest' + description: Data for the new setting + required: true + x-name: request x-position: 4 - - description: "If specified, limits the results to the specified resource type(s)." - explode: true - in: query - name: type - required: false - schema: - items: - title: String - type: string - nullable: true - title: "String[]" - type: array - style: form - x-position: 5 - - description: |- - By default, items which are tagged by XenDesktop are not shown. Set this to - `true` to override that behavior. - explode: true - in: query - name: showTagged - required: false - schema: - nullable: true - title: Boolean - type: boolean - style: form - x-position: 6 - - description: |- - If `true`, full details of VMs, snapshots, and templates will be retrieved. - This can be very time consuming and will reduce the performance of the call. - May only be used if `path` refers to a VM, snapshot, or template resource. - - explode: true - in: query - name: detail - required: false - schema: - nullable: true - title: Boolean - type: boolean - style: form - x-position: 7 - - description: 'Async request to get the resources with *path. ' - explode: true - in: query - name: async - required: false - schema: - default: false - nullable: true - title: Boolean - type: boolean - style: form - x-position: 8 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/HypervisorResourceResponseModel' - description: |- - A list of hypervisor resources. - or - A list of hypervisor resources. - or - A list of hypervisor resources. - or - A list of hypervisor resources. - or - A list of hypervisor resources. - or - A list of hypervisor resources. - or - A list of hypervisor resources. - or - A list of hypervisor resources. - or - A list of hypervisor resources. - or - A list of hypervisor resources. - or - A list of hypervisor resources. + $ref: '#/components/schemas/SettingResponse' + description: The newly created setting headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -155821,61 +154083,21 @@ paths: schema: type: string style: simple - x-expectedSchemas: - - description: A list of hypervisor resources. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorAvailabilityZoneResourceResponseModel' - - description: A list of hypervisor resources. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorGpuTypeResourceResponseModel' - - description: A list of hypervisor resources. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorSecurityGroupResourceResponseModel' - - description: A list of hypervisor resources. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorServiceOfferingResourceResponseModel' - - description: A list of hypervisor resources. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorStorageResourceResponseModel' - - description: A list of hypervisor resources. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorTemplateResourceResponseModel' - - description: A list of hypervisor resources. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorVmResourceResponseModel' - - description: A list of hypervisor resources. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorVmSnapshotResourceResponseModel' - - description: A list of hypervisor resources. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorVpcResourceResponseModel' - - description: A list of hypervisor resources. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorCloudRegionResourceResponseModel' - - description: A list of hypervisor resources. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorResourceResponseModel' - "202": - description: Async request was accepted and is being processed. - headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime schema: - type: string - style: simple + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -155927,20 +154149,20 @@ paths: schema: type: string style: simple - "400": + "401": content: application/json: example: - https://errors-api.cloud.com/common/outOfRange: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: property - value: startTime + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -155993,20 +154215,22 @@ paths: schema: type: string style: simple - "401": + "403": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - - name: reason - value: missing + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -156059,22 +154283,20 @@ paths: schema: type: string style: simple - "403": + "406": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -156127,22 +154349,18 @@ paths: schema: type: string style: simple - "404": + "409": content: application/json: example: - https://errors-api.cloud.com/common/notFound: + https://errors-api.cloud.com/common/optimisticConcurrency: value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found - parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null schema: $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. + description: Caller requested an invalid relation to be created or deleted. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -156195,20 +154413,21 @@ paths: schema: type: string style: simple - "406": + "415": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/unsupportedMediaType: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type parameters: - - name: contentType - value: application/json + - name: mediaType + value: application/xml schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -156462,14 +154681,13 @@ paths: schema: type: string style: simple - summary: Get the resources within a hypervisor resource pool. + summary: Create a setting in a policy. Settings cannot be created in the policy + set of type SiteTemplates. tags: - - Hypervisors APIs - /hypervisors/{nameOrId}/resourcePools/{poolId}/resources/$search: + - Gpo + /gpo/settings/$search: post: - description: "Currently, only AWS's AMIs(template) and Machine Profile(vm and\ - \ launch template version) is supported." - operationId: Hypervisors_DoHypervisorResourceSearch + operationId: Gpo_SearchSettings parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -156532,33 +154750,8 @@ paths: schema: type: string style: simple - - description: Name or ID of the hypervisor. - explode: false - in: path - name: nameOrId - required: true - schema: - nullable: true - title: String - type: string - style: simple - x-position: 2 - - description: Name or ID of the resource pool. - explode: false - in: path - name: poolId - required: true - schema: - nullable: true - title: String - type: string - style: simple - x-position: 3 - - description: |- - The max number of resources returned by this query. - If not specified, the server might use a default limit of 1 items. - If the specified value is larger than 1000, the server might reject the call. - The default and maximum values depend on server settings. + - description: "Maximum number of objects, which must not exceed 1000, to return.\ + \ If not specified, the default value is 250." explode: true in: query name: limit @@ -156569,13 +154762,10 @@ paths: title: Int32 type: integer style: form - x-position: 4 + x-position: 2 - description: |- - If a query cannot be completed, the response will have a - ContinuationToken set. - To obtain more results from the query, pass the - continuation token back into the query to get the next - batch of results. + If a previous call didn't return all the records expected, pass the continuation token returned from the + previous response to this current query to continue retrieving the remaining objects. explode: true in: query name: continuationToken @@ -156585,23 +154775,9 @@ paths: title: String type: string style: form - x-position: 5 - - description: |- - If `true`, full details of templates will be retrieved. - This can be very time consuming and will reduce the - performance of the call. - explode: true - in: query - name: detail - required: false - schema: - default: false - nullable: true - title: Boolean - type: boolean - style: form - x-position: 6 - - description: 'Async request to get the resources with *path. ' + x-position: 3 + - description: "If `true`, the search operations will be executed as a background\ + \ task." explode: true in: query name: async @@ -156612,26 +154788,23 @@ paths: title: Boolean type: boolean style: form - x-position: 7 + x-position: 4 requestBody: content: application/json: schema: - $ref: '#/components/schemas/HypervisorResourceSearchRequestModel' + $ref: '#/components/schemas/SettingSearch' description: Specifies the advanced search parameters. required: true - x-name: searchRequest + x-name: request x-position: 1 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/HypervisorResourceResponseModelCollection' - description: |- - A list of hypervisor resources. - or - A list of hypervisor resources. + $ref: '#/components/schemas/CollectionEnvelopeOfSettingResponse' + description: List of policy sets that match the search criteria. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -156684,15 +154857,6 @@ paths: schema: type: string style: simple - x-expectedSchemas: - - description: A list of hypervisor resources. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorResourceResponseModelCollection' - - description: A list of hypervisor resources. - schema: - nullable: true - $ref: '#/components/schemas/HypervisorResourceResponseModelCollection' "202": description: Async request was accepted and is being processed. headers: @@ -156954,74 +155118,6 @@ paths: schema: type: string style: simple - "404": - content: - application/json: - example: - https://errors-api.cloud.com/common/notFound: - value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found - parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 - schema: - $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple "406": content: application/json: @@ -157420,12 +155516,12 @@ paths: schema: type: string style: simple - summary: Search the resources within a hypervisor resource pool. + summary: Perform an advanced search for GPO settings. tags: - - Hypervisors APIs - /hypervisors/{nameOrId}/resourcePools/{poolId}/resources/$validate: - post: - operationId: Hypervisors_ValidateHypervisorResourcePoolResource + - Gpo + /gpo/settings/{settingGuid}: + delete: + operationId: Gpo_DeleteGpoSetting parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -157488,56 +155584,20 @@ paths: schema: type: string style: simple - - description: Name or Id of the hypervisor. + - description: GUID of the setting to be deleted explode: false in: path - name: nameOrId + name: settingGuid required: true schema: - nullable: true - title: String - type: string - style: simple - x-position: 2 - - description: Name or Id of the resource pool. - explode: false - in: path - name: poolId - required: true - schema: - nullable: true - title: String + format: guid + title: Guid type: string style: simple x-position: 3 - - description: If async execute. - explode: true - in: query - name: async - required: false - schema: - default: false - nullable: true - title: Boolean - type: boolean - style: form - x-position: 4 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/HypervisorResourceValidationRequestModel' - description: More details attached to this validation. - required: true - x-name: request - x-position: 1 responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/HypervisorResourceValidationResponseModel' - description: The validation result. + "204": + description: Operation is successful with no response content. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -157590,16 +155650,21 @@ paths: schema: type: string style: simple - "202": - description: Async request was accepted and is being processed. - headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime schema: - type: string - style: simple + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -157651,20 +155716,20 @@ paths: schema: type: string style: simple - "400": + "401": content: application/json: example: - https://errors-api.cloud.com/common/outOfRange: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: property - value: startTime + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -157717,20 +155782,22 @@ paths: schema: type: string style: simple - "401": + "403": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - - name: reason - value: missing + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -157783,22 +155850,74 @@ paths: schema: type: string style: simple - "403": + "404": + description: A referenced entity was not found. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "406": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -157851,219 +155970,18 @@ paths: schema: type: string style: simple - "404": + "409": content: application/json: example: - https://errors-api.cloud.com/common/notFound: + https://errors-api.cloud.com/common/optimisticConcurrency: value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found - parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null schema: $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "406": - content: - application/json: - example: - https://errors-api.cloud.com/common/notAcceptable: - value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type - parameters: - - name: contentType - value: application/json - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "409": - content: - application/json: - example: - https://errors-api.cloud.com/common/optimisticConcurrency: - value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "415": - content: - application/json: - example: - https://errors-api.cloud.com/common/unsupportedMediaType: - value: - type: https://errors-api.cloud.com/common/unsupportedMediaType - detail: Must use application/json;charset=utf-8 media type - parameters: - - name: mediaType - value: application/xml - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller must send request body in utf-8 and specify request - Content-Type as utf-8. + description: Caller requested an invalid relation to be created or deleted. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -158317,16 +156235,12 @@ paths: schema: type: string style: simple - summary: "Validate a resource for certain usages, currently default and only\ - \ usage is for Machine Profile." + summary: Delete a setting. Settings in the policy set of type SiteTemplates + cannot be deleted. tags: - - Hypervisors APIs - /Hypervisors/{nameOrId}/ResourcePools/{poolId}/TestReport: + - Gpo get: - description: |- - Get the test report from the last run of - TestHypervisorResourcePool. - operationId: Hypervisors_GetHypervisorResourcePoolTestReport + operationId: Gpo_ReadGpoSetting parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -158389,36 +156303,24 @@ paths: schema: type: string style: simple - - description: Name or ID of the hypervisor. + - description: GUID of the setting to be read explode: false in: path - name: nameOrId + name: settingGuid required: true schema: - nullable: true - title: String - type: string - style: simple - x-position: 1 - - description: Name or ID of the resource pool. - explode: false - in: path - name: poolId - required: true - schema: - nullable: true - title: String + format: guid + title: Guid type: string style: simple - x-position: 2 + x-position: 3 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/TestReportResponseModel' - description: "Last test report. If no tests have been run, returns a 404\ - \ Not Found." + $ref: '#/components/schemas/SettingResponse' + description: The setting read headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -159006,14 +156908,11 @@ paths: schema: type: string style: simple - summary: Get the most recent test report for a resource pool. + summary: Read a specific setting. tags: - - Hypervisors APIs - /hypervisors/{nameOrId}/serverHAAddresses: - get: - description: URI with ?noCache=true can ignore the cache and fetch the data - directly. - operationId: Hypervisors_GetHypervisorServerHAAddresses + - Gpo + patch: + operationId: Gpo_UpdateGpoSetting parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -159076,36 +156975,29 @@ paths: schema: type: string style: simple - - description: 'The hypervisor connection name or id. ' + - description: GUID of the setting to be updated explode: false in: path - name: nameOrId + name: settingGuid required: true schema: - nullable: true - title: String + format: guid + title: Guid type: string style: simple - x-position: 1 - - description: 'If the execution with async model. ' - explode: true - in: query - name: async - required: false - schema: - default: false - nullable: true - title: Boolean - type: boolean - style: form - x-position: 2 + x-position: 3 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SettingRequest' + description: New setting value + required: true + x-name: request + x-position: 4 responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/HypervisorServerHAAddressesResponseModel' - description: 'HypervisorServerHAAddressesResponseModel object. ' + "204": + description: Operation is successful with no response content. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -159158,67 +157050,6 @@ paths: schema: type: string style: simple - "202": - description: Async request was accepted and is being processed. - headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false - schema: - type: string - style: simple - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple "400": content: application/json: @@ -159553,21 +157384,21 @@ paths: schema: type: string style: simple - "429": + "415": content: application/json: example: - https://errors-api.cloud.com/common/rateLimitExceeded: + https://errors-api.cloud.com/common/unsupportedMediaType: value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type parameters: - - name: retryDelay - value: "4" + - name: mediaType + value: application/xml schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -159620,21 +157451,21 @@ paths: schema: type: string style: simple - "503": + "429": content: application/json: example: - https://errors-api.cloud.com/common/serviceUnavailable: + https://errors-api.cloud.com/common/rateLimitExceeded: value: - type: https://errors-api.cloud.com/common/serviceUnavailable - detail: Service is unavailable; try again in 4 seconds + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds parameters: - name: retryDelay value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: "Service is temporarily unable to process the request. Caller\ - \ may attempt the operation again, with exponential back-off." + description: Caller has made too many requests in a short period of time + and is being rate-limited. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -159687,164 +157518,21 @@ paths: schema: type: string style: simple - "500": + "503": content: application/json: example: - https://errors-api.cloud.com/common/internalServerError: + https://errors-api.cloud.com/common/serviceUnavailable: value: - type: https://errors-api.cloud.com/common/internalServerError - detail: An internal server error has occurred; try again in 4 - seconds + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds parameters: - name: retryDelay value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: An unexpected server error occurred. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - summary: "Get hypervisor server HA addresses. Currently, it only valid for Citrix\ - \ hypervisors." - tags: - - Hypervisors APIs - /Hypervisors/{nameOrId}/TestReport: - get: - description: |- - Get the test report from the last run of - TestHypervisor. - operationId: Hypervisors_GetHypervisorTestReport - parameters: - - description: Citrix Customer ID. Default is 'CitrixOnPremises' - example: CitrixOnPremises - explode: false - in: header - name: Citrix-CustomerId - required: true - schema: - type: string - style: simple - - description: Citrix Instance (Site) ID. - explode: false - in: header - name: Citrix-InstanceId - required: true - schema: - type: string - style: simple - - description: User Agent type of the request. - example: Mozilla/5.0 - explode: false - in: header - name: User-Agent - required: false - schema: - type: string - style: simple - - description: "Citrix authorization header: CWSAuth Bearer={token}" - explode: false - in: header - name: Authorization - required: false - schema: - type: string - style: simple - - description: "Transaction ID that will be used to track this request. If not\ - \ provided, a new GUID will be generated and returned." - explode: false - in: header - name: Citrix-TransactionId - required: false - schema: - type: string - style: simple - - description: Must accept application/json. - example: application/json - explode: false - in: header - name: Accept - required: false - schema: - type: string - style: simple - - description: Locale of the request. - example: en-US - explode: false - in: header - name: Citrix-Locale - required: false - schema: - type: string - style: simple - - description: Name or ID of the hypervisor. - explode: false - in: path - name: nameOrId - required: true - schema: - nullable: true - title: String - type: string - style: simple - x-position: 1 - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/TestReportResponseModel' - description: "Last test report. If no tests have been run, returns a 404\ - \ Not Found." + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -159897,20 +157585,21 @@ paths: schema: type: string style: simple - "400": + "500": content: application/json: example: - https://errors-api.cloud.com/common/outOfRange: + https://errors-api.cloud.com/common/internalServerError: value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds parameters: - - name: property - value: startTime + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + description: An unexpected server error occurred. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -159963,20 +157652,105 @@ paths: schema: type: string style: simple - "401": + summary: Update a setting. Settings in the policy set of type SiteTemplates + cannot be updated. + tags: + - Gpo + /gpo/simulation: + post: + operationId: Gpo_RunSimulation + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + - description: "The GUID of the policy set, on which this simulation is run" + explode: true + in: query + name: policySetGuid + required: true + schema: + format: guid + title: Guid + type: string + style: form + x-position: 4 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SimulationRequestContract' + description: Modeling request + required: true + x-name: request + x-position: 3 + responses: + "200": content: application/json: - example: - https://errors-api.cloud.com/common/authentication: - value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details - parameters: - - name: reason - value: missing schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + items: + $ref: '#/components/schemas/SimulationResponseContract' + title: IEnumerable`1 + type: array + description: Modeling result headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -160029,22 +157803,20 @@ paths: schema: type: string style: simple - "403": + "400": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/outOfRange: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: property + value: startTime schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: Caller passed an invalid input. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -160097,22 +157869,20 @@ paths: schema: type: string style: simple - "404": + "401": content: application/json: example: - https://errors-api.cloud.com/common/notFound: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -160165,20 +157935,22 @@ paths: schema: type: string style: simple - "406": + "403": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - - name: contentType - value: application/json + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -160231,21 +158003,20 @@ paths: schema: type: string style: simple - "429": + "406": content: application/json: example: - https://errors-api.cloud.com/common/rateLimitExceeded: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type parameters: - - name: retryDelay - value: "4" + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -160298,21 +158069,18 @@ paths: schema: type: string style: simple - "503": + "409": content: application/json: example: - https://errors-api.cloud.com/common/serviceUnavailable: + https://errors-api.cloud.com/common/optimisticConcurrency: value: - type: https://errors-api.cloud.com/common/serviceUnavailable - detail: Service is unavailable; try again in 4 seconds - parameters: - - name: retryDelay - value: "4" + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null schema: $ref: '#/components/schemas/ErrorResponse' - description: "Service is temporarily unable to process the request. Caller\ - \ may attempt the operation again, with exponential back-off." + description: Caller requested an invalid relation to be created or deleted. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -160365,21 +158133,21 @@ paths: schema: type: string style: simple - "500": + "415": content: application/json: example: - https://errors-api.cloud.com/common/internalServerError: + https://errors-api.cloud.com/common/unsupportedMediaType: value: - type: https://errors-api.cloud.com/common/internalServerError - detail: An internal server error has occurred; try again in 4 - seconds + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type parameters: - - name: retryDelay - value: "4" + - name: mediaType + value: application/xml schema: $ref: '#/components/schemas/ErrorResponse' - description: An unexpected server error occurred. + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -160432,117 +158200,21 @@ paths: schema: type: string style: simple - summary: Get the most recent test report for a hypervisor. - tags: - - Hypervisors APIs - /hypervisors/supportedPlugins: - get: - description: URI with ?noCache=true can ignore the cache and fetch the data - directly. - operationId: Hypervisors_GetSupportHypervisors - parameters: - - description: Citrix Customer ID. Default is 'CitrixOnPremises' - example: CitrixOnPremises - explode: false - in: header - name: Citrix-CustomerId - required: true - schema: - type: string - style: simple - - description: Citrix Instance (Site) ID. - explode: false - in: header - name: Citrix-InstanceId - required: true - schema: - type: string - style: simple - - description: User Agent type of the request. - example: Mozilla/5.0 - explode: false - in: header - name: User-Agent - required: false - schema: - type: string - style: simple - - description: "Citrix authorization header: CWSAuth Bearer={token}" - explode: false - in: header - name: Authorization - required: false - schema: - type: string - style: simple - - description: "Transaction ID that will be used to track this request. If not\ - \ provided, a new GUID will be generated and returned." - explode: false - in: header - name: Citrix-TransactionId - required: false - schema: - type: string - style: simple - - description: Must accept application/json. - example: application/json - explode: false - in: header - name: Accept - required: false - schema: - type: string - style: simple - - description: Locale of the request. - example: en-US - explode: false - in: header - name: Citrix-Locale - required: false - schema: - type: string - style: simple - - description: 'If execute this API asynchronous. ' - explode: true - in: query - name: async - required: false - schema: - default: false - nullable: true - title: Boolean - type: boolean - style: form - x-position: 1 - - description: 'The zone name or id. ' - explode: true - in: query - name: zoneNameOrId - required: false - schema: - nullable: true - title: String - type: string - style: form - x-position: 2 - - description: Flag to show all supported hypervisor plugins. - explode: true - in: query - name: includeUnavailable - required: false - schema: - default: false - title: Boolean - type: boolean - style: form - x-position: 3 - responses: - "200": + "429": content: application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" schema: - $ref: '#/components/schemas/HypervisorPluginResponseModelCollection' - description: 'List of Hypervisor Plugin response model. ' + $ref: '#/components/schemas/ErrorResponse' + description: Caller has made too many requests in a short period of time + and is being rate-limited. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -160595,16 +158267,22 @@ paths: schema: type: string style: simple - "202": - description: Async request was accepted and is being processed. - headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false + "503": + content: + application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" schema: - type: string - style: simple + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." + headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -160656,20 +158334,21 @@ paths: schema: type: string style: simple - "400": + "500": content: application/json: example: - https://errors-api.cloud.com/common/outOfRange: + https://errors-api.cloud.com/common/internalServerError: value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds parameters: - - name: property - value: startTime + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + description: An unexpected server error occurred. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -160722,20 +158401,65 @@ paths: schema: type: string style: simple - "401": + summary: Simulate policy application. + tags: + - Gpo + /HealthCheck: + get: + operationId: HealthCheck_HealthCheck + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + responses: + "200": content: application/json: - example: - https://errors-api.cloud.com/common/authentication: - value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details - parameters: - - name: reason - value: missing schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + title: Boolean + type: boolean + description: true or false headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -160788,22 +158512,20 @@ paths: schema: type: string style: simple - "403": + "400": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/outOfRange: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: property + value: startTime schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: Caller passed an invalid input. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -160856,20 +158578,20 @@ paths: schema: type: string style: simple - "406": + "401": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: contentType - value: application/json + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -160922,21 +158644,22 @@ paths: schema: type: string style: simple - "429": + "403": content: application/json: example: - https://errors-api.cloud.com/common/rateLimitExceeded: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - - name: retryDelay - value: "4" + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -160989,21 +158712,20 @@ paths: schema: type: string style: simple - "503": + "406": content: application/json: example: - https://errors-api.cloud.com/common/serviceUnavailable: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/serviceUnavailable - detail: Service is unavailable; try again in 4 seconds + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type parameters: - - name: retryDelay - value: "4" + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: "Service is temporarily unable to process the request. Caller\ - \ may attempt the operation again, with exponential back-off." + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -161056,21 +158778,21 @@ paths: schema: type: string style: simple - "500": + "429": content: application/json: example: - https://errors-api.cloud.com/common/internalServerError: + https://errors-api.cloud.com/common/rateLimitExceeded: value: - type: https://errors-api.cloud.com/common/internalServerError - detail: An internal server error has occurred; try again in 4 - seconds + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds parameters: - name: retryDelay value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: An unexpected server error occurred. + description: Caller has made too many requests in a short period of time + and is being rate-limited. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -161123,95 +158845,21 @@ paths: schema: type: string style: simple - summary: Get current server support hypervisors. - tags: - - Hypervisors APIs - /hypervisorsAndResourcePools: - get: - description: URI with ?noCache=true can ignore the cache and fetch the data - directly. - operationId: Hypervisors_GetHypervisorsAndResourcePools - parameters: - - description: Citrix Customer ID. Default is 'CitrixOnPremises' - example: CitrixOnPremises - explode: false - in: header - name: Citrix-CustomerId - required: true - schema: - type: string - style: simple - - description: Citrix Instance (Site) ID. - explode: false - in: header - name: Citrix-InstanceId - required: true - schema: - type: string - style: simple - - description: User Agent type of the request. - example: Mozilla/5.0 - explode: false - in: header - name: User-Agent - required: false - schema: - type: string - style: simple - - description: "Citrix authorization header: CWSAuth Bearer={token}" - explode: false - in: header - name: Authorization - required: false - schema: - type: string - style: simple - - description: "Transaction ID that will be used to track this request. If not\ - \ provided, a new GUID will be generated and returned." - explode: false - in: header - name: Citrix-TransactionId - required: false - schema: - type: string - style: simple - - description: Must accept application/json. - example: application/json - explode: false - in: header - name: Accept - required: false - schema: - type: string - style: simple - - description: Locale of the request. - example: en-US - explode: false - in: header - name: Citrix-Locale - required: false - schema: - type: string - style: simple - - description: 'If execute this API asynchronous. ' - explode: true - in: query - name: async - required: false - schema: - default: false - nullable: true - title: Boolean - type: boolean - style: form - x-position: 1 - responses: - "200": + "503": content: application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" schema: - $ref: '#/components/schemas/HypervisorsAndResourcePoolsResponseModelCollection' - description: 'List of Hypervisor Main View Response Model. ' + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -161264,16 +158912,224 @@ paths: schema: type: string style: simple - "202": - description: Async request was accepted and is being processed. - headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false + "500": + content: + application/json: + example: + https://errors-api.cloud.com/common/internalServerError: + value: + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds + parameters: + - name: retryDelay + value: "4" schema: - type: string - style: simple + $ref: '#/components/schemas/ErrorResponse' + description: An unexpected server error occurred. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + summary: The health check endpoint. + tags: + - HealthCheck APIs + /hypervisors: + get: + description: |- + Get all hypervisors configured in the site. + URI with ?noCache=true can ignore the cache and fetch the data directly. + operationId: Hypervisors_GetHypervisors + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + - description: 'Async request to hypervisor. ' + explode: true + in: query + name: async + required: false + schema: + default: false + title: Boolean + type: boolean + style: form + x-position: 1 + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/HypervisorResponseModelCollection' + description: List of hypervisors. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "202": + description: Async request was accepted and is being processed. + headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -161792,15 +159648,12 @@ paths: schema: type: string style: simple - summary: |- - Get hypervisors and resource pools. - This API is used for the hosting main view. + summary: Get the hypervisors. tags: - Hypervisors APIs - /Icons: - get: - description: Get all icons in the site. - operationId: Icons_GetIcons + post: + description: "Create a hypervisor, and optionally a resource pool on the hypervisor." + operationId: Hypervisors_CreateHypervisor parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -161864,47 +159717,13 @@ paths: type: string style: simple - description: |- - Icon format. Must be: `{mime-type};{width}x{height}x{colordepth}` - - - where: - - - * _mime-type_ must be `image/png`. (Other formats may be supported in future.) - * _width_ and _height_ are specified in pixels. - * _colordepth_ (optional) is either `8` or `24`. - - - example: `"image/png;32x32x24"` - - - Optional. If not specified, only the raw icon data will be returned. Note that - this is typically in ICO format, which some clients cannot display properly. - explode: true - in: query - name: iconFormat - required: false - schema: - nullable: true - title: String - type: string - style: form - x-position: 1 - - description: |- - If specified as `true`, only built-in icons will be returned. If specified as - `false`, only user-created icons will be returned. If not specified, all - icons will be returned. - explode: true - in: query - name: builtIn - required: false - schema: - nullable: true - title: Boolean - type: boolean - style: form - x-position: 2 - - description: 'If async execute. ' + If `true`, the hypervisor (and associated objects) will be created as a + background task. + The task will have JobType CreateHypervisor. + When the task is complete it will redirect to + GetHypervisor. + The job's Parameters will contain properties: + * _Name_ - Name of the hypervisor being created. explode: true in: query name: async @@ -161915,47 +159734,31 @@ paths: title: Boolean type: boolean style: form - x-position: 3 - - description: |- - The max number of icons returned by this query. - If not specified, the server might use a default limit of 250 items. - If the specified value is larger than 1000, the server might reject the call. - The default and maximum values depend on server settings. - explode: true - in: query - name: limit - required: false - schema: - format: int32 - nullable: true - title: Int32 - type: integer - style: form - x-position: 4 - - description: |- - If a query cannot be completed, the response will have a - ContinuationToken set. - To obtain more results from the query, pass the - continuation token back into the query to get the next - batch of results. - explode: true - in: query - name: continuationToken - required: false - schema: - nullable: true - title: String - type: string - style: form - x-position: 5 + x-position: 2 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateHypervisorRequestModel' + description: Details of the hypervisor to create. + required: true + x-name: model + x-position: 1 responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/IconResponseModelCollection' - description: List of icons. + $ref: '#/components/schemas/HypervisorDetailResponseModel' + description: Resource was created. headers: + Location: + description: Location where the newly created resource resides. + example: /services/myservice/widgets/1 + explode: false + schema: + type: string + style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -162007,6 +159810,35 @@ paths: schema: type: string style: simple + x-expectedSchemas: + - description: Details of the hypervisor that was created. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorDetailAWSResponseModel' + - description: Details of the hypervisor that was created. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorDetailAzureResponseModel' + - description: Details of the hypervisor that was created. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorDetailGCPResponseModel' + - description: Details of the hypervisor that was created. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorDetailWOLResponseModel' + - description: Details of the hypervisor that was created. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorDetailTraditionalResponseModel' + - description: Details of the hypervisor that was created. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorDetailOciResponseModel' + - description: Details of the hypervisor that was created. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorDetailResponseModel' "202": description: Async request was accepted and is being processed. headers: @@ -162068,6 +159900,60 @@ paths: schema: type: string style: simple + "204": + description: Operation is successful with no response content. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple "400": content: application/json: @@ -162334,21 +160220,18 @@ paths: schema: type: string style: simple - "429": + "409": content: application/json: example: - https://errors-api.cloud.com/common/rateLimitExceeded: + https://errors-api.cloud.com/common/optimisticConcurrency: value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds - parameters: - - name: retryDelay - value: "4" + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. + description: Caller requested an invalid relation to be created or deleted. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -162401,21 +160284,21 @@ paths: schema: type: string style: simple - "503": + "415": content: application/json: example: - https://errors-api.cloud.com/common/serviceUnavailable: + https://errors-api.cloud.com/common/unsupportedMediaType: value: - type: https://errors-api.cloud.com/common/serviceUnavailable - detail: Service is unavailable; try again in 4 seconds + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type parameters: - - name: retryDelay - value: "4" + - name: mediaType + value: application/xml schema: $ref: '#/components/schemas/ErrorResponse' - description: "Service is temporarily unable to process the request. Caller\ - \ may attempt the operation again, with exponential back-off." + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -162468,21 +160351,21 @@ paths: schema: type: string style: simple - "500": + "429": content: application/json: example: - https://errors-api.cloud.com/common/internalServerError: + https://errors-api.cloud.com/common/rateLimitExceeded: value: - type: https://errors-api.cloud.com/common/internalServerError - detail: An internal server error has occurred; try again in 4 - seconds + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds parameters: - name: retryDelay value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: An unexpected server error occurred. + description: Caller has made too many requests in a short period of time + and is being rate-limited. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -162535,110 +160418,22 @@ paths: schema: type: string style: simple - summary: Get all icons in the site. - tags: - - Icons APIs - post: - operationId: Icons_AddIcon - parameters: - - description: Citrix Customer ID. Default is 'CitrixOnPremises' - example: CitrixOnPremises - explode: false - in: header - name: Citrix-CustomerId - required: true - schema: - type: string - style: simple - - description: Citrix Instance (Site) ID. - explode: false - in: header - name: Citrix-InstanceId - required: true - schema: - type: string - style: simple - - description: User Agent type of the request. - example: Mozilla/5.0 - explode: false - in: header - name: User-Agent - required: false - schema: - type: string - style: simple - - description: "Citrix authorization header: CWSAuth Bearer={token}" - explode: false - in: header - name: Authorization - required: false - schema: - type: string - style: simple - - description: "Transaction ID that will be used to track this request. If not\ - \ provided, a new GUID will be generated and returned." - explode: false - in: header - name: Citrix-TransactionId - required: false - schema: - type: string - style: simple - - description: Must accept application/json. - example: application/json - explode: false - in: header - name: Accept - required: false - schema: - type: string - style: simple - - description: Locale of the request. - example: en-US - explode: false - in: header - name: Citrix-Locale - required: false - schema: - type: string - style: simple - - description: "If `true`, the icon will be added as a background task.\nThe\ - \ task will have JobType AddIcon.\nWhen the task is complete it will redirect\ - \ to\nGetIcon.\n " - explode: true - in: query - name: async - required: false - schema: - default: false - title: Boolean - type: boolean - style: form - x-position: 2 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AddIconRequestModel' - description: request body containing icon data - required: true - x-name: requestModel - x-position: 1 - responses: - "201": + "503": content: application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" schema: - $ref: '#/components/schemas/IconResponseModel' - description: Resource was created. + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." headers: - Location: - description: Location where the newly created resource resides. - example: /services/myservice/widgets/1 - explode: false - schema: - type: string - style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -162690,16 +160485,22 @@ paths: schema: type: string style: simple - "202": - description: Async request was accepted and is being processed. - headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false + "500": + content: + application/json: + example: + https://errors-api.cloud.com/common/internalServerError: + value: + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds + parameters: + - name: retryDelay + value: "4" schema: - type: string - style: simple + $ref: '#/components/schemas/ErrorResponse' + description: An unexpected server error occurred. + headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -162751,8 +160552,224 @@ paths: schema: type: string style: simple - "204": - description: Operation is successful with no response content. + summary: "Create a hypervisor, and optionally a resource pool on the hypervisor." + tags: + - Hypervisors APIs + /hypervisors/$GetResources: + post: + description: |- + Get the resources within a hypervisor, _without_ creating a + persistent connection to the hypervisor. Note: in previous versions + of the API, a "Hypervisor" was referred to as a "Connection". + This method is useful while determining the details required to + create both a hypervisor and a resource pool, but without finalizing + the creation of either. The caller is free to browse resources that + are available before deciding whether and how to proceed. + A caller can recursively enumerate by: + * Call with no `path`, and `children` equal to `1`. + * For each of the result's + Children where + IsContainer is + `true`, call with `path` equal to that item's + RelativePath and + `children` equal to `1`. + * Repeat recursively. + URI with ?force=true can get the VMs which provisioned by MCS. + URI with ?recurse=true can recurse fetch all resources under this folder. + operationId: Hypervisors_GetHypervisorAllResourcesWithoutConnection + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + - description: |- + Path to the resource container within the hypervisor. The path may + either be a relative path as specified by + RelativePath, or + may be a URL-encoded Virtual Apps & Desktops resource path + starting with `XDHyp:`; for example, as specified by + XDPath. + explode: true + in: query + name: path + required: false + schema: + nullable: true + title: String + type: string + style: form + x-position: 2 + - description: |- + Specifies the number of levels of children to enumerate. + Default is `0`, meaning that only the object referred to by `path` + is returned and its + Children array will be + left null. + A special value of `-1` indicates that the entire resource hierarchy + should be enumerated. Use with care! It may take a very long time + to enumerate a large number of resources from a hypervisor, and the + call may time out before completing. + explode: true + in: query + name: children + required: false + schema: + format: int32 + nullable: true + title: Int32 + type: integer + style: form + x-position: 3 + - description: "If specified, limits the results to the specified resource type(s)." + explode: true + in: query + name: type + required: false + schema: + items: + title: String + type: string + nullable: true + title: "String[]" + type: array + style: form + x-position: 4 + - description: |- + By default, items which are tagged by XenDesktop are not shown. Set + this to `true` to override that behavior. + explode: true + in: query + name: showTagged + required: false + schema: + nullable: true + title: Boolean + type: boolean + style: form + x-position: 5 + - description: |- + If `true`, full details of VMs, snapshots, and templates will be + retrieved. This can be very time consuming and will reduce the + performance of the call. May only be used if `path` refers to a VM, + snapshot, or template resource. + + explode: true + in: query + name: detail + required: false + schema: + nullable: true + title: Boolean + type: boolean + style: form + x-position: 6 + - description: Async request to get the resources with *path. + explode: true + in: query + name: async + required: false + schema: + default: false + title: Boolean + type: boolean + style: form + x-position: 7 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/HypervisorConnectionDetailRequestModel' + description: |- + Details of how to connect to the hypervisor to enumerate resources + from it. + required: true + x-name: connectionDetail + x-position: 1 + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/HypervisorResourceResponseModel' + description: |- + A list of hypervisor resources. + or + A list of hypervisor resources. + or + A list of hypervisor resources. + or + A list of hypervisor resources. + or + A list of hypervisor resources. + or + A list of hypervisor resources. + or + A list of hypervisor resources. + or + A list of hypervisor resources. + or + A list of hypervisor resources. + or + A list of hypervisor resources. + or + A list of hypervisor resources. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -162805,6 +160822,112 @@ paths: schema: type: string style: simple + x-expectedSchemas: + - description: A list of hypervisor resources. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorAvailabilityZoneResourceResponseModel' + - description: A list of hypervisor resources. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorGpuTypeResourceResponseModel' + - description: A list of hypervisor resources. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorSecurityGroupResourceResponseModel' + - description: A list of hypervisor resources. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorServiceOfferingResourceResponseModel' + - description: A list of hypervisor resources. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorStorageResourceResponseModel' + - description: A list of hypervisor resources. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorTemplateResourceResponseModel' + - description: A list of hypervisor resources. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorVmResourceResponseModel' + - description: A list of hypervisor resources. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorVmSnapshotResourceResponseModel' + - description: A list of hypervisor resources. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorVpcResourceResponseModel' + - description: A list of hypervisor resources. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorCloudRegionResourceResponseModel' + - description: A list of hypervisor resources. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorResourceResponseModel' + "202": + description: Async request was accepted and is being processed. + headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple "400": content: application/json: @@ -163403,12 +161526,15 @@ paths: schema: type: string style: simple - summary: add a customized icon. + summary: |- + Get all resources within a hypervisor, _without_ creating a + persistent connection to the hypervisor. tags: - - Icons APIs - /Icons/{id}: - delete: - operationId: Icons_RemoveIcon + - Hypervisors APIs + /hypervisors/$ValidateVm: + post: + description: Validate a list of hypervisor Vm Path. + operationId: Hypervisors_ValidateVmPath parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -163471,33 +161597,36 @@ paths: schema: type: string style: simple - - description: id of the icon to remove - explode: false - in: path - name: id - required: true - schema: - format: int32 - title: Int32 - type: integer - style: simple - x-position: 1 - - description: "If `true`, the icon will be removed as a background task.\n\ - The task will have JobType RemoveIcon.\nWhen the task is complete it will\ - \ redirect to\nGetIcons.\n " + - description: |- + If `true`, the resource pool will be updated as a background task. + The task will have JobType HypervisorVmValidation. explode: true in: query name: async required: false schema: default: false + nullable: true title: Boolean type: boolean style: form x-position: 2 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/HypervisorVmValidationRequestModel' + description: A list of Vm path. + required: true + x-name: VmPaths + x-position: 1 responses: - "204": - description: Operation is successful with no response content. + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/HypervisorVmValidationResponseModelCollection' + description: 'Details of the vm path validation results. ' headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -163811,8 +161940,20 @@ paths: schema: type: string style: simple - "404": - description: A referenced entity was not found. + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -163865,20 +162006,18 @@ paths: schema: type: string style: simple - "406": + "409": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/optimisticConcurrency: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type - parameters: - - name: contentType - value: application/json + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + description: Caller requested an invalid relation to be created or deleted. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -163931,18 +162070,21 @@ paths: schema: type: string style: simple - "409": + "415": content: application/json: example: - https://errors-api.cloud.com/common/optimisticConcurrency: + https://errors-api.cloud.com/common/unsupportedMediaType: value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type + parameters: + - name: mediaType + value: application/xml schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -164196,12 +162338,13 @@ paths: schema: type: string style: simple - summary: Remove a customized icon. + summary: Validate a list of hypervisor Vm Path. tags: - - Icons APIs - get: - description: Get a single icon from the site - operationId: Icons_GetIcon + - Hypervisors APIs + /hypervisors/{name}: + head: + description: Check for the existence of a hypervisor by name. + operationId: Hypervisors_CheckHypervisorExists parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -164264,10 +162407,10 @@ paths: schema: type: string style: simple - - description: ID of the icon. + - description: Name of the hypervisor. explode: false in: path - name: id + name: name required: true schema: nullable: true @@ -164275,38 +162418,9 @@ paths: type: string style: simple x-position: 1 - - description: |- - Icon format. Must be: - `{mime-type};{width}x{height}x{colordepth}` - - - where: - * _mime-type_ must be `image/png`. (Other formats may be supported in future.) - * _width_ and _height_ are specified in pixels. - * _colordepth_ (optional) is either `8` or `24`. - example: `"image/png;32x32x24"` - - - Optional. If not specified, only the raw icon data will be returned. Note that - this is typically in ICO format, which some clients cannot display properly. - explode: true - in: query - name: iconFormat - required: false - schema: - nullable: true - title: String - type: string - style: form - x-position: 2 responses: - "200": - content: - application/octet-stream: - schema: - format: binary - type: string - description: The icon. + "204": + description: Operation is successful with no response content. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -164894,15 +163008,12 @@ paths: schema: type: string style: simple - summary: Get a single icon from the site. + summary: Check for the existence of a hypervisor by name. tags: - - Icons APIs - /Icons/AppVServerPackageApplication: - post: - description: |- - Get the icon for a single App-V package on a server (as - opposed to within the site). - operationId: Icons_GetAppVServerPackageApplicationIcon + - Hypervisors APIs + /hypervisors/{nameOrId}: + delete: + operationId: Hypervisors_DeleteHypervisor parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -164965,22 +163076,32 @@ paths: schema: type: string style: simple - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AppvServerPackageApplicationIconRequestModel' - description: App-V server package application icon request model. + - description: 'The hypervisor connection name or id. ' + explode: false + in: path + name: nameOrId required: true - x-name: request + schema: + nullable: true + title: String + type: string + style: simple x-position: 1 + - description: 'If the api call with async type. ' + explode: true + in: query + name: async + required: false + schema: + default: false + nullable: true + title: Boolean + type: boolean + style: form + x-position: 2 responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/IconDataResponseModel' - description: Icon details. + "204": + description: Operation is successful with no response content. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -165033,87 +163154,16 @@ paths: schema: type: string style: simple - "400": - content: - application/json: - example: - https://errors-api.cloud.com/common/outOfRange: - value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range - parameters: - - name: property - value: startTime - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + "202": + description: Async request was accepted and is being processed. headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" explode: false schema: type: string style: simple - "401": - content: - application/json: - example: - https://errors-api.cloud.com/common/authentication: - value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details - parameters: - - name: reason - value: missing - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. - headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -165165,22 +163215,20 @@ paths: schema: type: string style: simple - "403": + "400": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/outOfRange: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: property + value: startTime schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: Caller passed an invalid input. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -165233,20 +163281,20 @@ paths: schema: type: string style: simple - "406": + "401": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: contentType - value: application/json + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -165299,18 +163347,22 @@ paths: schema: type: string style: simple - "409": + "403": content: application/json: example: - https://errors-api.cloud.com/common/optimisticConcurrency: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null + type: https://errors-api.cloud.com/common/authorization + detail: Access denied + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -165363,21 +163415,8 @@ paths: schema: type: string style: simple - "415": - content: - application/json: - example: - https://errors-api.cloud.com/common/unsupportedMediaType: - value: - type: https://errors-api.cloud.com/common/unsupportedMediaType - detail: Must use application/json;charset=utf-8 media type - parameters: - - name: mediaType - value: application/xml - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller must send request body in utf-8 and specify request - Content-Type as utf-8. + "404": + description: A referenced entity was not found. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -165430,21 +163469,20 @@ paths: schema: type: string style: simple - "429": + "406": content: application/json: example: - https://errors-api.cloud.com/common/rateLimitExceeded: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type parameters: - - name: retryDelay - value: "4" + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -165497,21 +163535,18 @@ paths: schema: type: string style: simple - "503": + "409": content: application/json: example: - https://errors-api.cloud.com/common/serviceUnavailable: + https://errors-api.cloud.com/common/optimisticConcurrency: value: - type: https://errors-api.cloud.com/common/serviceUnavailable - detail: Service is unavailable; try again in 4 seconds - parameters: - - name: retryDelay - value: "4" + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null schema: $ref: '#/components/schemas/ErrorResponse' - description: "Service is temporarily unable to process the request. Caller\ - \ may attempt the operation again, with exponential back-off." + description: Caller requested an invalid relation to be created or deleted. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -165564,156 +163599,21 @@ paths: schema: type: string style: simple - "500": + "429": content: application/json: example: - https://errors-api.cloud.com/common/internalServerError: + https://errors-api.cloud.com/common/rateLimitExceeded: value: - type: https://errors-api.cloud.com/common/internalServerError - detail: An internal server error has occurred; try again in 4 - seconds + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds parameters: - name: retryDelay value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: An unexpected server error occurred. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - summary: |- - Get the icon for a single App-V application within an App-V package - on a server. - tags: - - Icons APIs - /Jobs: - get: - description: |- - For security reasons, jobs are only visible to the caller who - initiated them. - - Note: completed jobs will be automatically removed by the system - 48 hours after completion. - operationId: Jobs_GetJobs - parameters: - - description: Citrix Customer ID. Default is 'CitrixOnPremises' - example: CitrixOnPremises - explode: false - in: header - name: Citrix-CustomerId - required: true - schema: - type: string - style: simple - - description: Citrix Instance (Site) ID. - explode: false - in: header - name: Citrix-InstanceId - required: true - schema: - type: string - style: simple - - description: User Agent type of the request. - example: Mozilla/5.0 - explode: false - in: header - name: User-Agent - required: false - schema: - type: string - style: simple - - description: "Citrix authorization header: CWSAuth Bearer={token}" - explode: false - in: header - name: Authorization - required: false - schema: - type: string - style: simple - - description: "Transaction ID that will be used to track this request. If not\ - \ provided, a new GUID will be generated and returned." - explode: false - in: header - name: Citrix-TransactionId - required: false - schema: - type: string - style: simple - - description: Must accept application/json. - example: application/json - explode: false - in: header - name: Accept - required: false - schema: - type: string - style: simple - - description: Locale of the request. - example: en-US - explode: false - in: header - name: Citrix-Locale - required: false - schema: - type: string - style: simple - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/JobResponseModelCollection' - description: List of jobs. + description: Caller has made too many requests in a short period of time + and is being rate-limited. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -165766,20 +163666,21 @@ paths: schema: type: string style: simple - "400": + "503": content: application/json: example: - https://errors-api.cloud.com/common/outOfRange: + https://errors-api.cloud.com/common/serviceUnavailable: value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds parameters: - - name: property - value: startTime + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -165832,20 +163733,21 @@ paths: schema: type: string style: simple - "401": + "500": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/internalServerError: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds parameters: - - name: reason - value: missing + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: An unexpected server error occurred. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -165898,362 +163800,14 @@ paths: schema: type: string style: simple - "403": - content: - application/json: - example: - https://errors-api.cloud.com/common/authorization: - value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied - parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "406": - content: - application/json: - example: - https://errors-api.cloud.com/common/notAcceptable: - value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type - parameters: - - name: contentType - value: application/json - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "429": - content: - application/json: - example: - https://errors-api.cloud.com/common/rateLimitExceeded: - value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds - parameters: - - name: retryDelay - value: "4" - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "503": - content: - application/json: - example: - https://errors-api.cloud.com/common/serviceUnavailable: - value: - type: https://errors-api.cloud.com/common/serviceUnavailable - detail: Service is unavailable; try again in 4 seconds - parameters: - - name: retryDelay - value: "4" - schema: - $ref: '#/components/schemas/ErrorResponse' - description: "Service is temporarily unable to process the request. Caller\ - \ may attempt the operation again, with exponential back-off." - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "500": - content: - application/json: - example: - https://errors-api.cloud.com/common/internalServerError: - value: - type: https://errors-api.cloud.com/common/internalServerError - detail: An internal server error has occurred; try again in 4 - seconds - parameters: - - name: retryDelay - value: "4" - schema: - $ref: '#/components/schemas/ErrorResponse' - description: An unexpected server error occurred. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - summary: |- - Get the list of jobs that are currently active, or have recently - completed, and were initiated by the caller. + summary: Delete a hypervisor and related resource pools. tags: - - Jobs APIs - /Jobs/{id}: - delete: + - Hypervisors APIs + get: description: |- - For security reasons, jobs are only visible to the caller who - initiated them. - - - This may only be called if the job has completed (with or without an error - or warning) or if the job has been cancelled. It will return an error - if the job is still in progress. - - - Note: completed jobs will be automatically removed by the system - 48 hours after completion. After this happens, this call will - return `404 Not Found` when given the removed job Id. - operationId: Jobs_DeleteJob + Get the details for a single hypervisor. + URI with ?noCache=true can ignore the cache and fetch the data directly. + operationId: Hypervisors_GetHypervisor parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -166316,10 +163870,10 @@ paths: schema: type: string style: simple - - description: ID of the job to remove. + - description: Name or ID of the hypervisor. explode: false in: path - name: id + name: nameOrId required: true schema: nullable: true @@ -166327,9 +163881,37 @@ paths: type: string style: simple x-position: 1 + - description: 'Async request to hypervisor. ' + explode: true + in: query + name: async + required: false + schema: + default: false + title: Boolean + type: boolean + style: form + x-position: 2 responses: - "204": - description: Operation is successful with no response content. + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/HypervisorDetailResponseModel' + description: |- + Hypervisor details. + or + Hypervisor details. + or + Hypervisor details. + or + Hypervisor details. + or + Hypervisor details. + or + Hypervisor details. + or + Hypervisor details. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -166382,21 +163964,45 @@ paths: schema: type: string style: simple - "400": - content: - application/json: - example: - https://errors-api.cloud.com/common/outOfRange: - value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range - parameters: - - name: property - value: startTime - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + x-expectedSchemas: + - description: Hypervisor details. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorDetailAWSResponseModel' + - description: Hypervisor details. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorDetailAzureResponseModel' + - description: Hypervisor details. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorDetailGCPResponseModel' + - description: Hypervisor details. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorDetailWOLResponseModel' + - description: Hypervisor details. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorDetailTraditionalResponseModel' + - description: Hypervisor details. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorDetailOciResponseModel' + - description: Hypervisor details. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorDetailResponseModel' + "202": + description: Async request was accepted and is being processed. headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -166448,20 +164054,20 @@ paths: schema: type: string style: simple - "401": + "400": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/outOfRange: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range parameters: - - name: reason - value: missing + - name: property + value: startTime schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: Caller passed an invalid input. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -166514,22 +164120,20 @@ paths: schema: type: string style: simple - "403": + "401": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -166582,8 +164186,22 @@ paths: schema: type: string style: simple - "404": - description: A referenced entity was not found. + "403": + content: + application/json: + example: + https://errors-api.cloud.com/common/authorization: + value: + type: https://errors-api.cloud.com/common/authorization + detail: Access denied + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -166636,20 +164254,22 @@ paths: schema: type: string style: simple - "406": + "404": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/notFound: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found parameters: - - name: contentType - value: application/json + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + description: A referenced entity was not found. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -166702,18 +164322,20 @@ paths: schema: type: string style: simple - "409": + "406": content: application/json: example: - https://errors-api.cloud.com/common/optimisticConcurrency: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -166967,18 +164589,12 @@ paths: schema: type: string style: simple - summary: Removes the job record. + summary: Get the details for a single hypervisor. tags: - - Jobs APIs - get: - description: |- - For security reasons, jobs are only visible to the caller who - initiated them. - - Note: completed jobs will be automatically removed by the system - 48 hours after completion. After this happens, this call will - return `404 Not Found` when given the removed job Id. - operationId: Jobs_GetJob + - Hypervisors APIs + patch: + description: Update a hypervisor. + operationId: Hypervisors_PatchHypervisor parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -167041,25 +164657,124 @@ paths: schema: type: string style: simple - - description: ID of the job. + - description: Name or ID of the hypervisor. explode: false in: path - name: id + name: nameOrId required: true schema: nullable: true title: String type: string style: simple + x-position: 2 + - description: |- + If `true`, the hypervisor will be updated as a background task. + The task will have JobType UpdateHypervisor. + When the task is complete it will redirect to + GetHypervisor. + The job's Parameters will contain properties: + * _Name_ - Name of the hypervisor being updated. + * _Id_ - ID of the hypervisor being updated. + explode: true + in: query + name: async + required: false + schema: + default: false + nullable: true + title: Boolean + type: boolean + style: form + x-position: 3 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EditHypervisorConnectionRequestModel' + description: |- + Details of the hypervisor to update. Note that each type of + hypervisor requires a different update model: + * AWS requires a model of + type EditHypervisorAWSConnectionRequestModel. + * AzureRM requires a model of + type EditHypervisorAzureConnectionRequestModel. + * GoogleCloudPlatform + requires a model of type + EditHypervisorGCPConnectionRequestModel. + * OracleCloudInfrastructure + requires a model of type + EditHypervisorOciConnectionRequestModel. + * All other hypervisor types require a model of type + EditHypervisorTraditionalConnectionRequestModel. + required: true + x-name: model x-position: 1 responses: - "200": - content: - application/json: + "204": + description: Operation is successful with no response content. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false schema: - $ref: '#/components/schemas/JobResponseModel' - description: Details of the job. + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "202": + description: Async request was accepted and is being processed. headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -167445,6 +165160,73 @@ paths: schema: type: string style: simple + "415": + content: + application/json: + example: + https://errors-api.cloud.com/common/unsupportedMediaType: + value: + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type + parameters: + - name: mediaType + value: application/xml + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple "429": content: application/json: @@ -167646,18 +165428,12 @@ paths: schema: type: string style: simple - summary: Get the details of a single job. + summary: Update a hypervisor. tags: - - Jobs APIs - /Jobs/{id}/$cancel: + - Hypervisors APIs + /hypervisors/{nameOrId}/$resetConnection: post: - description: "For security reasons, jobs are only visible to the caller who\n\ - initiated them.\n\nThis may only be called if \nis `true`, OR if the job has\ - \ completed (with or without an error\nor warning).\n\nNote: completed jobs\ - \ will be automatically removed by the system\n48 hours after completion.\ - \ After this happens, this call will\nreturn `404 Not Found` when given the\ - \ removed job Id." - operationId: Jobs_CancelJob + operationId: Hypervisors_ResetBrokerHypervisorConnection parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -167720,10 +165496,10 @@ paths: schema: type: string style: simple - - description: ID of the job to remove. + - description: 'Hypervisor connection name or id. ' explode: false in: path - name: id + name: nameOrId required: true schema: nullable: true @@ -167731,13 +165507,21 @@ paths: type: string style: simple x-position: 1 + - description: 'If async calling. ' + explode: true + in: query + name: async + required: false + schema: + default: false + nullable: true + title: Boolean + type: boolean + style: form + x-position: 2 responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/JobResponseModel' - description: Job details. + "204": + description: Operation is successful with no response content. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -167790,21 +165574,16 @@ paths: schema: type: string style: simple - "400": - content: - application/json: - example: - https://errors-api.cloud.com/common/outOfRange: - value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range - parameters: - - name: property - value: startTime - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + "202": + description: Async request was accepted and is being processed. headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -167856,20 +165635,20 @@ paths: schema: type: string style: simple - "401": + "400": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/outOfRange: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range parameters: - - name: reason - value: missing + - name: property + value: startTime schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: Caller passed an invalid input. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -167922,22 +165701,20 @@ paths: schema: type: string style: simple - "403": + "401": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -167990,14 +165767,14 @@ paths: schema: type: string style: simple - "404": + "403": content: application/json: example: - https://errors-api.cloud.com/common/notFound: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - name: entityType value: https://identifiers-api.cloud.com/example/widget @@ -168005,7 +165782,7 @@ paths: value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -168058,84 +165835,22 @@ paths: schema: type: string style: simple - "406": + "404": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/notFound: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found parameters: - - name: contentType - value: application/json - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "409": - content: - application/json: - example: - https://errors-api.cloud.com/common/optimisticConcurrency: - value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. + description: A referenced entity was not found. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -168188,21 +165903,151 @@ paths: schema: type: string style: simple - "429": + "406": content: application/json: example: - https://errors-api.cloud.com/common/rateLimitExceeded: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type parameters: - - name: retryDelay - value: "4" + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. + description: Caller must specify utf-8 charset with the Accept header. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "409": + content: + application/json: + example: + https://errors-api.cloud.com/common/optimisticConcurrency: + value: + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller requested an invalid relation to be created or deleted. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "429": + content: + application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller has made too many requests in a short period of time + and is being rate-limited. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -168389,20 +166234,20 @@ paths: schema: type: string style: simple - summary: Cancel a job. + summary: |- + Requests the broker hypervisor connection to be reset. + The connection is dropped, details including credentials refreshed and + the connection reestablished. The reset request is asynchronous and + may take a moment to occur. tags: - - Jobs APIs - /Jobs/{id}/$SkipRemaining: + - Hypervisors APIs + /Hypervisors/{nameOrId}/$test: post: - description: "For security reasons, jobs are only visible to the caller who\n\ - initiated them.\n\nOnly supported for jobs where \nis equal to . Any job\ - \ that\ndoes not support this action will return a `501 Not Implemented`\n\ - response code.\n\n\nIf the job has already completed successfully, this call\ - \ will return\na `303 See Other` response, with a `Location` header\npointing\ - \ to the affected resource(s).\n\nNote: completed jobs will be automatically\ - \ removed by the system\n48 hours after completion. After this happens, this\ - \ call will\nreturn `404 Not Found` when given the removed job Id." - operationId: Jobs_SkipRemainingSubtasks + description: |- + Run tests on a hypervisor and create a test report. Obtain the most + recent report from + GetHypervisorTestReport. + operationId: Hypervisors_TestHypervisor parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -168465,10 +166310,10 @@ paths: schema: type: string style: simple - - description: ID of the job. + - description: Name or ID of the hypervisor to test. explode: false in: path - name: id + name: nameOrId required: true schema: nullable: true @@ -168476,13 +166321,35 @@ paths: type: string style: simple x-position: 1 + - description: |- + If `true`, the tests will run as a background task. This is recommended as the + tests may take some time to run, and if it exceeds 90 seconds the request may + time out. + The task will have JobType TestHypervisor. + When the task is complete it will redirect to + GetJobResults. + The job's Parameters will contain properties: + + * _Id_ - ID of the hypervisor being tested, + * _Name_ - Name of the hypervisor being tested. + explode: true + in: query + name: async + required: false + schema: + default: false + nullable: true + title: Boolean + type: boolean + style: form + x-position: 2 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/JobResponseModel' - description: Details of the job. + $ref: '#/components/schemas/HypervisorTestResponseModel' + description: Test response. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -168535,21 +166402,16 @@ paths: schema: type: string style: simple - "400": - content: - application/json: - example: - https://errors-api.cloud.com/common/outOfRange: - value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range - parameters: - - name: property - value: startTime - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + "202": + description: Async request was accepted and is being processed. headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -168601,20 +166463,20 @@ paths: schema: type: string style: simple - "401": + "400": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/outOfRange: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range parameters: - - name: reason - value: missing + - name: property + value: startTime schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: Caller passed an invalid input. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -168667,22 +166529,20 @@ paths: schema: type: string style: simple - "403": + "401": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -168735,14 +166595,14 @@ paths: schema: type: string style: simple - "404": + "403": content: application/json: example: - https://errors-api.cloud.com/common/notFound: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - name: entityType value: https://identifiers-api.cloud.com/example/widget @@ -168750,7 +166610,7 @@ paths: value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -168803,20 +166663,88 @@ paths: schema: type: string style: simple - "406": + "404": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/notFound: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found parameters: - - name: contentType - value: application/json + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + description: A referenced entity was not found. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -169134,33 +167062,13 @@ paths: schema: type: string style: simple - summary: Skips any remaining / unstarted subtasks of the job. + summary: Run tests on a hypervisor and create a test report. tags: - - Jobs APIs - /Jobs/{id}/Results: + - Hypervisors APIs + /hypervisors/{nameOrId}/administrators: get: - description: |- - For security reasons, jobs are only visible to the caller who - initiated them. - - Most jobs do not store results, but rather, redirect the caller - to the object(s) upon which the job was executing once complete. - However, some jobs (such as long-running GET operations) have - results which are stored independently and are retrievable from - this API. Consult the documentation of the API which initiated - the job to determine if the results are obtained from this API - or elsewhere. - - - If the job has completed but its results are not retrievable - here, the call will return a `303 See Other` response, with a - response header Location directing the caller to an API where - the job results are obtained. - - Note: completed jobs will be automatically removed by the system - 48 hours after completion. After this happens, this call will - return `404 Not Found` when given the removed job Id. - operationId: Jobs_GetJobResults + description: Get administrators who can administer a hypervisor. + operationId: Hypervisors_GetHypervisorAdministrators parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -169223,10 +167131,10 @@ paths: schema: type: string style: simple - - description: ID of the job. + - description: Name or ID of the hypervisor. explode: false in: path - name: id + name: nameOrId required: true schema: nullable: true @@ -169234,14 +167142,57 @@ paths: type: string style: simple x-position: 1 + - description: 'If async execute. ' + explode: true + in: query + name: async + required: false + schema: + default: false + nullable: true + title: Boolean + type: boolean + style: form + x-position: 2 + - description: |- + The max number of administrators returned by this query. + If not specified, the server might use a default limit of 250 items. + If the specified value is larger than 1000, the server might reject the call. + The default and maximum values depend on server settings. + explode: true + in: query + name: limit + required: false + schema: + format: int32 + nullable: true + title: Int32 + type: integer + style: form + x-position: 3 + - description: |- + If a query cannot be completed, the response will have a + ContinuationToken set. + To obtain more results from the query, pass the + continuation token back into the query to get the next + batch of results. + explode: true + in: query + name: continuationToken + required: false + schema: + nullable: true + title: String + type: string + style: form + x-position: 4 responses: "200": content: - application/octet-stream: + application/json: schema: - format: binary - type: string - description: Job results. + $ref: '#/components/schemas/AdministratorResponseModelCollection' + description: List of administrators. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -169294,21 +167245,16 @@ paths: schema: type: string style: simple - "400": - content: - application/json: - example: - https://errors-api.cloud.com/common/outOfRange: - value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range - parameters: - - name: property - value: startTime - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + "202": + description: Async request was accepted and is being processed. headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -169360,20 +167306,20 @@ paths: schema: type: string style: simple - "401": + "400": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/outOfRange: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range parameters: - - name: reason - value: missing + - name: property + value: startTime schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: Caller passed an invalid input. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -169426,22 +167372,20 @@ paths: schema: type: string style: simple - "403": + "401": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -169494,14 +167438,14 @@ paths: schema: type: string style: simple - "404": + "403": content: application/json: example: - https://errors-api.cloud.com/common/notFound: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - name: entityType value: https://identifiers-api.cloud.com/example/widget @@ -169509,7 +167453,7 @@ paths: value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -169562,20 +167506,22 @@ paths: schema: type: string style: simple - "406": + "404": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/notFound: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found parameters: - - name: contentType - value: application/json + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + description: A referenced entity was not found. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -169628,21 +167574,20 @@ paths: schema: type: string style: simple - "429": + "406": content: application/json: example: - https://errors-api.cloud.com/common/rateLimitExceeded: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type parameters: - - name: retryDelay - value: "4" + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -169695,21 +167640,88 @@ paths: schema: type: string style: simple - "503": + "429": content: application/json: example: - https://errors-api.cloud.com/common/serviceUnavailable: + https://errors-api.cloud.com/common/rateLimitExceeded: value: - type: https://errors-api.cloud.com/common/serviceUnavailable - detail: Service is unavailable; try again in 4 seconds + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds parameters: - name: retryDelay value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: "Service is temporarily unable to process the request. Caller\ - \ may attempt the operation again, with exponential back-off." + description: Caller has made too many requests in a short period of time + and is being rate-limited. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "503": + content: + application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -169829,12 +167841,27 @@ paths: schema: type: string style: simple - summary: Get the results of a job which has completed execution. + summary: Get administrators who can administer a hypervisor. tags: - - Jobs APIs - /machineCatalogActions: - delete: - operationId: Actions_DeleteActions + - Hypervisors APIs + /hypervisors/{nameOrId}/allResources: + get: + description: |- + Get the resources within a hypervisor. Note: in previous versions + of the API, this was referred to as a "Connection". + A caller can recursively enumerate by: + * Call with no `path`, and `children` equal to `1`. + * For each of the result's + Children where + IsContainer is + `true`, call with `path` equal to that item's + RelativePath and + `children` equal to `1`. + * Repeat recursively. + URI with ?noCache=true can ignore the cache and fetch the data directly. + URI with ?force=true can get the VMs which provisioned by MCS. + URI with ?recurse=true can recurse fetch all resources under this folder. + operationId: Hypervisors_GetHypervisorAllResources parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -169897,20 +167924,138 @@ paths: schema: type: string style: simple - - description: 'If async to request actions. ' + - description: Name or ID of the hypervisor. + explode: false + in: path + name: nameOrId + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 1 + - description: |- + Path to the resource container within the hypervisor. The path may + either be a relative path as specified by + RelativePath, or + may be a URL-encoded XenApp & XenDesktop resource path starting + with `XDHyp:`; for example, as specified by + XDPath. + explode: true + in: query + name: path + required: false + schema: + nullable: true + title: String + type: string + style: form + x-position: 2 + - description: |- + Specifies the number of levels of children to enumerate. + Default is `0`, meaning that only the object referred to by `path` + is returned and its + Children array will be left + null. + A special value of `-1` indicates that the entire resource hierarchy + should be enumerated. Use with care! It may take a very long time + to enumerate a large number of resources from a hypervisor, and the + call may time out before completing. + explode: true + in: query + name: children + required: false + schema: + format: int32 + nullable: true + title: Int32 + type: integer + style: form + x-position: 3 + - description: "If specified, limits the results to the specified resource type(s)." + explode: true + in: query + name: type + required: false + schema: + items: + title: String + type: string + nullable: true + title: "String[]" + type: array + style: form + x-position: 4 + - description: |- + By default, items which are tagged by XenDesktop are not shown. Set + this to `true` to override that behavior. + explode: true + in: query + name: showTagged + required: false + schema: + nullable: true + title: Boolean + type: boolean + style: form + x-position: 5 + - description: |- + If `true`, full details of VMs, snapshots, and templates will be + retrieved. This can be very time consuming and will reduce the + performance of the call. May only be used if `path` refers to a VM, + snapshot, or template resource. + + explode: true + in: query + name: detail + required: false + schema: + nullable: true + title: Boolean + type: boolean + style: form + x-position: 6 + - description: Async request to get the resources with *path. explode: true in: query name: async required: false schema: default: false + nullable: true title: Boolean type: boolean style: form - x-position: 1 + x-position: 7 responses: - "204": - description: Operation is successful with no response content. + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/HypervisorResourceResponseModel' + description: |- + A list of hypervisor resources. + or + A list of hypervisor resources. + or + A list of hypervisor resources. + or + A list of hypervisor resources. + or + A list of hypervisor resources. + or + A list of hypervisor resources. + or + A list of hypervisor resources. + or + A list of hypervisor resources. + or + A list of hypervisor resources. + or + A list of hypervisor resources. + or + A list of hypervisor resources. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -169963,6 +168108,51 @@ paths: schema: type: string style: simple + x-expectedSchemas: + - description: A list of hypervisor resources. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorAvailabilityZoneResourceResponseModel' + - description: A list of hypervisor resources. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorGpuTypeResourceResponseModel' + - description: A list of hypervisor resources. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorSecurityGroupResourceResponseModel' + - description: A list of hypervisor resources. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorServiceOfferingResourceResponseModel' + - description: A list of hypervisor resources. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorStorageResourceResponseModel' + - description: A list of hypervisor resources. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorTemplateResourceResponseModel' + - description: A list of hypervisor resources. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorVmResourceResponseModel' + - description: A list of hypervisor resources. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorVmSnapshotResourceResponseModel' + - description: A list of hypervisor resources. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorVpcResourceResponseModel' + - description: A list of hypervisor resources. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorCloudRegionResourceResponseModel' + - description: A list of hypervisor resources. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorResourceResponseModel' "202": description: Async request was accepted and is being processed. headers: @@ -170224,20 +168414,22 @@ paths: schema: type: string style: simple - "406": + "404": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/notFound: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found parameters: - - name: contentType - value: application/json + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + description: A referenced entity was not found. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -170290,18 +168482,20 @@ paths: schema: type: string style: simple - "409": + "406": content: application/json: example: - https://errors-api.cloud.com/common/optimisticConcurrency: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -170555,11 +168749,12 @@ paths: schema: type: string style: simple - summary: Delete all completed machine catalog actions. + summary: Get all resources within a hypervisor. tags: - - Actions APIs - get: - operationId: Actions_GetActions + - Hypervisors APIs + /hypervisors/{nameOrId}/connection: + put: + operationId: Hypervisors_PutBrokerHypervisorConnection parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -170622,56 +168817,41 @@ paths: schema: type: string style: simple - - description: 'If async to request actions. ' - explode: true - in: query - name: async - required: false - schema: - default: false - title: Boolean - type: boolean - style: form - x-position: 1 - - description: |- - The max number of actions returned by this query. - If not specified, the server might use a default limit of 250 items. - If the specified value is larger than 1000, the server might reject the call. - The default and maximum values depend on server settings. - explode: true - in: query - name: limit - required: false + - description: 'Hypervisor connection name or id. ' + explode: false + in: path + name: nameOrId + required: true schema: - format: int32 nullable: true - title: Int32 - type: integer - style: form + title: String + type: string + style: simple x-position: 2 - - description: |- - If a query cannot be completed, the response will have a - ContinuationToken set. - To obtain more results from the query, pass the - continuation token back into the query to get the next - batch of results. + - description: 'If async calling. ' explode: true in: query - name: continuationToken + name: async required: false schema: + default: false nullable: true - title: String - type: string + title: Boolean + type: boolean style: form x-position: 3 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EditBrokerHypervisorConnectionRequestModel' + description: 'EditBrokerHypervisorConnectionRequestModel or derived objects. ' + required: true + x-name: model + x-position: 1 responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/ActionResponseModelCollection' - description: ActionResponseModelCollection + "204": + description: Operation is successful with no response content. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -170985,6 +169165,74 @@ paths: schema: type: string style: simple + "404": + content: + application/json: + example: + https://errors-api.cloud.com/common/notFound: + value: + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: A referenced entity was not found. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple "406": content: application/json: @@ -171051,6 +169299,73 @@ paths: schema: type: string style: simple + "415": + content: + application/json: + example: + https://errors-api.cloud.com/common/unsupportedMediaType: + value: + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type + parameters: + - name: mediaType + value: application/xml + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple "429": content: application/json: @@ -171252,13 +169567,13 @@ paths: schema: type: string style: simple - summary: Get all machine catalog actions. + summary: Set the properties on a broker hypervisor connection. tags: - - Actions APIs - /MachineCatalogs: + - Hypervisors APIs + /hypervisors/{nameOrId}/deletePreview: get: - description: Get all machine catalogs in the site. - operationId: MachineCatalogs_GetMachineCatalogs + description: Get the machine catalogs and related info that are using a hypervisor. + operationId: Hypervisors_GetHypervisorDeletePreview parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -171321,18 +169636,18 @@ paths: schema: type: string style: simple - - description: Admin folder path or Id. - explode: true - in: query - name: adminFolder - required: false + - description: Name or ID of the hypervisor. + explode: false + in: path + name: nameOrId + required: true schema: nullable: true title: String type: string - style: form + style: simple x-position: 1 - - description: "If `true`, it will be queried as a background task." + - description: 'If execute this API asynchronous. ' explode: true in: query name: async @@ -171344,59 +169659,13 @@ paths: type: boolean style: form x-position: 2 - - description: |- - The max number of machine catalogs returned by this query. - If not specified, the server might use a default limit of 250 items. - If the specified value is larger than 1000, the server might reject the call. - The default and maximum values depend on server settings. - explode: true - in: query - name: limit - required: false - schema: - format: int32 - nullable: true - title: Int32 - type: integer - style: form - x-position: 3 - - description: |- - If a query cannot be completed, the response will have a - ContinuationToken set. - To obtain more results from the query, pass the - continuation token back into the query to get the next - batch of results. - explode: true - in: query - name: continuationToken - required: false - schema: - nullable: true - title: String - type: string - style: form - x-position: 4 - - description: "Optional. A filter string containing object fields requested\ - \ to be returned, the requested fields are separated by comma','.\n \ - \ " - example: "Name,FullName,Id" - explode: true - in: query - name: fields - required: false - schema: - nullable: true - title: String - type: string - style: form - x-position: 5 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/MachineCatalogResponseModelCollection' - description: List of machine catalogs. + $ref: '#/components/schemas/HypervisorDeletePreviewResponseModel' + description: HypervisorDeletePreviewResponseModel object. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -171710,6 +169979,74 @@ paths: schema: type: string style: simple + "404": + content: + application/json: + example: + https://errors-api.cloud.com/common/notFound: + value: + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: A referenced entity was not found. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple "406": content: application/json: @@ -171977,19 +170314,13 @@ paths: schema: type: string style: simple - summary: Get all machine catalogs. + summary: Get the hypervisor delete preview. tags: - - MachineCatalogs APIs - post: - description: "Create a machine catalog.\n\nNote that if a machine catalog uses\ - \ \nof , the machine catalog creation will always invoke asynchronous\njob(s)\ - \ for the provisioning action. If this API is invoked asynchronously, the\ - \ asynchronous job\nwill include only the machine catalog creation, and the\ - \ provisioning task(s) will be associated\nwith the newly created catalog.\ - \ If this API is invoked synchronously, the machine catalog\ncreation will\ - \ complete synchronously but the provisioning task(s) may still be executing,\ - \ and\nwill be associated with the newly created catalog." - operationId: MachineCatalogs_CreateMachineCatalog + - Hypervisors APIs + /hypervisors/{nameOrId}/jobs: + get: + description: Get the currently active provisioning jobs that are using a hypervisor. + operationId: Hypervisors_GetHypervisorJobs parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -172034,30 +170365,6 @@ paths: schema: type: string style: simple - - description: "Admin credential to use when performing the operation. If not\ - \ specified, the operation will be performed using the account under which\ - \ the identity service is running If specified, must be in a format matching\ - \ that of the standard 'Authorization' request header; the username and\ - \ password separated by a colon, UTF8-encoded, then base64-encoded, then\ - \ the \"Basic \" scheme prepended.\r\nExample:Basic QWxhZGRpbjpPcGVuU2VzYW1l" - explode: false - in: header - name: X-AdminCredential - required: false - schema: - type: string - style: simple - - description: "Access token to use when performing the operation. If specified,\ - \ must be in a format matching that of the standard 'Authorization' request\ - \ header; UTF8-encoded, then base64-encoded, then the \"Bearer\" scheme\ - \ prepended.\r\nExample: Bearer bGljaGVuZy5saW5AY2l0cml4LmNvbQ==" - explode: false - in: header - name: X-AccessToken - required: false - schema: - type: string - style: simple - description: Must accept application/json. example: application/json explode: false @@ -172076,54 +170383,24 @@ paths: schema: type: string style: simple - - description: |- - If `true`, the machine catalog (and associated objects) will be - created as a background task. - The task will have JobType CreateMachineCatalog. - When the task is complete it will redirect to - GetMachineCatalog. - The job's Parameters will contain properties: - * _Name_ - Name of the machine catalog being created. - explode: true - in: query - name: async - required: false - schema: - default: false - nullable: true - title: Boolean - type: boolean - style: form - x-position: 2 - - description: |- - The machine catalog name or Id to recreate from. It is only used for catalog recreation - scenario. Here specify name or Id of the failed catalog to recreate. - explode: true - in: query - name: sourceNameOrId - required: false + - description: Name or ID of the hypervisor. + explode: false + in: path + name: nameOrId + required: true schema: nullable: true title: String type: string - style: form - x-position: 3 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CreateMachineCatalogRequestModel' - description: Details about the machine catalog to create. - required: true - x-name: request + style: simple x-position: 1 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/MachineCatalogDetailResponseModel' - description: Details about the machine catalog that was just created. + $ref: '#/components/schemas/JobResponseModelCollection' + description: List of machine catalogs that are using a hypervisor. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -172176,16 +170453,21 @@ paths: schema: type: string style: simple - "202": - description: Async request was accepted and is being processed. - headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime schema: - type: string - style: simple + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -172237,20 +170519,20 @@ paths: schema: type: string style: simple - "400": + "401": content: application/json: example: - https://errors-api.cloud.com/common/outOfRange: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: property - value: startTime + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -172303,20 +170585,22 @@ paths: schema: type: string style: simple - "401": + "403": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - - name: reason - value: missing + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -172369,14 +170653,14 @@ paths: schema: type: string style: simple - "403": + "404": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/notFound: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found parameters: - name: entityType value: https://identifiers-api.cloud.com/example/widget @@ -172384,7 +170668,7 @@ paths: value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: A referenced entity was not found. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -172503,18 +170787,21 @@ paths: schema: type: string style: simple - "409": + "429": content: application/json: example: - https://errors-api.cloud.com/common/optimisticConcurrency: + https://errors-api.cloud.com/common/rateLimitExceeded: value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. + description: Caller has made too many requests in a short period of time + and is being rate-limited. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -172567,21 +170854,21 @@ paths: schema: type: string style: simple - "415": + "503": content: application/json: example: - https://errors-api.cloud.com/common/unsupportedMediaType: + https://errors-api.cloud.com/common/serviceUnavailable: value: - type: https://errors-api.cloud.com/common/unsupportedMediaType - detail: Must use application/json;charset=utf-8 media type + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds parameters: - - name: mediaType - value: application/xml + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must send request body in utf-8 and specify request - Content-Type as utf-8. + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -172634,21 +170921,21 @@ paths: schema: type: string style: simple - "429": + "500": content: application/json: example: - https://errors-api.cloud.com/common/rateLimitExceeded: + https://errors-api.cloud.com/common/internalServerError: value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds parameters: - name: retryDelay value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. + description: An unexpected server error occurred. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -172701,147 +170988,13 @@ paths: schema: type: string style: simple - "503": - content: - application/json: - example: - https://errors-api.cloud.com/common/serviceUnavailable: - value: - type: https://errors-api.cloud.com/common/serviceUnavailable - detail: Service is unavailable; try again in 4 seconds - parameters: - - name: retryDelay - value: "4" - schema: - $ref: '#/components/schemas/ErrorResponse' - description: "Service is temporarily unable to process the request. Caller\ - \ may attempt the operation again, with exponential back-off." - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "500": - content: - application/json: - example: - https://errors-api.cloud.com/common/internalServerError: - value: - type: https://errors-api.cloud.com/common/internalServerError - detail: An internal server error has occurred; try again in 4 - seconds - parameters: - - name: retryDelay - value: "4" - schema: - $ref: '#/components/schemas/ErrorResponse' - description: An unexpected server error occurred. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - summary: Create a machine catalog. + summary: Get the currently active jobs that are using a hypervisor. tags: - - MachineCatalogs APIs - /MachineCatalogs/$checkCatalogName: - post: - description: Check for the existence of a machine catalog by name - operationId: MachineCatalogs_TestMachineCatalogExists + - Hypervisors APIs + /hypervisors/{nameOrId}/machineCatalogs: + get: + description: Get the machine catalogs that are using a hypervisor. + operationId: Hypervisors_GetHypervisorMachineCatalogs parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -172904,18 +171057,68 @@ paths: schema: type: string style: simple - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CatalogNameCheckRequestModel' - description: Name of the machine catalog. + - description: Name or ID of the hypervisor. + explode: false + in: path + name: nameOrId required: true - x-name: request + schema: + nullable: true + title: String + type: string + style: simple x-position: 1 + - description: 'If async execute. ' + explode: true + in: query + name: async + required: false + schema: + default: false + nullable: true + title: Boolean + type: boolean + style: form + x-position: 2 + - description: |- + The max number of machine catalogs returned by this query. + If not specified, the server might use a default limit of 250 items. + If the specified value is larger than 1000, the server might reject the call. + The default and maximum values depend on server settings. + explode: true + in: query + name: limit + required: false + schema: + format: int32 + nullable: true + title: Int32 + type: integer + style: form + x-position: 3 + - description: |- + If a query cannot be completed, the response will have a + ContinuationToken set. + To obtain more results from the query, pass the + continuation token back into the query to get the next + batch of results. + explode: true + in: query + name: continuationToken + required: false + schema: + nullable: true + title: String + type: string + style: form + x-position: 4 responses: - "204": - description: Operation is successful with no response content. + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/HypervisorMachineCatalogResponseModelCollection' + description: List of machine catalogs that are using a hypervisor. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -172968,21 +171171,16 @@ paths: schema: type: string style: simple - "400": - content: - application/json: - example: - https://errors-api.cloud.com/common/outOfRange: - value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range - parameters: - - name: property - value: startTime - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + "202": + description: Async request was accepted and is being processed. headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -173034,20 +171232,20 @@ paths: schema: type: string style: simple - "401": + "400": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/outOfRange: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range parameters: - - name: reason - value: missing + - name: property + value: startTime schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: Caller passed an invalid input. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -173100,22 +171298,20 @@ paths: schema: type: string style: simple - "403": + "401": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -173168,20 +171364,22 @@ paths: schema: type: string style: simple - "406": + "403": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - - name: contentType - value: application/json + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -173234,18 +171432,22 @@ paths: schema: type: string style: simple - "409": + "404": content: application/json: example: - https://errors-api.cloud.com/common/optimisticConcurrency: + https://errors-api.cloud.com/common/notFound: value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. + description: A referenced entity was not found. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -173298,21 +171500,20 @@ paths: schema: type: string style: simple - "415": + "406": content: application/json: example: - https://errors-api.cloud.com/common/unsupportedMediaType: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/unsupportedMediaType - detail: Must use application/json;charset=utf-8 media type + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type parameters: - - name: mediaType - value: application/xml + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must send request body in utf-8 and specify request - Content-Type as utf-8. + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -173566,15 +171767,13 @@ paths: schema: type: string style: simple - summary: Test the existence of a machine catalog by name. + summary: Get the machine catalogs that are using a hypervisor. tags: - - MachineCatalogs APIs - /Machinecatalogs/$search: - post: - description: |- - Perform an advanced search for machinecatalogs. Note that some combinations - of search parameters may result in slow performance. - operationId: MachineCatalogs_DoMachineCatalogSearch + - Hypervisors APIs + /Hypervisors/{nameOrId}/OrphanedResources: + get: + description: Run detect on a hypervisor and get a orphaned resources result. + operationId: Hypervisors_GetHypervisorOrphanedResources parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -173637,10 +171836,24 @@ paths: schema: type: string style: simple + - description: Name or ID of the hypervisor to detect. + explode: false + in: path + name: nameOrId + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 1 - description: |- - If `true`, the catalogs (and associated objects) will be added as a - background task. - The task will have JobType SearchMachineCatalogs. + If `true`, the tests will run as a background task. This is recommended as the + tests may take some time to run, and if it exceeds 90 seconds the request may + time out. + + * _Id_ - ID of the hypervisor being detected, + * _Name_ - Name of the hypervisor being detected. explode: true in: query name: async @@ -173652,67 +171865,13 @@ paths: type: boolean style: form x-position: 2 - - description: |- - The max number of machine catalogs returned by this query. - If not specified, the server might use a default limit of 250 items. - If the specified value is larger than 1000, the server might reject the call. - The default and maximum values depend on server settings. - explode: true - in: query - name: limit - required: false - schema: - format: int32 - nullable: true - title: Int32 - type: integer - style: form - x-position: 3 - - description: |- - If a query cannot be completed, the response will have a - ContinuationToken set. - To obtain more results from the query, pass the - continuation token back into the query to get the next - batch of results. - explode: true - in: query - name: continuationToken - required: false - schema: - nullable: true - title: String - type: string - style: form - x-position: 4 - - description: |- - Optional filter, removing unspecified properties that otherwise would - have been sent by the server. - explode: true - in: query - name: fields - required: false - schema: - nullable: true - title: String - type: string - style: form - x-position: 5 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CatalogSearchRequestModel' - description: Specifies the advanced search parameters. - required: true - x-name: searchRequest - x-position: 1 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/CatalogSearchResponseModelCollection' - description: List of machine catalogs that match the search criteria. + $ref: '#/components/schemas/DetectOrphanedResourcesResponseModel' + description: Detect orphaned resource response. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -174026,84 +172185,22 @@ paths: schema: type: string style: simple - "406": + "404": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/notFound: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found parameters: - - name: contentType - value: application/json - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "409": - content: - application/json: - example: - https://errors-api.cloud.com/common/optimisticConcurrency: - value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. + description: A referenced entity was not found. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -174156,21 +172253,20 @@ paths: schema: type: string style: simple - "415": + "406": content: application/json: example: - https://errors-api.cloud.com/common/unsupportedMediaType: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/unsupportedMediaType - detail: Must use application/json;charset=utf-8 media type + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type parameters: - - name: mediaType - value: application/xml + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must send request body in utf-8 and specify request - Content-Type as utf-8. + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -174424,12 +172520,16 @@ paths: schema: type: string style: simple - summary: Perform an advanced search for machinecatalogs. + summary: Run detect on a hypervisor and retrieve orphaned resources. tags: - - MachineCatalogs APIs - /machineCatalogs/{catalogNameOrId}/actions: - delete: - operationId: Actions_DeleteAction + - Hypervisors APIs + /hypervisors/{nameOrId}/resourcePools: + get: + description: |- + Get the list of hypervisor resource pools. Note: in previous versions of the API, + resource pools were referred to as "HostingUnits". + URI with ?noCache=true can ignore the cache and fetch the data directly. + operationId: Hypervisors_GetHypervisorResourcePools parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -174492,10 +172592,10 @@ paths: schema: type: string style: simple - - description: 'The machine catalog name or id. ' + - description: Name or ID of the hypervisor. explode: false in: path - name: catalogNameOrId + name: nameOrId required: true schema: nullable: true @@ -174503,7 +172603,7 @@ paths: type: string style: simple x-position: 1 - - description: 'If async calling. ' + - description: 'Async request to get the resource pool. ' explode: true in: query name: async @@ -174515,8 +172615,12 @@ paths: style: form x-position: 2 responses: - "204": - description: Operation is successful with no response content. + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/HypervisorResourcePoolResponseModelCollection' + description: List of hypervisor resource pools. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -174831,6 +172935,20 @@ paths: type: string style: simple "404": + content: + application/json: + example: + https://errors-api.cloud.com/common/notFound: + value: + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' description: A referenced entity was not found. headers: Citrix-TransactionId: @@ -174950,18 +173068,21 @@ paths: schema: type: string style: simple - "409": + "429": content: application/json: example: - https://errors-api.cloud.com/common/optimisticConcurrency: + https://errors-api.cloud.com/common/rateLimitExceeded: value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. + description: Caller has made too many requests in a short period of time + and is being rate-limited. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -175014,21 +173135,21 @@ paths: schema: type: string style: simple - "429": + "503": content: application/json: example: - https://errors-api.cloud.com/common/rateLimitExceeded: + https://errors-api.cloud.com/common/serviceUnavailable: value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds parameters: - name: retryDelay value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -175081,21 +173202,21 @@ paths: schema: type: string style: simple - "503": + "500": content: application/json: example: - https://errors-api.cloud.com/common/serviceUnavailable: + https://errors-api.cloud.com/common/internalServerError: value: - type: https://errors-api.cloud.com/common/serviceUnavailable - detail: Service is unavailable; try again in 4 seconds + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds parameters: - name: retryDelay value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: "Service is temporarily unable to process the request. Caller\ - \ may attempt the operation again, with exponential back-off." + description: An unexpected server error occurred. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -175148,78 +173269,12 @@ paths: schema: type: string style: simple - "500": - content: - application/json: - example: - https://errors-api.cloud.com/common/internalServerError: - value: - type: https://errors-api.cloud.com/common/internalServerError - detail: An internal server error has occurred; try again in 4 - seconds - parameters: - - name: retryDelay - value: "4" - schema: - $ref: '#/components/schemas/ErrorResponse' - description: An unexpected server error occurred. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - summary: Delete specified catalog actions. + summary: Get the list of hypervisor resource pools. tags: - - Actions APIs - get: - operationId: Actions_GetAction + - Hypervisors APIs + post: + description: Create a new resource pool on an existing hypervisor. + operationId: Hypervisors_CreateResourcePool parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -175282,47 +173337,60 @@ paths: schema: type: string style: simple - - description: 'The machine catalog name or id. ' + - description: Name or ID of the hypervisor. explode: false in: path - name: catalogNameOrId + name: nameOrId required: true schema: nullable: true title: String type: string style: simple - x-position: 1 - - description: "The action Id, the guid string value. " - explode: true - in: query - name: actionId - required: false - schema: - nullable: true - title: String - type: string - style: form x-position: 2 - - description: 'If async calling. ' + - description: |- + If `true`, the resource pool (and associated objects) will be created as a + background task. + The task will have JobType CreateHypervisorResourcePool. + When the task is complete it will redirect to + GetHypervisorResourcePool. + The job's Parameters will contain properties: + * _Name_ - Name of the resource pool being created. explode: true in: query name: async required: false schema: default: false + nullable: true title: Boolean type: boolean style: form x-position: 3 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateHypervisorResourcePoolRequestModel' + description: Details of the resource pool to create. + required: true + x-name: model + x-position: 1 responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/ActionResponseModelCollection' - description: ActionResponseModel + $ref: '#/components/schemas/HypervisorResourcePoolDetailResponseModel' + description: Resource was created. headers: + Location: + description: Location where the newly created resource resides. + example: /services/myservice/widgets/1 + explode: false + schema: + type: string + style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -175374,6 +173442,27 @@ paths: schema: type: string style: simple + x-expectedSchemas: + - description: Details of the resource pool that was created. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorResourcePoolAWSDetailResponseModel' + - description: Details of the resource pool that was created. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorResourcePoolAzureDetailResponseModel' + - description: Details of the resource pool that was created. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorResourcePoolGcpDetailResponseModel' + - description: Details of the resource pool that was created. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorResourcePoolTraditionalDetailResponseModel' + - description: Details of the resource pool that was created. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorResourcePoolDetailResponseModel' "202": description: Async request was accepted and is being processed. headers: @@ -175435,20 +173524,8 @@ paths: schema: type: string style: simple - "400": - content: - application/json: - example: - https://errors-api.cloud.com/common/outOfRange: - value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range - parameters: - - name: property - value: startTime - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + "204": + description: Operation is successful with no response content. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -175501,20 +173578,20 @@ paths: schema: type: string style: simple - "401": + "400": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/outOfRange: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range parameters: - - name: reason - value: missing + - name: property + value: startTime schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: Caller passed an invalid input. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -175567,22 +173644,20 @@ paths: schema: type: string style: simple - "403": + "401": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -175635,14 +173710,14 @@ paths: schema: type: string style: simple - "404": + "403": content: application/json: example: - https://errors-api.cloud.com/common/notFound: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - name: entityType value: https://identifiers-api.cloud.com/example/widget @@ -175650,7 +173725,7 @@ paths: value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -175703,20 +173778,22 @@ paths: schema: type: string style: simple - "406": + "404": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/notFound: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found parameters: - - name: contentType - value: application/json + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + description: A referenced entity was not found. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -175769,21 +173846,20 @@ paths: schema: type: string style: simple - "429": + "406": content: application/json: example: - https://errors-api.cloud.com/common/rateLimitExceeded: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type parameters: - - name: retryDelay - value: "4" + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -175836,21 +173912,18 @@ paths: schema: type: string style: simple - "503": + "409": content: application/json: example: - https://errors-api.cloud.com/common/serviceUnavailable: + https://errors-api.cloud.com/common/optimisticConcurrency: value: - type: https://errors-api.cloud.com/common/serviceUnavailable - detail: Service is unavailable; try again in 4 seconds - parameters: - - name: retryDelay - value: "4" + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null schema: $ref: '#/components/schemas/ErrorResponse' - description: "Service is temporarily unable to process the request. Caller\ - \ may attempt the operation again, with exponential back-off." + description: Caller requested an invalid relation to be created or deleted. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -175903,21 +173976,21 @@ paths: schema: type: string style: simple - "500": + "415": content: application/json: example: - https://errors-api.cloud.com/common/internalServerError: + https://errors-api.cloud.com/common/unsupportedMediaType: value: - type: https://errors-api.cloud.com/common/internalServerError - detail: An internal server error has occurred; try again in 4 - seconds + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type parameters: - - name: retryDelay - value: "4" + - name: mediaType + value: application/xml schema: $ref: '#/components/schemas/ErrorResponse' - description: An unexpected server error occurred. + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -175970,13 +174043,224 @@ paths: schema: type: string style: simple - summary: Get machine catalog actions by specified catalog name or id and action - Id. + "429": + content: + application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller has made too many requests in a short period of time + and is being rate-limited. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "503": + content: + application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "500": + content: + application/json: + example: + https://errors-api.cloud.com/common/internalServerError: + value: + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: An unexpected server error occurred. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + summary: Create a new resource pool on an existing hypervisor. tags: - - Actions APIs - /machineCatalogs/{catalogNameOrId}/actions/{actionId}: - get: - operationId: Actions_GetActionById + - Hypervisors APIs + /hypervisors/{nameOrId}/resourcePools/{name}: + head: + description: |- + Check for the existence of a resource pool by name. Note that + resource pool names must be unique within the site, so the + `nameOrId` parameter does not affect whether the resource pool name + is found. + If the name is found to be available, this returns 404 Not Found. + If a resource pool by that name exists and is associated with the + specified hypervisor, this returns 204 No Content. If a resource + pool by that name exists and is associated with a different + hypervisor, this returns 303 See Other, and the `Location` response + header refers to location of the resource pool with that name. + operationId: Hypervisors_CheckHypervisorResourcePoolExists parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -176039,10 +174323,10 @@ paths: schema: type: string style: simple - - description: 'The machine catalog name or id. ' + - description: Name or ID of the hypervisor. explode: false in: path - name: catalogNameOrId + name: nameOrId required: true schema: nullable: true @@ -176050,10 +174334,10 @@ paths: type: string style: simple x-position: 1 - - description: "The action Id, the guid string value. " + - description: Name of the resource pool. explode: false in: path - name: actionId + name: name required: true schema: nullable: true @@ -176061,161 +174345,10 @@ paths: type: string style: simple x-position: 2 - - description: 'If async calling. ' - explode: true - in: query - name: async - required: false - schema: - default: false - title: Boolean - type: boolean - style: form - x-position: 3 responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/ActionResponseModel' - description: |- - ActionResponseModel - ActionCatalogCreationResponseModel - ActionMachineCreationResponseModel - ActionMachineRemovalResponseModel - ActionUpdateImageResponseModel - or - ActionResponseModel - ActionCatalogCreationResponseModel - ActionMachineCreationResponseModel - ActionMachineRemovalResponseModel - ActionUpdateImageResponseModel - or - ActionResponseModel - ActionCatalogCreationResponseModel - ActionMachineCreationResponseModel - ActionMachineRemovalResponseModel - ActionUpdateImageResponseModel - or - ActionResponseModel - ActionCatalogCreationResponseModel - ActionMachineCreationResponseModel - ActionMachineRemovalResponseModel - ActionUpdateImageResponseModel - or - ActionResponseModel - ActionCatalogCreationResponseModel - ActionMachineCreationResponseModel - ActionMachineRemovalResponseModel - ActionUpdateImageResponseModel - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - x-expectedSchemas: - - description: |- - ActionResponseModel - ActionCatalogCreationResponseModel - ActionMachineCreationResponseModel - ActionMachineRemovalResponseModel - ActionUpdateImageResponseModel - schema: - nullable: true - $ref: '#/components/schemas/ActionCatalogCreationResponseModel' - - description: |- - ActionResponseModel - ActionCatalogCreationResponseModel - ActionMachineCreationResponseModel - ActionMachineRemovalResponseModel - ActionUpdateImageResponseModel - schema: - nullable: true - $ref: '#/components/schemas/ActionMachineCreationResponseModel' - - description: |- - ActionResponseModel - ActionCatalogCreationResponseModel - ActionMachineCreationResponseModel - ActionMachineRemovalResponseModel - ActionUpdateImageResponseModel - schema: - nullable: true - $ref: '#/components/schemas/ActionMachineRemovalResponseModel' - - description: |- - ActionResponseModel - ActionCatalogCreationResponseModel - ActionMachineCreationResponseModel - ActionMachineRemovalResponseModel - ActionUpdateImageResponseModel - schema: - nullable: true - $ref: '#/components/schemas/ActionUpdateImageResponseModel' - - description: |- - ActionResponseModel - ActionCatalogCreationResponseModel - ActionMachineCreationResponseModel - ActionMachineRemovalResponseModel - ActionUpdateImageResponseModel - schema: - nullable: true - $ref: '#/components/schemas/ActionResponseModel' - "202": - description: Async request was accepted and is being processed. + "204": + description: Operation is successful with no response content. headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false - schema: - type: string - style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -176802,12 +174935,12 @@ paths: schema: type: string style: simple - summary: Get specified machine catalog specified action. + summary: Check for the existence of a resource pool by name. tags: - - Actions APIs - /machineCatalogs/{catalogNameOrId}/actions/{actionId}/$Cancel: - post: - operationId: Actions_CancelAction + - Hypervisors APIs + /hypervisors/{nameOrId}/resourcePools/{poolId}: + delete: + operationId: Hypervisors_DeleteHypervisorResourcePool parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -176870,10 +175003,10 @@ paths: schema: type: string style: simple - - description: 'The machine catalog name or id. ' + - description: 'The name or id of hypervisor. ' explode: false in: path - name: catalogNameOrId + name: nameOrId required: true schema: nullable: true @@ -176881,10 +175014,10 @@ paths: type: string style: simple x-position: 1 - - description: "The action Id, the guid string value. " + - description: 'The hypervisor resource pool id. ' explode: false in: path - name: actionId + name: poolId required: true schema: nullable: true @@ -176892,7 +175025,7 @@ paths: type: string style: simple x-position: 2 - - description: 'If async calling. ' + - description: 'If the api call with async type. ' explode: true in: query name: async @@ -177220,20 +175353,6 @@ paths: type: string style: simple "404": - content: - application/json: - example: - https://errors-api.cloud.com/common/notFound: - value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found - parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 - schema: - $ref: '#/components/schemas/ErrorResponse' description: A referenced entity was not found. headers: Citrix-TransactionId: @@ -177618,13 +175737,15 @@ paths: schema: type: string style: simple - summary: Cancel the specified machine catalog and specified action. + summary: Delete a hypervisor resource pool. tags: - - Actions APIs - /MachineCatalogs/{name}: - head: - description: Check for the existence of a machine catalog by name - operationId: MachineCatalogs_CheckMachineCatalogExists + - Hypervisors APIs + get: + description: |- + Get details about a hypervisor resource pool. Note: in previous versions of + the API, resource pools were referred to as "HostingUnits". + URI with ?noCache=true can ignore the cache and fetch the data directly. + operationId: Hypervisors_GetHypervisorResourcePool parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -177687,13 +175808,10 @@ paths: schema: type: string style: simple - - description: |- - Name of the machine catalog. If the catalog is present in a catalog folder, - specify the name in this format: {catalog folder path plus catalog name}. - For example, FolderName1|FolderName2|CatalogName. + - description: Name or ID of the hypervisor. explode: false in: path - name: name + name: nameOrId required: true schema: nullable: true @@ -177701,75 +175819,44 @@ paths: type: string style: simple x-position: 1 + - description: Name or ID of the resource pool. + explode: false + in: path + name: poolId + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 2 + - description: 'Async request to get the resource pool. ' + explode: true + in: query + name: async + required: false + schema: + default: false + title: Boolean + type: boolean + style: form + x-position: 3 responses: - "204": - description: Operation is successful with no response content. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "400": + "200": content: application/json: - example: - https://errors-api.cloud.com/common/outOfRange: - value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range - parameters: - - name: property - value: startTime schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + $ref: '#/components/schemas/HypervisorResourcePoolDetailResponseModel' + description: |- + Details about the hypervisor resource pool. + or + Details about the hypervisor resource pool. + or + Details about the hypervisor resource pool. + or + Details about the hypervisor resource pool. + or + Details about the hypervisor resource pool. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -177822,89 +175909,237 @@ paths: schema: type: string style: simple - "401": - content: - application/json: - example: - https://errors-api.cloud.com/common/authentication: - value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details - parameters: - - name: reason - value: missing - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + x-expectedSchemas: + - description: Details about the hypervisor resource pool. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorResourcePoolAWSDetailResponseModel' + - description: Details about the hypervisor resource pool. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorResourcePoolAzureDetailResponseModel' + - description: Details about the hypervisor resource pool. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorResourcePoolGcpDetailResponseModel' + - description: Details about the hypervisor resource pool. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorResourcePoolTraditionalDetailResponseModel' + - description: Details about the hypervisor resource pool. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorResourcePoolDetailResponseModel' + "202": + description: Async request was accepted and is being processed. headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" explode: false schema: type: string style: simple - "403": - content: - application/json: - example: - https://errors-api.cloud.com/common/authorization: - value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied - parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. - headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "401": + content: + application/json: + example: + https://errors-api.cloud.com/common/authentication: + value: + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller did not present a valid bearer token. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "403": + content: + application/json: + example: + https://errors-api.cloud.com/common/authorization: + value: + type: https://errors-api.cloud.com/common/authorization + detail: Access denied + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller is not authorized to perform the operation. + headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -178291,13 +176526,12 @@ paths: schema: type: string style: simple - summary: Check for the existence of a machine catalog by name. + summary: Get details about a hypervisor resource pool. tags: - - MachineCatalogs APIs - /MachineCatalogs/{nameOrId}: - delete: - description: Delete a machine catalog - operationId: MachineCatalogs_DeleteMachineCatalog + - Hypervisors APIs + patch: + description: Update a hypervisor resource pool. + operationId: Hypervisors_PatchHypervisorResourcePool parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -178342,30 +176576,6 @@ paths: schema: type: string style: simple - - description: "Admin credential to use when performing the operation. If not\ - \ specified, the operation will be performed using the account under which\ - \ the identity service is running If specified, must be in a format matching\ - \ that of the standard 'Authorization' request header; the username and\ - \ password separated by a colon, UTF8-encoded, then base64-encoded, then\ - \ the \"Basic \" scheme prepended.\r\nExample:Basic QWxhZGRpbjpPcGVuU2VzYW1l" - explode: false - in: header - name: X-AdminCredential - required: false - schema: - type: string - style: simple - - description: "Access token to use when performing the operation. If specified,\ - \ must be in a format matching that of the standard 'Authorization' request\ - \ header; UTF8-encoded, then base64-encoded, then the \"Bearer\" scheme\ - \ prepended.\r\nExample: Bearer bGljaGVuZy5saW5AY2l0cml4LmNvbQ==" - explode: false - in: header - name: X-AccessToken - required: false - schema: - type: string - style: simple - description: Must accept application/json. example: application/json explode: false @@ -178384,11 +176594,7 @@ paths: schema: type: string style: simple - - description: |- - Name or ID of the machine catalog to update. - If the catalog is present in a catalog folder, - specify the name in this format: {catalog folder path plus catalog name}. - For example, FolderName1|FolderName2|CatalogName. + - description: Name or ID of the hypervisor. explode: false in: path name: nameOrId @@ -178398,65 +176604,26 @@ paths: title: String type: string style: simple - x-position: 1 - - description: |- - Specifies whether to delete virtual machines that were provisioned in the machine catalog. - Only relevant when ProvisioningType is - MCS; otherwise, ignored. - - Optional; default is `true`. - explode: true - in: query - name: deleteVm - required: false - schema: - default: true - nullable: true - title: Boolean - type: boolean - style: form x-position: 2 - - description: |- - Specifies what to do with AD machine accounts that are associated with the machine - catalog. - - Optional; default is . - explode: true - in: query - name: deleteAccount - required: false - schema: - allOf: - - $ref: '#/components/schemas/MachineAccountDeleteOption' - default: None - style: form - x-position: 3 - - description: |- - Specifies whether to only delete virtual machines record that were provisioned in the machine catalog from database, - not access hypervisor to delete virtual machines, this is recommended only when hypervisor cannot be accessed. - - Optional; default is `false`. - explode: true - in: query - name: purgeDBOnly - required: false + - description: Name or ID of the resource pool. + explode: false + in: path + name: poolId + required: true schema: - default: false nullable: true - title: Boolean - type: boolean - style: form - x-position: 4 + title: String + type: string + style: simple + x-position: 3 - description: |- - If `true`, the machine catalog (and associated objects) will be - deleted as a background task. - The task will have JobType DeleteMachineCatalog. + If `true`, the resource pool will be updated as a background task. + The task will have JobType UpdateHypervisorResourcePool. When the task is complete it will redirect to - GetMachineCatalogs. + GetHypervisorResourcePool. The job's Parameters will contain properties: - - * _Id_ - ID of the machine catalog being deleted, - * _Name_ - Name of the machine catalog being deleted. + * _Name_ - Name of the resource pool being updated. + * _Id_ - ID of the resource pool being updated. explode: true in: query name: async @@ -178467,7 +176634,16 @@ paths: title: Boolean type: boolean style: form - x-position: 5 + x-position: 4 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EditHypervisorResourcePoolRequestModel' + description: Details of the resource pool to update. + required: true + x-name: model + x-position: 1 responses: "204": description: Operation is successful with no response content. @@ -178785,6 +176961,20 @@ paths: type: string style: simple "404": + content: + application/json: + example: + https://errors-api.cloud.com/common/notFound: + value: + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' description: A referenced entity was not found. headers: Citrix-TransactionId: @@ -178904,18 +177094,21 @@ paths: schema: type: string style: simple - "409": + "415": content: application/json: example: - https://errors-api.cloud.com/common/optimisticConcurrency: + https://errors-api.cloud.com/common/unsupportedMediaType: value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type + parameters: + - name: mediaType + value: application/xml schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -179169,13 +177362,12 @@ paths: schema: type: string style: simple - summary: Delete a machine catalog. + summary: Update a hypervisor resource pool. tags: - - MachineCatalogs APIs - get: - description: Get details about a single machine catalog by name or ID of machine - catalog. - operationId: MachineCatalogs_GetMachineCatalog + - Hypervisors APIs + /hypervisors/{nameOrId}/resourcePools/{poolId}/$getPatchPreview: + post: + operationId: Hypervisors_GetHypervisorResourcePoolPatchPreview parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -179238,10 +177430,7 @@ paths: schema: type: string style: simple - - description: |- - Name or ID of the machine catalog. If the catalog is present in a catalog folder, - specify the name in this format: {catalog folder path plus catalog name}. - For example, FolderName1|FolderName2|CatalogName. + - description: Name or ID of the hypervisor. explode: false in: path name: nameOrId @@ -179251,8 +177440,19 @@ paths: title: String type: string style: simple - x-position: 1 - - description: "If `true`, it will be queried as a background task." + x-position: 2 + - description: Name or ID of the resource pool. + explode: false + in: path + name: poolId + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 3 + - description: "If `true`, the preview job will run as a background task." explode: true in: query name: async @@ -179263,27 +177463,23 @@ paths: title: Boolean type: boolean style: form - x-position: 2 - - description: "Optional parameters, removing unspecified properties that otherwise\ - \ would have been sent by the server." - example: "Name,FullName,Id" - explode: true - in: query - name: fields - required: false - schema: - nullable: true - title: String - type: string - style: form - x-position: 3 + x-position: 4 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/HypervisorResourcePoolPatchPreviewRequestModel' + description: New networks of the resource pool. + required: true + x-name: model + x-position: 1 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/MachineCatalogDetailResponseModel' - description: Details of machine catalog. + $ref: '#/components/schemas/HypervisorResourcePoolPatchPreviewResponseModel' + description: Reference of the networks. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -179731,21 +177927,18 @@ paths: schema: type: string style: simple - "429": + "409": content: application/json: example: - https://errors-api.cloud.com/common/rateLimitExceeded: + https://errors-api.cloud.com/common/optimisticConcurrency: value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds - parameters: - - name: retryDelay - value: "4" + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. + description: Caller requested an invalid relation to be created or deleted. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -179798,21 +177991,21 @@ paths: schema: type: string style: simple - "503": + "415": content: application/json: example: - https://errors-api.cloud.com/common/serviceUnavailable: + https://errors-api.cloud.com/common/unsupportedMediaType: value: - type: https://errors-api.cloud.com/common/serviceUnavailable - detail: Service is unavailable; try again in 4 seconds + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type parameters: - - name: retryDelay - value: "4" + - name: mediaType + value: application/xml schema: $ref: '#/components/schemas/ErrorResponse' - description: "Service is temporarily unable to process the request. Caller\ - \ may attempt the operation again, with exponential back-off." + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -179865,21 +178058,21 @@ paths: schema: type: string style: simple - "500": + "429": content: application/json: example: - https://errors-api.cloud.com/common/internalServerError: + https://errors-api.cloud.com/common/rateLimitExceeded: value: - type: https://errors-api.cloud.com/common/internalServerError - detail: An internal server error has occurred; try again in 4 - seconds + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds parameters: - name: retryDelay value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: An unexpected server error occurred. + description: Caller has made too many requests in a short period of time + and is being rate-limited. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -179932,137 +178125,21 @@ paths: schema: type: string style: simple - summary: Get details about a single machine catalog. - tags: - - MachineCatalogs APIs - patch: - description: Update a machine catalog - operationId: MachineCatalogs_UpdateMachineCatalog - parameters: - - description: Citrix Customer ID. Default is 'CitrixOnPremises' - example: CitrixOnPremises - explode: false - in: header - name: Citrix-CustomerId - required: true - schema: - type: string - style: simple - - description: Citrix Instance (Site) ID. - explode: false - in: header - name: Citrix-InstanceId - required: true - schema: - type: string - style: simple - - description: User Agent type of the request. - example: Mozilla/5.0 - explode: false - in: header - name: User-Agent - required: false - schema: - type: string - style: simple - - description: "Citrix authorization header: CWSAuth Bearer={token}" - explode: false - in: header - name: Authorization - required: false - schema: - type: string - style: simple - - description: "Transaction ID that will be used to track this request. If not\ - \ provided, a new GUID will be generated and returned." - explode: false - in: header - name: Citrix-TransactionId - required: false - schema: - type: string - style: simple - - description: "Access token to use when performing the operation. If specified,\ - \ must be in a format matching that of the standard 'Authorization' request\ - \ header; UTF8-encoded, then base64-encoded, then the \"Bearer\" scheme\ - \ prepended.\r\nExample: Bearer bGljaGVuZy5saW5AY2l0cml4LmNvbQ==" - explode: false - in: header - name: X-AccessToken - required: false - schema: - type: string - style: simple - - description: Must accept application/json. - example: application/json - explode: false - in: header - name: Accept - required: false - schema: - type: string - style: simple - - description: Locale of the request. - example: en-US - explode: false - in: header - name: Citrix-Locale - required: false - schema: - type: string - style: simple - - description: |- - Name or ID of the machine catalog to update. - If the catalog is present in a catalog folder, - specify the name in this format: {catalog folder path plus catalog name}. - For example, FolderName1|FolderName2|CatalogName. - explode: false - in: path - name: nameOrId - required: true - schema: - nullable: true - title: String - type: string - style: simple - x-position: 1 - - description: |- - If `true`, the machine catalog (and associated objects) will be - updated as a background task. - The task will have JobType UpdateMachineCatalog. - When the task is complete it will redirect to - GetMachineCatalog. - The job's Parameters will contain properties: - - * _Id_ - ID of the machine catalog being updated, - * _Name_ - Name of the machine catalog being updated. - explode: true - in: query - name: async - required: false - schema: - default: false - nullable: true - title: Boolean - type: boolean - style: form - x-position: 3 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/UpdateMachineCatalogRequestModel' - description: Properties of the machine catalog to update. - required: true - x-name: request - x-position: 2 - responses: - "200": + "503": content: application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" schema: - $ref: '#/components/schemas/MachineCatalogDetailResponseModel' - description: New machine catalog details. + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -180115,16 +178192,22 @@ paths: schema: type: string style: simple - "202": - description: Async request was accepted and is being processed. - headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false + "500": + content: + application/json: + example: + https://errors-api.cloud.com/common/internalServerError: + value: + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds + parameters: + - name: retryDelay + value: "4" schema: - type: string - style: simple + $ref: '#/components/schemas/ErrorResponse' + description: An unexpected server error occurred. + headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -180176,8 +178259,129 @@ paths: schema: type: string style: simple - "204": - description: Operation is successful with no response content. + summary: Get the hypervisor resource pool patch preview. + tags: + - Hypervisors APIs + /Hypervisors/{nameOrId}/ResourcePools/{poolId}/$test: + post: + description: |- + Run tests on a resource pool and create a test report. Obtain the most + recent report from + GetHypervisorResourcePoolTestReport. + operationId: Hypervisors_TestHypervisorResourcePool + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + - description: Name or ID of the hypervisor containing the resource pool. + explode: false + in: path + name: nameOrId + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 1 + - description: Name or ID of the resource pool to test. + explode: false + in: path + name: poolId + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 2 + - description: |- + If `true`, the tests will run as a background task. This is recommended as the + tests may take some time to run, and if it exceeds 90 seconds the request may + time out. + The task will have JobType TestHypervisorResourcePool. + When the task is complete it will redirect to + GetJobResults. + The job's Parameters will contain properties: + + * _Id_ - ID of the resource pool being tested, + * _Name_ - Name of the resource pool being tested. + explode: true + in: query + name: async + required: false + schema: + default: false + nullable: true + title: Boolean + type: boolean + style: form + x-position: 3 + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/HypervisorResourcePoolTestResponseModel' + description: Test response. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -180230,21 +178434,16 @@ paths: schema: type: string style: simple - "400": - content: - application/json: - example: - https://errors-api.cloud.com/common/outOfRange: - value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range - parameters: - - name: property - value: startTime - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + "202": + description: Async request was accepted and is being processed. headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -180296,20 +178495,20 @@ paths: schema: type: string style: simple - "401": + "400": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/outOfRange: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range parameters: - - name: reason - value: missing + - name: property + value: startTime schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: Caller passed an invalid input. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -180362,22 +178561,20 @@ paths: schema: type: string style: simple - "403": + "401": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -180430,14 +178627,14 @@ paths: schema: type: string style: simple - "404": + "403": content: application/json: example: - https://errors-api.cloud.com/common/notFound: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - name: entityType value: https://identifiers-api.cloud.com/example/widget @@ -180445,7 +178642,7 @@ paths: value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -180498,20 +178695,22 @@ paths: schema: type: string style: simple - "406": + "404": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/notFound: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found parameters: - - name: contentType - value: application/json + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + description: A referenced entity was not found. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -180564,21 +178763,20 @@ paths: schema: type: string style: simple - "415": + "406": content: application/json: example: - https://errors-api.cloud.com/common/unsupportedMediaType: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/unsupportedMediaType - detail: Must use application/json;charset=utf-8 media type + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type parameters: - - name: mediaType - value: application/xml + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must send request body in utf-8 and specify request - Content-Type as utf-8. + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -180631,21 +178829,85 @@ paths: schema: type: string style: simple - "429": + "409": content: application/json: example: - https://errors-api.cloud.com/common/rateLimitExceeded: + https://errors-api.cloud.com/common/optimisticConcurrency: value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds - parameters: - - name: retryDelay - value: "4" + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. + description: Caller requested an invalid relation to be created or deleted. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "429": + content: + application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller has made too many requests in a short period of time + and is being rate-limited. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -180832,12 +179094,13 @@ paths: schema: type: string style: simple - summary: Update a machine catalog. + summary: Run tests on a resource pool and create a test report. tags: - - MachineCatalogs APIs - /MachineCatalogs/{nameOrId}/$importProvisionedVirtualMachines: - post: - operationId: MachineCatalogs_ImportProvisionedVirtualMachines + - Hypervisors APIs + /hypervisors/{nameOrId}/resourcePools/{poolId}/administrators: + get: + description: Get administrators who can administer a resource pool. + operationId: Hypervisors_GetHypervisorResourcePoolAdministrators parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -180900,7 +179163,7 @@ paths: schema: type: string style: simple - - description: 'The machineCatalog name or Id. ' + - description: Name or ID of the hypervisor. explode: false in: path name: nameOrId @@ -180910,9 +179173,19 @@ paths: title: String type: string style: simple + x-position: 1 + - description: Name or ID of the resource pool. + explode: false + in: path + name: poolId + required: true + schema: + nullable: true + title: String + type: string + style: simple x-position: 2 - - description: "If `true`, the machine accounts repair will be performed as\ - \ a background task. " + - description: 'If async execute. ' explode: true in: query name: async @@ -180924,22 +179197,45 @@ paths: type: boolean style: form x-position: 3 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ImportProvisionedVirtualMachinesRequestModel' - description: 'The existing provisioned virtual machines data. ' - required: true - x-name: request - x-position: 1 + - description: |- + The max number of administrators returned by this query. + If not specified, the server might use a default limit of 250 items. + If the specified value is larger than 1000, the server might reject the call. + The default and maximum values depend on server settings. + explode: true + in: query + name: limit + required: false + schema: + format: int32 + nullable: true + title: Int32 + type: integer + style: form + x-position: 4 + - description: |- + If a query cannot be completed, the response will have a + ContinuationToken set. + To obtain more results from the query, pass the + continuation token back into the query to get the next + batch of results. + explode: true + in: query + name: continuationToken + required: false + schema: + nullable: true + title: String + type: string + style: form + x-position: 5 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/ImportProvisionedVirtualMachineResponseModelCollection' - description: ImportProvisionedVirtualMachineResponseModelCollection + $ref: '#/components/schemas/AdministratorResponseModelCollection' + description: List of administrators. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -181387,137 +179683,6 @@ paths: schema: type: string style: simple - "409": - content: - application/json: - example: - https://errors-api.cloud.com/common/optimisticConcurrency: - value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "415": - content: - application/json: - example: - https://errors-api.cloud.com/common/unsupportedMediaType: - value: - type: https://errors-api.cloud.com/common/unsupportedMediaType - detail: Must use application/json;charset=utf-8 media type - parameters: - - name: mediaType - value: application/xml - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller must send request body in utf-8 and specify request - Content-Type as utf-8. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple "429": content: application/json: @@ -181719,17 +179884,14 @@ paths: schema: type: string style: simple - summary: Import existing provisioned virtual machines. + summary: Get administrators who can administer a resource pool. tags: - - MachineCatalogs APIs - /MachineCatalogs/{nameOrId}/$RebootMachines: - post: - description: "Reboot all machines in a machine catalog.\n\n\nNote that there\ - \ is no job representation for the reboot operation.\nThe call returns immediately\ - \ even though the machines reboot over time.\nIf you want to follow the progress\ - \ of the reboot operation, check\nthe \nproperty of the machines in the machine\ - \ catalog." - operationId: MachineCatalogs_RebootMachineCatalogMachines + - Hypervisors APIs + /hypervisors/{nameOrId}/resourcePools/{poolId}/deletePreview: + get: + description: Get the machine catalogs and related resources that are using by + a resource pool. + operationId: Hypervisors_GetHypervisorResourcePoolDeletePreview parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -181792,10 +179954,7 @@ paths: schema: type: string style: simple - - description: |- - Name or ID of the machine catalog. If the catalog is present in a catalog folder, - specify the name in this format: {catalog folder path plus catalog name}. - For example, FolderName1|FolderName2|CatalogName. + - description: Name or ID of the hypervisor. explode: false in: path name: nameOrId @@ -181806,18 +179965,36 @@ paths: type: string style: simple x-position: 1 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RebootMachinesRequestModel' - description: Reboot options. + - description: Name or ID of the resource pool. + explode: false + in: path + name: poolId required: true - x-name: request + schema: + nullable: true + title: String + type: string + style: simple x-position: 2 + - description: 'If execute this API asynchronous. ' + explode: true + in: query + name: async + required: false + schema: + default: false + nullable: true + title: Boolean + type: boolean + style: form + x-position: 3 responses: - "204": - description: Operation is successful with no response content. + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/HypervisorDeletePreviewResponseModel' + description: 'HypervisorDeletePreviewResponseModel object. ' headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -181870,6 +180047,67 @@ paths: schema: type: string style: simple + "202": + description: Async request was accepted and is being processed. + headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple "400": content: application/json: @@ -182204,18 +180442,21 @@ paths: schema: type: string style: simple - "409": + "429": content: application/json: example: - https://errors-api.cloud.com/common/optimisticConcurrency: + https://errors-api.cloud.com/common/rateLimitExceeded: value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. + description: Caller has made too many requests in a short period of time + and is being rate-limited. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -182268,21 +180509,21 @@ paths: schema: type: string style: simple - "415": + "503": content: application/json: example: - https://errors-api.cloud.com/common/unsupportedMediaType: + https://errors-api.cloud.com/common/serviceUnavailable: value: - type: https://errors-api.cloud.com/common/unsupportedMediaType - detail: Must use application/json;charset=utf-8 media type + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds parameters: - - name: mediaType - value: application/xml + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must send request body in utf-8 and specify request - Content-Type as utf-8. + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -182335,21 +180576,21 @@ paths: schema: type: string style: simple - "429": + "500": content: application/json: example: - https://errors-api.cloud.com/common/rateLimitExceeded: + https://errors-api.cloud.com/common/internalServerError: value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds parameters: - name: retryDelay value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. + description: An unexpected server error occurred. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -182402,21 +180643,105 @@ paths: schema: type: string style: simple - "503": + summary: Get the hypervisor resource pool delete preview. + tags: + - Hypervisors APIs + /hypervisors/{nameOrId}/resourcePools/{poolId}/jobs: + get: + description: Get the currently active provisioning jobs that are using a resource + pool. + operationId: Hypervisors_GetHypervisorResourcePoolJobs + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + - description: Name or ID of the hypervisor. + explode: false + in: path + name: nameOrId + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 1 + - description: Name or ID of the resource pool. + explode: false + in: path + name: poolId + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 2 + responses: + "200": content: application/json: - example: - https://errors-api.cloud.com/common/serviceUnavailable: - value: - type: https://errors-api.cloud.com/common/serviceUnavailable - detail: Service is unavailable; try again in 4 seconds - parameters: - - name: retryDelay - value: "4" schema: - $ref: '#/components/schemas/ErrorResponse' - description: "Service is temporarily unable to process the request. Caller\ - \ may attempt the operation again, with exponential back-off." + $ref: '#/components/schemas/JobResponseModelCollection' + description: List of machine catalogs that are using a hypervisor. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -182469,304 +180794,6 @@ paths: schema: type: string style: simple - "500": - content: - application/json: - example: - https://errors-api.cloud.com/common/internalServerError: - value: - type: https://errors-api.cloud.com/common/internalServerError - detail: An internal server error has occurred; try again in 4 - seconds - parameters: - - name: retryDelay - value: "4" - schema: - $ref: '#/components/schemas/ErrorResponse' - description: An unexpected server error occurred. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - summary: Reboot all machines in a machine catalog. - tags: - - MachineCatalogs APIs - /MachineCatalogs/{nameOrId}/$repairMachineAccounts: - post: - description: Repair all machine accounts in a machine catalog. - operationId: MachineCatalogs_RepairMachineCatalogMachineAccounts - parameters: - - description: Citrix Customer ID. Default is 'CitrixOnPremises' - example: CitrixOnPremises - explode: false - in: header - name: Citrix-CustomerId - required: true - schema: - type: string - style: simple - - description: Citrix Instance (Site) ID. - explode: false - in: header - name: Citrix-InstanceId - required: true - schema: - type: string - style: simple - - description: User Agent type of the request. - example: Mozilla/5.0 - explode: false - in: header - name: User-Agent - required: false - schema: - type: string - style: simple - - description: "Citrix authorization header: CWSAuth Bearer={token}" - explode: false - in: header - name: Authorization - required: false - schema: - type: string - style: simple - - description: "Transaction ID that will be used to track this request. If not\ - \ provided, a new GUID will be generated and returned." - explode: false - in: header - name: Citrix-TransactionId - required: false - schema: - type: string - style: simple - - description: "Admin credential to use when performing the operation. If not\ - \ specified, the operation will be performed using the account under which\ - \ the identity service is running If specified, must be in a format matching\ - \ that of the standard 'Authorization' request header; the username and\ - \ password separated by a colon, UTF8-encoded, then base64-encoded, then\ - \ the \"Basic \" scheme prepended.\r\nExample:Basic QWxhZGRpbjpPcGVuU2VzYW1l" - explode: false - in: header - name: X-AdminCredential - required: false - schema: - type: string - style: simple - - description: Must accept application/json. - example: application/json - explode: false - in: header - name: Accept - required: false - schema: - type: string - style: simple - - description: Locale of the request. - example: en-US - explode: false - in: header - name: Citrix-Locale - required: false - schema: - type: string - style: simple - - description: Name or ID of the machine catalog. - explode: false - in: path - name: nameOrId - required: true - schema: - nullable: true - title: String - type: string - style: simple - x-position: 1 - - description: The repair option of the machine accounts - explode: true - in: query - name: repairOption - required: true - schema: - $ref: '#/components/schemas/MachineAccountRepairOption' - style: form - x-position: 2 - - description: "If `true`, the machine accounts repair will be performed as\ - \ a background task." - explode: true - in: query - name: async - required: false - schema: - default: false - nullable: true - title: Boolean - type: boolean - style: form - x-position: 3 - responses: - "204": - description: Operation is successful with no response content. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "202": - description: Async request was accepted and is being processed. - headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false - schema: - type: string - style: simple - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple "400": content: application/json: @@ -183101,70 +181128,6 @@ paths: schema: type: string style: simple - "409": - content: - application/json: - example: - https://errors-api.cloud.com/common/optimisticConcurrency: - value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple "429": content: application/json: @@ -183366,31 +181329,13 @@ paths: schema: type: string style: simple - summary: Repair all machine accounts in a machine catalog. + summary: Get the currently active jobs that are using a resource pool. tags: - - MachineCatalogs APIs - /MachineCatalogs/{nameOrId}/$RollbackProvisioningScheme: - post: - description: |- - Rollback the machine catalog's provisioning scheme. - - - Only valid when the machine catalog's ProvisioningType is MCS. - - - Provides the ability to roll back the hard disk image used to provision - virtual machines. If the provisioning scheme has CleanOnBoot equal to - `true`, then the next time that virtual machines are started, their - hard disks are updated to this new image. Regardless of CleanOnBoot, - all new virtual machines created after this call succeeds will use this - new hard disk image. - - - *Note:* The provisioning scheme for a machine catalog cannot be - changed while any provisioning tasks are already executing for the - machine catalog. Cancel existing provisioning tasks or wait for - their completion before updating the provisioning scheme. - operationId: MachineCatalogs_RollbackMachineCatalogProvisioningScheme + - Hypervisors APIs + /hypervisors/{nameOrId}/resourcePools/{poolId}/machineCatalogs: + get: + description: Get the machine catalogs that are using a resource pool. + operationId: Hypervisors_GetHypervisorResourcePoolMachineCatalogs parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -183435,19 +181380,6 @@ paths: schema: type: string style: simple - - description: "Admin credential to use when performing the operation. If not\ - \ specified, the operation will be performed using the account under which\ - \ the identity service is running If specified, must be in a format matching\ - \ that of the standard 'Authorization' request header; the username and\ - \ password separated by a colon, UTF8-encoded, then base64-encoded, then\ - \ the \"Basic \" scheme prepended.\r\nExample:Basic QWxhZGRpbjpPcGVuU2VzYW1l" - explode: false - in: header - name: X-AdminCredential - required: false - schema: - type: string - style: simple - description: Must accept application/json. example: application/json explode: false @@ -183466,10 +181398,7 @@ paths: schema: type: string style: simple - - description: |- - Name or ID of the machine catalog. If the catalog is present in a catalog folder, - specify the name in this format: {catalog folder path plus catalog name}. - For example, FolderName1|FolderName2|CatalogName. + - description: Name or ID of the hypervisor. explode: false in: path name: nameOrId @@ -183480,23 +181409,18 @@ paths: type: string style: simple x-position: 1 - - description: |- - Due to the long-running nature of the update operation, it cannot - complete synchronously, and always initiates an asynchronous job to - run to completion. If the `async` parameter is `true`, the only - difference is that instead of returning the initial job status in - the payload, the response is instead `202` with the `Location` - header pointing to the job status API. This may be desirable for - clients that wish to unify their logic for handling asynchronous - jobs. The task will have JobType - . - When the task is complete it will redirect to - . - The job's will contain properties: - - - * _Id_ - ID of the machine catalog for which the provisioning scheme is being updated, - * _Name_ - Name of the machine catalog for which the provisioning scheme is being updated. + - description: Name or ID of the resource pool. + explode: false + in: path + name: poolId + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 2 + - description: 'If async execute. ' explode: true in: query name: async @@ -183508,22 +181432,45 @@ paths: type: boolean style: form x-position: 3 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RebootMachinesRequestModel' - description: Details about the image update to be performed. - required: true - x-name: request - x-position: 2 + - description: |- + The max number of machine catalogs returned by this query. + If not specified, the server might use a default limit of 250 items. + If the specified value is larger than 1000, the server might reject the call. + The default and maximum values depend on server settings. + explode: true + in: query + name: limit + required: false + schema: + format: int32 + nullable: true + title: Int32 + type: integer + style: form + x-position: 4 + - description: |- + If a query cannot be completed, the response will have a + ContinuationToken set. + To obtain more results from the query, pass the + continuation token back into the query to get the next + batch of results. + explode: true + in: query + name: continuationToken + required: false + schema: + nullable: true + title: String + type: string + style: form + x-position: 5 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/JobResponseModel' - description: Asynchronous job status. + $ref: '#/components/schemas/HypervisorMachineCatalogResponseModelCollection' + description: List of machine catalogs that are using a hypervisor. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -183971,137 +181918,6 @@ paths: schema: type: string style: simple - "409": - content: - application/json: - example: - https://errors-api.cloud.com/common/optimisticConcurrency: - value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "415": - content: - application/json: - example: - https://errors-api.cloud.com/common/unsupportedMediaType: - value: - type: https://errors-api.cloud.com/common/unsupportedMediaType - detail: Must use application/json;charset=utf-8 media type - parameters: - - name: mediaType - value: application/xml - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller must send request body in utf-8 and specify request - Content-Type as utf-8. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple "429": content: application/json: @@ -184303,16 +182119,27 @@ paths: schema: type: string style: simple - summary: Rollback the machine catalog's provisioning scheme. + summary: Get the machine catalogs that are using a resource pool. tags: - - MachineCatalogs APIs - /MachineCatalogs/{nameOrId}/$test: - post: + - Hypervisors APIs + /hypervisors/{nameOrId}/resourcePools/{poolId}/resources: + get: description: |- - Run tests on a machine catalog and create a test report. Obtain the - most recent report from - GetMachineCatalogTestReport. - operationId: MachineCatalogs_TestMachineCatalog + Get the resources within a hypervisor resource pool. Note: in previous + versions of the API, resource pools were referred to as "HostingUnits". + A caller can recursively enumerate by: + * Call with no `path`, and `children` equal to `1`. + * For each of the result's + Children where + IsContainer is `true`, call + with `path` equal to that item's + RelativePath and `children` + equal to `1`. + * Repeat recursively. + URI with ?noCache=true can ignore the cache and fetch the data directly. + URI with ?force=true can get the VMs which provisioned by MCS. + URI with ?recurse=true can recurse fetch all resources under this folder. + operationId: Hypervisors_GetHypervisorResourcePoolResources parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -184375,11 +182202,7 @@ paths: schema: type: string style: simple - - description: |- - Name or ID of the machine catalog to test. - If the catalog is present in a catalog folder, - specify the name in this format: {catalog folder path plus catalog name}. - For example, FolderName1|FolderName2|CatalogName. + - description: Name or ID of the hypervisor. explode: false in: path name: nameOrId @@ -184390,17 +182213,97 @@ paths: type: string style: simple x-position: 1 + - description: Name or ID of the resource pool. + explode: false + in: path + name: poolId + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 2 - description: |- - If `true`, the tests will run as a background task. - This is recommended as the tests may take some time to run, - and if it exceeds 90 seconds the request may time out. - The task will have JobType TestMachineCatalog. - When the task is complete it will redirect to - GetJobResults. - The job's Parameters will contain properties: - - * _Id_ - ID of the machine catalog being tested, - * _Name_ - Name of the machine catalog being tested. + Path to the resource container within the resource pool. The path may either + be a relative path as specified by + RelativePath, or may be a + URL-encoded XenApp & XenDesktop resource path starting with `XDHyp:`; for + example, as specified by + XDPath. + explode: true + in: query + name: path + required: false + schema: + nullable: true + title: String + type: string + style: form + x-position: 3 + - description: |- + Specifies the number of levels of children to enumerate. + Default is `0`, meaning that only the object referred to by `path` is returned + and its Children array will be + left null. + A special value of `-1` indicates that the entire resource hierarchy should be + enumerated. Use with care! It may take a very long time to enumerate a large + number of resources from a hypervisor, and the call may time out before + completing. + explode: true + in: query + name: children + required: false + schema: + format: int32 + nullable: true + title: Int32 + type: integer + style: form + x-position: 4 + - description: "If specified, limits the results to the specified resource type(s)." + explode: true + in: query + name: type + required: false + schema: + items: + title: String + type: string + nullable: true + title: "String[]" + type: array + style: form + x-position: 5 + - description: |- + By default, items which are tagged by XenDesktop are not shown. Set this to + `true` to override that behavior. + explode: true + in: query + name: showTagged + required: false + schema: + nullable: true + title: Boolean + type: boolean + style: form + x-position: 6 + - description: |- + If `true`, full details of VMs, snapshots, and templates will be retrieved. + This can be very time consuming and will reduce the performance of the call. + May only be used if `path` refers to a VM, snapshot, or template resource. + + explode: true + in: query + name: detail + required: false + schema: + nullable: true + title: Boolean + type: boolean + style: form + x-position: 7 + - description: 'Async request to get the resources with *path. ' explode: true in: query name: async @@ -184411,14 +182314,35 @@ paths: title: Boolean type: boolean style: form - x-position: 2 + x-position: 8 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/MachineCatalogTestResponseModel' - description: Machine catalog test report. + $ref: '#/components/schemas/HypervisorResourceResponseModel' + description: |- + A list of hypervisor resources. + or + A list of hypervisor resources. + or + A list of hypervisor resources. + or + A list of hypervisor resources. + or + A list of hypervisor resources. + or + A list of hypervisor resources. + or + A list of hypervisor resources. + or + A list of hypervisor resources. + or + A list of hypervisor resources. + or + A list of hypervisor resources. + or + A list of hypervisor resources. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -184471,6 +182395,51 @@ paths: schema: type: string style: simple + x-expectedSchemas: + - description: A list of hypervisor resources. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorAvailabilityZoneResourceResponseModel' + - description: A list of hypervisor resources. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorGpuTypeResourceResponseModel' + - description: A list of hypervisor resources. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorSecurityGroupResourceResponseModel' + - description: A list of hypervisor resources. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorServiceOfferingResourceResponseModel' + - description: A list of hypervisor resources. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorStorageResourceResponseModel' + - description: A list of hypervisor resources. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorTemplateResourceResponseModel' + - description: A list of hypervisor resources. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorVmResourceResponseModel' + - description: A list of hypervisor resources. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorVmSnapshotResourceResponseModel' + - description: A list of hypervisor resources. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorVpcResourceResponseModel' + - description: A list of hypervisor resources. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorCloudRegionResourceResponseModel' + - description: A list of hypervisor resources. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorResourceResponseModel' "202": description: Async request was accepted and is being processed. headers: @@ -184866,70 +182835,6 @@ paths: schema: type: string style: simple - "409": - content: - application/json: - example: - https://errors-api.cloud.com/common/optimisticConcurrency: - value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple "429": content: application/json: @@ -185131,42 +183036,14 @@ paths: schema: type: string style: simple - summary: Run tests on a machine catalog and create a test report. + summary: Get the resources within a hypervisor resource pool. tags: - - MachineCatalogs APIs - /MachineCatalogs/{nameOrId}/$UpdateProvisioningScheme: + - Hypervisors APIs + /hypervisors/{nameOrId}/resourcePools/{poolId}/resources/$search: post: - description: |- - Update the machine catalog's provisioning scheme. - - - Only valid when the machine catalog's ProvisioningType is MCS. - - - Provides the ability to update the hard disk image used to provision - virtual machines. If the provisioning scheme has CleanOnBoot equal to - `true`, then the next time that virtual machines are started, their - hard disks are updated to this new image. Regardless of CleanOnBoot, - all new virtual machines created after this call succeeds will use this - new hard disk image. - - - A snapshot or VM template is used rather than a VM, so that the - content of the hard disk for the provisioning scheme can be easily - determined. - - - The previous hard disk image path is stored into the history (see - ). The - data stored in the history allows for a rollback to be undertaken, - to revert to the previous hard disk image if required. - - - *Note:* The provisioning scheme for a machine catalog cannot be - changed while any provisioning tasks are already executing for the - machine catalog. Cancel existing provisioning tasks or wait for - their completion before updating the provisioning scheme. - operationId: MachineCatalogs_UpdateMachineCatalogProvisioningScheme + description: "Currently, only AWS's AMIs(template) and Machine Profile(vm and\ + \ launch template version) is supported." + operationId: Hypervisors_DoHypervisorResourceSearch parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -185229,10 +183106,7 @@ paths: schema: type: string style: simple - - description: |- - Name or ID of the machine catalog. If the catalog is present in a catalog folder, - specify the name in this format: {catalog folder path plus catalog name}. - For example, FolderName1|FolderName2|CatalogName. + - description: Name or ID of the hypervisor. explode: false in: path name: nameOrId @@ -185242,27 +183116,66 @@ paths: title: String type: string style: simple - x-position: 1 + x-position: 2 + - description: Name or ID of the resource pool. + explode: false + in: path + name: poolId + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 3 - description: |- - Due to the long-running nature of the update operation, it cannot - complete synchronously, and always initiates an asynchronous job to - run to completion. If the `async` parameter is `true`, the only - difference is that instead of returning the initial job status in - the payload, the response is instead `202` with the `Location` - header pointing to the job status API. This may be desirable for - clients that wish to unify their logic for handling asynchronous - jobs. The task will have JobType - . - When the task is complete it will redirect to - . - The job's will contain properties: - - - * _Id_ - ID of the machine catalog for which the provisioning scheme is being updated, - * _Name_ - Name of the machine catalog for which the provisioning scheme is being updated, - * _MasterImageXDPath_ - Path to the new image specified for the provisioning scheme, in XenApp & XenDesktop path format. - * _MasterImageFullPath_ - Path to the new image specified for the provisioning scheme, relative to the root of the API. - * _MasterImageRelativePath_ - Path to the new image specified for the provisioning scheme, relative to the resource pool. + The max number of resources returned by this query. + If not specified, the server might use a default limit of 1 items. + If the specified value is larger than 1000, the server might reject the call. + The default and maximum values depend on server settings. + explode: true + in: query + name: limit + required: false + schema: + format: int32 + nullable: true + title: Int32 + type: integer + style: form + x-position: 4 + - description: |- + If a query cannot be completed, the response will have a + ContinuationToken set. + To obtain more results from the query, pass the + continuation token back into the query to get the next + batch of results. + explode: true + in: query + name: continuationToken + required: false + schema: + nullable: true + title: String + type: string + style: form + x-position: 5 + - description: |- + If `true`, full details of templates will be retrieved. + This can be very time consuming and will reduce the + performance of the call. + explode: true + in: query + name: detail + required: false + schema: + default: false + nullable: true + title: Boolean + type: boolean + style: form + x-position: 6 + - description: 'Async request to get the resources with *path. ' explode: true in: query name: async @@ -185273,23 +183186,26 @@ paths: title: Boolean type: boolean style: form - x-position: 3 + x-position: 7 requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateMachineCatalogProvisioningSchemeRequestModel' - description: Details about the image update to be performed. + $ref: '#/components/schemas/HypervisorResourceSearchRequestModel' + description: Specifies the advanced search parameters. required: true - x-name: request - x-position: 2 + x-name: searchRequest + x-position: 1 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/JobResponseModel' - description: Asynchronous job status. + $ref: '#/components/schemas/HypervisorResourceResponseModelCollection' + description: |- + A list of hypervisor resources. + or + A list of hypervisor resources. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -185342,6 +183258,15 @@ paths: schema: type: string style: simple + x-expectedSchemas: + - description: A list of hypervisor resources. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorResourceResponseModelCollection' + - description: A list of hypervisor resources. + schema: + nullable: true + $ref: '#/components/schemas/HypervisorResourceResponseModelCollection' "202": description: Async request was accepted and is being processed. headers: @@ -186069,13 +183994,12 @@ paths: schema: type: string style: simple - summary: Update the machine catalog's provisioning scheme. + summary: Search the resources within a hypervisor resource pool. tags: - - MachineCatalogs APIs - /MachineCatalogs/{nameOrId}/Administrators: - get: - description: Get administrators who can administer a machine catalog - operationId: MachineCatalogs_GetMachineCatalogsAdministrators + - Hypervisors APIs + /hypervisors/{nameOrId}/resourcePools/{poolId}/resources/$validate: + post: + operationId: Hypervisors_ValidateHypervisorResourcePoolResource parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -186138,10 +184062,7 @@ paths: schema: type: string style: simple - - description: |- - Name or ID of the machine catalog. If the catalog is present in a catalog folder, - specify the name in this format: {catalog folder path plus catalog name}. - For example, FolderName1|FolderName2|CatalogName. + - description: Name or Id of the hypervisor. explode: false in: path name: nameOrId @@ -186151,14 +184072,46 @@ paths: title: String type: string style: simple + x-position: 2 + - description: Name or Id of the resource pool. + explode: false + in: path + name: poolId + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 3 + - description: If async execute. + explode: true + in: query + name: async + required: false + schema: + default: false + nullable: true + title: Boolean + type: boolean + style: form + x-position: 4 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/HypervisorResourceValidationRequestModel' + description: More details attached to this validation. + required: true + x-name: request x-position: 1 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/AdministratorResponseModelCollection' - description: List of administrators. + $ref: '#/components/schemas/HypervisorResourceValidationResponseModel' + description: The validation result. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -186211,6 +184164,67 @@ paths: schema: type: string style: simple + "202": + description: Async request was accepted and is being processed. + headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple "400": content: application/json: @@ -186545,6 +184559,137 @@ paths: schema: type: string style: simple + "409": + content: + application/json: + example: + https://errors-api.cloud.com/common/optimisticConcurrency: + value: + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller requested an invalid relation to be created or deleted. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "415": + content: + application/json: + example: + https://errors-api.cloud.com/common/unsupportedMediaType: + value: + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type + parameters: + - name: mediaType + value: application/xml + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple "429": content: application/json: @@ -186746,14 +184891,16 @@ paths: schema: type: string style: simple - summary: Get administrators who can administer a machine catalog. + summary: "Validate a resource for certain usages, currently default and only\ + \ usage is for Machine Profile." tags: - - MachineCatalogs APIs - /MachineCatalogs/{nameOrId}/DeliveryGroupAssociations: + - Hypervisors APIs + /Hypervisors/{nameOrId}/ResourcePools/{poolId}/TestReport: get: - description: Get delivery group associations by name or Id of a remote pc machine - catalog. - operationId: MachineCatalogs_GetMachineCatalogDeliveryGroupAssociations + description: |- + Get the test report from the last run of + TestHypervisorResourcePool. + operationId: Hypervisors_GetHypervisorResourcePoolTestReport parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -186816,10 +184963,7 @@ paths: schema: type: string style: simple - - description: |- - Name or ID of the machine catalog. If the catalog is present in a catalog folder, - specify the name in this format: {catalog folder path plus catalog name}. - For example, FolderName1|FolderName2|CatalogName. + - description: Name or ID of the hypervisor. explode: false in: path name: nameOrId @@ -186830,58 +184974,25 @@ paths: type: string style: simple x-position: 1 - - description: |- - The max number of delivery group associations returned by this query. - If not specified, the server might use a default limit of 250 items. - If the specified value is larger than 1000, the server might reject the call. - The default and maximum values depend on server settings. - explode: true - in: query - name: limit - required: false - schema: - format: int32 - nullable: true - title: Int32 - type: integer - style: form - x-position: 2 - - description: |- - If a query cannot be completed, the response will have a - ContinuationToken set. - To obtain more results from the query, pass the - continuation token back into the query to get the next - batch of results. - explode: true - in: query - name: continuationToken - required: false + - description: Name or ID of the resource pool. + explode: false + in: path + name: poolId + required: true schema: nullable: true title: String type: string - style: form - x-position: 3 - - description: "If `true`, it will be queried as a background task." - explode: true - in: query - name: async - required: false - schema: - default: false - nullable: true - title: Boolean - type: boolean - style: form - x-position: 4 + style: simple + x-position: 2 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/DeliveryGroupAssociationResponseModelCollection' - description: The delivery group associations of the given machine catalog - identifier + $ref: '#/components/schemas/TestReportResponseModel' + description: "Last test report. If no tests have been run, returns a 404\ + \ Not Found." headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -186934,67 +185045,6 @@ paths: schema: type: string style: simple - "202": - description: Async request was accepted and is being processed. - headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false - schema: - type: string - style: simple - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple "400": content: application/json: @@ -187530,12 +185580,14 @@ paths: schema: type: string style: simple - summary: Get delivery group associations of a machine catalog. + summary: Get the most recent test report for a resource pool. tags: - - MachineCatalogs APIs - /MachineCatalogs/{nameOrId}/Enrollments: + - Hypervisors APIs + /hypervisors/{nameOrId}/serverHAAddresses: get: - operationId: MachineCatalogs_GetMachineCatalogEnrollments + description: URI with ?noCache=true can ignore the cache and fetch the data + directly. + operationId: Hypervisors_GetHypervisorServerHAAddresses parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -187598,7 +185650,7 @@ paths: schema: type: string style: simple - - description: Name or ID of the machine catalog. + - description: 'The hypervisor connection name or id. ' explode: false in: path name: nameOrId @@ -187609,13 +185661,25 @@ paths: type: string style: simple x-position: 1 + - description: 'If the execution with async model. ' + explode: true + in: query + name: async + required: false + schema: + default: false + nullable: true + title: Boolean + type: boolean + style: form + x-position: 2 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/EnrollmentResponseModelCollection' - description: List of enrollments. + $ref: '#/components/schemas/HypervisorServerHAAddressesResponseModel' + description: 'HypervisorServerHAAddressesResponseModel object. ' headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -187668,6 +185732,67 @@ paths: schema: type: string style: simple + "202": + description: Async request was accepted and is being processed. + headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple "400": content: application/json: @@ -188203,13 +186328,16 @@ paths: schema: type: string style: simple - summary: Get the list of enrollments in the machine catalog. + summary: "Get hypervisor server HA addresses. Currently, it only valid for Citrix\ + \ hypervisors." tags: - - MachineCatalogs APIs - /MachineCatalogs/{nameOrId}/LastMasterImage: + - Hypervisors APIs + /Hypervisors/{nameOrId}/TestReport: get: - description: Get the last master VM images used by the machine catalog - operationId: MachineCatalogs_GetMachineCatalogLastMasterImage + description: |- + Get the test report from the last run of + TestHypervisor. + operationId: Hypervisors_GetHypervisorTestReport parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -188272,10 +186400,7 @@ paths: schema: type: string style: simple - - description: |- - Name or ID of the machine catalog. If the catalog is present in a catalog folder, - specify the name in this format: {catalog folder path plus catalog name}. - For example, FolderName1|FolderName2|CatalogName. + - description: Name or ID of the hypervisor. explode: false in: path name: nameOrId @@ -188286,87 +186411,15 @@ paths: type: string style: simple x-position: 1 - - description: "If `true`, it will be queried as a background task." - explode: true - in: query - name: async - required: false - schema: - default: false - nullable: true - title: Boolean - type: boolean - style: form - x-position: 2 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/VMImageResponseModel' - description: Last image used by the machine catalog to provision VMs. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "202": - description: Async request was accepted and is being processed. + $ref: '#/components/schemas/TestReportResponseModel' + description: "Last test report. If no tests have been run, returns a 404\ + \ Not Found." headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false - schema: - type: string - style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -188953,19 +187006,14 @@ paths: schema: type: string style: simple - summary: Get the last master VM images used by the machine catalog. + summary: Get the most recent test report for a hypervisor. tags: - - MachineCatalogs APIs - /MachineCatalogs/{nameOrId}/MachineAccounts: + - Hypervisors APIs + /hypervisors/supportedPlugins: get: - description: |- - Get all machine accounts associated with a machine catalog. This returns - all machine accounts for the machine catalog regardless of whether they are - in-use, available, locked, etc. - - - This is only relevant for machine catalogs where ProvisioningType is MCS. - operationId: MachineCatalogs_GetMachineCatalogMachineAccounts + description: URI with ?noCache=true can ignore the cache and fetch the data + directly. + operationId: Hypervisors_GetSupportHypervisors parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -189028,85 +187076,47 @@ paths: schema: type: string style: simple - - description: |- - Name or ID of the machine catalog to get machine accounts for. - If the catalog is present in a catalog folder, - specify the name in this format: {catalog folder path plus catalog name}. - For example, FolderName1|FolderName2|CatalogName. - explode: false - in: path - name: nameOrId - required: true - schema: - nullable: true - title: String - type: string - style: simple - x-position: 1 - - description: |- - The max number of machine accounts returned by this query. - If not specified, the server might use a default limit of 250 items. - If the specified value is larger than 1000, the server might reject the call. - The default and maximum values depend on server settings. + - description: 'If execute this API asynchronous. ' explode: true in: query - name: limit + name: async required: false schema: - format: int32 + default: false nullable: true - title: Int32 - type: integer + title: Boolean + type: boolean style: form - x-position: 2 - - description: |- - If a query cannot be completed, the response will have a - ContinuationToken set. - To obtain more results from the query, pass the - continuation token back into the query to get the next - batch of results. + x-position: 1 + - description: 'The zone name or id. ' explode: true in: query - name: continuationToken + name: zoneNameOrId required: false schema: nullable: true title: String type: string style: form - x-position: 3 - - description: |- - If `true`, the machine accounts will be queried as a background task. - The task will have JobType GetMachineCatalogMachineAccounts. - When the task is complete it will redirect to GetJobResults. + x-position: 2 + - description: Flag to show all supported hypervisor plugins. explode: true in: query - name: async + name: includeUnavailable required: false schema: default: false - nullable: true title: Boolean type: boolean style: form - x-position: 4 - - description: The state of accounts for query. - explode: true - in: query - name: accountState - required: false - schema: - allOf: - - $ref: '#/components/schemas/ProvisioningSchemeMachineAccountState' - style: form - x-position: 5 + x-position: 3 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/ProvisioningSchemeMachineAccountResponseModelCollection' - description: List of machine accounts. + $ref: '#/components/schemas/HypervisorPluginResponseModelCollection' + description: 'List of Hypervisor Plugin response model. ' headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -189420,74 +187430,6 @@ paths: schema: type: string style: simple - "404": - content: - application/json: - example: - https://errors-api.cloud.com/common/notFound: - value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found - parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 - schema: - $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple "406": content: application/json: @@ -189755,13 +187697,14 @@ paths: schema: type: string style: simple - summary: Get all machine accounts associated with a machine catalog. + summary: Get current server support hypervisors. tags: - - MachineCatalogs APIs - post: - description: Add a machine account to the machine catalog. This is only relevant - for machine catalogs where ProvisioningType is MCS. - operationId: MachineCatalogs_AddMachineCatalogMachineAccount + - Hypervisors APIs + /hypervisorsAndResourcePools: + get: + description: URI with ?noCache=true can ignore the cache and fetch the data + directly. + operationId: Hypervisors_GetHypervisorsAndResourcePools parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -189806,19 +187749,6 @@ paths: schema: type: string style: simple - - description: "Admin credential to use when performing the operation. If not\ - \ specified, the operation will be performed using the account under which\ - \ the identity service is running If specified, must be in a format matching\ - \ that of the standard 'Authorization' request header; the username and\ - \ password separated by a colon, UTF8-encoded, then base64-encoded, then\ - \ the \"Basic \" scheme prepended.\r\nExample:Basic QWxhZGRpbjpPcGVuU2VzYW1l" - explode: false - in: header - name: X-AdminCredential - required: false - schema: - type: string - style: simple - description: Must accept application/json. example: application/json explode: false @@ -189837,38 +187767,25 @@ paths: schema: type: string style: simple - - description: |- - Name or ID of the machine catalog to add the machine account to. - If the catalog is present in a catalog folder, - specify the name in this format: {catalog folder path plus catalog name}. - For example, FolderName1|FolderName2|CatalogName. - explode: false - in: path - name: nameOrId - required: true + - description: 'If execute this API asynchronous. ' + explode: true + in: query + name: async + required: false schema: + default: false nullable: true - title: String - type: string - style: simple + title: Boolean + type: boolean + style: form x-position: 1 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MachineAccountRequestModel' - description: Machine account to add to the machine catalog. The machine must - not be a member of any other machine catalog. - required: true - x-name: machine - x-position: 2 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/ProvisioningSchemeMachineAccountResponseModel' - description: Machine account that was added. + $ref: '#/components/schemas/HypervisorsAndResourcePoolsResponseModelCollection' + description: 'List of Hypervisor Main View Response Model. ' headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -189921,21 +187838,16 @@ paths: schema: type: string style: simple - "400": - content: - application/json: - example: - https://errors-api.cloud.com/common/outOfRange: - value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range - parameters: - - name: property - value: startTime - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + "202": + description: Async request was accepted and is being processed. headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -189987,20 +187899,20 @@ paths: schema: type: string style: simple - "401": + "400": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/outOfRange: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range parameters: - - name: reason - value: missing + - name: property + value: startTime schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: Caller passed an invalid input. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -190053,22 +187965,20 @@ paths: schema: type: string style: simple - "403": + "401": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -190121,14 +188031,14 @@ paths: schema: type: string style: simple - "404": + "403": content: application/json: example: - https://errors-api.cloud.com/common/notFound: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - name: entityType value: https://identifiers-api.cloud.com/example/widget @@ -190136,7 +188046,7 @@ paths: value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -190255,137 +188165,6 @@ paths: schema: type: string style: simple - "409": - content: - application/json: - example: - https://errors-api.cloud.com/common/optimisticConcurrency: - value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "415": - content: - application/json: - example: - https://errors-api.cloud.com/common/unsupportedMediaType: - value: - type: https://errors-api.cloud.com/common/unsupportedMediaType - detail: Must use application/json;charset=utf-8 media type - parameters: - - name: mediaType - value: application/xml - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller must send request body in utf-8 and specify request - Content-Type as utf-8. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple "429": content: application/json: @@ -190587,14 +188366,15 @@ paths: schema: type: string style: simple - summary: Add a machine account to the machine catalog. + summary: |- + Get hypervisors and resource pools. + This API is used for the hosting main view. tags: - - MachineCatalogs APIs - /MachineCatalogs/{nameOrId}/MachineAccounts/{machine}: - delete: - description: Remove a machine account from the machine catalog. This is only - relevant for machine catalogs where ProvisioningType is MCS. - operationId: MachineCatalogs_RemoveMachineCatalogMachineAccount + - Hypervisors APIs + /Icons: + get: + description: Get all icons in the site. + operationId: Icons_GetIcons parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -190639,19 +188419,6 @@ paths: schema: type: string style: simple - - description: "Admin credential to use when performing the operation. If not\ - \ specified, the operation will be performed using the account under which\ - \ the identity service is running If specified, must be in a format matching\ - \ that of the standard 'Authorization' request header; the username and\ - \ password separated by a colon, UTF8-encoded, then base64-encoded, then\ - \ the \"Basic \" scheme prepended.\r\nExample:Basic QWxhZGRpbjpPcGVuU2VzYW1l" - explode: false - in: header - name: X-AdminCredential - required: false - schema: - type: string - style: simple - description: Must accept application/json. example: application/json explode: false @@ -190671,48 +188438,159 @@ paths: type: string style: simple - description: |- - Name or ID of the machine catalog to remove the machine account from. - If the catalog is present in a catalog folder, - specify the name in this format: {catalog folder path plus catalog name}. - For example, FolderName1|FolderName2|CatalogName. - explode: false - in: path - name: nameOrId - required: true + Icon format. Must be: `{mime-type};{width}x{height}x{colordepth}` + + + where: + + + * _mime-type_ must be `image/png`. (Other formats may be supported in future.) + * _width_ and _height_ are specified in pixels. + * _colordepth_ (optional) is either `8` or `24`. + + + example: `"image/png;32x32x24"` + + + Optional. If not specified, only the raw icon data will be returned. Note that + this is typically in ICO format, which some clients cannot display properly. + explode: true + in: query + name: iconFormat + required: false schema: nullable: true title: String type: string - style: simple + style: form x-position: 1 - - description: "Machine account to remove. May be specified by SamName, UPN,\ - \ or SID." - explode: false - in: path - name: machine - required: true + - description: |- + If specified as `true`, only built-in icons will be returned. If specified as + `false`, only user-created icons will be returned. If not specified, all + icons will be returned. + explode: true + in: query + name: builtIn + required: false schema: nullable: true - title: String - type: string - style: simple + title: Boolean + type: boolean + style: form x-position: 2 - - description: Specifies what to do with the machine account in AD. Optional; - default is None. + - description: 'If async execute. ' explode: true in: query - name: deleteAccount + name: async required: false schema: - allOf: - - $ref: '#/components/schemas/MachineAccountDeleteOption' - default: None + default: false + nullable: true + title: Boolean + type: boolean style: form x-position: 3 + - description: |- + The max number of icons returned by this query. + If not specified, the server might use a default limit of 250 items. + If the specified value is larger than 1000, the server might reject the call. + The default and maximum values depend on server settings. + explode: true + in: query + name: limit + required: false + schema: + format: int32 + nullable: true + title: Int32 + type: integer + style: form + x-position: 4 + - description: |- + If a query cannot be completed, the response will have a + ContinuationToken set. + To obtain more results from the query, pass the + continuation token back into the query to get the next + batch of results. + explode: true + in: query + name: continuationToken + required: false + schema: + nullable: true + title: String + type: string + style: form + x-position: 5 responses: - "204": - description: Operation is successful with no response content. + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/IconResponseModelCollection' + description: List of icons. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "202": + description: Async request was accepted and is being processed. headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -190964,60 +188842,6 @@ paths: schema: type: string style: simple - "404": - description: A referenced entity was not found. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple "406": content: application/json: @@ -191084,70 +188908,6 @@ paths: schema: type: string style: simple - "409": - content: - application/json: - example: - https://errors-api.cloud.com/common/optimisticConcurrency: - value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple "429": content: application/json: @@ -191349,18 +189109,11 @@ paths: schema: type: string style: simple - summary: Remove a machine account from the machine catalog. + summary: Get all icons in the site. tags: - - MachineCatalogs APIs - patch: - description: |- - Update a machine account within the machine catalog. This is typically used to reset or - update the machine password so that the site is able to apply the machine account to a - provisioned VM. - - - This is only relevant for machine catalogs where ProvisioningType is MCS. - operationId: MachineCatalogs_UpdateMachineCatalogMachineAccount + - Icons APIs + post: + operationId: Icons_AddIcon parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -191405,19 +189158,6 @@ paths: schema: type: string style: simple - - description: "Admin credential to use when performing the operation. If not\ - \ specified, the operation will be performed using the account under which\ - \ the identity service is running If specified, must be in a format matching\ - \ that of the standard 'Authorization' request header; the username and\ - \ password separated by a colon, UTF8-encoded, then base64-encoded, then\ - \ the \"Basic \" scheme prepended.\r\nExample:Basic QWxhZGRpbjpPcGVuU2VzYW1l" - explode: false - in: header - name: X-AdminCredential - required: false - schema: - type: string - style: simple - description: Must accept application/json. example: application/json explode: false @@ -191436,50 +189176,43 @@ paths: schema: type: string style: simple - - description: |- - Name or ID of the machine catalog containing the machine account. - If the catalog is present in a catalog folder, - specify the name in this format: {catalog folder path plus catalog name}. - For example, FolderName1|FolderName2|CatalogName. - explode: false - in: path - name: nameOrId - required: true - schema: - nullable: true - title: String - type: string - style: simple - x-position: 1 - - description: "Machine account to update. May be specified by SamName, UPN,\ - \ or SID." - explode: false - in: path - name: machine - required: true + - description: "If `true`, the icon will be added as a background task.\nThe\ + \ task will have JobType AddIcon.\nWhen the task is complete it will redirect\ + \ to\nGetIcon.\n " + explode: true + in: query + name: async + required: false schema: - nullable: true - title: String - type: string - style: simple + default: false + title: Boolean + type: boolean + style: form x-position: 2 requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateMachineAccountRequestModel' - description: New details for the machine account record. + $ref: '#/components/schemas/AddIconRequestModel' + description: request body containing icon data required: true - x-name: details - x-position: 3 + x-name: requestModel + x-position: 1 responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/ProvisioningSchemeMachineAccountResponseModel' - description: Machine account details. + $ref: '#/components/schemas/IconResponseModel' + description: Resource was created. headers: + Location: + description: Location where the newly created resource resides. + example: /services/myservice/widgets/1 + explode: false + schema: + type: string + style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -191531,9 +189264,16 @@ paths: schema: type: string style: simple - "204": - description: Operation is successful with no response content. + "202": + description: Async request was accepted and is being processed. headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -191585,20 +189325,8 @@ paths: schema: type: string style: simple - "400": - content: - application/json: - example: - https://errors-api.cloud.com/common/outOfRange: - value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range - parameters: - - name: property - value: startTime - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + "204": + description: Operation is successful with no response content. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -191651,20 +189379,20 @@ paths: schema: type: string style: simple - "401": + "400": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/outOfRange: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range parameters: - - name: reason - value: missing + - name: property + value: startTime schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: Caller passed an invalid input. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -191717,22 +189445,20 @@ paths: schema: type: string style: simple - "403": + "401": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -191785,14 +189511,14 @@ paths: schema: type: string style: simple - "404": + "403": content: application/json: example: - https://errors-api.cloud.com/common/notFound: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - name: entityType value: https://identifiers-api.cloud.com/example/widget @@ -191800,7 +189526,7 @@ paths: value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -191919,6 +189645,70 @@ paths: schema: type: string style: simple + "409": + content: + application/json: + example: + https://errors-api.cloud.com/common/optimisticConcurrency: + value: + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller requested an invalid relation to be created or deleted. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple "415": content: application/json: @@ -192187,12 +189977,12 @@ paths: schema: type: string style: simple - summary: Update a machine account within the machine catalog. + summary: add a customized icon. tags: - - MachineCatalogs APIs - /MachineCatalogs/{nameOrId}/Machines: - get: - operationId: MachineCatalogs_GetMachineCatalogMachines + - Icons APIs + /Icons/{id}: + delete: + operationId: Icons_RemoveIcon parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -192255,84 +190045,33 @@ paths: schema: type: string style: simple - - description: |- - Name or ID of the machine catalog. If the catalog is present in a catalog folder, - specify the name in this format: {catalog folder path plus catalog name}. - For example, FolderName1|FolderName2|CatalogName. + - description: id of the icon to remove explode: false in: path - name: nameOrId + name: id required: true - schema: - nullable: true - title: String - type: string - style: simple - x-position: 1 - - description: |- - The max number of machines returned by this query. - If not specified, the server might use a default limit of 250 items. - If the specified value is larger than 1000, the server might reject the call. - The default and maximum values depend on server settings. - explode: true - in: query - name: limit - required: false schema: format: int32 - nullable: true title: Int32 type: integer - style: form - x-position: 2 - - description: |- - If a query cannot be completed, the response will have a - ContinuationToken set. - To obtain more results from the query, pass the - continuation token back into the query to get the next - batch of results. - explode: true - in: query - name: continuationToken - required: false - schema: - nullable: true - title: String - type: string - style: form - x-position: 3 - - description: "If `true`, it will be queried as a background task." + style: simple + x-position: 1 + - description: "If `true`, the icon will be removed as a background task.\n\ + The task will have JobType RemoveIcon.\nWhen the task is complete it will\ + \ redirect to\nGetIcons.\n " explode: true in: query name: async required: false schema: default: false - nullable: true title: Boolean type: boolean style: form - x-position: 4 - - description: "Optional parameters, only the specified properties in the fields\ - \ are required." - example: "Uid,AgentVersion,AllocationType" - explode: true - in: query - name: fields - required: false - schema: - nullable: true - title: String - type: string - style: form - x-position: 5 + x-position: 2 responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MachineResponseModelCollection' - description: The machines of the given machine catalog identifier + "204": + description: Operation is successful with no response content. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -192647,20 +190386,6 @@ paths: type: string style: simple "404": - content: - application/json: - example: - https://errors-api.cloud.com/common/notFound: - value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found - parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 - schema: - $ref: '#/components/schemas/ErrorResponse' description: A referenced entity was not found. headers: Citrix-TransactionId: @@ -192780,6 +190505,70 @@ paths: schema: type: string style: simple + "409": + content: + application/json: + example: + https://errors-api.cloud.com/common/optimisticConcurrency: + value: + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller requested an invalid relation to be created or deleted. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple "429": content: application/json: @@ -192981,35 +190770,12 @@ paths: schema: type: string style: simple - summary: GET the machines of a catalog + summary: Remove a customized icon. tags: - - MachineCatalogs APIs - post: - description: |- - Add a machine to the machine catalog. This is the first step in making the - machine available to run users' desktops and applications. The machine may - be physical or virtual. The type of machine (physical or virtual) must - match the machine catalog configuration. - - - Note that due to - the long-running nature of the adding operation, it cannot - complete synchronously, would always initiate an asynchronous job to - run to completion. - - - The machine must support the expected capabilities of the machine catalog: - the and - . The session - support of the machine is determined by the type of Citrix VDA software - installed (server or workstation) and the functional level depends on the - version of the Citrix VDA software installed. The API will complete - successfully if these are not correct but the machine will be unable to register. - - - Note: to add multiple machines in a single call, use the - API. - operationId: MachineCatalogs_AddMachineCatalogMachine + - Icons APIs + get: + description: Get a single icon from the site + operationId: Icons_GetIcon parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -193054,30 +190820,6 @@ paths: schema: type: string style: simple - - description: "Admin credential to use when performing the operation. If not\ - \ specified, the operation will be performed using the account under which\ - \ the identity service is running If specified, must be in a format matching\ - \ that of the standard 'Authorization' request header; the username and\ - \ password separated by a colon, UTF8-encoded, then base64-encoded, then\ - \ the \"Basic \" scheme prepended.\r\nExample:Basic QWxhZGRpbjpPcGVuU2VzYW1l" - explode: false - in: header - name: X-AdminCredential - required: false - schema: - type: string - style: simple - - description: "Access token to use when performing the operation. If specified,\ - \ must be in a format matching that of the standard 'Authorization' request\ - \ header; UTF8-encoded, then base64-encoded, then the \"Bearer\" scheme\ - \ prepended.\r\nExample: Bearer bGljaGVuZy5saW5AY2l0cml4LmNvbQ==" - explode: false - in: header - name: X-AccessToken - required: false - schema: - type: string - style: simple - description: Must accept application/json. example: application/json explode: false @@ -193096,14 +190838,10 @@ paths: schema: type: string style: simple - - description: |- - Name or ID of the machine catalog to add machine to. - If the catalog is present in a catalog folder, - specify the name in this format: {catalog folder path plus catalog name}. - For example, FolderName1|FolderName2|CatalogName. + - description: ID of the icon. explode: false in: path - name: nameOrId + name: id required: true schema: nullable: true @@ -193112,101 +190850,38 @@ paths: style: simple x-position: 1 - description: |- - If `true`, the machine will be added into the machine catalog as a background task. - The task will have JobType AddMachineCatalogMachine. - When the task is complete it will redirect to - GetMachineCatalog. - The job's Parameters will contain properties: - * _NameOrId_ - Name or ID of the machine being added. + Icon format. Must be: + `{mime-type};{width}x{height}x{colordepth}` + + + where: + * _mime-type_ must be `image/png`. (Other formats may be supported in future.) + * _width_ and _height_ are specified in pixels. + * _colordepth_ (optional) is either `8` or `24`. + example: `"image/png;32x32x24"` + + + Optional. If not specified, only the raw icon data will be returned. Note that + this is typically in ICO format, which some clients cannot display properly. explode: true in: query - name: async + name: iconFormat required: false schema: - default: false nullable: true - title: Boolean - type: boolean + title: String + type: string style: form - x-position: 3 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AddMachineToMachineCatalogDetailRequestModel' - description: Details of the machine to add to the machine catalog. - required: true - x-name: machine x-position: 2 responses: "200": content: - application/json: - schema: - $ref: '#/components/schemas/JobResponseModel' - description: Asynchronous job status. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false + application/octet-stream: schema: + format: binary type: string - style: simple - "202": - description: Async request was accepted and is being processed. + description: The icon. headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false - schema: - type: string - style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -193592,137 +191267,6 @@ paths: schema: type: string style: simple - "409": - content: - application/json: - example: - https://errors-api.cloud.com/common/optimisticConcurrency: - value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "415": - content: - application/json: - example: - https://errors-api.cloud.com/common/unsupportedMediaType: - value: - type: https://errors-api.cloud.com/common/unsupportedMediaType - detail: Must use application/json;charset=utf-8 media type - parameters: - - name: mediaType - value: application/xml - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller must send request body in utf-8 and specify request - Content-Type as utf-8. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple "429": content: application/json: @@ -193924,22 +191468,15 @@ paths: schema: type: string style: simple - summary: Add machine to the machine catalog. + summary: Get a single icon from the site. tags: - - MachineCatalogs APIs - /MachineCatalogs/{nameOrId}/Machines/{machine}: - delete: + - Icons APIs + /Icons/AppVServerPackageApplication: + post: description: |- - Remove a machine from the machine catalog. Removing the machine from the machine - catalog removes it from the site. - - - A machine cannot be removed from the machine catalog if it is a member of a delivery group. - - - Note: to remove multiple machines in a single call, use the - API. - operationId: MachineCatalogs_RemoveMachineCatalogMachine + Get the icon for a single App-V package on a server (as + opposed to within the site). + operationId: Icons_GetAppVServerPackageApplicationIcon parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -194002,36 +191539,22 @@ paths: schema: type: string style: simple - - description: |- - Name or ID of the machine catalog to remove the machine from. - If the catalog is present in a catalog folder, - specify the name in this format: {catalog folder path plus catalog name}. - For example, FolderName1|FolderName2|CatalogName. - explode: false - in: path - name: nameOrId + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AppvServerPackageApplicationIconRequestModel' + description: App-V server package application icon request model. required: true - schema: - nullable: true - title: String - type: string - style: simple + x-name: request x-position: 1 - - description: "Machine to remove from the catalog. May be specified by name,\ - \ ID, or SID." - explode: false - in: path - name: machine - required: true - schema: - nullable: true - title: String - type: string - style: simple - x-position: 2 responses: - "204": - description: Operation is successful with no response content. + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/IconDataResponseModel' + description: Icon details. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -194284,8 +191807,20 @@ paths: schema: type: string style: simple - "404": - description: A referenced entity was not found. + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -194338,20 +191873,18 @@ paths: schema: type: string style: simple - "406": + "409": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/optimisticConcurrency: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type - parameters: - - name: contentType - value: application/json + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + description: Caller requested an invalid relation to be created or deleted. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -194404,18 +191937,21 @@ paths: schema: type: string style: simple - "409": + "415": content: application/json: example: - https://errors-api.cloud.com/common/optimisticConcurrency: + https://errors-api.cloud.com/common/unsupportedMediaType: value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type + parameters: + - name: mediaType + value: application/xml schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -194669,13 +192205,20 @@ paths: schema: type: string style: simple - summary: Remove a machine from the machine catalog. + summary: |- + Get the icon for a single App-V application within an App-V package + on a server. tags: - - MachineCatalogs APIs - /MachineCatalogs/{nameOrId}/MasterImageHistory: + - Icons APIs + /Jobs: get: - description: Get the history of master VM images used by the machine catalog - operationId: MachineCatalogs_GetMachineCatalogMasterImageHistory + description: |- + For security reasons, jobs are only visible to the caller who + initiated them. + + Note: completed jobs will be automatically removed by the system + 48 hours after completion. + operationId: Jobs_GetJobs parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -194738,24 +192281,13 @@ paths: schema: type: string style: simple - - description: Name or ID of the machine catalog. - explode: false - in: path - name: nameOrId - required: true - schema: - nullable: true - title: String - type: string - style: simple - x-position: 1 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/VMImageResponseModelCollection' - description: List of images used by the machine catalog to provision VMs. + $ref: '#/components/schemas/JobResponseModelCollection' + description: List of jobs. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -195008,74 +192540,6 @@ paths: schema: type: string style: simple - "404": - content: - application/json: - example: - https://errors-api.cloud.com/common/notFound: - value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found - parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 - schema: - $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple "406": content: application/json: @@ -195343,24 +192807,27 @@ paths: schema: type: string style: simple - summary: Get the history of master VM images used by the machine catalog. + summary: |- + Get the list of jobs that are currently active, or have recently + completed, and were initiated by the caller. tags: - - MachineCatalogs APIs - /MachineCatalogs/{nameOrId}/RemotePCEnrollmentScopes/$checkScopeName: - post: + - Jobs APIs + /Jobs/{id}: + delete: description: |- - Check for the existence of a RemotePC enrollment scope by name. Note that - RemotePC enrollment scope names must be unique within the site, so the - `nameOrId` parameter does not affect whether the RemotePC enrollment scope - name is found. - If the name is found to be available, this returns 404 Not Found. - If a RemotePC enrollment scope by that name exists and is associated with the - specified machine catalog, this returns 204 No Content. If a RemotePC - enrollment scope by that name exists and is associated with a different - machine catalog, this returns 303 See Other, and the `Location` - response header refers to location of the machine catalog which is associated - by the RemotePC enrollment scope. - operationId: MachineCatalogs_TestRemotePCEnrollmentScopeExists + For security reasons, jobs are only visible to the caller who + initiated them. + + + This may only be called if the job has completed (with or without an error + or warning) or if the job has been cancelled. It will return an error + if the job is still in progress. + + + Note: completed jobs will be automatically removed by the system + 48 hours after completion. After this happens, this call will + return `404 Not Found` when given the removed job Id. + operationId: Jobs_DeleteJob parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -195423,13 +192890,10 @@ paths: schema: type: string style: simple - - description: |- - Name or ID of the machine catalog. If the catalog is present in a catalog folder, - specify the name in this format: {catalog folder path plus catalog name}. - For example, FolderName1|FolderName2|CatalogName. + - description: ID of the job to remove. explode: false in: path - name: nameOrId + name: id required: true schema: nullable: true @@ -195437,16 +192901,6 @@ paths: type: string style: simple x-position: 1 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RemotePCEnrollmentScopeCheckModel' - description: Request model that contains distinguished name of an OU containing - machines allowed to enroll as remote PCs. - required: true - x-name: request - x-position: 2 responses: "204": description: Operation is successful with no response content. @@ -195703,20 +193157,6 @@ paths: type: string style: simple "404": - content: - application/json: - example: - https://errors-api.cloud.com/common/notFound: - value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found - parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 - schema: - $ref: '#/components/schemas/ErrorResponse' description: A referenced entity was not found. headers: Citrix-TransactionId: @@ -195900,73 +193340,6 @@ paths: schema: type: string style: simple - "415": - content: - application/json: - example: - https://errors-api.cloud.com/common/unsupportedMediaType: - value: - type: https://errors-api.cloud.com/common/unsupportedMediaType - detail: Must use application/json;charset=utf-8 media type - parameters: - - name: mediaType - value: application/xml - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller must send request body in utf-8 and specify request - Content-Type as utf-8. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple "429": content: application/json: @@ -196168,26 +193541,18 @@ paths: schema: type: string style: simple - summary: |- - Check for the existence of a RemotePC enrollment scope by name in the request body. - Use HttpPost and take name in body as this name may be very long, and cause url too long exception. + summary: Removes the job record. tags: - - MachineCatalogs APIs - /MachineCatalogs/{nameOrId}/RemotePCEnrollmentScopes/{name}: - head: + - Jobs APIs + get: description: |- - Check for the existence of a RemotePC enrollment scope by name. Note that - RemotePC enrollment scope names must be unique within the site, so the - `nameOrId` parameter does not affect whether the RemotePC enrollment scope - name is found. - If the name is found to be available, this returns 404 Not Found. - If a RemotePC enrollment scope by that name exists and is associated with the - specified machine catalog, this returns 204 No Content. If a RemotePC - enrollment scope by that name exists and is associated with a different - machine catalog, this returns 303 See Other, and the `Location` - response header refers to location of the machine catalog which is associated - by the RemotePC enrollment scope. - operationId: MachineCatalogs_CheckRemotePCEnrollmentScopeExists + For security reasons, jobs are only visible to the caller who + initiated them. + + Note: completed jobs will be automatically removed by the system + 48 hours after completion. After this happens, this call will + return `404 Not Found` when given the removed job Id. + operationId: Jobs_GetJob parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -196250,13 +193615,10 @@ paths: schema: type: string style: simple - - description: |- - Name or ID of the machine catalog. If the catalog is present in a catalog folder, - specify the name in this format: {catalog folder path plus catalog name}. - For example, FolderName1|FolderName2|CatalogName. + - description: ID of the job. explode: false in: path - name: nameOrId + name: id required: true schema: nullable: true @@ -196264,21 +193626,13 @@ paths: type: string style: simple x-position: 1 - - description: Distinguished name of an OU containing machines allowed to enroll - as remote PCs. - explode: false - in: path - name: name - required: true - schema: - nullable: true - title: String - type: string - style: simple - x-position: 2 responses: - "204": - description: Operation is successful with no response content. + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/JobResponseModel' + description: Details of the job. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -196866,19 +194220,18 @@ paths: schema: type: string style: simple - summary: Check for the existence of a RemotePC enrollment scope by name. + summary: Get the details of a single job. tags: - - MachineCatalogs APIs - /MachineCatalogs/{nameOrId}/StartMenuApplications: - get: - description: |- - Get the start menu applications from a machine in the machine catalog - - Note that this API may require a machine within a catalog to be - booted, if no machines are currently available. Therefore the API - may take quite some time to complete. Consider using the `async=true` - parameter to mitigate this. - operationId: MachineCatalogs_GetMachineCatalogStartMenuApplications + - Jobs APIs + /Jobs/{id}/$cancel: + post: + description: "For security reasons, jobs are only visible to the caller who\n\ + initiated them.\n\nThis may only be called if \nis `true`, OR if the job has\ + \ completed (with or without an error\nor warning).\n\nNote: completed jobs\ + \ will be automatically removed by the system\n48 hours after completion.\ + \ After this happens, this call will\nreturn `404 Not Found` when given the\ + \ removed job Id." + operationId: Jobs_CancelJob parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -196941,13 +194294,10 @@ paths: schema: type: string style: simple - - description: |- - Name or ID of the machine catalog. If the catalog is present in a catalog folder, - specify the name in this format: {catalog folder path plus catalog name}. - For example, FolderName1|FolderName2|CatalogName. + - description: ID of the job to remove. explode: false in: path - name: nameOrId + name: id required: true schema: nullable: true @@ -196955,53 +194305,13 @@ paths: type: string style: simple x-position: 1 - - description: The machines to get start menu applications - explode: true - in: query - name: machines - required: false - schema: - items: - title: String - type: string - nullable: true - title: "String[]" - type: array - style: form - x-position: 2 - - description: |- - If `true`, the start menu applications will be queried as a background task. - This is recommended as this operation may cause a power - action, turning on a machine in order to gather the data. - This may take some time to run, - and if it exceeds 90 seconds the request may time out. - The task will have JobType GetStartMenuApplications. - When the task is complete it will redirect to - "JobsControllerTP.GetJobResults(string)". - The job's Parameters will contain properties: - - * _Id_ - ID of the machine catalog from which start menu applications are being obtained, - * _Name_ - Name of the machine catalog from which start menu applications are being obtained. - * _MachineId_ - ID of the machine selected, from which the start menu applications are being obtained; will be present in Parameters only after a machine is selected. - * _MachineName_ - Name of the machine selected, from which the start menu applications are being obtained; will be present in Parameters only after a machine is selected. - explode: true - in: query - name: async - required: false - schema: - default: false - nullable: true - title: Boolean - type: boolean - style: form - x-position: 3 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/StartMenuApplicationResponseModelCollection' - description: List of start menu applications. + $ref: '#/components/schemas/JobResponseModel' + description: Job details. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -197054,16 +194364,21 @@ paths: schema: type: string style: simple - "202": - description: Async request was accepted and is being processed. - headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime schema: - type: string - style: simple + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -197115,20 +194430,20 @@ paths: schema: type: string style: simple - "400": + "401": content: application/json: example: - https://errors-api.cloud.com/common/outOfRange: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: property - value: startTime + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -197181,20 +194496,22 @@ paths: schema: type: string style: simple - "401": + "403": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - - name: reason - value: missing + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -197247,14 +194564,14 @@ paths: schema: type: string style: simple - "403": + "404": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/notFound: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found parameters: - name: entityType value: https://identifiers-api.cloud.com/example/widget @@ -197262,7 +194579,7 @@ paths: value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: A referenced entity was not found. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -197315,22 +194632,20 @@ paths: schema: type: string style: simple - "404": + "406": content: application/json: example: - https://errors-api.cloud.com/common/notFound: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -197383,20 +194698,18 @@ paths: schema: type: string style: simple - "406": + "409": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/optimisticConcurrency: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type - parameters: - - name: contentType - value: application/json + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + description: Caller requested an invalid relation to be created or deleted. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -197650,19 +194963,20 @@ paths: schema: type: string style: simple - summary: Get the start menu applications from a machine in the machine catalog. + summary: Cancel a job. tags: - - MachineCatalogs APIs - /MachineCatalogs/{nameOrId}/Tags: - get: - description: |- - Get tags associated with a machine catalog. This includes tags which are - directly associated with the machine catalog, as well as tags associated with - machines that are associated with the machine catalog. - To find only tags directly associated with the machine catalog, - filter the results to those with - NumMachineCatalogs equal to `1`. - operationId: MachineCatalogs_GetMachineCatalogTags + - Jobs APIs + /Jobs/{id}/$SkipRemaining: + post: + description: "For security reasons, jobs are only visible to the caller who\n\ + initiated them.\n\nOnly supported for jobs where \nis equal to . Any job\ + \ that\ndoes not support this action will return a `501 Not Implemented`\n\ + response code.\n\n\nIf the job has already completed successfully, this call\ + \ will return\na `303 See Other` response, with a `Location` header\npointing\ + \ to the affected resource(s).\n\nNote: completed jobs will be automatically\ + \ removed by the system\n48 hours after completion. After this happens, this\ + \ call will\nreturn `404 Not Found` when given the removed job Id." + operationId: Jobs_SkipRemainingSubtasks parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -197725,13 +195039,10 @@ paths: schema: type: string style: simple - - description: |- - Name or ID of the machine catalog. If the catalog is present in a catalog folder, - specify the name in this format: {catalog folder path plus catalog name}. - For example, FolderName1|FolderName2|CatalogName. + - description: ID of the job. explode: false in: path - name: nameOrId + name: id required: true schema: nullable: true @@ -197739,26 +195050,13 @@ paths: type: string style: simple x-position: 1 - - description: "Optional parameters, removing unspecified properties that otherwise\ - \ would have been sent by the server." - example: "Name,Id,Description" - explode: true - in: query - name: fields - required: false - schema: - nullable: true - title: String - type: string - style: form - x-position: 2 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/TagResponseModelCollection' - description: List of tags. + $ref: '#/components/schemas/JobResponseModel' + description: Details of the job. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -198145,6 +195443,70 @@ paths: schema: type: string style: simple + "409": + content: + application/json: + example: + https://errors-api.cloud.com/common/optimisticConcurrency: + value: + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller requested an invalid relation to be created or deleted. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple "429": content: application/json: @@ -198346,11 +195708,33 @@ paths: schema: type: string style: simple - summary: Get tags associated with a machine catalog. + summary: Skips any remaining / unstarted subtasks of the job. tags: - - MachineCatalogs APIs - put: - operationId: MachineCatalogs_SetMachineCatalogTags + - Jobs APIs + /Jobs/{id}/Results: + get: + description: |- + For security reasons, jobs are only visible to the caller who + initiated them. + + Most jobs do not store results, but rather, redirect the caller + to the object(s) upon which the job was executing once complete. + However, some jobs (such as long-running GET operations) have + results which are stored independently and are retrievable from + this API. Consult the documentation of the API which initiated + the job to determine if the results are obtained from this API + or elsewhere. + + + If the job has completed but its results are not retrievable + here, the call will return a `303 See Other` response, with a + response header Location directing the caller to an API where + the job results are obtained. + + Note: completed jobs will be automatically removed by the system + 48 hours after completion. After this happens, this call will + return `404 Not Found` when given the removed job Id. + operationId: Jobs_GetJobResults parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -198413,13 +195797,10 @@ paths: schema: type: string style: simple - - description: |- - Name or ID of the machine catalog. If the catalog is present in a catalog folder, - specify the name in this format: {catalog folder path plus catalog name}. - For example, FolderName1|FolderName2|CatalogName. + - description: ID of the job. explode: false in: path - name: nameOrId + name: id required: true schema: nullable: true @@ -198427,29 +195808,14 @@ paths: type: string style: simple x-position: 1 - - description: "If `true`, the tags will be modified as a background task." - explode: true - in: query - name: async - required: false - schema: - default: false - title: Boolean - type: boolean - style: form - x-position: 3 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TagsRequestModel' - description: Details of the tags to set on the machine catalog. - required: true - x-name: request - x-position: 2 responses: - "204": - description: Operation is successful with no response content. + "200": + content: + application/octet-stream: + schema: + format: binary + type: string + description: Job results. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -198502,16 +195868,21 @@ paths: schema: type: string style: simple - "202": - description: Async request was accepted and is being processed. - headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime schema: - type: string - style: simple + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -198563,20 +195934,20 @@ paths: schema: type: string style: simple - "400": + "401": content: application/json: example: - https://errors-api.cloud.com/common/outOfRange: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: property - value: startTime + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -198629,88 +196000,22 @@ paths: schema: type: string style: simple - "401": + "403": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - - name: reason - value: missing + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "403": - content: - application/json: - example: - https://errors-api.cloud.com/common/authorization: - value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied - parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -198897,73 +196202,6 @@ paths: schema: type: string style: simple - "415": - content: - application/json: - example: - https://errors-api.cloud.com/common/unsupportedMediaType: - value: - type: https://errors-api.cloud.com/common/unsupportedMediaType - detail: Must use application/json;charset=utf-8 media type - parameters: - - name: mediaType - value: application/xml - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller must send request body in utf-8 and specify request - Content-Type as utf-8. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple "429": content: application/json: @@ -199165,15 +196403,12 @@ paths: schema: type: string style: simple - summary: Set tags associated with a machine catalog. + summary: Get the results of a job which has completed execution. tags: - - MachineCatalogs APIs - /MachineCatalogs/{nameOrId}/Tags/{tagNameOrId}: + - Jobs APIs + /machineCatalogActions: delete: - description: |- - Remove a tag from a machine catalog. Does not delete the tag, - only its association to the machine catalog. - operationId: MachineCatalogs_RemoveMachineCatalogTags + operationId: Actions_DeleteActions parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -199236,32 +196471,7 @@ paths: schema: type: string style: simple - - description: |- - Name or ID of the machine catalog. If the catalog is present in a catalog folder, - specify the name in this format: {catalog folder path plus catalog name}. - For example, FolderName1|FolderName2|CatalogName. - explode: false - in: path - name: nameOrId - required: true - schema: - nullable: true - title: String - type: string - style: simple - x-position: 1 - - description: Name or ID of the tag. - explode: false - in: path - name: tagNameOrId - required: true - schema: - nullable: true - title: String - type: string - style: simple - x-position: 2 - - description: "If `true`, the tags will be modified as a background task." + - description: 'If async to request actions. ' explode: true in: query name: async @@ -199271,7 +196481,7 @@ paths: title: Boolean type: boolean style: form - x-position: 3 + x-position: 1 responses: "204": description: Operation is successful with no response content. @@ -199588,8 +196798,20 @@ paths: schema: type: string style: simple - "404": - description: A referenced entity was not found. + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -199642,151 +196864,85 @@ paths: schema: type: string style: simple - "406": + "409": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/optimisticConcurrency: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller requested an invalid relation to be created or deleted. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "429": + content: + application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds parameters: - - name: contentType - value: application/json + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "409": - content: - application/json: - example: - https://errors-api.cloud.com/common/optimisticConcurrency: - value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "429": - content: - application/json: - example: - https://errors-api.cloud.com/common/rateLimitExceeded: - value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds - parameters: - - name: retryDelay - value: "4" - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. + description: Caller has made too many requests in a short period of time + and is being rate-limited. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -199973,11 +197129,11 @@ paths: schema: type: string style: simple - summary: Remove a tag from a machine catalog. + summary: Delete all completed machine catalog actions. tags: - - MachineCatalogs APIs - post: - operationId: MachineCatalogs_AddMachineCatalogTags + - Actions APIs + get: + operationId: Actions_GetActions parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -200040,40 +197196,47 @@ paths: schema: type: string style: simple - - description: |- - Name or ID of the machine catalog. If the catalog is present in a catalog folder, - specify the name in this format: {catalog folder path plus catalog name}. - For example, FolderName1|FolderName2|CatalogName. - explode: false - in: path - name: nameOrId - required: true + - description: 'If async to request actions. ' + explode: true + in: query + name: async + required: false schema: - nullable: true - title: String - type: string - style: simple + default: false + title: Boolean + type: boolean + style: form x-position: 1 - - description: Name or ID of the tag to add. - explode: false - in: path - name: tagNameOrId - required: true + - description: |- + The max number of actions returned by this query. + If not specified, the server might use a default limit of 250 items. + If the specified value is larger than 1000, the server might reject the call. + The default and maximum values depend on server settings. + explode: true + in: query + name: limit + required: false schema: + format: int32 nullable: true - title: String - type: string - style: simple + title: Int32 + type: integer + style: form x-position: 2 - - description: "If `true`, the tags will be modified as a background task." + - description: |- + If a query cannot be completed, the response will have a + ContinuationToken set. + To obtain more results from the query, pass the + continuation token back into the query to get the next + batch of results. explode: true in: query - name: async + name: continuationToken required: false schema: - default: false - title: Boolean - type: boolean + nullable: true + title: String + type: string style: form x-position: 3 responses: @@ -200081,8 +197244,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TagResponseModelCollection' - description: List of tags associated with the machine catalog. + $ref: '#/components/schemas/ActionResponseModelCollection' + description: ActionResponseModelCollection headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -200396,22 +197559,20 @@ paths: schema: type: string style: simple - "404": + "406": content: application/json: example: - https://errors-api.cloud.com/common/notFound: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -200464,20 +197625,21 @@ paths: schema: type: string style: simple - "406": + "429": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/rateLimitExceeded: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds parameters: - - name: contentType - value: application/json + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + description: Caller has made too many requests in a short period of time + and is being rate-limited. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -200530,18 +197692,21 @@ paths: schema: type: string style: simple - "409": + "503": content: application/json: example: - https://errors-api.cloud.com/common/optimisticConcurrency: + https://errors-api.cloud.com/common/serviceUnavailable: value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -200594,21 +197759,21 @@ paths: schema: type: string style: simple - "429": + "500": content: application/json: example: - https://errors-api.cloud.com/common/rateLimitExceeded: + https://errors-api.cloud.com/common/internalServerError: value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds parameters: - name: retryDelay value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. + description: An unexpected server error occurred. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -200661,149 +197826,13 @@ paths: schema: type: string style: simple - "503": - content: - application/json: - example: - https://errors-api.cloud.com/common/serviceUnavailable: - value: - type: https://errors-api.cloud.com/common/serviceUnavailable - detail: Service is unavailable; try again in 4 seconds - parameters: - - name: retryDelay - value: "4" - schema: - $ref: '#/components/schemas/ErrorResponse' - description: "Service is temporarily unable to process the request. Caller\ - \ may attempt the operation again, with exponential back-off." - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "500": - content: - application/json: - example: - https://errors-api.cloud.com/common/internalServerError: - value: - type: https://errors-api.cloud.com/common/internalServerError - detail: An internal server error has occurred; try again in 4 - seconds - parameters: - - name: retryDelay - value: "4" - schema: - $ref: '#/components/schemas/ErrorResponse' - description: An unexpected server error occurred. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - summary: Add a tag to a machine catalog. + summary: Get all machine catalog actions. tags: - - MachineCatalogs APIs - /MachineCatalogs/{nameOrId}/TestReport: + - Actions APIs + /MachineCatalogs: get: - description: |- - Get the test report from the last run of - TestMachineCatalog. - operationId: MachineCatalogs_GetMachineCatalogTestReport + description: Get all machine catalogs in the site. + operationId: MachineCatalogs_GetMachineCatalogs parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -200866,29 +197895,82 @@ paths: schema: type: string style: simple - - description: |- - Name or ID of the machine catalog. If the catalog is present in a catalog folder, - specify the name in this format: {catalog folder path plus catalog name}. - For example, FolderName1|FolderName2|CatalogName. - explode: false - in: path - name: nameOrId - required: true + - description: Admin folder path or Id. + explode: true + in: query + name: adminFolder + required: false schema: nullable: true title: String type: string - style: simple + style: form x-position: 1 + - description: "If `true`, it will be queried as a background task." + explode: true + in: query + name: async + required: false + schema: + default: false + nullable: true + title: Boolean + type: boolean + style: form + x-position: 2 + - description: |- + The max number of machine catalogs returned by this query. + If not specified, the server might use a default limit of 250 items. + If the specified value is larger than 1000, the server might reject the call. + The default and maximum values depend on server settings. + explode: true + in: query + name: limit + required: false + schema: + format: int32 + nullable: true + title: Int32 + type: integer + style: form + x-position: 3 + - description: |- + If a query cannot be completed, the response will have a + ContinuationToken set. + To obtain more results from the query, pass the + continuation token back into the query to get the next + batch of results. + explode: true + in: query + name: continuationToken + required: false + schema: + nullable: true + title: String + type: string + style: form + x-position: 4 + - description: "Optional. A filter string containing object fields requested\ + \ to be returned, the requested fields are separated by comma','.\n \ + \ " + example: "Name,FullName,Id" + explode: true + in: query + name: fields + required: false + schema: + nullable: true + title: String + type: string + style: form + x-position: 5 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/TestReportResponseModel' - description: |- - Last test report. If no tests have been run, - returns a 404 Not Found. + $ref: '#/components/schemas/MachineCatalogResponseModelCollection' + description: List of machine catalogs. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -200941,21 +198023,16 @@ paths: schema: type: string style: simple - "400": - content: - application/json: - example: - https://errors-api.cloud.com/common/outOfRange: - value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range - parameters: - - name: property - value: startTime - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + "202": + description: Async request was accepted and is being processed. headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -201007,20 +198084,20 @@ paths: schema: type: string style: simple - "401": + "400": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/outOfRange: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range parameters: - - name: reason - value: missing + - name: property + value: startTime schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: Caller passed an invalid input. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -201073,22 +198150,20 @@ paths: schema: type: string style: simple - "403": + "401": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -201141,14 +198216,14 @@ paths: schema: type: string style: simple - "404": + "403": content: application/json: example: - https://errors-api.cloud.com/common/notFound: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - name: entityType value: https://identifiers-api.cloud.com/example/widget @@ -201156,7 +198231,7 @@ paths: value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -201476,16 +198551,19 @@ paths: schema: type: string style: simple - summary: Get the most recent test report of a machine catalog. + summary: Get all machine catalogs. tags: - MachineCatalogs APIs - /MachineCatalogs/{nameOrId}/UpgradeSchedule: - delete: - description: |- - A VDA upgrade schedule can only be cancelled for a machine catalog - when the upgrade status is waiting to start. If the current upgrade is - in another status, the operation fails with HTTP response status 404. - operationId: MachineCatalogs_RemoveMachineCatalogUpgradeSchedule + post: + description: "Create a machine catalog.\n\nNote that if a machine catalog uses\ + \ \nof , the machine catalog creation will always invoke asynchronous\njob(s)\ + \ for the provisioning action. If this API is invoked asynchronously, the\ + \ asynchronous job\nwill include only the machine catalog creation, and the\ + \ provisioning task(s) will be associated\nwith the newly created catalog.\ + \ If this API is invoked synchronously, the machine catalog\ncreation will\ + \ complete synchronously but the provisioning task(s) may still be executing,\ + \ and\nwill be associated with the newly created catalog." + operationId: MachineCatalogs_CreateMachineCatalog parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -201530,6 +198608,30 @@ paths: schema: type: string style: simple + - description: "Admin credential to use when performing the operation. If not\ + \ specified, the operation will be performed using the account under which\ + \ the identity service is running If specified, must be in a format matching\ + \ that of the standard 'Authorization' request header; the username and\ + \ password separated by a colon, UTF8-encoded, then base64-encoded, then\ + \ the \"Basic \" scheme prepended.\r\nExample:Basic QWxhZGRpbjpPcGVuU2VzYW1l" + explode: false + in: header + name: X-AdminCredential + required: false + schema: + type: string + style: simple + - description: "Access token to use when performing the operation. If specified,\ + \ must be in a format matching that of the standard 'Authorization' request\ + \ header; UTF8-encoded, then base64-encoded, then the \"Bearer\" scheme\ + \ prepended.\r\nExample: Bearer bGljaGVuZy5saW5AY2l0cml4LmNvbQ==" + explode: false + in: header + name: X-AccessToken + required: false + schema: + type: string + style: simple - description: Must accept application/json. example: application/json explode: false @@ -201549,26 +198651,16 @@ paths: type: string style: simple - description: |- - Name or ID of the machine catalog. If the catalog is present in a catalog folder, - specify the name in this format: {catalog folder path plus catalog name}. - For example, FolderName1|FolderName2|CatalogName. - explode: false - in: path - name: nameOrId - required: true - schema: - nullable: true - title: String - type: string - style: simple - x-position: 1 - - description: |- - If `true`, VDA upgrade schedules existing with all machines within the - catalog will be removed except those upgrade status in progressing. - If `false`, only the perform removing when catalog level schedule not started. + If `true`, the machine catalog (and associated objects) will be + created as a background task. + The task will have JobType CreateMachineCatalog. + When the task is complete it will redirect to + GetMachineCatalog. + The job's Parameters will contain properties: + * _Name_ - Name of the machine catalog being created. explode: true in: query - name: force + name: async required: false schema: default: false @@ -201577,22 +198669,35 @@ paths: type: boolean style: form x-position: 2 - - description: "If `true`, the VDA upgrade schedule will be removed as a background\ - \ task." + - description: |- + The machine catalog name or Id to recreate from. It is only used for catalog recreation + scenario. Here specify name or Id of the failed catalog to recreate. explode: true in: query - name: async + name: sourceNameOrId required: false schema: - default: false nullable: true - title: Boolean - type: boolean + title: String + type: string style: form x-position: 3 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateMachineCatalogRequestModel' + description: Details about the machine catalog to create. + required: true + x-name: request + x-position: 1 responses: - "204": - description: Operation is successful with no response content. + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/MachineCatalogDetailResponseModel' + description: Details about the machine catalog that was just created. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -201645,19 +198750,16 @@ paths: schema: type: string style: simple - "409": - content: - application/json: - example: - https://errors-api.cloud.com/common/optimisticConcurrency: - value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. + "202": + description: Async request was accepted and is being processed. headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -201709,16 +198811,21 @@ paths: schema: type: string style: simple - "202": - description: Async request was accepted and is being processed. - headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime schema: - type: string - style: simple + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -201770,20 +198877,20 @@ paths: schema: type: string style: simple - "400": + "401": content: application/json: example: - https://errors-api.cloud.com/common/outOfRange: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: property - value: startTime + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -201836,20 +198943,22 @@ paths: schema: type: string style: simple - "401": + "403": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - - name: reason - value: missing + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -201902,22 +199011,20 @@ paths: schema: type: string style: simple - "403": + "406": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -201970,8 +199077,18 @@ paths: schema: type: string style: simple - "404": - description: A referenced entity was not found. + "409": + content: + application/json: + example: + https://errors-api.cloud.com/common/optimisticConcurrency: + value: + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller requested an invalid relation to be created or deleted. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -202024,20 +199141,21 @@ paths: schema: type: string style: simple - "406": + "415": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/unsupportedMediaType: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type parameters: - - name: contentType - value: application/json + - name: mediaType + value: application/xml schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -202291,11 +199409,13 @@ paths: schema: type: string style: simple - summary: Remove a pending VDA upgrade schedule for a machine catalog. + summary: Create a machine catalog. tags: - MachineCatalogs APIs - patch: - operationId: MachineCatalogs_UpdateMachineCatalogUpgradeSchedule + /MachineCatalogs/$checkCatalogName: + post: + description: Check for the existence of a machine catalog by name + operationId: MachineCatalogs_TestMachineCatalogExists parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -202358,43 +199478,15 @@ paths: schema: type: string style: simple - - description: |- - Name or ID of the machine catalog. - If the catalog is present in a catalog folder, - specify the name in this format: {catalog folder path plus catalog name}. - For example, FolderName1|FolderName2|CatalogName. - explode: false - in: path - name: nameOrId - required: true - schema: - nullable: true - title: String - type: string - style: simple - x-position: 1 - - description: "If `true`, the VDA upgrade schedule will be updated as a background\ - \ task." - explode: true - in: query - name: async - required: false - schema: - default: false - nullable: true - title: Boolean - type: boolean - style: form - x-position: 3 requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateUpgradeScheduleRequestModel' - description: Details about the updated VDA upgrade schedule. + $ref: '#/components/schemas/CatalogNameCheckRequestModel' + description: Name of the machine catalog. required: true x-name: request - x-position: 2 + x-position: 1 responses: "204": description: Operation is successful with no response content. @@ -202516,131 +199608,6 @@ paths: schema: type: string style: simple - "409": - content: - application/json: - example: - https://errors-api.cloud.com/common/optimisticConcurrency: - value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null - schema: - $ref: '#/components/schemas/ErrorResponse' - description: "" - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "202": - description: Async request was accepted and is being processed. - headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false - schema: - type: string - style: simple - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple "401": content: application/json: @@ -202775,22 +199742,20 @@ paths: schema: type: string style: simple - "404": + "406": content: application/json: example: - https://errors-api.cloud.com/common/notFound: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -202843,20 +199808,18 @@ paths: schema: type: string style: simple - "406": + "409": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/optimisticConcurrency: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type - parameters: - - name: contentType - value: application/json + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + description: Caller requested an invalid relation to be created or deleted. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -203177,15 +200140,15 @@ paths: schema: type: string style: simple - summary: Reschedule a pending VDA upgrade schedule for a machine catalog. + summary: Test the existence of a machine catalog by name. tags: - MachineCatalogs APIs + /Machinecatalogs/$search: post: description: |- - A new VDA upgrade schedule can only be created for a machine catalog - when the upgrade status for the catalog is UpgradeSuccessful, UpgradeFailed or UpgradeCancelled. - If the status is ongoing or waiting to start, the operation fails. - operationId: MachineCatalogs_CreateMachineCatalogUpgradeSchedule + Perform an advanced search for machinecatalogs. Note that some combinations + of search parameters may result in slow performance. + operationId: MachineCatalogs_DoMachineCatalogSearch parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -203249,21 +200212,9 @@ paths: type: string style: simple - description: |- - Name or ID of the machine catalog. If the catalog is present in a catalog folder, - specify the name in this format: {catalog folder path plus catalog name}. - For example, FolderName1|FolderName2|CatalogName. - explode: false - in: path - name: nameOrId - required: true - schema: - nullable: true - title: String - type: string - style: simple - x-position: 1 - - description: "If `true`, the VDA upgrade schedule will be created as a background\ - \ task." + If `true`, the catalogs (and associated objects) will be added as a + background task. + The task will have JobType SearchMachineCatalogs. explode: true in: query name: async @@ -203274,27 +200225,69 @@ paths: title: Boolean type: boolean style: form + x-position: 2 + - description: |- + The max number of machine catalogs returned by this query. + If not specified, the server might use a default limit of 250 items. + If the specified value is larger than 1000, the server might reject the call. + The default and maximum values depend on server settings. + explode: true + in: query + name: limit + required: false + schema: + format: int32 + nullable: true + title: Int32 + type: integer + style: form x-position: 3 + - description: |- + If a query cannot be completed, the response will have a + ContinuationToken set. + To obtain more results from the query, pass the + continuation token back into the query to get the next + batch of results. + explode: true + in: query + name: continuationToken + required: false + schema: + nullable: true + title: String + type: string + style: form + x-position: 4 + - description: |- + Optional filter, removing unspecified properties that otherwise would + have been sent by the server. + explode: true + in: query + name: fields + required: false + schema: + nullable: true + title: String + type: string + style: form + x-position: 5 requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateUpgradeScheduleRequestModel' - description: Details about the VDA upgrade schedule to create. + $ref: '#/components/schemas/CatalogSearchRequestModel' + description: Specifies the advanced search parameters. required: true - x-name: request - x-position: 2 + x-name: searchRequest + x-position: 1 responses: - "201": - description: Resource was created. - headers: - Location: - description: Location where the newly created resource resides. - example: /services/myservice/widgets/1 - explode: false + "200": + content: + application/json: schema: - type: string - style: simple + $ref: '#/components/schemas/CatalogSearchResponseModelCollection' + description: List of machine catalogs that match the search criteria. + headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -203346,134 +200339,16 @@ paths: schema: type: string style: simple - "409": - content: - application/json: - example: - https://errors-api.cloud.com/common/optimisticConcurrency: - value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "202": - description: Async request was accepted and is being processed. - headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false - schema: - type: string - style: simple - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "204": - description: Operation is successful with no response content. + "202": + description: Async request was accepted and is being processed. headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -203725,22 +200600,20 @@ paths: schema: type: string style: simple - "404": + "406": content: application/json: example: - https://errors-api.cloud.com/common/notFound: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -203793,20 +200666,18 @@ paths: schema: type: string style: simple - "406": + "409": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/optimisticConcurrency: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type - parameters: - - name: contentType - value: application/json + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + description: Caller requested an invalid relation to be created or deleted. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -204127,12 +200998,12 @@ paths: schema: type: string style: simple - summary: Setup a new VDA upgrade schedule for a machine catalog. + summary: Perform an advanced search for machinecatalogs. tags: - MachineCatalogs APIs - /MachineCatalogs/{nameOrId}/VDAComponentsAndFeatures: - get: - operationId: MachineCatalogs_GetMachineCatalogVDAComponentsAndFeatures + /machineCatalogs/{catalogNameOrId}/actions: + delete: + operationId: Actions_DeleteAction parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -204195,14 +201066,10 @@ paths: schema: type: string style: simple - - description: |- - Name or ID of the machine catalog. - If the catalog is present in a catalog folder, - specify the name in this format: {catalog folder path plus catalog name}. - For example, FolderName1|FolderName2|CatalogName. + - description: 'The machine catalog name or id. ' explode: false in: path - name: nameOrId + name: catalogNameOrId required: true schema: nullable: true @@ -204210,13 +201077,20 @@ paths: type: string style: simple x-position: 1 + - description: 'If async calling. ' + explode: true + in: query + name: async + required: false + schema: + default: false + title: Boolean + type: boolean + style: form + x-position: 2 responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MachineCatalogVusComponentResponseModel' - description: Components and features of VDAs associated with a machine catalog. + "204": + description: Operation is successful with no response content. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -204269,21 +201143,16 @@ paths: schema: type: string style: simple - "400": - content: - application/json: - example: - https://errors-api.cloud.com/common/outOfRange: - value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range - parameters: - - name: property - value: startTime - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + "202": + description: Async request was accepted and is being processed. headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -204335,20 +201204,20 @@ paths: schema: type: string style: simple - "401": + "400": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/outOfRange: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range parameters: - - name: reason - value: missing + - name: property + value: startTime schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: Caller passed an invalid input. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -204401,22 +201270,20 @@ paths: schema: type: string style: simple - "403": + "401": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -204469,14 +201336,14 @@ paths: schema: type: string style: simple - "404": + "403": content: application/json: example: - https://errors-api.cloud.com/common/notFound: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - name: entityType value: https://identifiers-api.cloud.com/example/widget @@ -204484,7 +201351,7 @@ paths: value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -204537,20 +201404,138 @@ paths: schema: type: string style: simple - "406": - content: - application/json: - example: - https://errors-api.cloud.com/common/notAcceptable: - value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type - parameters: - - name: contentType - value: application/json - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + "404": + description: A referenced entity was not found. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "409": + content: + application/json: + example: + https://errors-api.cloud.com/common/optimisticConcurrency: + value: + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller requested an invalid relation to be created or deleted. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -204804,12 +201789,11 @@ paths: schema: type: string style: simple - summary: Get the components and features of VDAs associated with a machine catalog. + summary: Delete specified catalog actions. tags: - - MachineCatalogs APIs - /MachineCatalogs/{nameOrId}/VDAComponentsAndFeatures/$validate: - post: - operationId: MachineCatalogs_ValidateMachineCatalogVDAComponentsAndFeaturesSelection + - Actions APIs + get: + operationId: Actions_GetAction parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -204872,13 +201856,10 @@ paths: schema: type: string style: simple - - description: |- - Name or ID of the machine catalog. If the catalog is present in a catalog folder, - specify the name in this format: {catalog folder path plus catalog name}. - For example, FolderName1|FolderName2|CatalogName. + - description: 'The machine catalog name or id. ' explode: false in: path - name: nameOrId + name: catalogNameOrId required: true schema: nullable: true @@ -204886,34 +201867,35 @@ paths: type: string style: simple x-position: 1 - - description: If async execute. + - description: "The action Id, the guid string value. " + explode: true + in: query + name: actionId + required: false + schema: + nullable: true + title: String + type: string + style: form + x-position: 2 + - description: 'If async calling. ' explode: true in: query name: async required: false schema: default: false - nullable: true title: Boolean type: boolean style: form x-position: 3 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/VDAComponentsSelectionValidationRequestModel' - description: More details attached to this validation. - required: true - x-name: request - x-position: 2 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/VDAComponentsSelectionValidationResponseModel' - description: The validation result. + $ref: '#/components/schemas/ActionResponseModelCollection' + description: ActionResponseModel headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -205361,85 +202343,21 @@ paths: schema: type: string style: simple - "409": - content: - application/json: - example: - https://errors-api.cloud.com/common/optimisticConcurrency: - value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "415": + "429": content: application/json: example: - https://errors-api.cloud.com/common/unsupportedMediaType: + https://errors-api.cloud.com/common/rateLimitExceeded: value: - type: https://errors-api.cloud.com/common/unsupportedMediaType - detail: Must use application/json;charset=utf-8 media type + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds parameters: - - name: mediaType - value: application/xml + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must send request body in utf-8 and specify request - Content-Type as utf-8. + description: Caller has made too many requests in a short period of time + and is being rate-limited. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -205492,88 +202410,21 @@ paths: schema: type: string style: simple - "429": + "503": content: application/json: example: - https://errors-api.cloud.com/common/rateLimitExceeded: + https://errors-api.cloud.com/common/serviceUnavailable: value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds parameters: - name: retryDelay value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "503": - content: - application/json: - example: - https://errors-api.cloud.com/common/serviceUnavailable: - value: - type: https://errors-api.cloud.com/common/serviceUnavailable - detail: Service is unavailable; try again in 4 seconds - parameters: - - name: retryDelay - value: "4" - schema: - $ref: '#/components/schemas/ErrorResponse' - description: "Service is temporarily unable to process the request. Caller\ - \ may attempt the operation again, with exponential back-off." + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -205693,20 +202544,13 @@ paths: schema: type: string style: simple - summary: |- - Validate the VDA component selection at catalog level that can be Included/Excluded and features that need enable - during an VDA upgrade using VDA Upgrade Service. + summary: Get machine catalog actions by specified catalog name or id and action + Id. tags: - - MachineCatalogs APIs - /Machines: + - Actions APIs + /machineCatalogs/{catalogNameOrId}/actions/{actionId}: get: - description: |- - Get all the machines in the site. Note that the response - may not contain the entire list of machines; if this happens the - response will have a ContinuationToken - which, if passed, will resume retrieving results from the original - query. - operationId: Machines_GetMachines + operationId: Actions_GetActionById parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -205769,101 +202613,75 @@ paths: schema: type: string style: simple - - description: |- - Optionally limit the results to machines that are either single or multi-session capable. - If not specified, all types of machines are returned. - explode: true - in: query - name: sessionSupport - required: false - schema: - allOf: - - $ref: '#/components/schemas/SessionSupport' - style: form - x-position: 1 - - description: |- - Optionally limit the results to machines that are either configured or not. - If not specified, only configured machines are returned. - explode: true - in: query - name: configured - required: false - schema: - default: true - nullable: true - title: Boolean - type: boolean - style: form - x-position: 2 - - description: |- - The max number of machines returned by this query. - If not specified, the server might use a default limit of 250 items. - If the specified value is larger than 1000, the server might reject the call. - The default and maximum values depend on server settings. - explode: true - in: query - name: limit - required: false + - description: 'The machine catalog name or id. ' + explode: false + in: path + name: catalogNameOrId + required: true schema: - format: int32 nullable: true - title: Int32 - type: integer - style: form - x-position: 3 - - description: |- - If a query cannot be completed, the response will have a - ContinuationToken set. - To obtain more results from the query, pass the - continuation token back into the query to get the next - batch of results. - explode: true - in: query - name: continuationToken - required: false + title: String + type: string + style: simple + x-position: 1 + - description: "The action Id, the guid string value. " + explode: false + in: path + name: actionId + required: true schema: nullable: true title: String type: string - style: form - x-position: 4 - - description: |- - If `true`, the get machines will be executed as a background task. - The task will have JobType GetMachines. - When the task is complete it will redirect to - GetJobResults. + style: simple + x-position: 2 + - description: 'If async calling. ' explode: true in: query name: async required: false schema: default: false - nullable: true title: Boolean type: boolean style: form - x-position: 5 - - description: "Optional. A filter string containing object fields requested\ - \ to be returned, the requested fields are separated by comma','.\n \ - \ " - example: "Uid,AgentVersion,AllocationType" - explode: true - in: query - name: fields - required: false - schema: - nullable: true - title: String - type: string - style: form - x-position: 6 + x-position: 3 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/MachineResponseModelCollection' - description: List of machines. + $ref: '#/components/schemas/ActionResponseModel' + description: |- + ActionResponseModel + ActionCatalogCreationResponseModel + ActionMachineCreationResponseModel + ActionMachineRemovalResponseModel + ActionUpdateImageResponseModel + or + ActionResponseModel + ActionCatalogCreationResponseModel + ActionMachineCreationResponseModel + ActionMachineRemovalResponseModel + ActionUpdateImageResponseModel + or + ActionResponseModel + ActionCatalogCreationResponseModel + ActionMachineCreationResponseModel + ActionMachineRemovalResponseModel + ActionUpdateImageResponseModel + or + ActionResponseModel + ActionCatalogCreationResponseModel + ActionMachineCreationResponseModel + ActionMachineRemovalResponseModel + ActionUpdateImageResponseModel + or + ActionResponseModel + ActionCatalogCreationResponseModel + ActionMachineCreationResponseModel + ActionMachineRemovalResponseModel + ActionUpdateImageResponseModel headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -205916,6 +202734,52 @@ paths: schema: type: string style: simple + x-expectedSchemas: + - description: |- + ActionResponseModel + ActionCatalogCreationResponseModel + ActionMachineCreationResponseModel + ActionMachineRemovalResponseModel + ActionUpdateImageResponseModel + schema: + nullable: true + $ref: '#/components/schemas/ActionCatalogCreationResponseModel' + - description: |- + ActionResponseModel + ActionCatalogCreationResponseModel + ActionMachineCreationResponseModel + ActionMachineRemovalResponseModel + ActionUpdateImageResponseModel + schema: + nullable: true + $ref: '#/components/schemas/ActionMachineCreationResponseModel' + - description: |- + ActionResponseModel + ActionCatalogCreationResponseModel + ActionMachineCreationResponseModel + ActionMachineRemovalResponseModel + ActionUpdateImageResponseModel + schema: + nullable: true + $ref: '#/components/schemas/ActionMachineRemovalResponseModel' + - description: |- + ActionResponseModel + ActionCatalogCreationResponseModel + ActionMachineCreationResponseModel + ActionMachineRemovalResponseModel + ActionUpdateImageResponseModel + schema: + nullable: true + $ref: '#/components/schemas/ActionUpdateImageResponseModel' + - description: |- + ActionResponseModel + ActionCatalogCreationResponseModel + ActionMachineCreationResponseModel + ActionMachineRemovalResponseModel + ActionUpdateImageResponseModel + schema: + nullable: true + $ref: '#/components/schemas/ActionResponseModel' "202": description: Async request was accepted and is being processed. headers: @@ -206177,20 +203041,88 @@ paths: schema: type: string style: simple - "406": + "404": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/notFound: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found parameters: - - name: contentType - value: application/json + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + description: A referenced entity was not found. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -206444,15 +203376,12 @@ paths: schema: type: string style: simple - summary: Get all machines in the site. + summary: Get specified machine catalog specified action. tags: - - Machines APIs - /Machines/$search: + - Actions APIs + /machineCatalogs/{catalogNameOrId}/actions/{actionId}/$Cancel: post: - description: "Perform an advanced search for machines. Note that some combinations\n\ - of search parameters may result in slow performance.\n\nThe 'SessionSupport'\ - \ \nmust be included in search filters." - operationId: Machines_DoMachineSearch + operationId: Actions_CancelAction parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -206515,95 +203444,42 @@ paths: schema: type: string style: simple - - description: |- - The max number of machines returned by this query. - If not specified, the server might use a default limit of 250 items. - If the specified value is larger than 1000, the server might reject the call. - The default and maximum values depend on server settings. - explode: true - in: query - name: limit - required: false - schema: - format: int32 - nullable: true - title: Int32 - type: integer - style: form - x-position: 2 - - description: |- - If a query cannot be completed, the response will have a - ContinuationToken set. - To obtain more results from the query, pass the - continuation token back into the query to get the next - batch of results. - explode: true - in: query - name: continuationToken - required: false + - description: 'The machine catalog name or id. ' + explode: false + in: path + name: catalogNameOrId + required: true schema: nullable: true title: String type: string - style: form - x-position: 3 - - description: |- - Optional filter, removing unspecified properties that otherwise would - have been sent by the server - explode: true - in: query - name: fields - required: false + style: simple + x-position: 1 + - description: "The action Id, the guid string value. " + explode: false + in: path + name: actionId + required: true schema: nullable: true title: String type: string - style: form - x-position: 4 - - description: |- - If `true`, the search machines will be executed as a background task. - The task will have JobType DoMachineSearch. - When the task is complete it will redirect to - GetJobResults. + style: simple + x-position: 2 + - description: 'If async calling. ' explode: true in: query name: async required: false schema: default: false - nullable: true title: Boolean type: boolean style: form - x-position: 5 - - description: The number of machines to skip. - explode: true - in: query - name: skip - required: false - schema: - format: int32 - nullable: true - title: Int32 - type: integer - style: form - x-position: 6 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MachineAndSessionSearchRequestModel' - description: Specifies the advanced search parameters. - required: true - x-name: searchRequest - x-position: 1 + x-position: 3 responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MachineResponseModelCollection' - description: List of machines that match the search criteria. + "204": + description: Operation is successful with no response content. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -206917,84 +203793,22 @@ paths: schema: type: string style: simple - "406": + "404": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/notFound: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found parameters: - - name: contentType - value: application/json - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "409": - content: - application/json: - example: - https://errors-api.cloud.com/common/optimisticConcurrency: - value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. + description: A referenced entity was not found. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -207047,21 +203861,84 @@ paths: schema: type: string style: simple - "415": + "406": content: application/json: example: - https://errors-api.cloud.com/common/unsupportedMediaType: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/unsupportedMediaType - detail: Must use application/json;charset=utf-8 media type + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type parameters: - - name: mediaType - value: application/xml + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must send request body in utf-8 and specify request - Content-Type as utf-8. + description: Caller must specify utf-8 charset with the Accept header. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "409": + content: + application/json: + example: + https://errors-api.cloud.com/common/optimisticConcurrency: + value: + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller requested an invalid relation to be created or deleted. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -207315,13 +204192,13 @@ paths: schema: type: string style: simple - summary: Perform an advanced search for machines. + summary: Cancel the specified machine catalog and specified action. tags: - - Machines APIs - /Machines/{name}: + - Actions APIs + /MachineCatalogs/{name}: head: - description: Check for the existence of a machine by name - operationId: Machines_CheckMachineExists + description: Check for the existence of a machine catalog by name + operationId: MachineCatalogs_CheckMachineCatalogExists parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -207384,7 +204261,10 @@ paths: schema: type: string style: simple - - description: Name of the machine. + - description: |- + Name of the machine catalog. If the catalog is present in a catalog folder, + specify the name in this format: {catalog folder path plus catalog name}. + For example, FolderName1|FolderName2|CatalogName. explode: false in: path name: name @@ -207985,12 +204865,13 @@ paths: schema: type: string style: simple - summary: Check for the existence of a machine by name. + summary: Check for the existence of a machine catalog by name. tags: - - Machines APIs - /Machines/{nameOrId}: + - MachineCatalogs APIs + /MachineCatalogs/{nameOrId}: delete: - operationId: Machines_RemoveMachine + description: Delete a machine catalog + operationId: MachineCatalogs_DeleteMachineCatalog parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -208048,6 +204929,17 @@ paths: schema: type: string style: simple + - description: "Access token to use when performing the operation. If specified,\ + \ must be in a format matching that of the standard 'Authorization' request\ + \ header; UTF8-encoded, then base64-encoded, then the \"Bearer\" scheme\ + \ prepended.\r\nExample: Bearer bGljaGVuZy5saW5AY2l0cml4LmNvbQ==" + explode: false + in: header + name: X-AccessToken + required: false + schema: + type: string + style: simple - description: Must accept application/json. example: application/json explode: false @@ -208066,7 +204958,11 @@ paths: schema: type: string style: simple - - description: "Machine to remove. May be specified by SamName, UPN, or SID." + - description: |- + Name or ID of the machine catalog to update. + If the catalog is present in a catalog folder, + specify the name in this format: {catalog folder path plus catalog name}. + For example, FolderName1|FolderName2|CatalogName. explode: false in: path name: nameOrId @@ -208078,9 +204974,10 @@ paths: style: simple x-position: 1 - description: |- - Specifies whether to delete the virtual machines, or just the machine record - in the site database. - Only relevant when ProvisioningType + Specifies whether to delete virtual machines that were provisioned in the machine catalog. + Only relevant when ProvisioningType is + MCS; otherwise, ignored. + Optional; default is `true`. explode: true in: query @@ -208088,52 +204985,59 @@ paths: required: false schema: default: true + nullable: true title: Boolean type: boolean style: form x-position: 2 - description: |- - Specifies whether to only delete virtual machines record that were provisioned in the machine catalog from database, - not access hypervisor to delete virtual machines, this is recommended only when hypervisor cannot be accessed. + Specifies what to do with AD machine accounts that are associated with the machine + catalog. - Optional; default is `false`. + Optional; default is . explode: true in: query - name: purgeDBOnly + name: deleteAccount required: false schema: - default: false - title: Boolean - type: boolean + allOf: + - $ref: '#/components/schemas/MachineAccountDeleteOption' + default: None style: form x-position: 3 - description: |- - Specifies what to do with the machine account in AD. Optional; default is - Leave. - Only relevant when `deleteVm` is `true`; otherwise, ignored. + Specifies whether to only delete virtual machines record that were provisioned in the machine catalog from database, + not access hypervisor to delete virtual machines, this is recommended only when hypervisor cannot be accessed. + + Optional; default is `false`. explode: true in: query - name: deleteAccount + name: purgeDBOnly required: false schema: - allOf: - - $ref: '#/components/schemas/MachineAccountDeleteOption' - default: Leave + default: false + nullable: true + title: Boolean + type: boolean style: form x-position: 4 - description: |- - If `true`, the machine will be deleted as a background task. - The task will have JobType DeleteMachine. + If `true`, the machine catalog (and associated objects) will be + deleted as a background task. + The task will have JobType DeleteMachineCatalog. When the task is complete it will redirect to + GetMachineCatalogs. The job's Parameters will contain properties: - * _Id_ - ID of the machine being deleted, - * _Name_ - Name of the machine being deleted. + + * _Id_ - ID of the machine catalog being deleted, + * _Name_ - Name of the machine catalog being deleted. explode: true in: query name: async required: false schema: default: false + nullable: true title: Boolean type: boolean style: form @@ -208839,12 +205743,13 @@ paths: schema: type: string style: simple - summary: Delete a machine from the site. + summary: Delete a machine catalog. tags: - - Machines APIs + - MachineCatalogs APIs get: - description: Get details of a single machine - operationId: Machines_GetMachine + description: Get details about a single machine catalog by name or ID of machine + catalog. + operationId: MachineCatalogs_GetMachineCatalog parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -208907,7 +205812,10 @@ paths: schema: type: string style: simple - - description: Name or ID of the machine. + - description: |- + Name or ID of the machine catalog. If the catalog is present in a catalog folder, + specify the name in this format: {catalog folder path plus catalog name}. + For example, FolderName1|FolderName2|CatalogName. explode: false in: path name: nameOrId @@ -208918,8 +205826,21 @@ paths: type: string style: simple x-position: 1 - - description: The requested fields. - example: "Uid,AgentVersion,AllocationType" + - description: "If `true`, it will be queried as a background task." + explode: true + in: query + name: async + required: false + schema: + default: false + nullable: true + title: Boolean + type: boolean + style: form + x-position: 2 + - description: "Optional parameters, removing unspecified properties that otherwise\ + \ would have been sent by the server." + example: "Name,FullName,Id" explode: true in: query name: fields @@ -208929,14 +205850,14 @@ paths: title: String type: string style: form - x-position: 2 + x-position: 3 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/MachineDetailResponseModel' - description: Details of the machine. + $ref: '#/components/schemas/MachineCatalogDetailResponseModel' + description: Details of machine catalog. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -208989,6 +205910,67 @@ paths: schema: type: string style: simple + "202": + description: Async request was accepted and is being processed. + headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple "400": content: application/json: @@ -209524,14 +206506,12 @@ paths: schema: type: string style: simple - summary: Get details of a single machine. + summary: Get details about a single machine catalog. tags: - - Machines APIs + - MachineCatalogs APIs patch: - description: |- - Update a machine. Typically used to change the assignment of a - statically-assigned machine. - operationId: Machines_UpdateMachineCatalogMachine + description: Update a machine catalog + operationId: MachineCatalogs_UpdateMachineCatalog parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -209576,6 +206556,17 @@ paths: schema: type: string style: simple + - description: "Access token to use when performing the operation. If specified,\ + \ must be in a format matching that of the standard 'Authorization' request\ + \ header; UTF8-encoded, then base64-encoded, then the \"Bearer\" scheme\ + \ prepended.\r\nExample: Bearer bGljaGVuZy5saW5AY2l0cml4LmNvbQ==" + explode: false + in: header + name: X-AccessToken + required: false + schema: + type: string + style: simple - description: Must accept application/json. example: application/json explode: false @@ -209594,7 +206585,11 @@ paths: schema: type: string style: simple - - description: "Machine to update. May be specified by name, ID, or SID." + - description: |- + Name or ID of the machine catalog to update. + If the catalog is present in a catalog folder, + specify the name in this format: {catalog folder path plus catalog name}. + For example, FolderName1|FolderName2|CatalogName. explode: false in: path name: nameOrId @@ -209606,14 +206601,15 @@ paths: style: simple x-position: 1 - description: |- - If `true`, the tag will be created as a background task. - The task will have JobType UpdateMachineCatalogMachine. + If `true`, the machine catalog (and associated objects) will be + updated as a background task. + The task will have JobType UpdateMachineCatalog. When the task is complete it will redirect to - "GetMachine(string)". + GetMachineCatalog. The job's Parameters will contain properties: - * _Id_ - ID of the machine being updated, - * _Name_ - Name of the machine being updated. + * _Id_ - ID of the machine catalog being updated, + * _Name_ - Name of the machine catalog being updated. explode: true in: query name: async @@ -209629,14 +206625,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UpdateMachineRequestModel' - description: Details of the machine to update. + $ref: '#/components/schemas/UpdateMachineCatalogRequestModel' + description: Properties of the machine catalog to update. required: true - x-name: update + x-name: request x-position: 2 responses: - "204": - description: Operation is successful with no response content. + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/MachineCatalogDetailResponseModel' + description: New machine catalog details. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -209750,6 +206750,60 @@ paths: schema: type: string style: simple + "204": + description: Operation is successful with no response content. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple "400": content: application/json: @@ -210352,13 +207406,12 @@ paths: schema: type: string style: simple - summary: Update a machine. + summary: Update a machine catalog. tags: - - Machines APIs - /Machines/{nameOrId}/$disconnect: + - MachineCatalogs APIs + /MachineCatalogs/{nameOrId}/$importProvisionedVirtualMachines: post: - description: Disconnect all sessions on a machine. - operationId: Machines_DisconnectSessions + operationId: MachineCatalogs_ImportProvisionedVirtualMachines parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -210421,7 +207474,7 @@ paths: schema: type: string style: simple - - description: Machine to disconnect sessions from. + - description: 'The machineCatalog name or Id. ' explode: false in: path name: nameOrId @@ -210431,28 +207484,9 @@ paths: title: String type: string style: simple - x-position: 1 - - description: |- - Identify if the API need to return detail info in response model. - Set to false will improve performance with return basic machine model. - explode: true - in: query - name: detailResponseRequired - required: false - schema: - default: true - title: Boolean - type: boolean - style: form x-position: 2 - - description: |- - If `true`, the session will be disconnected as a background task. - The task will have JobType DisconnectSessions. - When the task is complete it will redirect to - GetMachine. - The job's Parameters will contain properties: - * _Id_ - ID of the machine on which sessions are being disconnected. - * _Name_ - Name of the machine on which sessions are being disconnected. + - description: "If `true`, the machine accounts repair will be performed as\ + \ a background task. " explode: true in: query name: async @@ -210464,13 +207498,22 @@ paths: type: boolean style: form x-position: 3 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ImportProvisionedVirtualMachinesRequestModel' + description: 'The existing provisioned virtual machines data. ' + required: true + x-name: request + x-position: 1 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/MachineDetailResponseModel' - description: Detail of the machine. + $ref: '#/components/schemas/ImportProvisionedVirtualMachineResponseModelCollection' + description: ImportProvisionedVirtualMachineResponseModelCollection headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -210982,6 +208025,73 @@ paths: schema: type: string style: simple + "415": + content: + application/json: + example: + https://errors-api.cloud.com/common/unsupportedMediaType: + value: + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type + parameters: + - name: mediaType + value: application/xml + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple "429": content: application/json: @@ -211183,13 +208293,17 @@ paths: schema: type: string style: simple - summary: Disconnect all sessions on a machine. + summary: Import existing provisioned virtual machines. tags: - - Machines APIs - /Machines/{nameOrId}/$logoff: + - MachineCatalogs APIs + /MachineCatalogs/{nameOrId}/$RebootMachines: post: - description: Logoff all sessions on a machine - operationId: Machines_LogoffMachineSessions + description: "Reboot all machines in a machine catalog.\n\n\nNote that there\ + \ is no job representation for the reboot operation.\nThe call returns immediately\ + \ even though the machines reboot over time.\nIf you want to follow the progress\ + \ of the reboot operation, check\nthe \nproperty of the machines in the machine\ + \ catalog." + operationId: MachineCatalogs_RebootMachineCatalogMachines parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -211252,7 +208366,10 @@ paths: schema: type: string style: simple - - description: Machine to log sessions off from. + - description: |- + Name or ID of the machine catalog. If the catalog is present in a catalog folder, + specify the name in this format: {catalog folder path plus catalog name}. + For example, FolderName1|FolderName2|CatalogName. explode: false in: path name: nameOrId @@ -211263,47 +208380,18 @@ paths: type: string style: simple x-position: 1 - - description: |- - Identify if the API need to return detail info in response model. - Set to false will improve performance with return basic machine model. - explode: true - in: query - name: detailResponseRequired - required: false - schema: - default: true - title: Boolean - type: boolean - style: form + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RebootMachinesRequestModel' + description: Reboot options. + required: true + x-name: request x-position: 2 - - description: |- - If `true`, the sessions will be logged off as a background task. - The task will have JobType . - When the task is complete it will redirect to - . - The job's will contain properties: - - - * _Id_ - ID of the machine which sessions are being logged off from, - * _Name_ - Name of the machine which sessions are being logged off from. - explode: true - in: query - name: async - required: false - schema: - default: false - nullable: true - title: Boolean - type: boolean - style: form - x-position: 3 responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MachineDetailResponseModel' - description: Machine detail. + "204": + description: Operation is successful with no response content. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -211356,16 +208444,21 @@ paths: schema: type: string style: simple - "202": - description: Async request was accepted and is being processed. - headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime schema: - type: string - style: simple + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -211417,20 +208510,20 @@ paths: schema: type: string style: simple - "400": + "401": content: application/json: example: - https://errors-api.cloud.com/common/outOfRange: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: property - value: startTime + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -211483,20 +208576,22 @@ paths: schema: type: string style: simple - "401": + "403": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - - name: reason - value: missing + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -211549,14 +208644,14 @@ paths: schema: type: string style: simple - "403": + "404": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/notFound: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found parameters: - name: entityType value: https://identifiers-api.cloud.com/example/widget @@ -211564,7 +208659,7 @@ paths: value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: A referenced entity was not found. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -211617,22 +208712,20 @@ paths: schema: type: string style: simple - "404": + "406": content: application/json: example: - https://errors-api.cloud.com/common/notFound: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -211685,20 +208778,18 @@ paths: schema: type: string style: simple - "406": + "409": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/optimisticConcurrency: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type - parameters: - - name: contentType - value: application/json + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + description: Caller requested an invalid relation to be created or deleted. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -211751,18 +208842,21 @@ paths: schema: type: string style: simple - "409": + "415": content: application/json: example: - https://errors-api.cloud.com/common/optimisticConcurrency: + https://errors-api.cloud.com/common/unsupportedMediaType: value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type + parameters: + - name: mediaType + value: application/xml schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -212016,13 +209110,13 @@ paths: schema: type: string style: simple - summary: Logoff all sessions on a machine. + summary: Reboot all machines in a machine catalog. tags: - - Machines APIs - /Machines/{nameOrId}/$reboot: + - MachineCatalogs APIs + /MachineCatalogs/{nameOrId}/$repairMachineAccounts: post: - description: Reboot a machine. The machine must be capable of power management. - operationId: Machines_RebootMachine + description: Repair all machine accounts in a machine catalog. + operationId: MachineCatalogs_RepairMachineCatalogMachineAccounts parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -212067,6 +209161,19 @@ paths: schema: type: string style: simple + - description: "Admin credential to use when performing the operation. If not\ + \ specified, the operation will be performed using the account under which\ + \ the identity service is running If specified, must be in a format matching\ + \ that of the standard 'Authorization' request header; the username and\ + \ password separated by a colon, UTF8-encoded, then base64-encoded, then\ + \ the \"Basic \" scheme prepended.\r\nExample:Basic QWxhZGRpbjpPcGVuU2VzYW1l" + explode: false + in: header + name: X-AdminCredential + required: false + schema: + type: string + style: simple - description: Must accept application/json. example: application/json explode: false @@ -212085,7 +209192,7 @@ paths: schema: type: string style: simple - - description: Machine to reboot. + - description: Name or ID of the machine catalog. explode: false in: path name: nameOrId @@ -212096,43 +209203,17 @@ paths: type: string style: simple x-position: 1 - - description: |- - If `true`, the machine will be forced to reboot without waiting for user - activity to stop. This may cause loss of user data if work is not saved. + - description: The repair option of the machine accounts explode: true in: query - name: force - required: false + name: repairOption + required: true schema: - default: false - nullable: true - title: Boolean - type: boolean + $ref: '#/components/schemas/MachineAccountRepairOption' style: form x-position: 2 - - description: |- - Identify if the API need to return detail info in response model. - Set to false will improve performance with return basic machine model. - explode: true - in: query - name: detailResponseRequired - required: false - schema: - default: true - title: Boolean - type: boolean - style: form - x-position: 3 - - description: |- - If `true`, the machine will be rebooted as a background task. - This is recommended as this operation may take some time to run, and if it - exceeds 90 seconds the request may time out. - The task will have JobType RebootMachines. - When the task is complete it will redirect to - GetMachine. - The job's Parameters will contain properties: - * _Id_ - ID of the machine being rebooted, - * _Name_ - Name of the machine being rebooted. + - description: "If `true`, the machine accounts repair will be performed as\ + \ a background task." explode: true in: query name: async @@ -212143,14 +209224,10 @@ paths: title: Boolean type: boolean style: form - x-position: 4 + x-position: 3 responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MachineDetailResponseModel' - description: Machine detail. + "204": + description: Operation is successful with no response content. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -212863,12 +209940,31 @@ paths: schema: type: string style: simple - summary: Reboot a machine. + summary: Repair all machine accounts in a machine catalog. tags: - - Machines APIs - /Machines/{nameOrId}/$ResetProvVMDisk: + - MachineCatalogs APIs + /MachineCatalogs/{nameOrId}/$RollbackProvisioningScheme: post: - operationId: Machines_ResetProvVMDisk + description: |- + Rollback the machine catalog's provisioning scheme. + + + Only valid when the machine catalog's ProvisioningType is MCS. + + + Provides the ability to roll back the hard disk image used to provision + virtual machines. If the provisioning scheme has CleanOnBoot equal to + `true`, then the next time that virtual machines are started, their + hard disks are updated to this new image. Regardless of CleanOnBoot, + all new virtual machines created after this call succeeds will use this + new hard disk image. + + + *Note:* The provisioning scheme for a machine catalog cannot be + changed while any provisioning tasks are already executing for the + machine catalog. Cancel existing provisioning tasks or wait for + their completion before updating the provisioning scheme. + operationId: MachineCatalogs_RollbackMachineCatalogProvisioningScheme parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -212913,6 +210009,19 @@ paths: schema: type: string style: simple + - description: "Admin credential to use when performing the operation. If not\ + \ specified, the operation will be performed using the account under which\ + \ the identity service is running If specified, must be in a format matching\ + \ that of the standard 'Authorization' request header; the username and\ + \ password separated by a colon, UTF8-encoded, then base64-encoded, then\ + \ the \"Basic \" scheme prepended.\r\nExample:Basic QWxhZGRpbjpPcGVuU2VzYW1l" + explode: false + in: header + name: X-AdminCredential + required: false + schema: + type: string + style: simple - description: Must accept application/json. example: application/json explode: false @@ -212931,8 +210040,10 @@ paths: schema: type: string style: simple - - description: "Name or ID of the machine. May be specified by name, ID, or\ - \ SID." + - description: |- + Name or ID of the machine catalog. If the catalog is present in a catalog folder, + specify the name in this format: {catalog folder path plus catalog name}. + For example, FolderName1|FolderName2|CatalogName. explode: false in: path name: nameOrId @@ -212944,12 +210055,22 @@ paths: style: simple x-position: 1 - description: |- - If `true`, the machine will be deleted as a background task. - The task will have JobType ResetVMDisk. + Due to the long-running nature of the update operation, it cannot + complete synchronously, and always initiates an asynchronous job to + run to completion. If the `async` parameter is `true`, the only + difference is that instead of returning the initial job status in + the payload, the response is instead `202` with the `Location` + header pointing to the job status API. This may be desirable for + clients that wish to unify their logic for handling asynchronous + jobs. The task will have JobType + . When the task is complete it will redirect to - The job's Parameters will contain properties: - * _Id_ - ID of the machine being deleted, - * _Name_ - Name of the machine being deleted. + . + The job's will contain properties: + + + * _Id_ - ID of the machine catalog for which the provisioning scheme is being updated, + * _Name_ - Name of the machine catalog for which the provisioning scheme is being updated. explode: true in: query name: async @@ -212960,10 +210081,23 @@ paths: title: Boolean type: boolean style: form + x-position: 3 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RebootMachinesRequestModel' + description: Details about the image update to be performed. + required: true + x-name: request x-position: 2 responses: - "204": - description: Operation is successful with no response content. + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/JobResponseModel' + description: Asynchronous job status. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -213475,6 +210609,73 @@ paths: schema: type: string style: simple + "415": + content: + application/json: + example: + https://errors-api.cloud.com/common/unsupportedMediaType: + value: + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type + parameters: + - name: mediaType + value: application/xml + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple "429": content: application/json: @@ -213676,15 +210877,16 @@ paths: schema: type: string style: simple - summary: Resets the OS disk of persistent VMs to the current master image. + summary: Rollback the machine catalog's provisioning scheme. tags: - - Machines APIs - /Machines/{nameOrId}/$resume: + - MachineCatalogs APIs + /MachineCatalogs/{nameOrId}/$test: post: description: |- - Resume a machine after it has been suspended. The machine must be capable of - power management. - operationId: Machines_ResumeMachine + Run tests on a machine catalog and create a test report. Obtain the + most recent report from + GetMachineCatalogTestReport. + operationId: MachineCatalogs_TestMachineCatalog parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -213747,7 +210949,11 @@ paths: schema: type: string style: simple - - description: Machine to resume. + - description: |- + Name or ID of the machine catalog to test. + If the catalog is present in a catalog folder, + specify the name in this format: {catalog folder path plus catalog name}. + For example, FolderName1|FolderName2|CatalogName. explode: false in: path name: nameOrId @@ -213759,28 +210965,16 @@ paths: style: simple x-position: 1 - description: |- - Identify if the API need to return detail info in response model. - Set to false will improve performance with return basic machine model. - explode: true - in: query - name: detailResponseRequired - required: false - schema: - default: true - title: Boolean - type: boolean - style: form - x-position: 2 - - description: |- - If `true`, the machine will be resumed as a background task. - This is recommended as this operation may take some time to run, and if it - exceeds 90 seconds the request may time out. - The task will have JobType ResumeMachines. + If `true`, the tests will run as a background task. + This is recommended as the tests may take some time to run, + and if it exceeds 90 seconds the request may time out. + The task will have JobType TestMachineCatalog. When the task is complete it will redirect to - GetMachine. + GetJobResults. The job's Parameters will contain properties: - * _Id_ - ID of the machine being resumed, - * _Name_ - Name of the machine being resumed. + + * _Id_ - ID of the machine catalog being tested, + * _Name_ - Name of the machine catalog being tested. explode: true in: query name: async @@ -213791,14 +210985,14 @@ paths: title: Boolean type: boolean style: form - x-position: 3 + x-position: 2 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/MachineDetailResponseModel' - description: Machine detail. + $ref: '#/components/schemas/MachineCatalogTestResponseModel' + description: Machine catalog test report. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -214511,15 +211705,42 @@ paths: schema: type: string style: simple - summary: Resume a machine. + summary: Run tests on a machine catalog and create a test report. tags: - - Machines APIs - /Machines/{nameOrId}/$shutdown: + - MachineCatalogs APIs + /MachineCatalogs/{nameOrId}/$UpdateProvisioningScheme: post: description: |- - Shut down (power-off) a machine. The machine must be capable of power - management. - operationId: Machines_ShutdownMachine + Update the machine catalog's provisioning scheme. + + + Only valid when the machine catalog's ProvisioningType is MCS. + + + Provides the ability to update the hard disk image used to provision + virtual machines. If the provisioning scheme has CleanOnBoot equal to + `true`, then the next time that virtual machines are started, their + hard disks are updated to this new image. Regardless of CleanOnBoot, + all new virtual machines created after this call succeeds will use this + new hard disk image. + + + A snapshot or VM template is used rather than a VM, so that the + content of the hard disk for the provisioning scheme can be easily + determined. + + + The previous hard disk image path is stored into the history (see + ). The + data stored in the history allows for a rollback to be undertaken, + to revert to the previous hard disk image if required. + + + *Note:* The provisioning scheme for a machine catalog cannot be + changed while any provisioning tasks are already executing for the + machine catalog. Cancel existing provisioning tasks or wait for + their completion before updating the provisioning scheme. + operationId: MachineCatalogs_UpdateMachineCatalogProvisioningScheme parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -214582,7 +211803,10 @@ paths: schema: type: string style: simple - - description: Machine to shut down. + - description: |- + Name or ID of the machine catalog. If the catalog is present in a catalog folder, + specify the name in this format: {catalog folder path plus catalog name}. + For example, FolderName1|FolderName2|CatalogName. explode: false in: path name: nameOrId @@ -214594,42 +211818,25 @@ paths: style: simple x-position: 1 - description: |- - If `true`, the machine will be forced to shut down without waiting for user - activity to stop. This may cause loss of user data if work is not saved. - explode: true - in: query - name: force - required: false - schema: - default: false - nullable: true - title: Boolean - type: boolean - style: form - x-position: 2 - - description: |- - Identify if the API need to return detail info in response model. - Set to false will improve performance with return basic machine model. - explode: true - in: query - name: detailResponseRequired - required: false - schema: - default: true - title: Boolean - type: boolean - style: form - x-position: 3 - - description: |- - If `true`, the machine will be shut down as a background task. - This is recommended as this operation may take some time to run, and if it - exceeds 90 seconds the request may time out. - The task will have JobType ShutDownMachines. + Due to the long-running nature of the update operation, it cannot + complete synchronously, and always initiates an asynchronous job to + run to completion. If the `async` parameter is `true`, the only + difference is that instead of returning the initial job status in + the payload, the response is instead `202` with the `Location` + header pointing to the job status API. This may be desirable for + clients that wish to unify their logic for handling asynchronous + jobs. The task will have JobType + . When the task is complete it will redirect to - GetMachine. - The job's Parameters will contain properties: - * _Id_ - ID of the machine being shut down, - * _Name_ - Name of the machine being shut down. + . + The job's will contain properties: + + + * _Id_ - ID of the machine catalog for which the provisioning scheme is being updated, + * _Name_ - Name of the machine catalog for which the provisioning scheme is being updated, + * _MasterImageXDPath_ - Path to the new image specified for the provisioning scheme, in XenApp & XenDesktop path format. + * _MasterImageFullPath_ - Path to the new image specified for the provisioning scheme, relative to the root of the API. + * _MasterImageRelativePath_ - Path to the new image specified for the provisioning scheme, relative to the resource pool. explode: true in: query name: async @@ -214640,28 +211847,23 @@ paths: title: Boolean type: boolean style: form - x-position: 4 - - description: |- - Shutdown a machine after the specified number of seconds delay, - If `null`, the machine will be shut down without delay. - explode: true - in: query - name: delay - required: false - schema: - format: int32 - nullable: true - title: Int32 - type: integer - style: form - x-position: 5 + x-position: 3 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateMachineCatalogProvisioningSchemeRequestModel' + description: Details about the image update to be performed. + required: true + x-name: request + x-position: 2 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/MachineDetailResponseModel' - description: Machine detail. + $ref: '#/components/schemas/JobResponseModel' + description: Asynchronous job status. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -215173,21 +212375,88 @@ paths: schema: type: string style: simple - "429": + "415": content: application/json: example: - https://errors-api.cloud.com/common/rateLimitExceeded: + https://errors-api.cloud.com/common/unsupportedMediaType: value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type parameters: - - name: retryDelay - value: "4" + - name: mediaType + value: application/xml schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "429": + content: + application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller has made too many requests in a short period of time + and is being rate-limited. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -215374,14 +212643,13 @@ paths: schema: type: string style: simple - summary: Shut down a machine. + summary: Update the machine catalog's provisioning scheme. tags: - - Machines APIs - /Machines/{nameOrId}/$start: - post: - description: Start (power-on) a machine. The machine must be capable of power - management. - operationId: Machines_StartMachine + - MachineCatalogs APIs + /MachineCatalogs/{nameOrId}/Administrators: + get: + description: Get administrators who can administer a machine catalog + operationId: MachineCatalogs_GetMachineCatalogsAdministrators parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -215444,7 +212712,10 @@ paths: schema: type: string style: simple - - description: Machine to start. + - description: |- + Name or ID of the machine catalog. If the catalog is present in a catalog folder, + specify the name in this format: {catalog folder path plus catalog name}. + For example, FolderName1|FolderName2|CatalogName. explode: false in: path name: nameOrId @@ -215455,109 +212726,14 @@ paths: type: string style: simple x-position: 1 - - description: |- - Identify if the API need to return detail info in response model. - Set to false will improve performance with return basic machine model. - explode: true - in: query - name: detailResponseRequired - required: false - schema: - default: true - title: Boolean - type: boolean - style: form - x-position: 2 - - description: |- - If `true`, the machine will be started as a background task. - This is recommended as this operation may take some time to run, and if it - exceeds 90 seconds the request may time out. - The task will have JobType StartMachines. - When the task is complete it will redirect to - GetMachine. - The job's Parameters will contain properties: - * _Id_ - ID of the machine being started, - * _Name_ - Name of the machine being started. - explode: true - in: query - name: async - required: false - schema: - default: false - nullable: true - title: Boolean - type: boolean - style: form - x-position: 3 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/MachineDetailResponseModel' - description: Machine detail. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "202": - description: Async request was accepted and is being processed. + $ref: '#/components/schemas/AdministratorResponseModelCollection' + description: List of administrators. headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false - schema: - type: string - style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -215943,70 +213119,6 @@ paths: schema: type: string style: simple - "409": - content: - application/json: - example: - https://errors-api.cloud.com/common/optimisticConcurrency: - value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple "429": content: application/json: @@ -216208,13 +213320,14 @@ paths: schema: type: string style: simple - summary: Start a machine. + summary: Get administrators who can administer a machine catalog. tags: - - Machines APIs - /Machines/{nameOrId}/$suspend: - post: - description: Suspend a machine. The machine must be capable of power management. - operationId: Machines_SuspendMachine + - MachineCatalogs APIs + /MachineCatalogs/{nameOrId}/DeliveryGroupAssociations: + get: + description: Get delivery group associations by name or Id of a remote pc machine + catalog. + operationId: MachineCatalogs_GetMachineCatalogDeliveryGroupAssociations parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -216277,7 +213390,10 @@ paths: schema: type: string style: simple - - description: Machine to suspend. + - description: |- + Name or ID of the machine catalog. If the catalog is present in a catalog folder, + specify the name in this format: {catalog folder path plus catalog name}. + For example, FolderName1|FolderName2|CatalogName. explode: false in: path name: nameOrId @@ -216289,51 +213405,47 @@ paths: style: simple x-position: 1 - description: |- - Identify if the API need to return detail info in response model. - Set to false will improve performance with return basic machine model. + The max number of delivery group associations returned by this query. + If not specified, the server might use a default limit of 250 items. + If the specified value is larger than 1000, the server might reject the call. + The default and maximum values depend on server settings. explode: true in: query - name: detailResponseRequired + name: limit required: false schema: - default: true - title: Boolean - type: boolean + format: int32 + nullable: true + title: Int32 + type: integer style: form x-position: 2 - description: |- - If `true`, the machine will be suspended as a background task. - This is recommended as this operation may take some time to run, and if it - exceeds 90 seconds the request may time out. - The task will have JobType SuspendMachines. - When the task is complete it will redirect to - GetMachine. - The job's Parameters will contain properties: - * _Id_ - ID of the machine being suspended, - * _Name_ - Name of the machine being suspended. + If a query cannot be completed, the response will have a + ContinuationToken set. + To obtain more results from the query, pass the + continuation token back into the query to get the next + batch of results. explode: true in: query - name: async + name: continuationToken required: false schema: - default: false nullable: true - title: Boolean - type: boolean + title: String + type: string style: form x-position: 3 - - description: |- - Suspend a machine after the specified number of seconds delay, - If `null`, the machine will be suspended without delay. + - description: "If `true`, it will be queried as a background task." explode: true in: query - name: delay + name: async required: false schema: - format: int32 + default: false nullable: true - title: Int32 - type: integer + title: Boolean + type: boolean style: form x-position: 4 responses: @@ -216341,8 +213453,9 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MachineDetailResponseModel' - description: Machine detail. + $ref: '#/components/schemas/DeliveryGroupAssociationResponseModelCollection' + description: The delivery group associations of the given machine catalog + identifier headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -216790,70 +213903,6 @@ paths: schema: type: string style: simple - "409": - content: - application/json: - example: - https://errors-api.cloud.com/common/optimisticConcurrency: - value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple "429": content: application/json: @@ -217055,12 +214104,12 @@ paths: schema: type: string style: simple - summary: Suspend a machine. + summary: Get delivery group associations of a machine catalog. tags: - - Machines APIs - /Machines/{nameOrId}/$test: - post: - operationId: Machines_TestMachine + - MachineCatalogs APIs + /MachineCatalogs/{nameOrId}/Enrollments: + get: + operationId: MachineCatalogs_GetMachineCatalogEnrollments parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -217123,7 +214172,7 @@ paths: schema: type: string style: simple - - description: Name or ID of the machine to test. + - description: Name or ID of the machine catalog. explode: false in: path name: nameOrId @@ -217139,8 +214188,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MachineTestResponseModel' - description: Machine test report. + $ref: '#/components/schemas/EnrollmentResponseModelCollection' + description: List of enrollments. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -217527,70 +214576,6 @@ paths: schema: type: string style: simple - "409": - content: - application/json: - example: - https://errors-api.cloud.com/common/optimisticConcurrency: - value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple "429": content: application/json: @@ -217792,13 +214777,13 @@ paths: schema: type: string style: simple - summary: Run Cloud Health Check on a VDA machine. + summary: Get the list of enrollments in the machine catalog. tags: - - Machines APIs - /Machines/{nameOrId}/Administrators: + - MachineCatalogs APIs + /MachineCatalogs/{nameOrId}/LastMasterImage: get: - description: Get administrators who can administer a machine. - operationId: Machines_GetMachinesAdministrators + description: Get the last master VM images used by the machine catalog + operationId: MachineCatalogs_GetMachineCatalogLastMasterImage parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -217861,7 +214846,10 @@ paths: schema: type: string style: simple - - description: "SamName, UPN, or SID of the machine." + - description: |- + Name or ID of the machine catalog. If the catalog is present in a catalog folder, + specify the name in this format: {catalog folder path plus catalog name}. + For example, FolderName1|FolderName2|CatalogName. explode: false in: path name: nameOrId @@ -217872,13 +214860,25 @@ paths: type: string style: simple x-position: 1 + - description: "If `true`, it will be queried as a background task." + explode: true + in: query + name: async + required: false + schema: + default: false + nullable: true + title: Boolean + type: boolean + style: form + x-position: 2 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/AdministratorResponseModelCollection' - description: List of administrators. + $ref: '#/components/schemas/VMImageResponseModel' + description: Last image used by the machine catalog to provision VMs. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -217931,21 +214931,16 @@ paths: schema: type: string style: simple - "400": - content: - application/json: - example: - https://errors-api.cloud.com/common/outOfRange: - value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range - parameters: - - name: property - value: startTime - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + "202": + description: Async request was accepted and is being processed. headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -217997,20 +214992,86 @@ paths: schema: type: string style: simple - "401": + "400": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/outOfRange: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range parameters: - - name: reason - value: missing + - name: property + value: startTime schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: Caller passed an invalid input. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "401": + content: + application/json: + example: + https://errors-api.cloud.com/common/authentication: + value: + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -218466,17 +215527,19 @@ paths: schema: type: string style: simple - summary: Get administrators who can administer a machine + summary: Get the last master VM images used by the machine catalog. tags: - - Machines APIs - /Machines/{nameOrId}/Applications: + - MachineCatalogs APIs + /MachineCatalogs/{nameOrId}/MachineAccounts: get: description: |- - Get the list of applications published or in use on a machine. - At least one of Published - or InUse - will be `true` for each application returned. - operationId: Machines_GetMachineApplications + Get all machine accounts associated with a machine catalog. This returns + all machine accounts for the machine catalog regardless of whether they are + in-use, available, locked, etc. + + + This is only relevant for machine catalogs where ProvisioningType is MCS. + operationId: MachineCatalogs_GetMachineCatalogMachineAccounts parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -218539,7 +215602,11 @@ paths: schema: type: string style: simple - - description: Name or ID of the machine. + - description: |- + Name or ID of the machine catalog to get machine accounts for. + If the catalog is present in a catalog folder, + specify the name in this format: {catalog folder path plus catalog name}. + For example, FolderName1|FolderName2|CatalogName. explode: false in: path name: nameOrId @@ -218550,13 +215617,70 @@ paths: type: string style: simple x-position: 1 + - description: |- + The max number of machine accounts returned by this query. + If not specified, the server might use a default limit of 250 items. + If the specified value is larger than 1000, the server might reject the call. + The default and maximum values depend on server settings. + explode: true + in: query + name: limit + required: false + schema: + format: int32 + nullable: true + title: Int32 + type: integer + style: form + x-position: 2 + - description: |- + If a query cannot be completed, the response will have a + ContinuationToken set. + To obtain more results from the query, pass the + continuation token back into the query to get the next + batch of results. + explode: true + in: query + name: continuationToken + required: false + schema: + nullable: true + title: String + type: string + style: form + x-position: 3 + - description: |- + If `true`, the machine accounts will be queried as a background task. + The task will have JobType GetMachineCatalogMachineAccounts. + When the task is complete it will redirect to GetJobResults. + explode: true + in: query + name: async + required: false + schema: + default: false + nullable: true + title: Boolean + type: boolean + style: form + x-position: 4 + - description: The state of accounts for query. + explode: true + in: query + name: accountState + required: false + schema: + allOf: + - $ref: '#/components/schemas/ProvisioningSchemeMachineAccountState' + style: form + x-position: 5 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/MachineApplicationResponseModelCollection' - description: List of applications. + $ref: '#/components/schemas/ProvisioningSchemeMachineAccountResponseModelCollection' + description: List of machine accounts. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -218609,21 +215733,16 @@ paths: schema: type: string style: simple - "400": - content: - application/json: - example: - https://errors-api.cloud.com/common/outOfRange: - value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range - parameters: - - name: property - value: startTime - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + "202": + description: Async request was accepted and is being processed. headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -218675,20 +215794,20 @@ paths: schema: type: string style: simple - "401": + "400": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/outOfRange: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range parameters: - - name: reason - value: missing + - name: property + value: startTime schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: Caller passed an invalid input. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -218741,22 +215860,20 @@ paths: schema: type: string style: simple - "403": + "401": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -218809,14 +215926,14 @@ paths: schema: type: string style: simple - "404": + "403": content: application/json: example: - https://errors-api.cloud.com/common/notFound: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - name: entityType value: https://identifiers-api.cloud.com/example/widget @@ -218824,7 +215941,7 @@ paths: value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -218877,20 +215994,22 @@ paths: schema: type: string style: simple - "406": + "404": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/notFound: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found parameters: - - name: contentType - value: application/json + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + description: A referenced entity was not found. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -218943,21 +216062,20 @@ paths: schema: type: string style: simple - "429": + "406": content: application/json: example: - https://errors-api.cloud.com/common/rateLimitExceeded: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type parameters: - - name: retryDelay - value: "4" + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -219010,21 +216128,88 @@ paths: schema: type: string style: simple - "503": + "429": content: application/json: example: - https://errors-api.cloud.com/common/serviceUnavailable: + https://errors-api.cloud.com/common/rateLimitExceeded: value: - type: https://errors-api.cloud.com/common/serviceUnavailable - detail: Service is unavailable; try again in 4 seconds + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds parameters: - name: retryDelay value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: "Service is temporarily unable to process the request. Caller\ - \ may attempt the operation again, with exponential back-off." + description: Caller has made too many requests in a short period of time + and is being rate-limited. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "503": + content: + application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -219144,13 +216329,13 @@ paths: schema: type: string style: simple - summary: Get the list of applications on a machine. + summary: Get all machine accounts associated with a machine catalog. tags: - - Machines APIs - /Machines/{nameOrId}/DeliveryGroup: - get: - description: Get the details of the delivery group in which a machine resides. - operationId: Machines_GetMachineDeliveryGroup + - MachineCatalogs APIs + post: + description: Add a machine account to the machine catalog. This is only relevant + for machine catalogs where ProvisioningType is MCS. + operationId: MachineCatalogs_AddMachineCatalogMachineAccount parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -219195,6 +216380,19 @@ paths: schema: type: string style: simple + - description: "Admin credential to use when performing the operation. If not\ + \ specified, the operation will be performed using the account under which\ + \ the identity service is running If specified, must be in a format matching\ + \ that of the standard 'Authorization' request header; the username and\ + \ password separated by a colon, UTF8-encoded, then base64-encoded, then\ + \ the \"Basic \" scheme prepended.\r\nExample:Basic QWxhZGRpbjpPcGVuU2VzYW1l" + explode: false + in: header + name: X-AdminCredential + required: false + schema: + type: string + style: simple - description: Must accept application/json. example: application/json explode: false @@ -219213,7 +216411,11 @@ paths: schema: type: string style: simple - - description: Name or ID of the machine. + - description: |- + Name or ID of the machine catalog to add the machine account to. + If the catalog is present in a catalog folder, + specify the name in this format: {catalog folder path plus catalog name}. + For example, FolderName1|FolderName2|CatalogName. explode: false in: path name: nameOrId @@ -219224,15 +216426,23 @@ paths: type: string style: simple x-position: 1 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MachineAccountRequestModel' + description: Machine account to add to the machine catalog. The machine must + not be a member of any other machine catalog. + required: true + x-name: machine + x-position: 2 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/DeliveryGroupDetailResponseModel' - description: |- - Details of the delivery group. If the machine is not a member of - a delivery group, the response will be `204 No Content`. + $ref: '#/components/schemas/ProvisioningSchemeMachineAccountResponseModel' + description: Machine account that was added. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -219619,6 +216829,137 @@ paths: schema: type: string style: simple + "409": + content: + application/json: + example: + https://errors-api.cloud.com/common/optimisticConcurrency: + value: + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller requested an invalid relation to be created or deleted. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "415": + content: + application/json: + example: + https://errors-api.cloud.com/common/unsupportedMediaType: + value: + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type + parameters: + - name: mediaType + value: application/xml + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple "429": content: application/json: @@ -219820,14 +217161,14 @@ paths: schema: type: string style: simple - summary: Get the delivery group for a machine. + summary: Add a machine account to the machine catalog. tags: - - Machines APIs - /Machines/{nameOrId}/Desktop: - get: - description: "Get the details of the desktop associated with the machine, if\ - \ any." - operationId: Machines_GetMachineDesktop + - MachineCatalogs APIs + /MachineCatalogs/{nameOrId}/MachineAccounts/{machine}: + delete: + description: Remove a machine account from the machine catalog. This is only + relevant for machine catalogs where ProvisioningType is MCS. + operationId: MachineCatalogs_RemoveMachineCatalogMachineAccount parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -219872,6 +217213,19 @@ paths: schema: type: string style: simple + - description: "Admin credential to use when performing the operation. If not\ + \ specified, the operation will be performed using the account under which\ + \ the identity service is running If specified, must be in a format matching\ + \ that of the standard 'Authorization' request header; the username and\ + \ password separated by a colon, UTF8-encoded, then base64-encoded, then\ + \ the \"Basic \" scheme prepended.\r\nExample:Basic QWxhZGRpbjpPcGVuU2VzYW1l" + explode: false + in: header + name: X-AdminCredential + required: false + schema: + type: string + style: simple - description: Must accept application/json. example: application/json explode: false @@ -219890,7 +217244,11 @@ paths: schema: type: string style: simple - - description: Name or ID of the machine. + - description: |- + Name or ID of the machine catalog to remove the machine account from. + If the catalog is present in a catalog folder, + specify the name in this format: {catalog folder path plus catalog name}. + For example, FolderName1|FolderName2|CatalogName. explode: false in: path name: nameOrId @@ -219901,15 +217259,33 @@ paths: type: string style: simple x-position: 1 + - description: "Machine account to remove. May be specified by SamName, UPN,\ + \ or SID." + explode: false + in: path + name: machine + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 2 + - description: Specifies what to do with the machine account in AD. Optional; + default is None. + explode: true + in: query + name: deleteAccount + required: false + schema: + allOf: + - $ref: '#/components/schemas/MachineAccountDeleteOption' + default: None + style: form + x-position: 3 responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/DesktopResponseModel' - description: |- - Details of the desktop. If the machine is not associated with a - desktop, the response will be `204 No Content`. + "204": + description: Operation is successful with no response content. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -220163,20 +217539,6 @@ paths: type: string style: simple "404": - content: - application/json: - example: - https://errors-api.cloud.com/common/notFound: - value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found - parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 - schema: - $ref: '#/components/schemas/ErrorResponse' description: A referenced entity was not found. headers: Citrix-TransactionId: @@ -220296,6 +217658,70 @@ paths: schema: type: string style: simple + "409": + content: + application/json: + example: + https://errors-api.cloud.com/common/optimisticConcurrency: + value: + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller requested an invalid relation to be created or deleted. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple "429": content: application/json: @@ -220497,12 +217923,18 @@ paths: schema: type: string style: simple - summary: "Get the desktop associated with the machine, if any." + summary: Remove a machine account from the machine catalog. tags: - - Machines APIs - /Machines/{nameOrId}/FileTypes/$import: - post: - operationId: Machines_ImportFileTypes + - MachineCatalogs APIs + patch: + description: |- + Update a machine account within the machine catalog. This is typically used to reset or + update the machine password so that the site is able to apply the machine account to a + provisioned VM. + + + This is only relevant for machine catalogs where ProvisioningType is MCS. + operationId: MachineCatalogs_UpdateMachineCatalogMachineAccount parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -220547,6 +217979,19 @@ paths: schema: type: string style: simple + - description: "Admin credential to use when performing the operation. If not\ + \ specified, the operation will be performed using the account under which\ + \ the identity service is running If specified, must be in a format matching\ + \ that of the standard 'Authorization' request header; the username and\ + \ password separated by a colon, UTF8-encoded, then base64-encoded, then\ + \ the \"Basic \" scheme prepended.\r\nExample:Basic QWxhZGRpbjpPcGVuU2VzYW1l" + explode: false + in: header + name: X-AdminCredential + required: false + schema: + type: string + style: simple - description: Must accept application/json. example: application/json explode: false @@ -220565,7 +218010,11 @@ paths: schema: type: string style: simple - - description: Name or ID of the machine. + - description: |- + Name or ID of the machine catalog containing the machine account. + If the catalog is present in a catalog folder, + specify the name in this format: {catalog folder path plus catalog name}. + For example, FolderName1|FolderName2|CatalogName. explode: false in: path name: nameOrId @@ -220576,32 +218025,34 @@ paths: type: string style: simple x-position: 1 - - description: |- - If `true`, the file types will be imported as a background task. - The task will have JobType ImportFTA. - When the task is complete it will redirect to - GetJobResults. - The job's Parameters will contain properties: - * _MachineId_ - ID of the machine - * _MachineName_ - Name of the machine - explode: true - in: query - name: async - required: false + - description: "Machine account to update. May be specified by SamName, UPN,\ + \ or SID." + explode: false + in: path + name: machine + required: true schema: - default: false nullable: true - title: Boolean - type: boolean - style: form + title: String + type: string + style: simple x-position: 2 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateMachineAccountRequestModel' + description: New details for the machine account record. + required: true + x-name: details + x-position: 3 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/FtaResponseModelCollection' - description: List of file type associations imported from the machine. + $ref: '#/components/schemas/ProvisioningSchemeMachineAccountResponseModel' + description: Machine account details. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -220654,82 +218105,75 @@ paths: schema: type: string style: simple - "202": - description: Async request was accepted and is being processed. + "204": + description: Operation is successful with no response content. headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 explode: false schema: type: string style: simple - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "400": - content: - application/json: - example: - https://errors-api.cloud.com/common/outOfRange: - value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range - parameters: - - name: property - value: startTime - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. - headers: + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -221049,18 +218493,21 @@ paths: schema: type: string style: simple - "409": + "415": content: application/json: example: - https://errors-api.cloud.com/common/optimisticConcurrency: + https://errors-api.cloud.com/common/unsupportedMediaType: value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type + parameters: + - name: mediaType + value: application/xml schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -221314,13 +218761,12 @@ paths: schema: type: string style: simple - summary: Import file type associations from the machine. + summary: Update a machine account within the machine catalog. tags: - - Machines APIs - /Machines/{nameOrId}/MachineCatalog: + - MachineCatalogs APIs + /MachineCatalogs/{nameOrId}/Machines: get: - description: Get the details of the machine catalog in which a machine resides. - operationId: Machines_GetMachineMachineCatalog + operationId: MachineCatalogs_GetMachineCatalogMachines parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -221383,7 +218829,10 @@ paths: schema: type: string style: simple - - description: Name or ID of the machine. + - description: |- + Name or ID of the machine catalog. If the catalog is present in a catalog folder, + specify the name in this format: {catalog folder path plus catalog name}. + For example, FolderName1|FolderName2|CatalogName. explode: false in: path name: nameOrId @@ -221394,13 +218843,70 @@ paths: type: string style: simple x-position: 1 + - description: |- + The max number of machines returned by this query. + If not specified, the server might use a default limit of 250 items. + If the specified value is larger than 1000, the server might reject the call. + The default and maximum values depend on server settings. + explode: true + in: query + name: limit + required: false + schema: + format: int32 + nullable: true + title: Int32 + type: integer + style: form + x-position: 2 + - description: |- + If a query cannot be completed, the response will have a + ContinuationToken set. + To obtain more results from the query, pass the + continuation token back into the query to get the next + batch of results. + explode: true + in: query + name: continuationToken + required: false + schema: + nullable: true + title: String + type: string + style: form + x-position: 3 + - description: "If `true`, it will be queried as a background task." + explode: true + in: query + name: async + required: false + schema: + default: false + nullable: true + title: Boolean + type: boolean + style: form + x-position: 4 + - description: "Optional parameters, only the specified properties in the fields\ + \ are required." + example: "Uid,AgentVersion,AllocationType" + explode: true + in: query + name: fields + required: false + schema: + nullable: true + title: String + type: string + style: form + x-position: 5 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/MachineCatalogDetailResponseModel' - description: Details of the machine catalog. + $ref: '#/components/schemas/MachineResponseModelCollection' + description: The machines of the given machine catalog identifier headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -221453,21 +218959,16 @@ paths: schema: type: string style: simple - "400": - content: - application/json: - example: - https://errors-api.cloud.com/common/outOfRange: - value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range - parameters: - - name: property - value: startTime - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + "202": + description: Async request was accepted and is being processed. headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -221519,20 +219020,20 @@ paths: schema: type: string style: simple - "401": + "400": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/outOfRange: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range parameters: - - name: reason - value: missing + - name: property + value: startTime schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: Caller passed an invalid input. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -221585,22 +219086,20 @@ paths: schema: type: string style: simple - "403": + "401": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -221653,14 +219152,14 @@ paths: schema: type: string style: simple - "404": + "403": content: application/json: example: - https://errors-api.cloud.com/common/notFound: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - name: entityType value: https://identifiers-api.cloud.com/example/widget @@ -221668,7 +219167,7 @@ paths: value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -221721,20 +219220,22 @@ paths: schema: type: string style: simple - "406": + "404": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/notFound: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found parameters: - - name: contentType - value: application/json + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + description: A referenced entity was not found. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -221787,21 +219288,20 @@ paths: schema: type: string style: simple - "429": + "406": content: application/json: example: - https://errors-api.cloud.com/common/rateLimitExceeded: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type parameters: - - name: retryDelay - value: "4" + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -221854,21 +219354,88 @@ paths: schema: type: string style: simple - "503": + "429": content: application/json: example: - https://errors-api.cloud.com/common/serviceUnavailable: + https://errors-api.cloud.com/common/rateLimitExceeded: value: - type: https://errors-api.cloud.com/common/serviceUnavailable - detail: Service is unavailable; try again in 4 seconds + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds parameters: - name: retryDelay value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: "Service is temporarily unable to process the request. Caller\ - \ may attempt the operation again, with exponential back-off." + description: Caller has made too many requests in a short period of time + and is being rate-limited. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "503": + content: + application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -221988,12 +219555,35 @@ paths: schema: type: string style: simple - summary: Get the machine catalog for a machine. + summary: GET the machines of a catalog tags: - - Machines APIs - /Machines/{nameOrId}/PowerActionSchedules: - delete: - operationId: Machines_RemovePowerActionSchedule + - MachineCatalogs APIs + post: + description: |- + Add a machine to the machine catalog. This is the first step in making the + machine available to run users' desktops and applications. The machine may + be physical or virtual. The type of machine (physical or virtual) must + match the machine catalog configuration. + + + Note that due to + the long-running nature of the adding operation, it cannot + complete synchronously, would always initiate an asynchronous job to + run to completion. + + + The machine must support the expected capabilities of the machine catalog: + the and + . The session + support of the machine is determined by the type of Citrix VDA software + installed (server or workstation) and the functional level depends on the + version of the Citrix VDA software installed. The API will complete + successfully if these are not correct but the machine will be unable to register. + + + Note: to add multiple machines in a single call, use the + API. + operationId: MachineCatalogs_AddMachineCatalogMachine parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -222038,6 +219628,30 @@ paths: schema: type: string style: simple + - description: "Admin credential to use when performing the operation. If not\ + \ specified, the operation will be performed using the account under which\ + \ the identity service is running If specified, must be in a format matching\ + \ that of the standard 'Authorization' request header; the username and\ + \ password separated by a colon, UTF8-encoded, then base64-encoded, then\ + \ the \"Basic \" scheme prepended.\r\nExample:Basic QWxhZGRpbjpPcGVuU2VzYW1l" + explode: false + in: header + name: X-AdminCredential + required: false + schema: + type: string + style: simple + - description: "Access token to use when performing the operation. If specified,\ + \ must be in a format matching that of the standard 'Authorization' request\ + \ header; UTF8-encoded, then base64-encoded, then the \"Bearer\" scheme\ + \ prepended.\r\nExample: Bearer bGljaGVuZy5saW5AY2l0cml4LmNvbQ==" + explode: false + in: header + name: X-AccessToken + required: false + schema: + type: string + style: simple - description: Must accept application/json. example: application/json explode: false @@ -222056,7 +219670,11 @@ paths: schema: type: string style: simple - - description: Name or ID of the machine. + - description: |- + Name or ID of the machine catalog to add machine to. + If the catalog is present in a catalog folder, + specify the name in this format: {catalog folder path plus catalog name}. + For example, FolderName1|FolderName2|CatalogName. explode: false in: path name: nameOrId @@ -222067,8 +219685,13 @@ paths: type: string style: simple x-position: 1 - - description: "If `true`, the power action schedule will be removed as a background\ - \ task." + - description: |- + If `true`, the machine will be added into the machine catalog as a background task. + The task will have JobType AddMachineCatalogMachine. + When the task is complete it will redirect to + GetMachineCatalog. + The job's Parameters will contain properties: + * _NameOrId_ - Name or ID of the machine being added. explode: true in: query name: async @@ -222079,10 +219702,23 @@ paths: title: Boolean type: boolean style: form + x-position: 3 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddMachineToMachineCatalogDetailRequestModel' + description: Details of the machine to add to the machine catalog. + required: true + x-name: machine x-position: 2 responses: - "204": - description: Operation is successful with no response content. + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/JobResponseModel' + description: Asynchronous job status. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -222397,6 +220033,20 @@ paths: type: string style: simple "404": + content: + application/json: + example: + https://errors-api.cloud.com/common/notFound: + value: + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' description: A referenced entity was not found. headers: Citrix-TransactionId: @@ -222580,6 +220230,73 @@ paths: schema: type: string style: simple + "415": + content: + application/json: + example: + https://errors-api.cloud.com/common/unsupportedMediaType: + value: + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type + parameters: + - name: mediaType + value: application/xml + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple "429": content: application/json: @@ -222781,11 +220498,22 @@ paths: schema: type: string style: simple - summary: Remove pending power action schedules for a machine. + summary: Add machine to the machine catalog. tags: - - Machines APIs - get: - operationId: Machines_GetMachinePowerActionSchedules + - MachineCatalogs APIs + /MachineCatalogs/{nameOrId}/Machines/{machine}: + delete: + description: |- + Remove a machine from the machine catalog. Removing the machine from the machine + catalog removes it from the site. + + + A machine cannot be removed from the machine catalog if it is a member of a delivery group. + + + Note: to remove multiple machines in a single call, use the + API. + operationId: MachineCatalogs_RemoveMachineCatalogMachine parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -222848,7 +220576,11 @@ paths: schema: type: string style: simple - - description: Name or ID of the machine. + - description: |- + Name or ID of the machine catalog to remove the machine from. + If the catalog is present in a catalog folder, + specify the name in this format: {catalog folder path plus catalog name}. + For example, FolderName1|FolderName2|CatalogName. explode: false in: path name: nameOrId @@ -222859,13 +220591,21 @@ paths: type: string style: simple x-position: 1 + - description: "Machine to remove from the catalog. May be specified by name,\ + \ ID, or SID." + explode: false + in: path + name: machine + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 2 responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/PowerActionScheduleResponseModelCollection' - description: List of power action schedules. + "204": + description: Operation is successful with no response content. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -223119,20 +220859,6 @@ paths: type: string style: simple "404": - content: - application/json: - example: - https://errors-api.cloud.com/common/notFound: - value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found - parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 - schema: - $ref: '#/components/schemas/ErrorResponse' description: A referenced entity was not found. headers: Citrix-TransactionId: @@ -223252,6 +220978,70 @@ paths: schema: type: string style: simple + "409": + content: + application/json: + example: + https://errors-api.cloud.com/common/optimisticConcurrency: + value: + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller requested an invalid relation to be created or deleted. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple "429": content: application/json: @@ -223453,13 +221243,13 @@ paths: schema: type: string style: simple - summary: Get the power action schedules associated with a machine. + summary: Remove a machine from the machine catalog. tags: - - Machines APIs - /Machines/{nameOrId}/Sessions: + - MachineCatalogs APIs + /MachineCatalogs/{nameOrId}/MasterImageHistory: get: - description: Get the list of sessions running on a machine - operationId: Machines_GetMachineSessions + description: Get the history of master VM images used by the machine catalog + operationId: MachineCatalogs_GetMachineCatalogMasterImageHistory parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -223522,7 +221312,7 @@ paths: schema: type: string style: simple - - description: Name or ID of the machine. + - description: Name or ID of the machine catalog. explode: false in: path name: nameOrId @@ -223533,25 +221323,13 @@ paths: type: string style: simple x-position: 1 - - description: The requested session fields. - example: "Id,Uid,ApplicationsInUse" - explode: true - in: query - name: fields - required: false - schema: - nullable: true - title: String - type: string - style: form - x-position: 2 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/SessionResponseModelCollection' - description: List of sessions. + $ref: '#/components/schemas/VMImageResponseModelCollection' + description: List of images used by the machine catalog to provision VMs. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -224139,18 +221917,24 @@ paths: schema: type: string style: simple - summary: Get the list of sessions running on a machine. + summary: Get the history of master VM images used by the machine catalog. tags: - - Machines APIs - /Machines/{nameOrId}/StartMenuShortcutIcon: - get: + - MachineCatalogs APIs + /MachineCatalogs/{nameOrId}/RemotePCEnrollmentScopes/$checkScopeName: + post: description: |- - Get a start menu shortcut icon from the machine. The machine must be powered-on - and registered in order for the call to succeed. - - - This icon is usually used to help create a published application. - operationId: Machines_GetMachineStartMenuShortcutIcon + Check for the existence of a RemotePC enrollment scope by name. Note that + RemotePC enrollment scope names must be unique within the site, so the + `nameOrId` parameter does not affect whether the RemotePC enrollment scope + name is found. + If the name is found to be available, this returns 404 Not Found. + If a RemotePC enrollment scope by that name exists and is associated with the + specified machine catalog, this returns 204 No Content. If a RemotePC + enrollment scope by that name exists and is associated with a different + machine catalog, this returns 303 See Other, and the `Location` + response header refers to location of the machine catalog which is associated + by the RemotePC enrollment scope. + operationId: MachineCatalogs_TestRemotePCEnrollmentScopeExists parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -224213,7 +221997,10 @@ paths: schema: type: string style: simple - - description: Machine to get the shortcut icon from. + - description: |- + Name or ID of the machine catalog. If the catalog is present in a catalog folder, + specify the name in this format: {catalog folder path plus catalog name}. + For example, FolderName1|FolderName2|CatalogName. explode: false in: path name: nameOrId @@ -224224,72 +222011,19 @@ paths: type: string style: simple x-position: 1 - - description: Path to the start menu shortcut. - explode: true - in: query - name: shortcutPath - required: false - schema: - nullable: true - title: String - type: string - style: form + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RemotePCEnrollmentScopeCheckModel' + description: Request model that contains distinguished name of an OU containing + machines allowed to enroll as remote PCs. + required: true + x-name: request x-position: 2 - - description: |- - Icon format. Must be: - `{mime-type};{width}x{height}x{colordepth}` - - - where: - - - * _mime-type_ must be `image/png`. (Other formats may be supported in future.) - * _width_ and _height_ are specified in pixels. - * _colordepth_ (optional) is either `8` or `24`. - - - Optional. If not specified, only the raw icon data will be returned. - Note that this is typically in ICO format, which many clients cannot - display properly. - explode: true - in: query - name: iconFormat - required: false - schema: - nullable: true - title: String - type: string - style: form - x-position: 3 - - description: |- - If `true`, the start menu shortcut icon will be queried as a background task. - The task will have JobType GetMachineStartMenuShortcutIcon. - When the task is complete it will redirect to - GetJobResults. - The job's Parameters will contain properties: - - * _Id_ - ID of the machine from which start menu icon are being obtained, - * _Name_ - Name of the machine from which start menu icon are being obtained. - * _ShortcutPath_ - Path to the start menu shortcut. - explode: true - in: query - name: async - required: false - schema: - default: false - nullable: true - title: Boolean - type: boolean - style: form - x-position: 4 responses: - "200": - content: - application/octet-stream: - schema: - format: binary - type: string - description: Icon data in the requested format. + "204": + description: Operation is successful with no response content. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -224342,16 +222076,21 @@ paths: schema: type: string style: simple - "202": - description: Async request was accepted and is being processed. - headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime schema: - type: string - style: simple + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -224403,20 +222142,20 @@ paths: schema: type: string style: simple - "400": + "401": content: application/json: example: - https://errors-api.cloud.com/common/outOfRange: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: property - value: startTime + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -224469,20 +222208,22 @@ paths: schema: type: string style: simple - "401": + "403": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - - name: reason - value: missing + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -224535,14 +222276,14 @@ paths: schema: type: string style: simple - "403": + "404": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/notFound: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found parameters: - name: entityType value: https://identifiers-api.cloud.com/example/widget @@ -224550,7 +222291,7 @@ paths: value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: A referenced entity was not found. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -224603,22 +222344,20 @@ paths: schema: type: string style: simple - "404": + "406": content: application/json: example: - https://errors-api.cloud.com/common/notFound: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -224671,20 +222410,85 @@ paths: schema: type: string style: simple - "406": + "409": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/optimisticConcurrency: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller requested an invalid relation to be created or deleted. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "415": + content: + application/json: + example: + https://errors-api.cloud.com/common/unsupportedMediaType: + value: + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type parameters: - - name: contentType - value: application/json + - name: mediaType + value: application/xml schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -224938,23 +222742,26 @@ paths: schema: type: string style: simple - summary: Get a start menu shortcut icon from the machine. + summary: |- + Check for the existence of a RemotePC enrollment scope by name in the request body. + Use HttpPost and take name in body as this name may be very long, and cause url too long exception. tags: - - Machines APIs - /Machines/{nameOrId}/StartMenuShortcuts: - get: + - MachineCatalogs APIs + /MachineCatalogs/{nameOrId}/RemotePCEnrollmentScopes/{name}: + head: description: |- - Get start menu shortcuts from the machine. The machine must be powered-on - and registered in order for the call to succeed. - - - The shortcuts obtained are from the 'All users' start menu; user-specific shortcuts are not found. - - - Note that this call does not retrieve the shortcut icon; use - - to get the icon. - operationId: Machines_GetMachineStartMenuShortcuts + Check for the existence of a RemotePC enrollment scope by name. Note that + RemotePC enrollment scope names must be unique within the site, so the + `nameOrId` parameter does not affect whether the RemotePC enrollment scope + name is found. + If the name is found to be available, this returns 404 Not Found. + If a RemotePC enrollment scope by that name exists and is associated with the + specified machine catalog, this returns 204 No Content. If a RemotePC + enrollment scope by that name exists and is associated with a different + machine catalog, this returns 303 See Other, and the `Location` + response header refers to location of the machine catalog which is associated + by the RemotePC enrollment scope. + operationId: MachineCatalogs_CheckRemotePCEnrollmentScopeExists parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -225017,7 +222824,10 @@ paths: schema: type: string style: simple - - description: Machine to get the shortcuts from. + - description: |- + Name or ID of the machine catalog. If the catalog is present in a catalog folder, + specify the name in this format: {catalog folder path plus catalog name}. + For example, FolderName1|FolderName2|CatalogName. explode: false in: path name: nameOrId @@ -225028,13 +222838,21 @@ paths: type: string style: simple x-position: 1 + - description: Distinguished name of an OU containing machines allowed to enroll + as remote PCs. + explode: false + in: path + name: name + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 2 responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/StartMenuApplicationResponseModelCollection' - description: List of shortcuts. + "204": + description: Operation is successful with no response content. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -225622,19 +223440,19 @@ paths: schema: type: string style: simple - summary: Get start menu shortcuts from the machine. + summary: Check for the existence of a RemotePC enrollment scope by name. tags: - - Machines APIs - /Machines/{nameOrId}/Tags: + - MachineCatalogs APIs + /MachineCatalogs/{nameOrId}/StartMenuApplications: get: description: |- - Get tags associated with a machine. This includes tags which are - directly associated with the machine, as well as tags associated - with delivery groups, application groups, or applications that are - associated with the machine. To find only tags directly associated - with the machine, filter the results to those with - NumMachines equal to `1`. - operationId: Machines_GetMachineTags + Get the start menu applications from a machine in the machine catalog + + Note that this API may require a machine within a catalog to be + booted, if no machines are currently available. Therefore the API + may take quite some time to complete. Consider using the `async=true` + parameter to mitigate this. + operationId: MachineCatalogs_GetMachineCatalogStartMenuApplications parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -225697,7 +223515,10 @@ paths: schema: type: string style: simple - - description: Name or ID of the machine. + - description: |- + Name or ID of the machine catalog. If the catalog is present in a catalog folder, + specify the name in this format: {catalog folder path plus catalog name}. + For example, FolderName1|FolderName2|CatalogName. explode: false in: path name: nameOrId @@ -225708,27 +223529,53 @@ paths: type: string style: simple x-position: 1 - - description: |- - Optional. A filter string containing object fields requested to be returned, - the requested fields are separated by comma','. return all if not specified. - example: "Name,Id,Description" + - description: The machines to get start menu applications explode: true in: query - name: fields + name: machines required: false schema: + items: + title: String + type: string nullable: true - title: String - type: string + title: "String[]" + type: array style: form x-position: 2 + - description: |- + If `true`, the start menu applications will be queried as a background task. + This is recommended as this operation may cause a power + action, turning on a machine in order to gather the data. + This may take some time to run, + and if it exceeds 90 seconds the request may time out. + The task will have JobType GetStartMenuApplications. + When the task is complete it will redirect to + "JobsControllerTP.GetJobResults(string)". + The job's Parameters will contain properties: + + * _Id_ - ID of the machine catalog from which start menu applications are being obtained, + * _Name_ - Name of the machine catalog from which start menu applications are being obtained. + * _MachineId_ - ID of the machine selected, from which the start menu applications are being obtained; will be present in Parameters only after a machine is selected. + * _MachineName_ - Name of the machine selected, from which the start menu applications are being obtained; will be present in Parameters only after a machine is selected. + explode: true + in: query + name: async + required: false + schema: + default: false + nullable: true + title: Boolean + type: boolean + style: form + x-position: 3 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/TagResponseModelCollection' - description: List of tags. + $ref: '#/components/schemas/StartMenuApplicationResponseModelCollection' + description: List of start menu applications. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -225781,21 +223628,16 @@ paths: schema: type: string style: simple - "400": - content: - application/json: - example: - https://errors-api.cloud.com/common/outOfRange: - value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range - parameters: - - name: property - value: startTime - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + "202": + description: Async request was accepted and is being processed. headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -225847,20 +223689,86 @@ paths: schema: type: string style: simple - "401": + "400": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/outOfRange: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range parameters: - - name: reason - value: missing + - name: property + value: startTime schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: Caller passed an invalid input. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "401": + content: + application/json: + example: + https://errors-api.cloud.com/common/authentication: + value: + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -226316,11 +224224,19 @@ paths: schema: type: string style: simple - summary: Get tags associated with a machine. + summary: Get the start menu applications from a machine in the machine catalog. tags: - - Machines APIs - put: - operationId: Machines_SetMachineTags + - MachineCatalogs APIs + /MachineCatalogs/{nameOrId}/Tags: + get: + description: |- + Get tags associated with a machine catalog. This includes tags which are + directly associated with the machine catalog, as well as tags associated with + machines that are associated with the machine catalog. + To find only tags directly associated with the machine catalog, + filter the results to those with + NumMachineCatalogs equal to `1`. + operationId: MachineCatalogs_GetMachineCatalogTags parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -226383,7 +224299,10 @@ paths: schema: type: string style: simple - - description: Name or ID of the machine. + - description: |- + Name or ID of the machine catalog. If the catalog is present in a catalog folder, + specify the name in this format: {catalog folder path plus catalog name}. + For example, FolderName1|FolderName2|CatalogName. explode: false in: path name: nameOrId @@ -226394,41 +224313,26 @@ paths: type: string style: simple x-position: 1 - - description: "If `true`, the tags will be modified as a background task." + - description: "Optional parameters, removing unspecified properties that otherwise\ + \ would have been sent by the server." + example: "Name,Id,Description" explode: true in: query - name: async + name: fields required: false schema: - default: false - title: Boolean - type: boolean + nullable: true + title: String + type: string style: form - x-position: 3 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TagsRequestModel' - description: Details of the tags to set on the machine. - required: true - x-name: request x-position: 2 responses: - "400": + "200": content: application/json: - example: - https://errors-api.cloud.com/common/outOfRange: - value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range - parameters: - - name: property - value: startTime schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + $ref: '#/components/schemas/TagResponseModelCollection' + description: List of tags. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -226481,69 +224385,20 @@ paths: schema: type: string style: simple - "202": - description: Async request was accepted and is being processed. - headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false - schema: - type: string - style: simple - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime schema: - type: string - style: simple - "204": - description: Operation is successful with no response content. + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -226864,73 +224719,6 @@ paths: schema: type: string style: simple - "415": - content: - application/json: - example: - https://errors-api.cloud.com/common/unsupportedMediaType: - value: - type: https://errors-api.cloud.com/common/unsupportedMediaType - detail: Must use application/json;charset=utf-8 media type - parameters: - - name: mediaType - value: application/xml - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller must send request body in utf-8 and specify request - Content-Type as utf-8. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple "429": content: application/json: @@ -227132,12 +224920,11 @@ paths: schema: type: string style: simple - summary: Set tags associated with a machine. + summary: Get tags associated with a machine catalog. tags: - - Machines APIs - /Machines/{nameOrId}/Tags/{tagNameOrId}: - delete: - operationId: Machines_RemoveMachineTags + - MachineCatalogs APIs + put: + operationId: MachineCatalogs_SetMachineCatalogTags parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -227200,7 +224987,10 @@ paths: schema: type: string style: simple - - description: Name or ID of the machine. + - description: |- + Name or ID of the machine catalog. If the catalog is present in a catalog folder, + specify the name in this format: {catalog folder path plus catalog name}. + For example, FolderName1|FolderName2|CatalogName. explode: false in: path name: nameOrId @@ -227211,17 +225001,6 @@ paths: type: string style: simple x-position: 1 - - description: Name or ID of the tag. - explode: false - in: path - name: tagNameOrId - required: true - schema: - nullable: true - title: String - type: string - style: simple - x-position: 2 - description: "If `true`, the tags will be modified as a background task." explode: true in: query @@ -227233,21 +225012,18 @@ paths: type: boolean style: form x-position: 3 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TagsRequestModel' + description: Details of the tags to set on the machine catalog. + required: true + x-name: request + x-position: 2 responses: - "400": - content: - application/json: - example: - https://errors-api.cloud.com/common/outOfRange: - value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range - parameters: - - name: property - value: startTime - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + "204": + description: Operation is successful with no response content. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -227361,8 +225137,20 @@ paths: schema: type: string style: simple - "204": - description: Operation is successful with no response content. + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -227550,6 +225338,20 @@ paths: type: string style: simple "404": + content: + application/json: + example: + https://errors-api.cloud.com/common/notFound: + value: + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' description: A referenced entity was not found. headers: Citrix-TransactionId: @@ -227669,18 +225471,21 @@ paths: schema: type: string style: simple - "409": + "415": content: application/json: example: - https://errors-api.cloud.com/common/optimisticConcurrency: + https://errors-api.cloud.com/common/unsupportedMediaType: value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type + parameters: + - name: mediaType + value: application/xml schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -227934,11 +225739,15 @@ paths: schema: type: string style: simple - summary: Remove a tag from a machine. + summary: Set tags associated with a machine catalog. tags: - - Machines APIs - post: - operationId: Machines_AddMachineTags + - MachineCatalogs APIs + /MachineCatalogs/{nameOrId}/Tags/{tagNameOrId}: + delete: + description: |- + Remove a tag from a machine catalog. Does not delete the tag, + only its association to the machine catalog. + operationId: MachineCatalogs_RemoveMachineCatalogTags parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -228001,7 +225810,10 @@ paths: schema: type: string style: simple - - description: Name or ID of the machine. + - description: |- + Name or ID of the machine catalog. If the catalog is present in a catalog folder, + specify the name in this format: {catalog folder path plus catalog name}. + For example, FolderName1|FolderName2|CatalogName. explode: false in: path name: nameOrId @@ -228012,7 +225824,7 @@ paths: type: string style: simple x-position: 1 - - description: Name or ID of the tag to add. + - description: Name or ID of the tag. explode: false in: path name: tagNameOrId @@ -228035,12 +225847,8 @@ paths: style: form x-position: 3 responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/TagResponseModelCollection' - description: List of tags associated with the machine. + "204": + description: Operation is successful with no response content. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -228355,20 +226163,6 @@ paths: type: string style: simple "404": - content: - application/json: - example: - https://errors-api.cloud.com/common/notFound: - value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found - parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 - schema: - $ref: '#/components/schemas/ErrorResponse' description: A referenced entity was not found. headers: Citrix-TransactionId: @@ -228753,12 +226547,11 @@ paths: schema: type: string style: simple - summary: Add a tag to a machine. + summary: Remove a tag from a machine catalog. tags: - - Machines APIs - /Machines/{nameOrId}/TestReports/{reportId}: - get: - operationId: Machines_GetTestMachineReport + - MachineCatalogs APIs + post: + operationId: MachineCatalogs_AddMachineCatalogTags parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -228821,7 +226614,10 @@ paths: schema: type: string style: simple - - description: Name or ID of the machine to test. + - description: |- + Name or ID of the machine catalog. If the catalog is present in a catalog folder, + specify the name in this format: {catalog folder path plus catalog name}. + For example, FolderName1|FolderName2|CatalogName. explode: false in: path name: nameOrId @@ -228832,10 +226628,10 @@ paths: type: string style: simple x-position: 1 - - description: ID of the Cloud Health Check Report. + - description: Name or ID of the tag to add. explode: false in: path - name: reportId + name: tagNameOrId required: true schema: nullable: true @@ -228843,14 +226639,86 @@ paths: type: string style: simple x-position: 2 + - description: "If `true`, the tags will be modified as a background task." + explode: true + in: query + name: async + required: false + schema: + default: false + title: Boolean + type: boolean + style: form + x-position: 3 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/MachineTestResponseModel' - description: Machine test report. + $ref: '#/components/schemas/TagResponseModelCollection' + description: List of tags associated with the machine catalog. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "202": + description: Async request was accepted and is being processed. headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -229236,21 +227104,18 @@ paths: schema: type: string style: simple - "429": + "409": content: application/json: example: - https://errors-api.cloud.com/common/rateLimitExceeded: + https://errors-api.cloud.com/common/optimisticConcurrency: value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds - parameters: - - name: retryDelay - value: "4" + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. + description: Caller requested an invalid relation to be created or deleted. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -229303,21 +227168,88 @@ paths: schema: type: string style: simple - "503": + "429": content: application/json: example: - https://errors-api.cloud.com/common/serviceUnavailable: + https://errors-api.cloud.com/common/rateLimitExceeded: value: - type: https://errors-api.cloud.com/common/serviceUnavailable - detail: Service is unavailable; try again in 4 seconds + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds parameters: - name: retryDelay value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: "Service is temporarily unable to process the request. Caller\ - \ may attempt the operation again, with exponential back-off." + description: Caller has made too many requests in a short period of time + and is being rate-limited. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "503": + content: + application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -229437,12 +227369,15 @@ paths: schema: type: string style: simple - summary: Get Cloud Health Check Report on a VDA machine. + summary: Add a tag to a machine catalog. tags: - - Machines APIs - /Machines/{nameOrId}/UpgradeSchedule: - delete: - operationId: Machines_RemoveMachineUpgradeSchedule + - MachineCatalogs APIs + /MachineCatalogs/{nameOrId}/TestReport: + get: + description: |- + Get the test report from the last run of + TestMachineCatalog. + operationId: MachineCatalogs_GetMachineCatalogTestReport parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -229505,7 +227440,10 @@ paths: schema: type: string style: simple - - description: Name or ID of the machine. + - description: |- + Name or ID of the machine catalog. If the catalog is present in a catalog folder, + specify the name in this format: {catalog folder path plus catalog name}. + For example, FolderName1|FolderName2|CatalogName. explode: false in: path name: nameOrId @@ -229516,87 +227454,15 @@ paths: type: string style: simple x-position: 1 - - explode: true - in: query - name: force - required: false - schema: - default: false - nullable: true - title: Boolean - type: boolean - style: form - x-position: 2 - - description: "If `true`, the VDA upgrade schedule will be removed as a background\ - \ task." - explode: true - in: query - name: async - required: false - schema: - default: false - nullable: true - title: Boolean - type: boolean - style: form - x-position: 3 responses: - "204": - description: Operation is successful with no response content. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false + "200": + content: + application/json: schema: - type: string - style: simple - "404": - description: A referenced entity was not found. + $ref: '#/components/schemas/TestReportResponseModel' + description: |- + Last test report. If no tests have been run, + returns a 404 Not Found. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -229649,16 +227515,21 @@ paths: schema: type: string style: simple - "202": - description: Async request was accepted and is being processed. - headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime schema: - type: string - style: simple + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -229710,20 +227581,20 @@ paths: schema: type: string style: simple - "400": + "401": content: application/json: example: - https://errors-api.cloud.com/common/outOfRange: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: property - value: startTime + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -229776,20 +227647,22 @@ paths: schema: type: string style: simple - "401": + "403": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - - name: reason - value: missing + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -229842,14 +227715,14 @@ paths: schema: type: string style: simple - "403": + "404": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/notFound: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found parameters: - name: entityType value: https://identifiers-api.cloud.com/example/widget @@ -229857,7 +227730,7 @@ paths: value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: A referenced entity was not found. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -229976,18 +227849,21 @@ paths: schema: type: string style: simple - "409": + "429": content: application/json: example: - https://errors-api.cloud.com/common/optimisticConcurrency: + https://errors-api.cloud.com/common/rateLimitExceeded: value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. + description: Caller has made too many requests in a short period of time + and is being rate-limited. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -230040,88 +227916,21 @@ paths: schema: type: string style: simple - "429": + "503": content: application/json: example: - https://errors-api.cloud.com/common/rateLimitExceeded: + https://errors-api.cloud.com/common/serviceUnavailable: value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds parameters: - name: retryDelay value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "503": - content: - application/json: - example: - https://errors-api.cloud.com/common/serviceUnavailable: - value: - type: https://errors-api.cloud.com/common/serviceUnavailable - detail: Service is unavailable; try again in 4 seconds - parameters: - - name: retryDelay - value: "4" - schema: - $ref: '#/components/schemas/ErrorResponse' - description: "Service is temporarily unable to process the request. Caller\ - \ may attempt the operation again, with exponential back-off." + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -230241,11 +228050,16 @@ paths: schema: type: string style: simple - summary: Remove a pending VDA upgrade schedule for a machine. + summary: Get the most recent test report of a machine catalog. tags: - - Machines APIs - patch: - operationId: Machines_UpdateMachineUpgradeSchedule + - MachineCatalogs APIs + /MachineCatalogs/{nameOrId}/UpgradeSchedule: + delete: + description: |- + A VDA upgrade schedule can only be cancelled for a machine catalog + when the upgrade status is waiting to start. If the current upgrade is + in another status, the operation fails with HTTP response status 404. + operationId: MachineCatalogs_RemoveMachineCatalogUpgradeSchedule parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -230308,7 +228122,10 @@ paths: schema: type: string style: simple - - description: Name or ID of the machine. + - description: |- + Name or ID of the machine catalog. If the catalog is present in a catalog folder, + specify the name in this format: {catalog folder path plus catalog name}. + For example, FolderName1|FolderName2|CatalogName. explode: false in: path name: nameOrId @@ -230319,7 +228136,22 @@ paths: type: string style: simple x-position: 1 - - description: "If `true`, the VDA upgrade schedule will be updated as a background\ + - description: |- + If `true`, VDA upgrade schedules existing with all machines within the + catalog will be removed except those upgrade status in progressing. + If `false`, only the perform removing when catalog level schedule not started. + explode: true + in: query + name: force + required: false + schema: + default: false + nullable: true + title: Boolean + type: boolean + style: form + x-position: 2 + - description: "If `true`, the VDA upgrade schedule will be removed as a background\ \ task." explode: true in: query @@ -230332,15 +228164,6 @@ paths: type: boolean style: form x-position: 3 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/UpdateUpgradeScheduleRequestModel' - description: Details about the updated VDA upgrade schedule. - required: true - x-name: request - x-position: 2 responses: "204": description: Operation is successful with no response content. @@ -230396,20 +228219,18 @@ paths: schema: type: string style: simple - "400": + "409": content: application/json: example: - https://errors-api.cloud.com/common/outOfRange: + https://errors-api.cloud.com/common/optimisticConcurrency: value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range - parameters: - - name: property - value: startTime + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + description: Caller requested an invalid relation to be created or deleted. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -230462,23 +228283,16 @@ paths: schema: type: string style: simple - "404": - content: - application/json: - example: - https://errors-api.cloud.com/common/notFound: - value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found - parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 - schema: - $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. + "202": + description: Async request was accepted and is being processed. headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -230530,16 +228344,21 @@ paths: schema: type: string style: simple - "202": - description: Async request was accepted and is being processed. - headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime schema: - type: string - style: simple + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -230725,6 +228544,60 @@ paths: schema: type: string style: simple + "404": + description: A referenced entity was not found. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple "406": content: application/json: @@ -230791,21 +228664,21 @@ paths: schema: type: string style: simple - "415": + "429": content: application/json: example: - https://errors-api.cloud.com/common/unsupportedMediaType: + https://errors-api.cloud.com/common/rateLimitExceeded: value: - type: https://errors-api.cloud.com/common/unsupportedMediaType - detail: Must use application/json;charset=utf-8 media type + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds parameters: - - name: mediaType - value: application/xml + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must send request body in utf-8 and specify request - Content-Type as utf-8. + description: Caller has made too many requests in a short period of time + and is being rate-limited. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -230858,21 +228731,21 @@ paths: schema: type: string style: simple - "429": + "503": content: application/json: example: - https://errors-api.cloud.com/common/rateLimitExceeded: + https://errors-api.cloud.com/common/serviceUnavailable: value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds parameters: - name: retryDelay value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -230925,21 +228798,21 @@ paths: schema: type: string style: simple - "503": + "500": content: application/json: example: - https://errors-api.cloud.com/common/serviceUnavailable: + https://errors-api.cloud.com/common/internalServerError: value: - type: https://errors-api.cloud.com/common/serviceUnavailable - detail: Service is unavailable; try again in 4 seconds + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds parameters: - name: retryDelay value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: "Service is temporarily unable to process the request. Caller\ - \ may attempt the operation again, with exponential back-off." + description: An unexpected server error occurred. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -230992,78 +228865,11 @@ paths: schema: type: string style: simple - "500": - content: - application/json: - example: - https://errors-api.cloud.com/common/internalServerError: - value: - type: https://errors-api.cloud.com/common/internalServerError - detail: An internal server error has occurred; try again in 4 - seconds - parameters: - - name: retryDelay - value: "4" - schema: - $ref: '#/components/schemas/ErrorResponse' - description: An unexpected server error occurred. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - summary: Reschedule a pending VDA upgrade schedule for a machine. + summary: Remove a pending VDA upgrade schedule for a machine catalog. tags: - - Machines APIs - post: - operationId: Machines_CreateMachineUpgradeSchedule + - MachineCatalogs APIs + patch: + operationId: MachineCatalogs_UpdateMachineCatalogUpgradeSchedule parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -231126,7 +228932,11 @@ paths: schema: type: string style: simple - - description: Name or ID of the machine. + - description: |- + Name or ID of the machine catalog. + If the catalog is present in a catalog folder, + specify the name in this format: {catalog folder path plus catalog name}. + For example, FolderName1|FolderName2|CatalogName. explode: false in: path name: nameOrId @@ -231137,7 +228947,7 @@ paths: type: string style: simple x-position: 1 - - description: "If `true`, the VDA upgrade schedule will be created as a background\ + - description: "If `true`, the VDA upgrade schedule will be updated as a background\ \ task." explode: true in: query @@ -231154,22 +228964,81 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CreateUpgradeScheduleRequestModel' - description: Details about the VDA upgrade schedule to create. + $ref: '#/components/schemas/UpdateUpgradeScheduleRequestModel' + description: Details about the updated VDA upgrade schedule. required: true x-name: request x-position: 2 responses: - "201": - description: Resource was created. + "204": + description: Operation is successful with no response content. headers: - Location: - description: Location where the newly created resource resides. - example: /services/myservice/widgets/1 + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 explode: false schema: type: string style: simple + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -231232,7 +229101,7 @@ paths: parameters: null schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. + description: "" headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -231346,8 +229215,20 @@ paths: schema: type: string style: simple - "204": - description: Operation is successful with no response content. + "401": + content: + application/json: + example: + https://errors-api.cloud.com/common/authentication: + value: + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -231400,20 +229281,22 @@ paths: schema: type: string style: simple - "400": + "403": content: application/json: example: - https://errors-api.cloud.com/common/outOfRange: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - - name: property - value: startTime + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -231466,20 +229349,22 @@ paths: schema: type: string style: simple - "401": + "404": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/notFound: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found parameters: - - name: reason - value: missing + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: A referenced entity was not found. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -231532,22 +229417,20 @@ paths: schema: type: string style: simple - "403": + "406": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -231600,22 +229483,21 @@ paths: schema: type: string style: simple - "404": + "415": content: application/json: example: - https://errors-api.cloud.com/common/notFound: + https://errors-api.cloud.com/common/unsupportedMediaType: value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: mediaType + value: application/xml schema: $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -231668,20 +229550,21 @@ paths: schema: type: string style: simple - "406": + "429": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/rateLimitExceeded: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds parameters: - - name: contentType - value: application/json + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + description: Caller has made too many requests in a short period of time + and is being rate-limited. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -231734,21 +229617,21 @@ paths: schema: type: string style: simple - "415": + "503": content: application/json: example: - https://errors-api.cloud.com/common/unsupportedMediaType: + https://errors-api.cloud.com/common/serviceUnavailable: value: - type: https://errors-api.cloud.com/common/unsupportedMediaType - detail: Must use application/json;charset=utf-8 media type + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds parameters: - - name: mediaType - value: application/xml + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must send request body in utf-8 and specify request - Content-Type as utf-8. + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -231801,21 +229684,21 @@ paths: schema: type: string style: simple - "429": + "500": content: application/json: example: - https://errors-api.cloud.com/common/rateLimitExceeded: + https://errors-api.cloud.com/common/internalServerError: value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds parameters: - name: retryDelay value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. + description: An unexpected server error occurred. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -231868,22 +229751,124 @@ paths: schema: type: string style: simple - "503": - content: - application/json: - example: - https://errors-api.cloud.com/common/serviceUnavailable: - value: - type: https://errors-api.cloud.com/common/serviceUnavailable - detail: Service is unavailable; try again in 4 seconds - parameters: - - name: retryDelay - value: "4" - schema: - $ref: '#/components/schemas/ErrorResponse' - description: "Service is temporarily unable to process the request. Caller\ - \ may attempt the operation again, with exponential back-off." + summary: Reschedule a pending VDA upgrade schedule for a machine catalog. + tags: + - MachineCatalogs APIs + post: + description: |- + A new VDA upgrade schedule can only be created for a machine catalog + when the upgrade status for the catalog is UpgradeSuccessful, UpgradeFailed or UpgradeCancelled. + If the status is ongoing or waiting to start, the operation fails. + operationId: MachineCatalogs_CreateMachineCatalogUpgradeSchedule + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + - description: |- + Name or ID of the machine catalog. If the catalog is present in a catalog folder, + specify the name in this format: {catalog folder path plus catalog name}. + For example, FolderName1|FolderName2|CatalogName. + explode: false + in: path + name: nameOrId + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 1 + - description: "If `true`, the VDA upgrade schedule will be created as a background\ + \ task." + explode: true + in: query + name: async + required: false + schema: + default: false + nullable: true + title: Boolean + type: boolean + style: form + x-position: 3 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateUpgradeScheduleRequestModel' + description: Details about the VDA upgrade schedule to create. + required: true + x-name: request + x-position: 2 + responses: + "201": + description: Resource was created. headers: + Location: + description: Location where the newly created resource resides. + example: /services/myservice/widgets/1 + explode: false + schema: + type: string + style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -231935,21 +229920,18 @@ paths: schema: type: string style: simple - "500": + "409": content: application/json: example: - https://errors-api.cloud.com/common/internalServerError: + https://errors-api.cloud.com/common/optimisticConcurrency: value: - type: https://errors-api.cloud.com/common/internalServerError - detail: An internal server error has occurred; try again in 4 - seconds - parameters: - - name: retryDelay - value: "4" + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null schema: $ref: '#/components/schemas/ErrorResponse' - description: An unexpected server error occurred. + description: Caller requested an invalid relation to be created or deleted. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -232002,68 +229984,16 @@ paths: schema: type: string style: simple - summary: Setup a new VDA upgrade schedule for a machine. - tags: - - Machines APIs - /me: - get: - description: |- - Gets details about the currently logged-in admin, including the - list of customers and sites that the admin has access to. - operationId: Me_GetMe - parameters: - - description: Citrix Customer ID. Default is 'CitrixOnPremises' - example: CitrixOnPremises - explode: false - in: header - name: Citrix-CustomerId - required: true - schema: - type: string - style: simple - - description: "Citrix authorization header: CWSAuth Bearer={token}" - explode: false - in: header - name: Authorization - required: false - schema: - type: string - style: simple - - description: "Transaction ID that will be used to track this request. If not\ - \ provided, a new GUID will be generated and returned." - explode: false - in: header - name: Citrix-TransactionId - required: false - schema: - type: string - style: simple - - description: Must accept application/json. - example: application/json - explode: false - in: header - name: Accept - required: false - schema: - type: string - style: simple - - description: Locale of the request. - example: en-US - explode: false - in: header - name: Citrix-Locale - required: false - schema: - type: string - style: simple - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/MeResponseModel' - description: Details about the currently logged-in admin. + "202": + description: Async request was accepted and is being processed. headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -232115,20 +230045,8 @@ paths: schema: type: string style: simple - "400": - content: - application/json: - example: - https://errors-api.cloud.com/common/outOfRange: - value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range - parameters: - - name: property - value: startTime - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + "204": + description: Operation is successful with no response content. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -232181,20 +230099,20 @@ paths: schema: type: string style: simple - "401": + "400": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/outOfRange: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range parameters: - - name: reason - value: missing + - name: property + value: startTime schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: Caller passed an invalid input. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -232247,22 +230165,20 @@ paths: schema: type: string style: simple - "403": + "401": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -232315,20 +230231,22 @@ paths: schema: type: string style: simple - "406": + "403": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - - name: contentType - value: application/json + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -232381,21 +230299,22 @@ paths: schema: type: string style: simple - "429": + "404": content: application/json: example: - https://errors-api.cloud.com/common/rateLimitExceeded: + https://errors-api.cloud.com/common/notFound: value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found parameters: - - name: retryDelay - value: "4" + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. + description: A referenced entity was not found. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -232448,21 +230367,20 @@ paths: schema: type: string style: simple - "503": + "406": content: application/json: example: - https://errors-api.cloud.com/common/serviceUnavailable: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/serviceUnavailable - detail: Service is unavailable; try again in 4 seconds + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type parameters: - - name: retryDelay - value: "4" + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: "Service is temporarily unable to process the request. Caller\ - \ may attempt the operation again, with exponential back-off." + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -232515,21 +230433,21 @@ paths: schema: type: string style: simple - "500": + "415": content: application/json: example: - https://errors-api.cloud.com/common/internalServerError: + https://errors-api.cloud.com/common/unsupportedMediaType: value: - type: https://errors-api.cloud.com/common/internalServerError - detail: An internal server error has occurred; try again in 4 - seconds + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type parameters: - - name: retryDelay - value: "4" + - name: mediaType + value: application/xml schema: $ref: '#/components/schemas/ErrorResponse' - description: An unexpected server error occurred. + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -232582,81 +230500,21 @@ paths: schema: type: string style: simple - summary: Get my details. - tags: - - Me APIs - /me/Preferences: - get: - description: |- - Get my preferences. - Preferences are free-form name/value pairs that are typically used to - keep track of how the user has configured the UI, so that the configuration - is retained across sessions. - operationId: Me_GetMyPreferences - parameters: - - description: Citrix Customer ID. Default is 'CitrixOnPremises' - example: CitrixOnPremises - explode: false - in: header - name: Citrix-CustomerId - required: true - schema: - type: string - style: simple - - description: "Citrix authorization header: CWSAuth Bearer={token}" - explode: false - in: header - name: Authorization - required: false - schema: - type: string - style: simple - - description: "Transaction ID that will be used to track this request. If not\ - \ provided, a new GUID will be generated and returned." - explode: false - in: header - name: Citrix-TransactionId - required: false - schema: - type: string - style: simple - - description: Must accept application/json. - example: application/json - explode: false - in: header - name: Accept - required: false - schema: - type: string - style: simple - - description: Locale of the request. - example: en-US - explode: false - in: header - name: Citrix-Locale - required: false - schema: - type: string - style: simple - - description: "Optional name prefix to filter results. If not specified, all\ - \ preferences are returned." - explode: true - in: query - name: namePrefix - required: false - schema: - nullable: true - title: String - type: string - style: form - x-position: 1 - responses: - "200": + "429": content: application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" schema: - $ref: '#/components/schemas/NameValueStringPairModelCollection' - description: List of user preferences. + $ref: '#/components/schemas/ErrorResponse' + description: Caller has made too many requests in a short period of time + and is being rate-limited. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -232709,20 +230567,21 @@ paths: schema: type: string style: simple - "400": + "503": content: application/json: example: - https://errors-api.cloud.com/common/outOfRange: + https://errors-api.cloud.com/common/serviceUnavailable: value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds parameters: - - name: property - value: startTime + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -232775,20 +230634,21 @@ paths: schema: type: string style: simple - "401": + "500": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/internalServerError: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds parameters: - - name: reason - value: missing + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: An unexpected server error occurred. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -232841,22 +230701,96 @@ paths: schema: type: string style: simple - "403": + summary: Setup a new VDA upgrade schedule for a machine catalog. + tags: + - MachineCatalogs APIs + /MachineCatalogs/{nameOrId}/VDAComponentsAndFeatures: + get: + operationId: MachineCatalogs_GetMachineCatalogVDAComponentsAndFeatures + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + - description: |- + Name or ID of the machine catalog. + If the catalog is present in a catalog folder, + specify the name in this format: {catalog folder path plus catalog name}. + For example, FolderName1|FolderName2|CatalogName. + explode: false + in: path + name: nameOrId + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 1 + responses: + "200": content: application/json: - example: - https://errors-api.cloud.com/common/authorization: - value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied - parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + $ref: '#/components/schemas/MachineCatalogVusComponentResponseModel' + description: Components and features of VDAs associated with a machine catalog. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -232909,20 +230843,20 @@ paths: schema: type: string style: simple - "406": + "400": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/outOfRange: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range parameters: - - name: contentType - value: application/json + - name: property + value: startTime schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + description: Caller passed an invalid input. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -232975,21 +230909,20 @@ paths: schema: type: string style: simple - "429": + "401": content: application/json: example: - https://errors-api.cloud.com/common/rateLimitExceeded: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: retryDelay - value: "4" + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -233042,21 +230975,22 @@ paths: schema: type: string style: simple - "503": + "403": content: application/json: example: - https://errors-api.cloud.com/common/serviceUnavailable: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/serviceUnavailable - detail: Service is unavailable; try again in 4 seconds + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - - name: retryDelay - value: "4" + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: "Service is temporarily unable to process the request. Caller\ - \ may attempt the operation again, with exponential back-off." + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -233109,21 +231043,22 @@ paths: schema: type: string style: simple - "500": + "404": content: application/json: example: - https://errors-api.cloud.com/common/internalServerError: + https://errors-api.cloud.com/common/notFound: value: - type: https://errors-api.cloud.com/common/internalServerError - detail: An internal server error has occurred; try again in 4 - seconds + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found parameters: - - name: retryDelay - value: "4" + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: An unexpected server error occurred. + description: A referenced entity was not found. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -233176,75 +231111,20 @@ paths: schema: type: string style: simple - summary: Get my preferences. - tags: - - Me APIs - put: - description: |- - Set a preference value. - Preferences are free-form name/value pairs that are typically used to - keep track of how the user has configured the UI, so that the configuration - is retained across sessions. - Note: if a preference with the given name already exists, it will be - overridden. - operationId: Me_SetMyPreference - parameters: - - description: Citrix Customer ID. Default is 'CitrixOnPremises' - example: CitrixOnPremises - explode: false - in: header - name: Citrix-CustomerId - required: true - schema: - type: string - style: simple - - description: "Citrix authorization header: CWSAuth Bearer={token}" - explode: false - in: header - name: Authorization - required: false - schema: - type: string - style: simple - - description: "Transaction ID that will be used to track this request. If not\ - \ provided, a new GUID will be generated and returned." - explode: false - in: header - name: Citrix-TransactionId - required: false - schema: - type: string - style: simple - - description: Must accept application/json. - example: application/json - explode: false - in: header - name: Accept - required: false - schema: - type: string - style: simple - - description: Locale of the request. - example: en-US - explode: false - in: header - name: Citrix-Locale - required: false - schema: - type: string - style: simple - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SetPreferenceModel' - description: Preference to set. - required: true - x-name: preference - x-position: 1 - responses: - "204": - description: Operation is successful with no response content. + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -233297,20 +231177,21 @@ paths: schema: type: string style: simple - "400": + "429": content: application/json: example: - https://errors-api.cloud.com/common/outOfRange: + https://errors-api.cloud.com/common/rateLimitExceeded: value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds parameters: - - name: property - value: startTime + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + description: Caller has made too many requests in a short period of time + and is being rate-limited. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -233363,20 +231244,21 @@ paths: schema: type: string style: simple - "401": + "503": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/serviceUnavailable: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds parameters: - - name: reason - value: missing + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -233429,22 +231311,21 @@ paths: schema: type: string style: simple - "403": + "500": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/internalServerError: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: An unexpected server error occurred. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -233497,20 +231378,116 @@ paths: schema: type: string style: simple - "406": + summary: Get the components and features of VDAs associated with a machine catalog. + tags: + - MachineCatalogs APIs + /MachineCatalogs/{nameOrId}/VDAComponentsAndFeatures/$validate: + post: + operationId: MachineCatalogs_ValidateMachineCatalogVDAComponentsAndFeaturesSelection + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + - description: |- + Name or ID of the machine catalog. If the catalog is present in a catalog folder, + specify the name in this format: {catalog folder path plus catalog name}. + For example, FolderName1|FolderName2|CatalogName. + explode: false + in: path + name: nameOrId + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 1 + - description: If async execute. + explode: true + in: query + name: async + required: false + schema: + default: false + nullable: true + title: Boolean + type: boolean + style: form + x-position: 3 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VDAComponentsSelectionValidationRequestModel' + description: More details attached to this validation. + required: true + x-name: request + x-position: 2 + responses: + "200": content: application/json: - example: - https://errors-api.cloud.com/common/notAcceptable: - value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type - parameters: - - name: contentType - value: application/json schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + $ref: '#/components/schemas/VDAComponentsSelectionValidationResponseModel' + description: The validation result. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -233563,22 +231540,16 @@ paths: schema: type: string style: simple - "415": - content: - application/json: - example: - https://errors-api.cloud.com/common/unsupportedMediaType: - value: - type: https://errors-api.cloud.com/common/unsupportedMediaType - detail: Must use application/json;charset=utf-8 media type - parameters: - - name: mediaType - value: application/xml - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller must send request body in utf-8 and specify request - Content-Type as utf-8. + "202": + description: Async request was accepted and is being processed. headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -233630,21 +231601,20 @@ paths: schema: type: string style: simple - "429": + "400": content: application/json: example: - https://errors-api.cloud.com/common/rateLimitExceeded: + https://errors-api.cloud.com/common/outOfRange: value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range parameters: - - name: retryDelay - value: "4" + - name: property + value: startTime schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. + description: Caller passed an invalid input. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -233697,21 +231667,20 @@ paths: schema: type: string style: simple - "503": + "401": content: application/json: example: - https://errors-api.cloud.com/common/serviceUnavailable: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/serviceUnavailable - detail: Service is unavailable; try again in 4 seconds + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: retryDelay - value: "4" + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: "Service is temporarily unable to process the request. Caller\ - \ may attempt the operation again, with exponential back-off." + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -233764,139 +231733,22 @@ paths: schema: type: string style: simple - "500": + "403": content: application/json: example: - https://errors-api.cloud.com/common/internalServerError: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/internalServerError - detail: An internal server error has occurred; try again in 4 - seconds + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - - name: retryDelay - value: "4" + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: An unexpected server error occurred. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - summary: Set a preference value. - tags: - - Me APIs - /me/Preferences/{name}: - delete: - description: Delete one of my preferences by name. - operationId: Me_DeleteMyPreference - parameters: - - description: Citrix Customer ID. Default is 'CitrixOnPremises' - example: CitrixOnPremises - explode: false - in: header - name: Citrix-CustomerId - required: true - schema: - type: string - style: simple - - description: "Citrix authorization header: CWSAuth Bearer={token}" - explode: false - in: header - name: Authorization - required: false - schema: - type: string - style: simple - - description: "Transaction ID that will be used to track this request. If not\ - \ provided, a new GUID will be generated and returned." - explode: false - in: header - name: Citrix-TransactionId - required: false - schema: - type: string - style: simple - - description: Must accept application/json. - example: application/json - explode: false - in: header - name: Accept - required: false - schema: - type: string - style: simple - - description: Locale of the request. - example: en-US - explode: false - in: header - name: Citrix-Locale - required: false - schema: - type: string - style: simple - - description: Preference name. - explode: false - in: path - name: name - required: true - schema: - nullable: true - title: String - type: string - style: simple - x-position: 1 - responses: - "204": - description: Operation is successful with no response content. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -233949,20 +231801,22 @@ paths: schema: type: string style: simple - "400": + "404": content: application/json: example: - https://errors-api.cloud.com/common/outOfRange: + https://errors-api.cloud.com/common/notFound: value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found parameters: - - name: property - value: startTime + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + description: A referenced entity was not found. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -234015,20 +231869,20 @@ paths: schema: type: string style: simple - "401": + "406": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type parameters: - - name: reason - value: missing + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -234081,22 +231935,18 @@ paths: schema: type: string style: simple - "403": + "409": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/optimisticConcurrency: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied - parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: Caller requested an invalid relation to be created or deleted. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -234149,8 +231999,21 @@ paths: schema: type: string style: simple - "404": - description: A referenced entity was not found. + "415": + content: + application/json: + example: + https://errors-api.cloud.com/common/unsupportedMediaType: + value: + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type + parameters: + - name: mediaType + value: application/xml + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -234203,20 +232066,21 @@ paths: schema: type: string style: simple - "406": + "429": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/rateLimitExceeded: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds parameters: - - name: contentType - value: application/json + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + description: Caller has made too many requests in a short period of time + and is being rate-limited. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -234269,152 +232133,21 @@ paths: schema: type: string style: simple - "409": + "503": content: application/json: example: - https://errors-api.cloud.com/common/optimisticConcurrency: + https://errors-api.cloud.com/common/serviceUnavailable: value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "429": - content: - application/json: - example: - https://errors-api.cloud.com/common/rateLimitExceeded: - value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds - parameters: - - name: retryDelay - value: "4" - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "503": - content: - application/json: - example: - https://errors-api.cloud.com/common/serviceUnavailable: - value: - type: https://errors-api.cloud.com/common/serviceUnavailable - detail: Service is unavailable; try again in 4 seconds - parameters: - - name: retryDelay - value: "4" - schema: - $ref: '#/components/schemas/ErrorResponse' - description: "Service is temporarily unable to process the request. Caller\ - \ may attempt the operation again, with exponential back-off." + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -234534,16 +232267,20 @@ paths: schema: type: string style: simple - summary: Delete one of admin preferences by name. + summary: |- + Validate the VDA component selection at catalog level that can be Included/Excluded and features that need enable + during an VDA upgrade using VDA Upgrade Service. tags: - - Me APIs + - MachineCatalogs APIs + /Machines: get: description: |- - Get one of my preferences by name. - Preferences are free-form name/value pairs that are typically used to - keep track of how the user has configured the UI, so that the configuration - is retained across sessions. - operationId: Me_GetMyPreference + Get all the machines in the site. Note that the response + may not contain the entire list of machines; if this happens the + response will have a ContinuationToken + which, if passed, will resume retrieving results from the original + query. + operationId: Machines_GetMachines parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -234554,6 +232291,23 @@ paths: schema: type: string style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple - description: "Citrix authorization header: CWSAuth Bearer={token}" explode: false in: header @@ -234589,24 +232343,101 @@ paths: schema: type: string style: simple - - description: Preference name. - explode: false - in: path - name: name - required: true + - description: |- + Optionally limit the results to machines that are either single or multi-session capable. + If not specified, all types of machines are returned. + explode: true + in: query + name: sessionSupport + required: false + schema: + allOf: + - $ref: '#/components/schemas/SessionSupport' + style: form + x-position: 1 + - description: |- + Optionally limit the results to machines that are either configured or not. + If not specified, only configured machines are returned. + explode: true + in: query + name: configured + required: false + schema: + default: true + nullable: true + title: Boolean + type: boolean + style: form + x-position: 2 + - description: |- + The max number of machines returned by this query. + If not specified, the server might use a default limit of 250 items. + If the specified value is larger than 1000, the server might reject the call. + The default and maximum values depend on server settings. + explode: true + in: query + name: limit + required: false + schema: + format: int32 + nullable: true + title: Int32 + type: integer + style: form + x-position: 3 + - description: |- + If a query cannot be completed, the response will have a + ContinuationToken set. + To obtain more results from the query, pass the + continuation token back into the query to get the next + batch of results. + explode: true + in: query + name: continuationToken + required: false schema: nullable: true title: String type: string - style: simple - x-position: 1 + style: form + x-position: 4 + - description: |- + If `true`, the get machines will be executed as a background task. + The task will have JobType GetMachines. + When the task is complete it will redirect to + GetJobResults. + explode: true + in: query + name: async + required: false + schema: + default: false + nullable: true + title: Boolean + type: boolean + style: form + x-position: 5 + - description: "Optional. A filter string containing object fields requested\ + \ to be returned, the requested fields are separated by comma','.\n \ + \ " + example: "Uid,AgentVersion,AllocationType" + explode: true + in: query + name: fields + required: false + schema: + nullable: true + title: String + type: string + style: form + x-position: 6 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/NameValueStringPairModel' - description: User preferences + $ref: '#/components/schemas/MachineResponseModelCollection' + description: List of machines. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -234659,21 +232490,16 @@ paths: schema: type: string style: simple - "400": - content: - application/json: - example: - https://errors-api.cloud.com/common/outOfRange: - value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range - parameters: - - name: property - value: startTime - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + "202": + description: Async request was accepted and is being processed. headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -234725,20 +232551,20 @@ paths: schema: type: string style: simple - "401": + "400": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/outOfRange: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range parameters: - - name: reason - value: missing + - name: property + value: startTime schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: Caller passed an invalid input. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -234791,22 +232617,20 @@ paths: schema: type: string style: simple - "403": + "401": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -234859,14 +232683,14 @@ paths: schema: type: string style: simple - "404": + "403": content: application/json: example: - https://errors-api.cloud.com/common/notFound: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - name: entityType value: https://identifiers-api.cloud.com/example/widget @@ -234874,7 +232698,7 @@ paths: value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -235194,13 +233018,15 @@ paths: schema: type: string style: simple - summary: Get one of my preferences by name. + summary: Get all machines in the site. tags: - - Me APIs - /RebootSchedules: - get: - description: Get a list of reboot schedules from all delivery groups. - operationId: RebootSchedules_GetRebootSchedules + - Machines APIs + /Machines/$search: + post: + description: "Perform an advanced search for machines. Note that some combinations\n\ + of search parameters may result in slow performance.\n\nThe 'SessionSupport'\ + \ \nmust be included in search filters." + operationId: Machines_DoMachineSearch parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -235263,13 +233089,95 @@ paths: schema: type: string style: simple + - description: |- + The max number of machines returned by this query. + If not specified, the server might use a default limit of 250 items. + If the specified value is larger than 1000, the server might reject the call. + The default and maximum values depend on server settings. + explode: true + in: query + name: limit + required: false + schema: + format: int32 + nullable: true + title: Int32 + type: integer + style: form + x-position: 2 + - description: |- + If a query cannot be completed, the response will have a + ContinuationToken set. + To obtain more results from the query, pass the + continuation token back into the query to get the next + batch of results. + explode: true + in: query + name: continuationToken + required: false + schema: + nullable: true + title: String + type: string + style: form + x-position: 3 + - description: |- + Optional filter, removing unspecified properties that otherwise would + have been sent by the server + explode: true + in: query + name: fields + required: false + schema: + nullable: true + title: String + type: string + style: form + x-position: 4 + - description: |- + If `true`, the search machines will be executed as a background task. + The task will have JobType DoMachineSearch. + When the task is complete it will redirect to + GetJobResults. + explode: true + in: query + name: async + required: false + schema: + default: false + nullable: true + title: Boolean + type: boolean + style: form + x-position: 5 + - description: The number of machines to skip. + explode: true + in: query + name: skip + required: false + schema: + format: int32 + nullable: true + title: Int32 + type: integer + style: form + x-position: 6 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MachineAndSessionSearchRequestModel' + description: Specifies the advanced search parameters. + required: true + x-name: searchRequest + x-position: 1 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/RebootScheduleResponseModelCollection' - description: List of reboot schedules. + $ref: '#/components/schemas/MachineResponseModelCollection' + description: List of machines that match the search criteria. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -235322,87 +233230,16 @@ paths: schema: type: string style: simple - "400": - content: - application/json: - example: - https://errors-api.cloud.com/common/outOfRange: - value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range - parameters: - - name: property - value: startTime - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + "202": + description: Async request was accepted and is being processed. headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" explode: false schema: type: string style: simple - "401": - content: - application/json: - example: - https://errors-api.cloud.com/common/authentication: - value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details - parameters: - - name: reason - value: missing - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. - headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -235454,22 +233291,20 @@ paths: schema: type: string style: simple - "403": + "400": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/outOfRange: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: property + value: startTime schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: Caller passed an invalid input. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -235522,20 +233357,20 @@ paths: schema: type: string style: simple - "406": + "401": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: contentType - value: application/json + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -235588,21 +233423,22 @@ paths: schema: type: string style: simple - "429": + "403": content: application/json: example: - https://errors-api.cloud.com/common/rateLimitExceeded: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - - name: retryDelay - value: "4" + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -235655,21 +233491,20 @@ paths: schema: type: string style: simple - "503": + "406": content: application/json: example: - https://errors-api.cloud.com/common/serviceUnavailable: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/serviceUnavailable - detail: Service is unavailable; try again in 4 seconds + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type parameters: - - name: retryDelay - value: "4" + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: "Service is temporarily unable to process the request. Caller\ - \ may attempt the operation again, with exponential back-off." + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -235722,21 +233557,18 @@ paths: schema: type: string style: simple - "500": + "409": content: application/json: example: - https://errors-api.cloud.com/common/internalServerError: + https://errors-api.cloud.com/common/optimisticConcurrency: value: - type: https://errors-api.cloud.com/common/internalServerError - detail: An internal server error has occurred; try again in 4 - seconds - parameters: - - name: retryDelay - value: "4" + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null schema: $ref: '#/components/schemas/ErrorResponse' - description: An unexpected server error occurred. + description: Caller requested an invalid relation to be created or deleted. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -235789,18 +233621,281 @@ paths: schema: type: string style: simple - summary: Get all reboot schedules in the site. + "415": + content: + application/json: + example: + https://errors-api.cloud.com/common/unsupportedMediaType: + value: + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type + parameters: + - name: mediaType + value: application/xml + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "429": + content: + application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller has made too many requests in a short period of time + and is being rate-limited. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "503": + content: + application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "500": + content: + application/json: + example: + https://errors-api.cloud.com/common/internalServerError: + value: + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: An unexpected server error occurred. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + summary: Perform an advanced search for machines. tags: - - RebootSchedules APIs - /Sessions: - get: - description: |- - Get all the sessions in the site. Note that the response - may not contain the entire list of sessions; if this happens the - response will have a ContinuationToken - which, if passed, will resume retrieving results from the original - query. - operationId: Sessions_GetSessions + - Machines APIs + /Machines/{name}: + head: + description: Check for the existence of a machine by name + operationId: Machines_CheckMachineExists parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -235863,75 +233958,20 @@ paths: schema: type: string style: simple - - description: |- - The max number of sessions returned by this query. - If not specified, the server might use a default limit of 250 items. - If the specified value is larger than 1000, the server might reject the call. - The default and maximum values depend on server settings. - explode: true - in: query - name: limit - required: false - schema: - format: int32 - nullable: true - title: Int32 - type: integer - style: form - x-position: 1 - - description: |- - If a query cannot be completed, the response will have a - ContinuationToken set. - To obtain more results from the query, pass the - continuation token back into the query to get the next - batch of results. - explode: true - in: query - name: continuationToken - required: false - schema: - nullable: true - title: String - type: string - style: form - x-position: 2 - - description: |- - If `true`, the get sessions will be executed as a background task. - The task will have JobType GetSessions. - When the task is complete it will redirect to - GetJobResults. - explode: true - in: query - name: async - required: false - schema: - default: false - nullable: true - title: Boolean - type: boolean - style: form - x-position: 3 - - description: "Optional. A filter string containing object fields requested\ - \ to be returned, the requested fields are separated by comma','.\n \ - \ " - example: "Id,Uid,ApplicationsInUse" - explode: true - in: query - name: fields - required: false + - description: Name of the machine. + explode: false + in: path + name: name + required: true schema: nullable: true title: String type: string - style: form - x-position: 4 + style: simple + x-position: 1 responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SessionResponseModelCollection' - description: List of sessions. + "204": + description: Operation is successful with no response content. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -235984,16 +234024,21 @@ paths: schema: type: string style: simple - "202": - description: Async request was accepted and is being processed. - headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime schema: - type: string - style: simple + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -236045,20 +234090,20 @@ paths: schema: type: string style: simple - "400": + "401": content: application/json: example: - https://errors-api.cloud.com/common/outOfRange: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: property - value: startTime + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -236111,20 +234156,22 @@ paths: schema: type: string style: simple - "401": + "403": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - - name: reason - value: missing + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -236177,14 +234224,14 @@ paths: schema: type: string style: simple - "403": + "404": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/notFound: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found parameters: - name: entityType value: https://identifiers-api.cloud.com/example/widget @@ -236192,7 +234239,7 @@ paths: value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: A referenced entity was not found. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -236512,15 +234559,12 @@ paths: schema: type: string style: simple - summary: Get all sessions in the site. + summary: Check for the existence of a machine by name. tags: - - Sessions APIs - /Sessions/$search: - post: - description: |- - Perform an advanced search for sessions. Note that some combinations - of search parameters may result in slow performance. - operationId: Sessions_DoSessionSearch + - Machines APIs + /Machines/{nameOrId}: + delete: + operationId: Machines_RemoveMachine parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -236565,6 +234609,19 @@ paths: schema: type: string style: simple + - description: "Admin credential to use when performing the operation. If not\ + \ specified, the operation will be performed using the account under which\ + \ the identity service is running If specified, must be in a format matching\ + \ that of the standard 'Authorization' request header; the username and\ + \ password separated by a colon, UTF8-encoded, then base64-encoded, then\ + \ the \"Basic \" scheme prepended.\r\nExample:Basic QWxhZGRpbjpPcGVuU2VzYW1l" + explode: false + in: header + name: X-AdminCredential + required: false + schema: + type: string + style: simple - description: Must accept application/json. example: application/json explode: false @@ -236583,95 +234640,81 @@ paths: schema: type: string style: simple + - description: "Machine to remove. May be specified by SamName, UPN, or SID." + explode: false + in: path + name: nameOrId + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 1 - description: |- - The max number of sessions returned by this query. - If not specified, the server might use a default limit of 250 items. - If the specified value is larger than 1000, the server might reject the call. - The default and maximum values depend on server settings. + Specifies whether to delete the virtual machines, or just the machine record + in the site database. + Only relevant when ProvisioningType + Optional; default is `true`. explode: true in: query - name: limit + name: deleteVm required: false schema: - format: int32 - nullable: true - title: Int32 - type: integer + default: true + title: Boolean + type: boolean style: form x-position: 2 - description: |- - If a query cannot be completed, the response will have a - ContinuationToken set. - To obtain more results from the query, pass the - continuation token back into the query to get the next - batch of results. + Specifies whether to only delete virtual machines record that were provisioned in the machine catalog from database, + not access hypervisor to delete virtual machines, this is recommended only when hypervisor cannot be accessed. + + Optional; default is `false`. explode: true in: query - name: continuationToken + name: purgeDBOnly required: false schema: - nullable: true - title: String - type: string + default: false + title: Boolean + type: boolean style: form x-position: 3 - description: |- - Optional filter, removing unspecified properties that otherwise would - have been sent by the server + Specifies what to do with the machine account in AD. Optional; default is + Leave. + Only relevant when `deleteVm` is `true`; otherwise, ignored. explode: true in: query - name: fields + name: deleteAccount required: false schema: - nullable: true - title: String - type: string + allOf: + - $ref: '#/components/schemas/MachineAccountDeleteOption' + default: Leave style: form x-position: 4 - description: |- - If `true`, the search sessions will be executed as a background task. - The task will have JobType DoSessionSearch. + If `true`, the machine will be deleted as a background task. + The task will have JobType DeleteMachine. When the task is complete it will redirect to - GetJobResults. + The job's Parameters will contain properties: + * _Id_ - ID of the machine being deleted, + * _Name_ - Name of the machine being deleted. explode: true in: query name: async required: false schema: default: false - nullable: true title: Boolean type: boolean style: form x-position: 5 - - description: The number of sessions to skip. - explode: true - in: query - name: skip - required: false - schema: - format: int32 - nullable: true - title: Int32 - type: integer - style: form - x-position: 6 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MachineAndSessionSearchRequestModel' - description: Specifies the advanced search parameters. - required: true - x-name: searchRequest - x-position: 1 responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SessionResponseModelCollection' - description: List of sessions that match the search criteria. + "204": + description: Operation is successful with no response content. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -236985,20 +235028,8 @@ paths: schema: type: string style: simple - "406": - content: - application/json: - example: - https://errors-api.cloud.com/common/notAcceptable: - value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type - parameters: - - name: contentType - value: application/json - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + "404": + description: A referenced entity was not found. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -237051,18 +235082,20 @@ paths: schema: type: string style: simple - "409": + "406": content: application/json: example: - https://errors-api.cloud.com/common/optimisticConcurrency: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -237115,21 +235148,18 @@ paths: schema: type: string style: simple - "415": + "409": content: application/json: example: - https://errors-api.cloud.com/common/unsupportedMediaType: + https://errors-api.cloud.com/common/optimisticConcurrency: value: - type: https://errors-api.cloud.com/common/unsupportedMediaType - detail: Must use application/json;charset=utf-8 media type - parameters: - - name: mediaType - value: application/xml + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must send request body in utf-8 and specify request - Content-Type as utf-8. + description: Caller requested an invalid relation to be created or deleted. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -237383,13 +235413,12 @@ paths: schema: type: string style: simple - summary: Perform an advanced search for sessions. + summary: Delete a machine from the site. tags: - - Sessions APIs - /Sessions/{id}: + - Machines APIs get: - description: Get details of a single session. - operationId: Sessions_GetSession + description: Get details of a single machine + operationId: Machines_GetMachine parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -237452,10 +235481,10 @@ paths: schema: type: string style: simple - - description: ID of the session. + - description: Name or ID of the machine. explode: false in: path - name: id + name: nameOrId required: true schema: nullable: true @@ -237464,7 +235493,7 @@ paths: style: simple x-position: 1 - description: The requested fields. - example: "Id,Uid,ApplicationsInUse" + example: "Uid,AgentVersion,AllocationType" explode: true in: query name: fields @@ -237480,8 +235509,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SessionResponseModel' - description: Details of the session. + $ref: '#/components/schemas/MachineDetailResponseModel' + description: Details of the machine. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -238069,13 +236098,14 @@ paths: schema: type: string style: simple - summary: Get details of a single session. + summary: Get details of a single machine. tags: - - Sessions APIs - /Sessions/{id}/$disconnect: - post: - description: Disconnect a session. - operationId: Sessions_DisconnectSession + - Machines APIs + patch: + description: |- + Update a machine. Typically used to change the assignment of a + statically-assigned machine. + operationId: Machines_UpdateMachineCatalogMachine parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -238138,10 +236168,10 @@ paths: schema: type: string style: simple - - description: ID of the session to disconnect. + - description: "Machine to update. May be specified by name, ID, or SID." explode: false in: path - name: id + name: nameOrId required: true schema: nullable: true @@ -238150,14 +236180,14 @@ paths: style: simple x-position: 1 - description: |- - If `true`, the session will be disconnected as a background task. - The task will have JobType . + If `true`, the tag will be created as a background task. + The task will have JobType UpdateMachineCatalogMachine. When the task is complete it will redirect to - . - The job's will contain properties: - + "GetMachine(string)". + The job's Parameters will contain properties: - * _Id_ - ID of the session being disconnected. + * _Id_ - ID of the machine being updated, + * _Name_ - Name of the machine being updated. explode: true in: query name: async @@ -238168,14 +236198,19 @@ paths: title: Boolean type: boolean style: form + x-position: 3 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateMachineRequestModel' + description: Details of the machine to update. + required: true + x-name: update x-position: 2 responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SessionResponseModel' - description: Details of the session. + "204": + description: Operation is successful with no response content. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -238623,18 +236658,21 @@ paths: schema: type: string style: simple - "409": + "415": content: application/json: example: - https://errors-api.cloud.com/common/optimisticConcurrency: + https://errors-api.cloud.com/common/unsupportedMediaType: value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type + parameters: + - name: mediaType + value: application/xml schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -238888,12 +236926,13 @@ paths: schema: type: string style: simple - summary: Disconnect a session. + summary: Update a machine. tags: - - Sessions APIs - /Sessions/{id}/$hide: + - Machines APIs + /Machines/{nameOrId}/$disconnect: post: - operationId: Sessions_HideSession + description: Disconnect all sessions on a machine. + operationId: Machines_DisconnectSessions parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -238956,10 +236995,10 @@ paths: schema: type: string style: simple - - description: ID of the session to hide or unhide. + - description: Machine to disconnect sessions from. explode: false in: path - name: id + name: nameOrId required: true schema: nullable: true @@ -238967,7 +237006,27 @@ paths: type: string style: simple x-position: 1 - - description: "If `true`, the session will be hidden as a background task." + - description: |- + Identify if the API need to return detail info in response model. + Set to false will improve performance with return basic machine model. + explode: true + in: query + name: detailResponseRequired + required: false + schema: + default: true + title: Boolean + type: boolean + style: form + x-position: 2 + - description: |- + If `true`, the session will be disconnected as a background task. + The task will have JobType DisconnectSessions. + When the task is complete it will redirect to + GetMachine. + The job's Parameters will contain properties: + * _Id_ - ID of the machine on which sessions are being disconnected. + * _Name_ - Name of the machine on which sessions are being disconnected. explode: true in: query name: async @@ -238978,10 +237037,14 @@ paths: title: Boolean type: boolean style: form - x-position: 2 + x-position: 3 responses: - "204": - description: Operation is successful with no response content. + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/MachineDetailResponseModel' + description: Detail of the machine. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -239694,13 +237757,13 @@ paths: schema: type: string style: simple - summary: Hide a session + summary: Disconnect all sessions on a machine. tags: - - Sessions APIs - /Sessions/{id}/$logoff: + - Machines APIs + /Machines/{nameOrId}/$logoff: post: - description: Logoff a session. - operationId: Sessions_LogoffSession + description: Logoff all sessions on a machine + operationId: Machines_LogoffMachineSessions parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -239763,10 +237826,10 @@ paths: schema: type: string style: simple - - description: ID of the session to log off. + - description: Machine to log sessions off from. explode: false in: path - name: id + name: nameOrId required: true schema: nullable: true @@ -239775,14 +237838,28 @@ paths: style: simple x-position: 1 - description: |- - If `true`, the session will be logged off as a background task. + Identify if the API need to return detail info in response model. + Set to false will improve performance with return basic machine model. + explode: true + in: query + name: detailResponseRequired + required: false + schema: + default: true + title: Boolean + type: boolean + style: form + x-position: 2 + - description: |- + If `true`, the sessions will be logged off as a background task. The task will have JobType . When the task is complete it will redirect to . The job's will contain properties: - * _Id_ - ID of the session being logged off. + * _Id_ - ID of the machine which sessions are being logged off from, + * _Name_ - Name of the machine which sessions are being logged off from. explode: true in: query name: async @@ -239793,72 +237870,76 @@ paths: title: Boolean type: boolean style: form - x-position: 2 + x-position: 3 responses: - "204": - description: Operation is successful with no response content. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false + "200": + content: + application/json: schema: - type: string - style: simple - "202": - description: Async request was accepted and is being processed. + $ref: '#/components/schemas/MachineDetailResponseModel' + description: Machine detail. headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false - schema: - type: string - style: simple + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "202": + description: Async request was accepted and is being processed. + headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -240509,13 +238590,13 @@ paths: schema: type: string style: simple - summary: Logoff a session. + summary: Logoff all sessions on a machine. tags: - - Sessions APIs - /Sessions/{id}/$sendMessage: + - Machines APIs + /Machines/{nameOrId}/$reboot: post: - description: Send a message to a session. - operationId: Sessions_SendSessionMessage + description: Reboot a machine. The machine must be capable of power management. + operationId: Machines_RebootMachine parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -240578,10 +238659,10 @@ paths: schema: type: string style: simple - - description: ID of the session to send a message to. + - description: Machine to reboot. explode: false in: path - name: id + name: nameOrId required: true schema: nullable: true @@ -240590,14 +238671,42 @@ paths: style: simple x-position: 1 - description: |- - If `true`, the message will be sent as a background task. - The task will have JobType . + If `true`, the machine will be forced to reboot without waiting for user + activity to stop. This may cause loss of user data if work is not saved. + explode: true + in: query + name: force + required: false + schema: + default: false + nullable: true + title: Boolean + type: boolean + style: form + x-position: 2 + - description: |- + Identify if the API need to return detail info in response model. + Set to false will improve performance with return basic machine model. + explode: true + in: query + name: detailResponseRequired + required: false + schema: + default: true + title: Boolean + type: boolean + style: form + x-position: 3 + - description: |- + If `true`, the machine will be rebooted as a background task. + This is recommended as this operation may take some time to run, and if it + exceeds 90 seconds the request may time out. + The task will have JobType RebootMachines. When the task is complete it will redirect to - . - The job's will contain properties: - - - * _Id_ - ID of the session to which a message is being sent. + GetMachine. + The job's Parameters will contain properties: + * _Id_ - ID of the machine being rebooted, + * _Name_ - Name of the machine being rebooted. explode: true in: query name: async @@ -240608,23 +238717,14 @@ paths: title: Boolean type: boolean style: form - x-position: 3 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SendMessageRequestModel' - description: Details of the message to send. - required: true - x-name: message - x-position: 2 + x-position: 4 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/SessionResponseModel' - description: Details of the session. + $ref: '#/components/schemas/MachineDetailResponseModel' + description: Machine detail. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -241136,73 +239236,6 @@ paths: schema: type: string style: simple - "415": - content: - application/json: - example: - https://errors-api.cloud.com/common/unsupportedMediaType: - value: - type: https://errors-api.cloud.com/common/unsupportedMediaType - detail: Must use application/json;charset=utf-8 media type - parameters: - - name: mediaType - value: application/xml - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller must send request body in utf-8 and specify request - Content-Type as utf-8. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple "429": content: application/json: @@ -241404,13 +239437,12 @@ paths: schema: type: string style: simple - summary: Send a message to a session. + summary: Reboot a machine. tags: - - Sessions APIs - /Sessions/{id}/$startRecording: + - Machines APIs + /Machines/{nameOrId}/$ResetProvVMDisk: post: - description: start recording for a session. - operationId: Sessions_StartSessionRecording + operationId: Machines_ResetProvVMDisk parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -241473,10 +239505,11 @@ paths: schema: type: string style: simple - - description: ID of the session. + - description: "Name or ID of the machine. May be specified by name, ID, or\ + \ SID." explode: false in: path - name: id + name: nameOrId required: true schema: nullable: true @@ -241484,27 +239517,13 @@ paths: type: string style: simple x-position: 1 - - description: Whether to notify session user or not. - explode: true - in: query - name: notifyUser - required: false - schema: - default: true - nullable: true - title: Boolean - type: boolean - style: form - x-position: 2 - description: |- - If `true`, the session will be recorded as a background task. - The task will have JobType . + If `true`, the machine will be deleted as a background task. + The task will have JobType ResetVMDisk. When the task is complete it will redirect to - . - The job's will contain properties: - - - * _Id_ - ID of the session. + The job's Parameters will contain properties: + * _Id_ - ID of the machine being deleted, + * _Name_ - Name of the machine being deleted. explode: true in: query name: async @@ -241515,14 +239534,10 @@ paths: title: Boolean type: boolean style: form - x-position: 3 + x-position: 2 responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SessionResponseModel' - description: Details of the session. + "204": + description: Operation is successful with no response content. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -242235,13 +240250,15 @@ paths: schema: type: string style: simple - summary: start recording for a session. + summary: Resets the OS disk of persistent VMs to the current master image. tags: - - Sessions APIs - /Sessions/{id}/$stopRecording: + - Machines APIs + /Machines/{nameOrId}/$resume: post: - description: stop recording for a session. - operationId: Sessions_StopSessionRecording + description: |- + Resume a machine after it has been suspended. The machine must be capable of + power management. + operationId: Machines_ResumeMachine parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -242304,10 +240321,10 @@ paths: schema: type: string style: simple - - description: ID of the session. + - description: Machine to resume. explode: false in: path - name: id + name: nameOrId required: true schema: nullable: true @@ -242316,14 +240333,28 @@ paths: style: simple x-position: 1 - description: |- - If `true`, the session will be recorded as a background task. - The task will have JobType . + Identify if the API need to return detail info in response model. + Set to false will improve performance with return basic machine model. + explode: true + in: query + name: detailResponseRequired + required: false + schema: + default: true + title: Boolean + type: boolean + style: form + x-position: 2 + - description: |- + If `true`, the machine will be resumed as a background task. + This is recommended as this operation may take some time to run, and if it + exceeds 90 seconds the request may time out. + The task will have JobType ResumeMachines. When the task is complete it will redirect to - . - The job's will contain properties: - - - * _Id_ - ID of the session. + GetMachine. + The job's Parameters will contain properties: + * _Id_ - ID of the machine being resumed, + * _Name_ - Name of the machine being resumed. explode: true in: query name: async @@ -242334,14 +240365,14 @@ paths: title: Boolean type: boolean style: form - x-position: 2 + x-position: 3 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/SessionResponseModel' - description: Details of the session. + $ref: '#/components/schemas/MachineDetailResponseModel' + description: Machine detail. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -243054,12 +241085,15 @@ paths: schema: type: string style: simple - summary: stop recording for a session. + summary: Resume a machine. tags: - - Sessions APIs - /Sessions/{id}/$unhide: + - Machines APIs + /Machines/{nameOrId}/$shutdown: post: - operationId: Sessions_UnhideSession + description: |- + Shut down (power-off) a machine. The machine must be capable of power + management. + operationId: Machines_ShutdownMachine parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -243122,10 +241156,10 @@ paths: schema: type: string style: simple - - description: ID of the session to hide or unhide. + - description: Machine to shut down. explode: false in: path - name: id + name: nameOrId required: true schema: nullable: true @@ -243133,10 +241167,12 @@ paths: type: string style: simple x-position: 1 - - description: "If `true`, the session will be hidden as a background task." + - description: |- + If `true`, the machine will be forced to shut down without waiting for user + activity to stop. This may cause loss of user data if work is not saved. explode: true in: query - name: async + name: force required: false schema: default: false @@ -243145,9 +241181,61 @@ paths: type: boolean style: form x-position: 2 + - description: |- + Identify if the API need to return detail info in response model. + Set to false will improve performance with return basic machine model. + explode: true + in: query + name: detailResponseRequired + required: false + schema: + default: true + title: Boolean + type: boolean + style: form + x-position: 3 + - description: |- + If `true`, the machine will be shut down as a background task. + This is recommended as this operation may take some time to run, and if it + exceeds 90 seconds the request may time out. + The task will have JobType ShutDownMachines. + When the task is complete it will redirect to + GetMachine. + The job's Parameters will contain properties: + * _Id_ - ID of the machine being shut down, + * _Name_ - Name of the machine being shut down. + explode: true + in: query + name: async + required: false + schema: + default: false + nullable: true + title: Boolean + type: boolean + style: form + x-position: 4 + - description: |- + Shutdown a machine after the specified number of seconds delay, + If `null`, the machine will be shut down without delay. + explode: true + in: query + name: delay + required: false + schema: + format: int32 + nullable: true + title: Int32 + type: integer + style: form + x-position: 5 responses: - "204": - description: Operation is successful with no response content. + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/MachineDetailResponseModel' + description: Machine detail. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -243860,13 +241948,14 @@ paths: schema: type: string style: simple - summary: Unhide a session + summary: Shut down a machine. tags: - - Sessions APIs - /Sessions/{id}/Applications: - get: - description: Get the list of applications running within a session. - operationId: Sessions_GetSessionApplications + - Machines APIs + /Machines/{nameOrId}/$start: + post: + description: Start (power-on) a machine. The machine must be capable of power + management. + operationId: Machines_StartMachine parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -243929,10 +242018,10 @@ paths: schema: type: string style: simple - - description: ID of the session. + - description: Machine to start. explode: false in: path - name: id + name: nameOrId required: true schema: nullable: true @@ -243941,13 +242030,28 @@ paths: style: simple x-position: 1 - description: |- - If `true`, the get applications will be executed as a background task. - The task will have JobType GetSessionApplications. + Identify if the API need to return detail info in response model. + Set to false will improve performance with return basic machine model. + explode: true + in: query + name: detailResponseRequired + required: false + schema: + default: true + title: Boolean + type: boolean + style: form + x-position: 2 + - description: |- + If `true`, the machine will be started as a background task. + This is recommended as this operation may take some time to run, and if it + exceeds 90 seconds the request may time out. + The task will have JobType StartMachines. When the task is complete it will redirect to - GetJobResults. + GetMachine. The job's Parameters will contain properties: - - * _Id_ - ID of the session being queried. + * _Id_ - ID of the machine being started, + * _Name_ - Name of the machine being started. explode: true in: query name: async @@ -243958,14 +242062,14 @@ paths: title: Boolean type: boolean style: form - x-position: 2 + x-position: 3 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/ApplicationResponseModelCollection' - description: List of applications. + $ref: '#/components/schemas/MachineDetailResponseModel' + description: Machine detail. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -244413,6 +242517,70 @@ paths: schema: type: string style: simple + "409": + content: + application/json: + example: + https://errors-api.cloud.com/common/optimisticConcurrency: + value: + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller requested an invalid relation to be created or deleted. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple "429": content: application/json: @@ -244614,13 +242782,13 @@ paths: schema: type: string style: simple - summary: Get the list of applications running within a session. + summary: Start a machine. tags: - - Sessions APIs - /Sessions/{id}/Machine: - get: - description: Get the details of the machine on which a session is running. - operationId: Sessions_GetSessionMachine + - Machines APIs + /Machines/{nameOrId}/$suspend: + post: + description: Suspend a machine. The machine must be capable of power management. + operationId: Machines_SuspendMachine parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -244683,10 +242851,10 @@ paths: schema: type: string style: simple - - description: ID of the session. + - description: Machine to suspend. explode: false in: path - name: id + name: nameOrId required: true schema: nullable: true @@ -244694,13 +242862,61 @@ paths: type: string style: simple x-position: 1 + - description: |- + Identify if the API need to return detail info in response model. + Set to false will improve performance with return basic machine model. + explode: true + in: query + name: detailResponseRequired + required: false + schema: + default: true + title: Boolean + type: boolean + style: form + x-position: 2 + - description: |- + If `true`, the machine will be suspended as a background task. + This is recommended as this operation may take some time to run, and if it + exceeds 90 seconds the request may time out. + The task will have JobType SuspendMachines. + When the task is complete it will redirect to + GetMachine. + The job's Parameters will contain properties: + * _Id_ - ID of the machine being suspended, + * _Name_ - Name of the machine being suspended. + explode: true + in: query + name: async + required: false + schema: + default: false + nullable: true + title: Boolean + type: boolean + style: form + x-position: 3 + - description: |- + Suspend a machine after the specified number of seconds delay, + If `null`, the machine will be suspended without delay. + explode: true + in: query + name: delay + required: false + schema: + format: int32 + nullable: true + title: Int32 + type: integer + style: form + x-position: 4 responses: "200": content: application/json: schema: $ref: '#/components/schemas/MachineDetailResponseModel' - description: Details of the machine. + description: Machine detail. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -244753,6 +242969,67 @@ paths: schema: type: string style: simple + "202": + description: Async request was accepted and is being processed. + headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple "400": content: application/json: @@ -245087,6 +243364,70 @@ paths: schema: type: string style: simple + "409": + content: + application/json: + example: + https://errors-api.cloud.com/common/optimisticConcurrency: + value: + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller requested an invalid relation to be created or deleted. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple "429": content: application/json: @@ -245288,13 +243629,12 @@ paths: schema: type: string style: simple - summary: Get the details of the machine on which a session is running. + summary: Suspend a machine. tags: - - Sessions APIs - /Sessions/RecordingStatus: - get: - description: get session recording status of a session. - operationId: Sessions_GetSessionRecordingStatus + - Machines APIs + /Machines/{nameOrId}/$test: + post: + operationId: Machines_TestMachine parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -245357,24 +243697,24 @@ paths: schema: type: string style: simple - - description: ID of the session. - explode: true - in: query - name: id + - description: Name or ID of the machine to test. + explode: false + in: path + name: nameOrId required: true schema: nullable: true title: String type: string - style: form + style: simple x-position: 1 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/SessionRecordingStatusResponseModel' - description: "" + $ref: '#/components/schemas/MachineTestResponseModel' + description: Machine test report. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -245627,6 +243967,74 @@ paths: schema: type: string style: simple + "404": + content: + application/json: + example: + https://errors-api.cloud.com/common/notFound: + value: + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: A referenced entity was not found. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple "406": content: application/json: @@ -245693,21 +244101,18 @@ paths: schema: type: string style: simple - "429": + "409": content: application/json: example: - https://errors-api.cloud.com/common/rateLimitExceeded: + https://errors-api.cloud.com/common/optimisticConcurrency: value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds - parameters: - - name: retryDelay - value: "4" + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. + description: Caller requested an invalid relation to be created or deleted. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -245760,21 +244165,21 @@ paths: schema: type: string style: simple - "503": + "429": content: application/json: example: - https://errors-api.cloud.com/common/serviceUnavailable: + https://errors-api.cloud.com/common/rateLimitExceeded: value: - type: https://errors-api.cloud.com/common/serviceUnavailable - detail: Service is unavailable; try again in 4 seconds + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds parameters: - name: retryDelay value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: "Service is temporarily unable to process the request. Caller\ - \ may attempt the operation again, with exponential back-off." + description: Caller has made too many requests in a short period of time + and is being rate-limited. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -245827,21 +244232,21 @@ paths: schema: type: string style: simple - "500": + "503": content: application/json: example: - https://errors-api.cloud.com/common/internalServerError: + https://errors-api.cloud.com/common/serviceUnavailable: value: - type: https://errors-api.cloud.com/common/internalServerError - detail: An internal server error has occurred; try again in 4 - seconds + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds parameters: - name: retryDelay value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: An unexpected server error occurred. + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -245894,12 +244299,80 @@ paths: schema: type: string style: simple - summary: get session recording status of a session. + "500": + content: + application/json: + example: + https://errors-api.cloud.com/common/internalServerError: + value: + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: An unexpected server error occurred. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + summary: Run Cloud Health Check on a VDA machine. tags: - - Sessions APIs - /Sites: + - Machines APIs + /Machines/{nameOrId}/Administrators: get: - operationId: Sites_GetSites + description: Get administrators who can administer a machine. + operationId: Machines_GetMachinesAdministrators parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -245910,6 +244383,23 @@ paths: schema: type: string style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple - description: "Citrix authorization header: CWSAuth Bearer={token}" explode: false in: header @@ -245945,13 +244435,24 @@ paths: schema: type: string style: simple + - description: "SamName, UPN, or SID of the machine." + explode: false + in: path + name: nameOrId + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 1 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/SiteResponseModelCollection' - description: List of sites. + $ref: '#/components/schemas/AdministratorResponseModelCollection' + description: List of administrators. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -246204,6 +244705,74 @@ paths: schema: type: string style: simple + "404": + content: + application/json: + example: + https://errors-api.cloud.com/common/notFound: + value: + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: A referenced entity was not found. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple "406": content: application/json: @@ -246471,13 +245040,17 @@ paths: schema: type: string style: simple - summary: Get the list of sites that are available to the customer and visible - to the admin. + summary: Get administrators who can administer a machine tags: - - Sites APIs - /Sites/{nameOrId}: + - Machines APIs + /Machines/{nameOrId}/Applications: get: - operationId: Sites_GetSite + description: |- + Get the list of applications published or in use on a machine. + At least one of Published + or InUse + will be `true` for each application returned. + operationId: Machines_GetMachineApplications parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -246488,6 +245061,23 @@ paths: schema: type: string style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple - description: "Citrix authorization header: CWSAuth Bearer={token}" explode: false in: header @@ -246523,7 +245113,7 @@ paths: schema: type: string style: simple - - description: Name or ID of the site. + - description: Name or ID of the machine. explode: false in: path name: nameOrId @@ -246539,8 +245129,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SiteDetailResponseModel' - description: Site details. + $ref: '#/components/schemas/MachineApplicationResponseModelCollection' + description: List of applications. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -247128,15 +245718,13 @@ paths: schema: type: string style: simple - summary: Get the details about a single site. + summary: Get the list of applications on a machine. tags: - - Sites APIs - /Sites/{nameOrId}/$test: - post: - description: |- - Run tests on a site and create a test report. Obtain the most recent report - from GetSiteTestReport. - operationId: Sites_TestSite + - Machines APIs + /Machines/{nameOrId}/DeliveryGroup: + get: + description: Get the details of the delivery group in which a machine resides. + operationId: Machines_GetMachineDeliveryGroup parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -247147,6 +245735,23 @@ paths: schema: type: string style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple - description: "Citrix authorization header: CWSAuth Bearer={token}" explode: false in: header @@ -247182,7 +245787,7 @@ paths: schema: type: string style: simple - - description: Name or ID of the site. + - description: Name or ID of the machine. explode: false in: path name: nameOrId @@ -247193,34 +245798,15 @@ paths: type: string style: simple x-position: 1 - - description: |- - If `true`, the tests will run as a background task. This is recommended as the - tests may take some time to run, and if it exceeds 90 seconds the request may - time out. The task will have JobType TestSite. - When the task is complete it will redirect to - GetJobResults. The job's - Parameters will contain properties: - - * _Id_ - ID of the site being tested. - * _Name_ - Name of the site being tested. - explode: true - in: query - name: async - required: false - schema: - default: false - nullable: true - title: Boolean - type: boolean - style: form - x-position: 2 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/SiteTestResponseModel' - description: Site test details. + $ref: '#/components/schemas/DeliveryGroupDetailResponseModel' + description: |- + Details of the delivery group. If the machine is not a member of + a delivery group, the response will be `204 No Content`. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -247273,67 +245859,6 @@ paths: schema: type: string style: simple - "202": - description: Async request was accepted and is being processed. - headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false - schema: - type: string - style: simple - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple "400": content: application/json: @@ -247668,70 +246193,6 @@ paths: schema: type: string style: simple - "409": - content: - application/json: - example: - https://errors-api.cloud.com/common/optimisticConcurrency: - value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple "429": content: application/json: @@ -247933,12 +246394,14 @@ paths: schema: type: string style: simple - summary: Run tests on a site and create a test report. + summary: Get the delivery group for a machine. tags: - - Sites APIs - /Sites/{nameOrId}/MultipleRemotePCAssignments: + - Machines APIs + /Machines/{nameOrId}/Desktop: get: - operationId: Sites_GetMultipleRemotePCAssignments + description: "Get the details of the desktop associated with the machine, if\ + \ any." + operationId: Machines_GetMachineDesktop parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -247949,6 +246412,23 @@ paths: schema: type: string style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple - description: "Citrix authorization header: CWSAuth Bearer={token}" explode: false in: header @@ -247984,7 +246464,7 @@ paths: schema: type: string style: simple - - description: Name or ID of the site. + - description: Name or ID of the machine. explode: false in: path name: nameOrId @@ -248000,10 +246480,10 @@ paths: content: application/json: schema: - title: Boolean - type: boolean - description: The result indicating if allow multi-user auto-assignment for - Remote PC Access. + $ref: '#/components/schemas/DesktopResponseModel' + description: |- + Details of the desktop. If the machine is not associated with a + desktop, the response will be `204 No Content`. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -248591,11 +247071,12 @@ paths: schema: type: string style: simple - summary: Get multi-user auto-assignment for Remote PC Access. + summary: "Get the desktop associated with the machine, if any." tags: - - Sites APIs - patch: - operationId: Sites_PatchMultipleRemotePCAssignments + - Machines APIs + /Machines/{nameOrId}/FileTypes/$import: + post: + operationId: Machines_ImportFileTypes parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -248606,6 +247087,23 @@ paths: schema: type: string style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple - description: "Citrix authorization header: CWSAuth Bearer={token}" explode: false in: header @@ -248641,7 +247139,7 @@ paths: schema: type: string style: simple - - description: Name or ID of the site. + - description: Name or ID of the machine. explode: false in: path name: nameOrId @@ -248652,19 +247150,32 @@ paths: type: string style: simple x-position: 1 - - description: specify if allow multi-user auto-assignment for Remote PC Access. + - description: |- + If `true`, the file types will be imported as a background task. + The task will have JobType ImportFTA. + When the task is complete it will redirect to + GetJobResults. + The job's Parameters will contain properties: + * _MachineId_ - ID of the machine + * _MachineName_ - Name of the machine explode: true in: query - name: allow - required: true + name: async + required: false schema: + default: false + nullable: true title: Boolean type: boolean style: form x-position: 2 responses: - "204": - description: Operation is successful with no response content. + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/FtaResponseModelCollection' + description: List of file type associations imported from the machine. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -248717,21 +247228,16 @@ paths: schema: type: string style: simple - "400": - content: - application/json: - example: - https://errors-api.cloud.com/common/outOfRange: - value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range - parameters: - - name: property - value: startTime - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + "202": + description: Async request was accepted and is being processed. headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -248783,20 +247289,20 @@ paths: schema: type: string style: simple - "401": + "400": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/outOfRange: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range parameters: - - name: reason - value: missing + - name: property + value: startTime schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: Caller passed an invalid input. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -248849,22 +247355,88 @@ paths: schema: type: string style: simple - "403": + "401": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: Caller did not present a valid bearer token. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "403": + content: + application/json: + example: + https://errors-api.cloud.com/common/authorization: + value: + type: https://errors-api.cloud.com/common/authorization + detail: Access denied + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -249051,6 +247623,70 @@ paths: schema: type: string style: simple + "409": + content: + application/json: + example: + https://errors-api.cloud.com/common/optimisticConcurrency: + value: + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller requested an invalid relation to be created or deleted. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple "429": content: application/json: @@ -249252,12 +247888,13 @@ paths: schema: type: string style: simple - summary: Update multi-user auto-assignment for Remote PC Access. + summary: Import file type associations from the machine. tags: - - Sites APIs - /Sites/{nameOrId}/SessionsTrend: + - Machines APIs + /Machines/{nameOrId}/MachineCatalog: get: - operationId: Sites_GetSessionsTrend + description: Get the details of the machine catalog in which a machine resides. + operationId: Machines_GetMachineMachineCatalog parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -249268,6 +247905,23 @@ paths: schema: type: string style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple - description: "Citrix authorization header: CWSAuth Bearer={token}" explode: false in: header @@ -249303,7 +247957,7 @@ paths: schema: type: string style: simple - - description: The site name or ID. + - description: Name or ID of the machine. explode: false in: path name: nameOrId @@ -249313,47 +247967,14 @@ paths: title: String type: string style: simple - x-position: 2 - - description: "The start date of sessions trend to query, for example '2021-11-01T12:00:00'." - explode: true - in: query - name: startDate - required: true - schema: - nullable: true - title: String - type: string - style: form - x-position: 3 - - description: "The end date of sessions trend to query, for example '2021-11-08T12:00:00'." - explode: true - in: query - name: endDate - required: true - schema: - nullable: true - title: String - type: string - style: form - x-position: 4 - - description: The minutes interval to query. - explode: true - in: query - name: intervalLength - required: true - schema: - format: int32 - title: Int32 - type: integer - style: form - x-position: 5 + x-position: 1 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/SessionsTrendResponseModel' - description: "" + $ref: '#/components/schemas/MachineCatalogDetailResponseModel' + description: Details of the machine catalog. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -249941,12 +248562,12 @@ paths: schema: type: string style: simple - summary: Get the sessions trend + summary: Get the machine catalog for a machine. tags: - - Sites APIs - /Sites/{nameOrId}/Settings: - get: - operationId: Sites_GetSiteSettings + - Machines APIs + /Machines/{nameOrId}/PowerActionSchedules: + delete: + operationId: Machines_RemovePowerActionSchedule parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -249957,6 +248578,23 @@ paths: schema: type: string style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple - description: "Citrix authorization header: CWSAuth Bearer={token}" explode: false in: header @@ -249992,7 +248630,7 @@ paths: schema: type: string style: simple - - description: Name or ID of the site. + - description: Name or ID of the machine. explode: false in: path name: nameOrId @@ -250003,13 +248641,22 @@ paths: type: string style: simple x-position: 1 + - description: "If `true`, the power action schedule will be removed as a background\ + \ task." + explode: true + in: query + name: async + required: false + schema: + default: false + nullable: true + title: Boolean + type: boolean + style: form + x-position: 2 responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/SiteSettingsResponseModel' - description: The result of site settings. + "204": + description: Operation is successful with no response content. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -250062,20 +248709,81 @@ paths: schema: type: string style: simple - "400": - content: - application/json: - example: - https://errors-api.cloud.com/common/outOfRange: - value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range - parameters: - - name: property - value: startTime - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + "202": + description: Async request was accepted and is being processed. + headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -250263,20 +248971,6 @@ paths: type: string style: simple "404": - content: - application/json: - example: - https://errors-api.cloud.com/common/notFound: - value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found - parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 - schema: - $ref: '#/components/schemas/ErrorResponse' description: A referenced entity was not found. headers: Citrix-TransactionId: @@ -250396,6 +249090,70 @@ paths: schema: type: string style: simple + "409": + content: + application/json: + example: + https://errors-api.cloud.com/common/optimisticConcurrency: + value: + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller requested an invalid relation to be created or deleted. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple "429": content: application/json: @@ -250597,11 +249355,11 @@ paths: schema: type: string style: simple - summary: Get the settings for the site. + summary: Remove pending power action schedules for a machine. tags: - - Sites APIs - patch: - operationId: Sites_PatchSiteSettings + - Machines APIs + get: + operationId: Machines_GetMachinePowerActionSchedules parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -250612,6 +249370,23 @@ paths: schema: type: string style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple - description: "Citrix authorization header: CWSAuth Bearer={token}" explode: false in: header @@ -250647,7 +249422,7 @@ paths: schema: type: string style: simple - - description: Name or ID of the site. + - description: Name or ID of the machine. explode: false in: path name: nameOrId @@ -250658,18 +249433,13 @@ paths: type: string style: simple x-position: 1 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/EditSiteSettingsRequestModel' - description: site settings request model. - required: true - x-name: request - x-position: 2 responses: - "204": - description: Operation is successful with no response content. + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/PowerActionScheduleResponseModelCollection' + description: List of power action schedules. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -251056,73 +249826,6 @@ paths: schema: type: string style: simple - "415": - content: - application/json: - example: - https://errors-api.cloud.com/common/unsupportedMediaType: - value: - type: https://errors-api.cloud.com/common/unsupportedMediaType - detail: Must use application/json;charset=utf-8 media type - parameters: - - name: mediaType - value: application/xml - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller must send request body in utf-8 and specify request - Content-Type as utf-8. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple "429": content: application/json: @@ -251324,12 +250027,13 @@ paths: schema: type: string style: simple - summary: Update the broker site settings. + summary: Get the power action schedules associated with a machine. tags: - - Sites APIs - /Sites/{nameOrId}/Status: + - Machines APIs + /Machines/{nameOrId}/Sessions: get: - operationId: Sites_GetSiteStatus + description: Get the list of sessions running on a machine + operationId: Machines_GetMachineSessions parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -251340,6 +250044,23 @@ paths: schema: type: string style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple - description: "Citrix authorization header: CWSAuth Bearer={token}" explode: false in: header @@ -251375,7 +250096,7 @@ paths: schema: type: string style: simple - - description: Name or ID of the site. + - description: Name or ID of the machine. explode: false in: path name: nameOrId @@ -251386,20 +250107,16 @@ paths: type: string style: simple x-position: 1 - - description: |- - If `true`, the site status query will be executed as a background task. - The task will have JobType GetSiteStatus. - When the task is complete it will redirect to - GetJobResults. + - description: The requested session fields. + example: "Id,Uid,ApplicationsInUse" explode: true in: query - name: async + name: fields required: false schema: - default: false nullable: true - title: Boolean - type: boolean + title: String + type: string style: form x-position: 2 responses: @@ -251407,70 +250124,9 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SiteStatusResponseModel' - description: The site status. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "202": - description: Async request was accepted and is being processed. + $ref: '#/components/schemas/SessionResponseModelCollection' + description: List of sessions. headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false - schema: - type: string - style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -252057,13 +250713,18 @@ paths: schema: type: string style: simple - summary: Get the status of a site. + summary: Get the list of sessions running on a machine. tags: - - Sites APIs - /Sites/{nameOrId}/TestReport: + - Machines APIs + /Machines/{nameOrId}/StartMenuShortcutIcon: get: - description: Get the test report from the last run of TestSite. - operationId: Sites_GetSiteTestReport + description: |- + Get a start menu shortcut icon from the machine. The machine must be powered-on + and registered in order for the call to succeed. + + + This icon is usually used to help create a published application. + operationId: Machines_GetMachineStartMenuShortcutIcon parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -252074,6 +250735,23 @@ paths: schema: type: string style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple - description: "Citrix authorization header: CWSAuth Bearer={token}" explode: false in: header @@ -252109,7 +250787,7 @@ paths: schema: type: string style: simple - - description: Name or ID of the site. + - description: Machine to get the shortcut icon from. explode: false in: path name: nameOrId @@ -252120,14 +250798,72 @@ paths: type: string style: simple x-position: 1 + - description: Path to the start menu shortcut. + explode: true + in: query + name: shortcutPath + required: false + schema: + nullable: true + title: String + type: string + style: form + x-position: 2 + - description: |- + Icon format. Must be: + `{mime-type};{width}x{height}x{colordepth}` + + + where: + + + * _mime-type_ must be `image/png`. (Other formats may be supported in future.) + * _width_ and _height_ are specified in pixels. + * _colordepth_ (optional) is either `8` or `24`. + + + Optional. If not specified, only the raw icon data will be returned. + Note that this is typically in ICO format, which many clients cannot + display properly. + explode: true + in: query + name: iconFormat + required: false + schema: + nullable: true + title: String + type: string + style: form + x-position: 3 + - description: |- + If `true`, the start menu shortcut icon will be queried as a background task. + The task will have JobType GetMachineStartMenuShortcutIcon. + When the task is complete it will redirect to + GetJobResults. + The job's Parameters will contain properties: + + * _Id_ - ID of the machine from which start menu icon are being obtained, + * _Name_ - Name of the machine from which start menu icon are being obtained. + * _ShortcutPath_ - Path to the start menu shortcut. + explode: true + in: query + name: async + required: false + schema: + default: false + nullable: true + title: Boolean + type: boolean + style: form + x-position: 4 responses: "200": content: - application/json: + application/octet-stream: schema: - $ref: '#/components/schemas/TestReportResponseModel' - description: "Last test report. If no tests have been run, returns a 404\ - \ Not Found." + format: binary + type: string + description: Icon data in the requested format. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -252180,21 +250916,16 @@ paths: schema: type: string style: simple - "400": - content: - application/json: - example: - https://errors-api.cloud.com/common/outOfRange: - value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range - parameters: - - name: property - value: startTime - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + "202": + description: Async request was accepted and is being processed. headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -252246,20 +250977,20 @@ paths: schema: type: string style: simple - "401": + "400": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/outOfRange: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range parameters: - - name: reason - value: missing + - name: property + value: startTime schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: Caller passed an invalid input. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -252312,22 +251043,20 @@ paths: schema: type: string style: simple - "403": + "401": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -252380,14 +251109,14 @@ paths: schema: type: string style: simple - "404": + "403": content: application/json: example: - https://errors-api.cloud.com/common/notFound: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - name: entityType value: https://identifiers-api.cloud.com/example/widget @@ -252395,7 +251124,7 @@ paths: value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -252448,20 +251177,88 @@ paths: schema: type: string style: simple - "406": + "404": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/notFound: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found parameters: - - name: contentType - value: application/json + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + description: A referenced entity was not found. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -252715,12 +251512,23 @@ paths: schema: type: string style: simple - summary: Get the most recent test report. + summary: Get a start menu shortcut icon from the machine. tags: - - Sites APIs - /Sites/{nameOrId}/UpgradePackageVersions: + - Machines APIs + /Machines/{nameOrId}/StartMenuShortcuts: get: - operationId: Sites_GetUpgradePackageVersions + description: |- + Get start menu shortcuts from the machine. The machine must be powered-on + and registered in order for the call to succeed. + + + The shortcuts obtained are from the 'All users' start menu; user-specific shortcuts are not found. + + + Note that this call does not retrieve the shortcut icon; use + + to get the icon. + operationId: Machines_GetMachineStartMenuShortcuts parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -252731,6 +251539,23 @@ paths: schema: type: string style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple - description: "Citrix authorization header: CWSAuth Bearer={token}" explode: false in: header @@ -252766,7 +251591,7 @@ paths: schema: type: string style: simple - - description: Name or ID of the site. + - description: Machine to get the shortcuts from. explode: false in: path name: nameOrId @@ -252782,9 +251607,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UpgradePackageVersionResponseModelCollection' - description: The latest released VDA upgrade package version of each upgrade - package type. + $ref: '#/components/schemas/StartMenuApplicationResponseModelCollection' + description: List of shortcuts. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -253372,15 +252196,19 @@ paths: schema: type: string style: simple - summary: Get the latest released VDA upgrade package versions in the site. + summary: Get start menu shortcuts from the machine. tags: - - Sites APIs - /StoreFrontServers: + - Machines APIs + /Machines/{nameOrId}/Tags: get: description: |- - Get all StoreFront servers configured for use by hosted receivers - within the site. - operationId: StoreFrontServers_GetStoreFrontServers + Get tags associated with a machine. This includes tags which are + directly associated with the machine, as well as tags associated + with delivery groups, application groups, or applications that are + associated with the machine. To find only tags directly associated + with the machine, filter the results to those with + NumMachines equal to `1`. + operationId: Machines_GetMachineTags parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -253443,13 +252271,38 @@ paths: schema: type: string style: simple + - description: Name or ID of the machine. + explode: false + in: path + name: nameOrId + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 1 + - description: |- + Optional. A filter string containing object fields requested to be returned, + the requested fields are separated by comma','. return all if not specified. + example: "Name,Id,Description" + explode: true + in: query + name: fields + required: false + schema: + nullable: true + title: String + type: string + style: form + x-position: 2 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/StoreFrontServerResponseModelCollection' - description: List of StoreFront servers. + $ref: '#/components/schemas/TagResponseModelCollection' + description: List of tags. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -253702,6 +252555,74 @@ paths: schema: type: string style: simple + "404": + content: + application/json: + example: + https://errors-api.cloud.com/common/notFound: + value: + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: A referenced entity was not found. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple "406": content: application/json: @@ -253969,14 +252890,11 @@ paths: schema: type: string style: simple - summary: Get all StoreFront servers. + summary: Get tags associated with a machine. tags: - - StoreFrontServers APIs - post: - description: |- - Create a StoreFront server for use by hosted receivers within the - site. - operationId: StoreFrontServers_CreateStoreFrontServer + - Machines APIs + put: + operationId: Machines_SetMachineTags parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -254039,44 +252957,52 @@ paths: schema: type: string style: simple - - description: |- - If `true`, the StoreFront server (and associated objects) will be - created as a background task. The task will have JobType - CreateStoreFrontServer. When the task is - complete it will redirect to - GetStoreFrontServer. The job's - Parameters will contain properties: - * _Name_ - Name of the StoreFront server being created. + - description: Name or ID of the machine. + explode: false + in: path + name: nameOrId + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 1 + - description: "If `true`, the tags will be modified as a background task." explode: true in: query name: async required: false schema: default: false - nullable: true title: Boolean type: boolean style: form - x-position: 2 + x-position: 3 requestBody: content: application/json: schema: - $ref: '#/components/schemas/StoreFrontServerRequestModel' - description: |- - Details about the StoreFront server to create. Note: the - Id property must not be - specified in the request. + $ref: '#/components/schemas/TagsRequestModel' + description: Details of the tags to set on the machine. required: true x-name: request - x-position: 1 + x-position: 2 responses: - "200": + "400": content: application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime schema: - $ref: '#/components/schemas/StoreFrontServerResponseModel' - description: Details about the StoreFront server that was just created. + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -254190,20 +253116,8 @@ paths: schema: type: string style: simple - "400": - content: - application/json: - example: - https://errors-api.cloud.com/common/outOfRange: - value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range - parameters: - - name: property - value: startTime - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + "204": + description: Operation is successful with no response content. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -254390,20 +253304,22 @@ paths: schema: type: string style: simple - "406": + "404": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/notFound: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found parameters: - - name: contentType - value: application/json + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + description: A referenced entity was not found. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -254456,18 +253372,20 @@ paths: schema: type: string style: simple - "409": + "406": content: application/json: example: - https://errors-api.cloud.com/common/optimisticConcurrency: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -254788,16 +253706,12 @@ paths: schema: type: string style: simple - summary: Create a StoreFront server. + summary: Set tags associated with a machine. tags: - - StoreFrontServers APIs - /StoreFrontServers/{nameOrId}: + - Machines APIs + /Machines/{nameOrId}/Tags/{tagNameOrId}: delete: - description: |- - Delete a StoreFront server from the site, regardless of whether it - is being used by delivery groups or not. This removes the - StoreFront server from hosted receivers. - operationId: StoreFrontServers_DeleteStoreFrontServer + operationId: Machines_RemoveMachineTags parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -254860,7 +253774,7 @@ paths: schema: type: string style: simple - - description: The name or ID of StoreFront server to be deleted. + - description: Name or ID of the machine. explode: false in: path name: nameOrId @@ -254871,28 +253785,43 @@ paths: type: string style: simple x-position: 1 - - description: |- - If `true`, the StoreFront server (and associated objects) will be - deleted as a background task. The task will have JobType - DeleteStoreFrontServer. When the task is - complete it will redirect to - GetStoreFrontServers. The job's - Parameters will contain properties: - * _Name_ - Name of the StoreFront server being deleted. + - description: Name or ID of the tag. + explode: false + in: path + name: tagNameOrId + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 2 + - description: "If `true`, the tags will be modified as a background task." explode: true in: query name: async required: false schema: default: false - nullable: true title: Boolean type: boolean style: form - x-position: 2 + x-position: 3 responses: - "204": - description: Operation is successful with no response content. + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -255006,20 +253935,8 @@ paths: schema: type: string style: simple - "400": - content: - application/json: - example: - https://errors-api.cloud.com/common/outOfRange: - value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range - parameters: - - name: property - value: startTime - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + "204": + description: Operation is successful with no response content. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -255591,14 +254508,11 @@ paths: schema: type: string style: simple - summary: Delete a StoreFront server from the site. + summary: Remove a tag from a machine. tags: - - StoreFrontServers APIs - get: - description: |- - Get a single StoreFront server configured for use by hosted - receivers within the site. - operationId: StoreFrontServers_GetStoreFrontServer + - Machines APIs + post: + operationId: Machines_AddMachineTags parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -255661,7 +254575,7 @@ paths: schema: type: string style: simple - - description: The name or ID of the StoreFront server. + - description: Name or ID of the machine. explode: false in: path name: nameOrId @@ -255672,13 +254586,35 @@ paths: type: string style: simple x-position: 1 + - description: Name or ID of the tag to add. + explode: false + in: path + name: tagNameOrId + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 2 + - description: "If `true`, the tags will be modified as a background task." + explode: true + in: query + name: async + required: false + schema: + default: false + title: Boolean + type: boolean + style: form + x-position: 3 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/StoreFrontServerResponseModel' - description: Details of the StoreFront server. + $ref: '#/components/schemas/TagResponseModelCollection' + description: List of tags associated with the machine. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -255731,21 +254667,16 @@ paths: schema: type: string style: simple - "400": - content: - application/json: - example: - https://errors-api.cloud.com/common/outOfRange: - value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range - parameters: - - name: property - value: startTime - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + "202": + description: Async request was accepted and is being processed. headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -255797,20 +254728,20 @@ paths: schema: type: string style: simple - "401": + "400": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/outOfRange: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range parameters: - - name: reason - value: missing + - name: property + value: startTime schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: Caller passed an invalid input. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -255863,22 +254794,20 @@ paths: schema: type: string style: simple - "403": + "401": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -255931,14 +254860,14 @@ paths: schema: type: string style: simple - "404": + "403": content: application/json: example: - https://errors-api.cloud.com/common/notFound: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - name: entityType value: https://identifiers-api.cloud.com/example/widget @@ -255946,7 +254875,7 @@ paths: value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -255999,20 +254928,22 @@ paths: schema: type: string style: simple - "406": + "404": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/notFound: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found parameters: - - name: contentType - value: application/json + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + description: A referenced entity was not found. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -256065,21 +254996,20 @@ paths: schema: type: string style: simple - "429": + "406": content: application/json: example: - https://errors-api.cloud.com/common/rateLimitExceeded: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type parameters: - - name: retryDelay - value: "4" + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -256132,21 +255062,18 @@ paths: schema: type: string style: simple - "503": + "409": content: application/json: example: - https://errors-api.cloud.com/common/serviceUnavailable: + https://errors-api.cloud.com/common/optimisticConcurrency: value: - type: https://errors-api.cloud.com/common/serviceUnavailable - detail: Service is unavailable; try again in 4 seconds - parameters: - - name: retryDelay - value: "4" + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null schema: $ref: '#/components/schemas/ErrorResponse' - description: "Service is temporarily unable to process the request. Caller\ - \ may attempt the operation again, with exponential back-off." + description: Caller requested an invalid relation to be created or deleted. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -256199,21 +255126,21 @@ paths: schema: type: string style: simple - "500": + "429": content: application/json: example: - https://errors-api.cloud.com/common/internalServerError: + https://errors-api.cloud.com/common/rateLimitExceeded: value: - type: https://errors-api.cloud.com/common/internalServerError - detail: An internal server error has occurred; try again in 4 - seconds + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds parameters: - name: retryDelay value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: An unexpected server error occurred. + description: Caller has made too many requests in a short period of time + and is being rate-limited. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -256266,123 +255193,21 @@ paths: schema: type: string style: simple - summary: Get the details for a single StoreFront server. - tags: - - StoreFrontServers APIs - patch: - description: Update a StoreFront server. - operationId: StoreFrontServers_UpdateStoreFrontServer - parameters: - - description: Citrix Customer ID. Default is 'CitrixOnPremises' - example: CitrixOnPremises - explode: false - in: header - name: Citrix-CustomerId - required: true - schema: - type: string - style: simple - - description: Citrix Instance (Site) ID. - explode: false - in: header - name: Citrix-InstanceId - required: true - schema: - type: string - style: simple - - description: User Agent type of the request. - example: Mozilla/5.0 - explode: false - in: header - name: User-Agent - required: false - schema: - type: string - style: simple - - description: "Citrix authorization header: CWSAuth Bearer={token}" - explode: false - in: header - name: Authorization - required: false - schema: - type: string - style: simple - - description: "Transaction ID that will be used to track this request. If not\ - \ provided, a new GUID will be generated and returned." - explode: false - in: header - name: Citrix-TransactionId - required: false - schema: - type: string - style: simple - - description: Must accept application/json. - example: application/json - explode: false - in: header - name: Accept - required: false - schema: - type: string - style: simple - - description: Locale of the request. - example: en-US - explode: false - in: header - name: Citrix-Locale - required: false - schema: - type: string - style: simple - - description: Name or ID of the StoreFront server to update. - explode: false - in: path - name: nameOrId - required: true - schema: - nullable: true - title: String - type: string - style: simple - x-position: 1 - - description: |- - If `true`, the StoreFront server (and associated objects) will be - updated as a background task. The task will have JobType - UpdateStoreFrontServer. When the task is - complete it will redirect to - GetStoreFrontServer. The job's - Parameters will contain properties: - * _Name_ - Name of the StoreFront server being updated. - explode: true - in: query - name: async - required: false - schema: - default: false - nullable: true - title: Boolean - type: boolean - style: form - x-position: 3 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/StoreFrontServerRequestModel' - description: |- - Properties of the StoreFront server to update. Note: the - Id property must not be - specified in the request. - required: true - x-name: request - x-position: 2 - responses: - "200": + "503": content: application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" schema: - $ref: '#/components/schemas/StoreFrontServerResponseModel' - description: New StoreFront server. + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -256435,16 +255260,22 @@ paths: schema: type: string style: simple - "202": - description: Async request was accepted and is being processed. - headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false + "500": + content: + application/json: + example: + https://errors-api.cloud.com/common/internalServerError: + value: + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds + parameters: + - name: retryDelay + value: "4" schema: - type: string - style: simple + $ref: '#/components/schemas/ErrorResponse' + description: An unexpected server error occurred. + headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -256496,8 +255327,103 @@ paths: schema: type: string style: simple - "204": - description: Operation is successful with no response content. + summary: Add a tag to a machine. + tags: + - Machines APIs + /Machines/{nameOrId}/TestReports/{reportId}: + get: + operationId: Machines_GetTestMachineReport + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + - description: Name or ID of the machine to test. + explode: false + in: path + name: nameOrId + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 1 + - description: ID of the Cloud Health Check Report. + explode: false + in: path + name: reportId + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 2 + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/MachineTestResponseModel' + description: Machine test report. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -256884,73 +255810,6 @@ paths: schema: type: string style: simple - "415": - content: - application/json: - example: - https://errors-api.cloud.com/common/unsupportedMediaType: - value: - type: https://errors-api.cloud.com/common/unsupportedMediaType - detail: Must use application/json;charset=utf-8 media type - parameters: - - name: mediaType - value: application/xml - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller must send request body in utf-8 and specify request - Content-Type as utf-8. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple "429": content: application/json: @@ -257152,13 +256011,12 @@ paths: schema: type: string style: simple - summary: Update a StoreFront server. + summary: Get Cloud Health Check Report on a VDA machine. tags: - - StoreFrontServers APIs - /StoreFrontServers/{nameOrId}/DeliveryGroups: - get: - description: GET delivery groups details for a Storefront - operationId: StoreFrontServers_GetStoreFrontDeliveryGroups + - Machines APIs + /Machines/{nameOrId}/UpgradeSchedule: + delete: + operationId: Machines_RemoveMachineUpgradeSchedule parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -257221,7 +256079,7 @@ paths: schema: type: string style: simple - - description: The id of the Storefront + - description: Name or ID of the machine. explode: false in: path name: nameOrId @@ -257232,13 +256090,33 @@ paths: type: string style: simple x-position: 1 + - explode: true + in: query + name: force + required: false + schema: + default: false + nullable: true + title: Boolean + type: boolean + style: form + x-position: 2 + - description: "If `true`, the VDA upgrade schedule will be removed as a background\ + \ task." + explode: true + in: query + name: async + required: false + schema: + default: false + nullable: true + title: Boolean + type: boolean + style: form + x-position: 3 responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/StoreFrontDeliveryGroupResponseModelCollection' - description: The delivery groups for the Storefront with the given identifier + "204": + description: Operation is successful with no response content. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -257291,20 +256169,8 @@ paths: schema: type: string style: simple - "400": - content: - application/json: - example: - https://errors-api.cloud.com/common/outOfRange: - value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range - parameters: - - name: property - value: startTime - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + "404": + description: A referenced entity was not found. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -257357,89 +256223,16 @@ paths: schema: type: string style: simple - "401": - content: - application/json: - example: - https://errors-api.cloud.com/common/authentication: - value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details - parameters: - - name: reason - value: missing - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + "202": + description: Async request was accepted and is being processed. headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" explode: false schema: type: string style: simple - "403": - content: - application/json: - example: - https://errors-api.cloud.com/common/authorization: - value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied - parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. - headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -257491,22 +256284,20 @@ paths: schema: type: string style: simple - "404": + "400": content: application/json: example: - https://errors-api.cloud.com/common/notFound: + https://errors-api.cloud.com/common/outOfRange: value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: property + value: startTime schema: $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. + description: Caller passed an invalid input. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -257559,20 +256350,20 @@ paths: schema: type: string style: simple - "406": + "401": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: contentType - value: application/json + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -257625,21 +256416,219 @@ paths: schema: type: string style: simple - "429": + "403": content: application/json: example: - https://errors-api.cloud.com/common/rateLimitExceeded: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - - name: retryDelay - value: "4" + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. + description: Caller is not authorized to perform the operation. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "409": + content: + application/json: + example: + https://errors-api.cloud.com/common/optimisticConcurrency: + value: + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller requested an invalid relation to be created or deleted. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "429": + content: + application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller has made too many requests in a short period of time + and is being rate-limited. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -257826,12 +256815,11 @@ paths: schema: type: string style: simple - summary: GET delivery groups details for a Storefront + summary: Remove a pending VDA upgrade schedule for a machine. tags: - - StoreFrontServers APIs - /Tags: - get: - operationId: Tags_GetTags + - Machines APIs + patch: + operationId: Machines_UpdateMachineUpgradeSchedule parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -257894,57 +256882,42 @@ paths: schema: type: string style: simple - - description: |- - The max number of tags returned by this query. - If not specified, the server might use a default limit of 250 items. - If the specified value is larger than 1000, the server might reject the call. - The default and maximum values depend on server settings. - explode: true - in: query - name: limit - required: false - schema: - format: int32 - nullable: true - title: Int32 - type: integer - style: form - x-position: 1 - - description: |- - If a query cannot be completed, the response will have a - ContinuationToken set. - To obtain more results from the query, pass the - continuation token back into the query to get the next - batch of results. - explode: true - in: query - name: continuationToken - required: false + - description: Name or ID of the machine. + explode: false + in: path + name: nameOrId + required: true schema: nullable: true title: String type: string - style: form - x-position: 2 - - description: The required fields of tag. - example: "Name,Id,Description" + style: simple + x-position: 1 + - description: "If `true`, the VDA upgrade schedule will be updated as a background\ + \ task." explode: true in: query - name: fields + name: async required: false schema: + default: false nullable: true - title: String - type: string + title: Boolean + type: boolean style: form x-position: 3 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateUpgradeScheduleRequestModel' + description: Details about the updated VDA upgrade schedule. + required: true + x-name: request + x-position: 2 responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/TagResponseModelCollection' - description: List of tags. + "204": + description: Operation is successful with no response content. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -258063,20 +257036,22 @@ paths: schema: type: string style: simple - "401": + "404": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/notFound: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found parameters: - - name: reason - value: missing + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: A referenced entity was not found. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -258129,23 +257104,16 @@ paths: schema: type: string style: simple - "403": - content: - application/json: - example: - https://errors-api.cloud.com/common/authorization: - value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied - parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + "202": + description: Async request was accepted and is being processed. headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -258197,20 +257165,20 @@ paths: schema: type: string style: simple - "406": + "401": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: contentType - value: application/json + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -258263,21 +257231,22 @@ paths: schema: type: string style: simple - "429": + "403": content: application/json: example: - https://errors-api.cloud.com/common/rateLimitExceeded: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - - name: retryDelay - value: "4" + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -258330,21 +257299,20 @@ paths: schema: type: string style: simple - "503": + "406": content: application/json: example: - https://errors-api.cloud.com/common/serviceUnavailable: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/serviceUnavailable - detail: Service is unavailable; try again in 4 seconds + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type parameters: - - name: retryDelay - value: "4" + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: "Service is temporarily unable to process the request. Caller\ - \ may attempt the operation again, with exponential back-off." + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -258397,21 +257365,21 @@ paths: schema: type: string style: simple - "500": + "415": content: application/json: example: - https://errors-api.cloud.com/common/internalServerError: + https://errors-api.cloud.com/common/unsupportedMediaType: value: - type: https://errors-api.cloud.com/common/internalServerError - detail: An internal server error has occurred; try again in 4 - seconds + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type parameters: - - name: retryDelay - value: "4" + - name: mediaType + value: application/xml schema: $ref: '#/components/schemas/ErrorResponse' - description: An unexpected server error occurred. + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -258464,108 +257432,21 @@ paths: schema: type: string style: simple - summary: Get the list of all tags in the site. - tags: - - Tags APIs - post: - operationId: Tags_CreateTag - parameters: - - description: Citrix Customer ID. Default is 'CitrixOnPremises' - example: CitrixOnPremises - explode: false - in: header - name: Citrix-CustomerId - required: true - schema: - type: string - style: simple - - description: Citrix Instance (Site) ID. - explode: false - in: header - name: Citrix-InstanceId - required: true - schema: - type: string - style: simple - - description: User Agent type of the request. - example: Mozilla/5.0 - explode: false - in: header - name: User-Agent - required: false - schema: - type: string - style: simple - - description: "Citrix authorization header: CWSAuth Bearer={token}" - explode: false - in: header - name: Authorization - required: false - schema: - type: string - style: simple - - description: "Transaction ID that will be used to track this request. If not\ - \ provided, a new GUID will be generated and returned." - explode: false - in: header - name: Citrix-TransactionId - required: false - schema: - type: string - style: simple - - description: Must accept application/json. - example: application/json - explode: false - in: header - name: Accept - required: false - schema: - type: string - style: simple - - description: Locale of the request. - example: en-US - explode: false - in: header - name: Citrix-Locale - required: false - schema: - type: string - style: simple - - description: |- - If `true`, the tag will be created as a background task. - The task will have JobType CreateTag. - When the task is complete it will redirect to - "GetTag(string)". - The job's Parameters will contain properties: - - * _Name_ - Name of the tag being created. - explode: true - in: query - name: async - required: false - schema: - default: false - nullable: true - title: Boolean - type: boolean - style: form - x-position: 2 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TagRequestModel' - description: Details of the tag to create. - required: true - x-name: request - x-position: 1 - responses: - "200": + "429": content: application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" schema: - $ref: '#/components/schemas/TagResponseModel' - description: Details of the tag created. + $ref: '#/components/schemas/ErrorResponse' + description: Caller has made too many requests in a short period of time + and is being rate-limited. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -258618,16 +257499,22 @@ paths: schema: type: string style: simple - "202": - description: Async request was accepted and is being processed. - headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false + "503": + content: + application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" schema: - type: string - style: simple + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." + headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -258679,20 +257566,21 @@ paths: schema: type: string style: simple - "400": + "500": content: application/json: example: - https://errors-api.cloud.com/common/outOfRange: + https://errors-api.cloud.com/common/internalServerError: value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds parameters: - - name: property - value: startTime + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + description: An unexpected server error occurred. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -258745,21 +257633,117 @@ paths: schema: type: string style: simple - "401": - content: - application/json: - example: - https://errors-api.cloud.com/common/authentication: - value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details - parameters: - - name: reason - value: missing - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + summary: Reschedule a pending VDA upgrade schedule for a machine. + tags: + - Machines APIs + post: + operationId: Machines_CreateMachineUpgradeSchedule + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + - description: Name or ID of the machine. + explode: false + in: path + name: nameOrId + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 1 + - description: "If `true`, the VDA upgrade schedule will be created as a background\ + \ task." + explode: true + in: query + name: async + required: false + schema: + default: false + nullable: true + title: Boolean + type: boolean + style: form + x-position: 3 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateUpgradeScheduleRequestModel' + description: Details about the VDA upgrade schedule to create. + required: true + x-name: request + x-position: 2 + responses: + "201": + description: Resource was created. headers: + Location: + description: Location where the newly created resource resides. + example: /services/myservice/widgets/1 + explode: false + schema: + type: string + style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -258811,22 +257795,18 @@ paths: schema: type: string style: simple - "403": + "409": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/optimisticConcurrency: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied - parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: Caller requested an invalid relation to be created or deleted. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -258879,21 +257859,16 @@ paths: schema: type: string style: simple - "406": - content: - application/json: - example: - https://errors-api.cloud.com/common/notAcceptable: - value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type - parameters: - - name: contentType - value: application/json - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + "202": + description: Async request was accepted and is being processed. headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -258945,18 +257920,8 @@ paths: schema: type: string style: simple - "409": - content: - application/json: - example: - https://errors-api.cloud.com/common/optimisticConcurrency: - value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. + "204": + description: Operation is successful with no response content. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -259009,21 +257974,20 @@ paths: schema: type: string style: simple - "415": + "400": content: application/json: example: - https://errors-api.cloud.com/common/unsupportedMediaType: + https://errors-api.cloud.com/common/outOfRange: value: - type: https://errors-api.cloud.com/common/unsupportedMediaType - detail: Must use application/json;charset=utf-8 media type + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range parameters: - - name: mediaType - value: application/xml + - name: property + value: startTime schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must send request body in utf-8 and specify request - Content-Type as utf-8. + description: Caller passed an invalid input. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -259076,21 +258040,20 @@ paths: schema: type: string style: simple - "429": + "401": content: application/json: example: - https://errors-api.cloud.com/common/rateLimitExceeded: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: retryDelay - value: "4" + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -259143,21 +258106,22 @@ paths: schema: type: string style: simple - "503": + "403": content: application/json: example: - https://errors-api.cloud.com/common/serviceUnavailable: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/serviceUnavailable - detail: Service is unavailable; try again in 4 seconds + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - - name: retryDelay - value: "4" + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: "Service is temporarily unable to process the request. Caller\ - \ may attempt the operation again, with exponential back-off." + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -259210,21 +258174,22 @@ paths: schema: type: string style: simple - "500": + "404": content: application/json: example: - https://errors-api.cloud.com/common/internalServerError: + https://errors-api.cloud.com/common/notFound: value: - type: https://errors-api.cloud.com/common/internalServerError - detail: An internal server error has occurred; try again in 4 - seconds + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found parameters: - - name: retryDelay - value: "4" + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: An unexpected server error occurred. + description: A referenced entity was not found. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -259277,89 +258242,20 @@ paths: schema: type: string style: simple - summary: Create a tag. - tags: - - Tags APIs - /Tags/{name}: - head: - description: Check for the existence of a tag by name. - operationId: Tags_CheckTagExists - parameters: - - description: Citrix Customer ID. Default is 'CitrixOnPremises' - example: CitrixOnPremises - explode: false - in: header - name: Citrix-CustomerId - required: true - schema: - type: string - style: simple - - description: Citrix Instance (Site) ID. - explode: false - in: header - name: Citrix-InstanceId - required: true - schema: - type: string - style: simple - - description: User Agent type of the request. - example: Mozilla/5.0 - explode: false - in: header - name: User-Agent - required: false - schema: - type: string - style: simple - - description: "Citrix authorization header: CWSAuth Bearer={token}" - explode: false - in: header - name: Authorization - required: false - schema: - type: string - style: simple - - description: "Transaction ID that will be used to track this request. If not\ - \ provided, a new GUID will be generated and returned." - explode: false - in: header - name: Citrix-TransactionId - required: false - schema: - type: string - style: simple - - description: Must accept application/json. - example: application/json - explode: false - in: header - name: Accept - required: false - schema: - type: string - style: simple - - description: Locale of the request. - example: en-US - explode: false - in: header - name: Citrix-Locale - required: false - schema: - type: string - style: simple - - description: Name of the tag. - explode: false - in: path - name: name - required: true - schema: - nullable: true - title: String - type: string - style: simple - x-position: 1 - responses: - "204": - description: Operation is successful with no response content. + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -259412,20 +258308,21 @@ paths: schema: type: string style: simple - "400": + "415": content: application/json: example: - https://errors-api.cloud.com/common/outOfRange: + https://errors-api.cloud.com/common/unsupportedMediaType: value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type parameters: - - name: property - value: startTime + - name: mediaType + value: application/xml schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -259478,20 +258375,21 @@ paths: schema: type: string style: simple - "401": + "429": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/rateLimitExceeded: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds parameters: - - name: reason - value: missing + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: Caller has made too many requests in a short period of time + and is being rate-limited. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -259544,22 +258442,21 @@ paths: schema: type: string style: simple - "403": + "503": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/serviceUnavailable: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -259612,22 +258509,21 @@ paths: schema: type: string style: simple - "404": + "500": content: application/json: example: - https://errors-api.cloud.com/common/notFound: + https://errors-api.cloud.com/common/internalServerError: value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. + description: An unexpected server error occurred. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -259680,20 +258576,67 @@ paths: schema: type: string style: simple - "406": + summary: Setup a new VDA upgrade schedule for a machine. + tags: + - Machines APIs + /me: + get: + description: |- + Gets details about the currently logged-in admin, including the + list of customers and sites that the admin has access to. + operationId: Me_GetMe + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + responses: + "200": content: application/json: - example: - https://errors-api.cloud.com/common/notAcceptable: - value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type - parameters: - - name: contentType - value: application/json schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + $ref: '#/components/schemas/MeResponseModel' + description: Details about the currently logged-in admin. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -259746,21 +258689,20 @@ paths: schema: type: string style: simple - "429": + "400": content: application/json: example: - https://errors-api.cloud.com/common/rateLimitExceeded: + https://errors-api.cloud.com/common/outOfRange: value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range parameters: - - name: retryDelay - value: "4" + - name: property + value: startTime schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. + description: Caller passed an invalid input. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -259813,21 +258755,20 @@ paths: schema: type: string style: simple - "503": + "401": content: application/json: example: - https://errors-api.cloud.com/common/serviceUnavailable: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/serviceUnavailable - detail: Service is unavailable; try again in 4 seconds + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: retryDelay - value: "4" + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: "Service is temporarily unable to process the request. Caller\ - \ may attempt the operation again, with exponential back-off." + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -259880,21 +258821,22 @@ paths: schema: type: string style: simple - "500": + "403": content: application/json: example: - https://errors-api.cloud.com/common/internalServerError: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/internalServerError - detail: An internal server error has occurred; try again in 4 - seconds + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - - name: retryDelay - value: "4" + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: An unexpected server error occurred. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -259947,119 +258889,20 @@ paths: schema: type: string style: simple - summary: Check for the existence of a tag by name. - tags: - - Tags APIs - /Tags/{nameOrId}: - delete: - operationId: Tags_DeleteTag - parameters: - - description: Citrix Customer ID. Default is 'CitrixOnPremises' - example: CitrixOnPremises - explode: false - in: header - name: Citrix-CustomerId - required: true - schema: - type: string - style: simple - - description: Citrix Instance (Site) ID. - explode: false - in: header - name: Citrix-InstanceId - required: true - schema: - type: string - style: simple - - description: User Agent type of the request. - example: Mozilla/5.0 - explode: false - in: header - name: User-Agent - required: false - schema: - type: string - style: simple - - description: "Citrix authorization header: CWSAuth Bearer={token}" - explode: false - in: header - name: Authorization - required: false - schema: - type: string - style: simple - - description: "Transaction ID that will be used to track this request. If not\ - \ provided, a new GUID will be generated and returned." - explode: false - in: header - name: Citrix-TransactionId - required: false - schema: - type: string - style: simple - - description: Must accept application/json. - example: application/json - explode: false - in: header - name: Accept - required: false - schema: - type: string - style: simple - - description: Locale of the request. - example: en-US - explode: false - in: header - name: Citrix-Locale - required: false - schema: - type: string - style: simple - - description: Name or ID of the tag. - explode: false - in: path - name: nameOrId - required: true - schema: - nullable: true - title: String - type: string - style: simple - x-position: 1 - - description: |- - If `true`, the tag will be deleted as a background task. - The task will have JobType DeleteTag. - When the task is complete it will redirect to - GetTags. - The job's Parameters will contain properties: - - * _Id_ - ID of the tag being deleted, - * _Name_ - Name of the tag being deleted. - explode: true - in: query - name: async - required: false - schema: - default: false - nullable: true - title: Boolean - type: boolean - style: form - x-position: 2 - - description: For deleting the tag if true - explode: true - in: query - name: force - required: false - schema: - default: false - title: Boolean - type: boolean - style: form - x-position: 3 - responses: - "204": - description: Operation is successful with no response content. + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -260112,16 +258955,22 @@ paths: schema: type: string style: simple - "202": - description: Async request was accepted and is being processed. - headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false + "429": + content: + application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" schema: - type: string - style: simple + $ref: '#/components/schemas/ErrorResponse' + description: Caller has made too many requests in a short period of time + and is being rate-limited. + headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -260173,20 +259022,21 @@ paths: schema: type: string style: simple - "400": + "503": content: application/json: example: - https://errors-api.cloud.com/common/outOfRange: + https://errors-api.cloud.com/common/serviceUnavailable: value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds parameters: - - name: property - value: startTime + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -260239,20 +259089,21 @@ paths: schema: type: string style: simple - "401": + "500": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/internalServerError: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds parameters: - - name: reason - value: missing + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: An unexpected server error occurred. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -260305,22 +259156,81 @@ paths: schema: type: string style: simple - "403": + summary: Get my details. + tags: + - Me APIs + /me/Preferences: + get: + description: |- + Get my preferences. + Preferences are free-form name/value pairs that are typically used to + keep track of how the user has configured the UI, so that the configuration + is retained across sessions. + operationId: Me_GetMyPreferences + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + - description: "Optional name prefix to filter results. If not specified, all\ + \ preferences are returned." + explode: true + in: query + name: namePrefix + required: false + schema: + nullable: true + title: String + type: string + style: form + x-position: 1 + responses: + "200": content: application/json: - example: - https://errors-api.cloud.com/common/authorization: - value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied - parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + $ref: '#/components/schemas/NameValueStringPairModelCollection' + description: List of user preferences. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -260373,8 +259283,20 @@ paths: schema: type: string style: simple - "404": - description: A referenced entity was not found. + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -260427,20 +259349,20 @@ paths: schema: type: string style: simple - "406": + "401": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: contentType - value: application/json + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -260493,18 +259415,88 @@ paths: schema: type: string style: simple - "409": + "403": content: application/json: example: - https://errors-api.cloud.com/common/optimisticConcurrency: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null + type: https://errors-api.cloud.com/common/authorization + detail: Access denied + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. + description: Caller is not authorized to perform the operation. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -260758,11 +259750,18 @@ paths: schema: type: string style: simple - summary: Delete a tag. + summary: Get my preferences. tags: - - Tags APIs - get: - operationId: Tags_GetTag + - Me APIs + put: + description: |- + Set a preference value. + Preferences are free-form name/value pairs that are typically used to + keep track of how the user has configured the UI, so that the configuration + is retained across sessions. + Note: if a preference with the given name already exists, it will be + overridden. + operationId: Me_SetMyPreference parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -260773,23 +259772,6 @@ paths: schema: type: string style: simple - - description: Citrix Instance (Site) ID. - explode: false - in: header - name: Citrix-InstanceId - required: true - schema: - type: string - style: simple - - description: User Agent type of the request. - example: Mozilla/5.0 - explode: false - in: header - name: User-Agent - required: false - schema: - type: string - style: simple - description: "Citrix authorization header: CWSAuth Bearer={token}" explode: false in: header @@ -260825,24 +259807,18 @@ paths: schema: type: string style: simple - - description: Name or ID of the tag. - explode: false - in: path - name: nameOrId + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetPreferenceModel' + description: Preference to set. required: true - schema: - nullable: true - title: String - type: string - style: simple + x-name: preference x-position: 1 responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/TagDetailResponseModel' - description: List of tags. + "204": + description: Operation is successful with no response content. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -261095,22 +260071,20 @@ paths: schema: type: string style: simple - "404": + "406": content: application/json: example: - https://errors-api.cloud.com/common/notFound: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -261163,20 +260137,21 @@ paths: schema: type: string style: simple - "406": + "415": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/unsupportedMediaType: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type parameters: - - name: contentType - value: application/json + - name: mediaType + value: application/xml schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -261430,11 +260405,13 @@ paths: schema: type: string style: simple - summary: Get a single tag from the site. + summary: Set a preference value. tags: - - Tags APIs - patch: - operationId: Tags_PatchTag + - Me APIs + /me/Preferences/{name}: + delete: + description: Delete one of my preferences by name. + operationId: Me_DeleteMyPreference parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -261445,23 +260422,6 @@ paths: schema: type: string style: simple - - description: Citrix Instance (Site) ID. - explode: false - in: header - name: Citrix-InstanceId - required: true - schema: - type: string - style: simple - - description: User Agent type of the request. - example: Mozilla/5.0 - explode: false - in: header - name: User-Agent - required: false - schema: - type: string - style: simple - description: "Citrix authorization header: CWSAuth Bearer={token}" explode: false in: header @@ -261497,10 +260457,10 @@ paths: schema: type: string style: simple - - description: Name or ID of the tag. + - description: Preference name. explode: false in: path - name: nameOrId + name: name required: true schema: nullable: true @@ -261508,38 +260468,9 @@ paths: type: string style: simple x-position: 1 - - description: "If `true`, the tag will be updated as a background task.\nThe\ - \ task will have JobType UpdateTag.\nWhen the task is complete it will redirect\ - \ to\n\"GetTag(string)\".\nThe job's Parameters will contain properties:\n\ - \ \n* _Id_ - ID of the tag being updated,\n* _Name_ - Name of the tag being\ - \ updated." - explode: true - in: query - name: async - required: false - schema: - default: false - nullable: true - title: Boolean - type: boolean - style: form - x-position: 3 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TagRequestModel' - description: Details of the tag to update. - required: true - x-name: request - x-position: 2 responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/TagResponseModel' - description: Details of the tag updated. + "204": + description: Operation is successful with no response content. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -261592,16 +260523,21 @@ paths: schema: type: string style: simple - "202": - description: Async request was accepted and is being processed. - headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime schema: - type: string - style: simple + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -261653,8 +260589,20 @@ paths: schema: type: string style: simple - "204": - description: Operation is successful with no response content. + "401": + content: + application/json: + example: + https://errors-api.cloud.com/common/authentication: + value: + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -261707,154 +260655,22 @@ paths: schema: type: string style: simple - "400": + "403": content: application/json: example: - https://errors-api.cloud.com/common/outOfRange: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - - name: property - value: startTime + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "401": - content: - application/json: - example: - https://errors-api.cloud.com/common/authentication: - value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details - parameters: - - name: reason - value: missing - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "403": - content: - application/json: - example: - https://errors-api.cloud.com/common/authorization: - value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied - parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -261908,20 +260724,6 @@ paths: type: string style: simple "404": - content: - application/json: - example: - https://errors-api.cloud.com/common/notFound: - value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found - parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 - schema: - $ref: '#/components/schemas/ErrorResponse' description: A referenced entity was not found. headers: Citrix-TransactionId: @@ -262041,21 +260843,18 @@ paths: schema: type: string style: simple - "415": + "409": content: application/json: example: - https://errors-api.cloud.com/common/unsupportedMediaType: + https://errors-api.cloud.com/common/optimisticConcurrency: value: - type: https://errors-api.cloud.com/common/unsupportedMediaType - detail: Must use application/json;charset=utf-8 media type - parameters: - - name: mediaType - value: application/xml + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must send request body in utf-8 and specify request - Content-Type as utf-8. + description: Caller requested an invalid relation to be created or deleted. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -262309,12 +261108,16 @@ paths: schema: type: string style: simple - summary: Update a tag. + summary: Delete one of admin preferences by name. tags: - - Tags APIs - /Tags/{nameOrId}/ApplicationGroups: + - Me APIs get: - operationId: Tags_GetTagApplicationGroups + description: |- + Get one of my preferences by name. + Preferences are free-form name/value pairs that are typically used to + keep track of how the user has configured the UI, so that the configuration + is retained across sessions. + operationId: Me_GetMyPreference parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -262325,23 +261128,6 @@ paths: schema: type: string style: simple - - description: Citrix Instance (Site) ID. - explode: false - in: header - name: Citrix-InstanceId - required: true - schema: - type: string - style: simple - - description: User Agent type of the request. - example: Mozilla/5.0 - explode: false - in: header - name: User-Agent - required: false - schema: - type: string - style: simple - description: "Citrix authorization header: CWSAuth Bearer={token}" explode: false in: header @@ -262377,10 +261163,10 @@ paths: schema: type: string style: simple - - description: Name or ID of the tag. + - description: Preference name. explode: false in: path - name: nameOrId + name: name required: true schema: nullable: true @@ -262388,45 +261174,13 @@ paths: type: string style: simple x-position: 1 - - description: |- - The max number of application groups returned by this query. - If not specified, the server might use a default limit of 250 items. - If the specified value is larger than 1000, the server might reject the call. - The default and maximum values depend on server settings. - explode: true - in: query - name: limit - required: false - schema: - format: int32 - nullable: true - title: Int32 - type: integer - style: form - x-position: 2 - - description: |- - If a query cannot be completed, the response will have a - ContinuationToken set. - To obtain more results from the query, pass the - continuation token back into the query to get the next - batch of results. - explode: true - in: query - name: continuationToken - required: false - schema: - nullable: true - title: String - type: string - style: form - x-position: 3 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/ApplicationGroupResponseModelCollection' - description: List of application groups. + $ref: '#/components/schemas/NameValueStringPairModel' + description: User preferences headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -263014,12 +261768,13 @@ paths: schema: type: string style: simple - summary: Get the application groups associated with a tag. + summary: Get one of my preferences by name. tags: - - Tags APIs - /Tags/{nameOrId}/Applications: + - Me APIs + /RebootSchedules: get: - operationId: Tags_GetTagApplications + description: Get a list of reboot schedules from all delivery groups. + operationId: RebootSchedules_GetRebootSchedules parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -263082,56 +261837,13 @@ paths: schema: type: string style: simple - - description: Name or ID of the tag. - explode: false - in: path - name: nameOrId - required: true - schema: - nullable: true - title: String - type: string - style: simple - x-position: 1 - - description: |- - The max number of applications returned by this query. - If not specified, the server might use a default limit of 250 items. - If the specified value is larger than 1000, the server might reject the call. - The default and maximum values depend on server settings. - explode: true - in: query - name: limit - required: false - schema: - format: int32 - nullable: true - title: Int32 - type: integer - style: form - x-position: 2 - - description: |- - If a query cannot be completed, the response will have a - ContinuationToken set. - To obtain more results from the query, pass the - continuation token back into the query to get the next - batch of results. - explode: true - in: query - name: continuationToken - required: false - schema: - nullable: true - title: String - type: string - style: form - x-position: 3 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/ApplicationResponseModelCollection' - description: List of applications. + $ref: '#/components/schemas/RebootScheduleResponseModelCollection' + description: List of reboot schedules. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -263384,74 +262096,6 @@ paths: schema: type: string style: simple - "404": - content: - application/json: - example: - https://errors-api.cloud.com/common/notFound: - value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found - parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 - schema: - $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple "406": content: application/json: @@ -263719,12 +262363,18 @@ paths: schema: type: string style: simple - summary: Get the applications associated with a tag. + summary: Get all reboot schedules in the site. tags: - - Tags APIs - put: - description: Associate a tag with applications. - operationId: Tags_SetTagApplications + - RebootSchedules APIs + /Sessions: + get: + description: |- + Get all the sessions in the site. Note that the response + may not contain the entire list of sessions; if this happens the + response will have a ContinuationToken + which, if passed, will resume retrieving results from the original + query. + operationId: Sessions_GetSessions parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -263787,25 +262437,43 @@ paths: schema: type: string style: simple - - description: Name or ID of the tag. - explode: false - in: path - name: nameOrId - required: true + - description: |- + The max number of sessions returned by this query. + If not specified, the server might use a default limit of 250 items. + If the specified value is larger than 1000, the server might reject the call. + The default and maximum values depend on server settings. + explode: true + in: query + name: limit + required: false + schema: + format: int32 + nullable: true + title: Int32 + type: integer + style: form + x-position: 1 + - description: |- + If a query cannot be completed, the response will have a + ContinuationToken set. + To obtain more results from the query, pass the + continuation token back into the query to get the next + batch of results. + explode: true + in: query + name: continuationToken + required: false schema: nullable: true title: String type: string - style: simple - x-position: 1 + style: form + x-position: 2 - description: |- - If `true`, the tags will be modified as a background task. - The task will have JobType SetTagApplications. + If `true`, the get sessions will be executed as a background task. + The task will have JobType GetSessions. When the task is complete it will redirect to - GetTagApplications. - The job's Parameters will contain properties: - * _Id_ - ID of the tag being associated with applications, - * _Name_ - Name of the tag being associated with applications. + GetJobResults. explode: true in: query name: async @@ -263817,32 +262485,27 @@ paths: type: boolean style: form x-position: 3 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RefsRequestModel' - description: |- - The applications to tag. Any application - not listed will be untagged if it was previously associated with the tag. - required: true - x-name: request - x-position: 2 + - description: "Optional. A filter string containing object fields requested\ + \ to be returned, the requested fields are separated by comma','.\n \ + \ " + example: "Id,Uid,ApplicationsInUse" + explode: true + in: query + name: fields + required: false + schema: + nullable: true + title: String + type: string + style: form + x-position: 4 responses: - "400": + "200": content: application/json: - example: - https://errors-api.cloud.com/common/outOfRange: - value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range - parameters: - - name: property - value: startTime schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + $ref: '#/components/schemas/SessionResponseModelCollection' + description: List of sessions. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -263956,8 +262619,20 @@ paths: schema: type: string style: simple - "204": - description: Operation is successful with no response content. + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -264144,74 +262819,6 @@ paths: schema: type: string style: simple - "404": - content: - application/json: - example: - https://errors-api.cloud.com/common/notFound: - value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found - parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 - schema: - $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple "406": content: application/json: @@ -264278,88 +262885,21 @@ paths: schema: type: string style: simple - "415": + "429": content: application/json: example: - https://errors-api.cloud.com/common/unsupportedMediaType: + https://errors-api.cloud.com/common/rateLimitExceeded: value: - type: https://errors-api.cloud.com/common/unsupportedMediaType - detail: Must use application/json;charset=utf-8 media type + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds parameters: - - name: mediaType - value: application/xml + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must send request body in utf-8 and specify request - Content-Type as utf-8. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "429": - content: - application/json: - example: - https://errors-api.cloud.com/common/rateLimitExceeded: - value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds - parameters: - - name: retryDelay - value: "4" - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. + description: Caller has made too many requests in a short period of time + and is being rate-limited. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -264546,12 +263086,15 @@ paths: schema: type: string style: simple - summary: Associate a tag with applications. + summary: Get all sessions in the site. tags: - - Tags APIs - /Tags/{nameOrId}/DeliveryGroups: - get: - operationId: Tags_GetTagDeliveryGroups + - Sessions APIs + /Sessions/$search: + post: + description: |- + Perform an advanced search for sessions. Note that some combinations + of search parameters may result in slow performance. + operationId: Sessions_DoSessionSearch parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -264614,19 +263157,8 @@ paths: schema: type: string style: simple - - description: Name or ID of the tag. - explode: false - in: path - name: nameOrId - required: true - schema: - nullable: true - title: String - type: string - style: simple - x-position: 1 - description: |- - The max number of delivery groups returned by this query. + The max number of sessions returned by this query. If not specified, the server might use a default limit of 250 items. If the specified value is larger than 1000, the server might reject the call. The default and maximum values depend on server settings. @@ -264657,13 +263189,63 @@ paths: type: string style: form x-position: 3 + - description: |- + Optional filter, removing unspecified properties that otherwise would + have been sent by the server + explode: true + in: query + name: fields + required: false + schema: + nullable: true + title: String + type: string + style: form + x-position: 4 + - description: |- + If `true`, the search sessions will be executed as a background task. + The task will have JobType DoSessionSearch. + When the task is complete it will redirect to + GetJobResults. + explode: true + in: query + name: async + required: false + schema: + default: false + nullable: true + title: Boolean + type: boolean + style: form + x-position: 5 + - description: The number of sessions to skip. + explode: true + in: query + name: skip + required: false + schema: + format: int32 + nullable: true + title: Int32 + type: integer + style: form + x-position: 6 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MachineAndSessionSearchRequestModel' + description: Specifies the advanced search parameters. + required: true + x-name: searchRequest + x-position: 1 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/DeliveryGroupResponseModelCollection' - description: List of delivery groups. + $ref: '#/components/schemas/SessionResponseModelCollection' + description: List of sessions that match the search criteria. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -264716,87 +263298,16 @@ paths: schema: type: string style: simple - "400": - content: - application/json: - example: - https://errors-api.cloud.com/common/outOfRange: - value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range - parameters: - - name: property - value: startTime - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + "202": + description: Async request was accepted and is being processed. headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" explode: false schema: type: string style: simple - "401": - content: - application/json: - example: - https://errors-api.cloud.com/common/authentication: - value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details - parameters: - - name: reason - value: missing - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. - headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -264848,22 +263359,20 @@ paths: schema: type: string style: simple - "403": + "400": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/outOfRange: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: property + value: startTime schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: Caller passed an invalid input. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -264916,22 +263425,88 @@ paths: schema: type: string style: simple - "404": + "401": content: application/json: example: - https://errors-api.cloud.com/common/notFound: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. + description: Caller did not present a valid bearer token. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "403": + content: + application/json: + example: + https://errors-api.cloud.com/common/authorization: + value: + type: https://errors-api.cloud.com/common/authorization + detail: Access denied + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -265050,6 +263625,137 @@ paths: schema: type: string style: simple + "409": + content: + application/json: + example: + https://errors-api.cloud.com/common/optimisticConcurrency: + value: + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller requested an invalid relation to be created or deleted. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "415": + content: + application/json: + example: + https://errors-api.cloud.com/common/unsupportedMediaType: + value: + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type + parameters: + - name: mediaType + value: application/xml + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple "429": content: application/json: @@ -265251,11 +263957,13 @@ paths: schema: type: string style: simple - summary: Get the delivery groups associated with a tag. + summary: Perform an advanced search for sessions. tags: - - Tags APIs - put: - operationId: Tags_SetTagDeliveryGroups + - Sessions APIs + /Sessions/{id}: + get: + description: Get details of a single session. + operationId: Sessions_GetSession parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -265318,10 +264026,10 @@ paths: schema: type: string style: simple - - description: Name or ID of the tag. + - description: ID of the session. explode: false in: path - name: nameOrId + name: id required: true schema: nullable: true @@ -265329,52 +264037,25 @@ paths: type: string style: simple x-position: 1 - - description: |- - If `true`, the tags will be modified as a background task. - The task will have JobType SetTagDeliveryGroups. - When the task is complete it will redirect to - GetTagDeliveryGroups. - The job's Parameters will contain properties: - - * _Id_ - ID of the tag being associated with delivery groups, - * _Name_ - Name of the tag being associated with delivery groups. + - description: The requested fields. + example: "Id,Uid,ApplicationsInUse" explode: true in: query - name: async + name: fields required: false schema: - default: false nullable: true - title: Boolean - type: boolean + title: String + type: string style: form - x-position: 3 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RefsRequestModel' - description: |- - The delivery groups to tag. Any delivery group - not listed will be untagged if it was previously associated with the tag. - required: true - x-name: request x-position: 2 responses: - "400": + "200": content: application/json: - example: - https://errors-api.cloud.com/common/outOfRange: - value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range - parameters: - - name: property - value: startTime schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + $ref: '#/components/schemas/SessionResponseModel' + description: Details of the session. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -265427,16 +264108,21 @@ paths: schema: type: string style: simple - "202": - description: Async request was accepted and is being processed. - headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime schema: - type: string - style: simple + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -265488,8 +264174,20 @@ paths: schema: type: string style: simple - "204": - description: Operation is successful with no response content. + "401": + content: + application/json: + example: + https://errors-api.cloud.com/common/authentication: + value: + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -265542,88 +264240,22 @@ paths: schema: type: string style: simple - "401": + "403": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - - name: reason - value: missing + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "403": - content: - application/json: - example: - https://errors-api.cloud.com/common/authorization: - value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied - parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -265810,73 +264442,6 @@ paths: schema: type: string style: simple - "415": - content: - application/json: - example: - https://errors-api.cloud.com/common/unsupportedMediaType: - value: - type: https://errors-api.cloud.com/common/unsupportedMediaType - detail: Must use application/json;charset=utf-8 media type - parameters: - - name: mediaType - value: application/xml - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller must send request body in utf-8 and specify request - Content-Type as utf-8. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple "429": content: application/json: @@ -266078,12 +264643,13 @@ paths: schema: type: string style: simple - summary: Associate a tag with delivery groups. + summary: Get details of a single session. tags: - - Tags APIs - /Tags/{nameOrId}/MachineCatalogs: - get: - operationId: Tags_GetTagMachineCatalogs + - Sessions APIs + /Sessions/{id}/$disconnect: + post: + description: Disconnect a session. + operationId: Sessions_DisconnectSession parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -266146,10 +264712,10 @@ paths: schema: type: string style: simple - - description: Name or ID of the tag. + - description: ID of the session to disconnect. explode: false in: path - name: nameOrId + name: id required: true schema: nullable: true @@ -266158,44 +264724,32 @@ paths: style: simple x-position: 1 - description: |- - The max number of machine catalogs returned by this query. - If not specified, the server might use a default limit of 250 items. - If the specified value is larger than 1000, the server might reject the call. - The default and maximum values depend on server settings. + If `true`, the session will be disconnected as a background task. + The task will have JobType . + When the task is complete it will redirect to + . + The job's will contain properties: + + + * _Id_ - ID of the session being disconnected. explode: true in: query - name: limit + name: async required: false schema: - format: int32 + default: false nullable: true - title: Int32 - type: integer + title: Boolean + type: boolean style: form x-position: 2 - - description: |- - If a query cannot be completed, the response will have a - ContinuationToken set. - To obtain more results from the query, pass the - continuation token back into the query to get the next - batch of results. - explode: true - in: query - name: continuationToken - required: false - schema: - nullable: true - title: String - type: string - style: form - x-position: 3 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/MachineCatalogResponseModelCollection' - description: List of machine catalogs. + $ref: '#/components/schemas/SessionResponseModel' + description: Details of the session. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -266248,6 +264802,67 @@ paths: schema: type: string style: simple + "202": + description: Async request was accepted and is being processed. + headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple "400": content: application/json: @@ -266582,21 +265197,85 @@ paths: schema: type: string style: simple - "429": + "409": content: application/json: example: - https://errors-api.cloud.com/common/rateLimitExceeded: + https://errors-api.cloud.com/common/optimisticConcurrency: value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds - parameters: - - name: retryDelay - value: "4" + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. + description: Caller requested an invalid relation to be created or deleted. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "429": + content: + application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller has made too many requests in a short period of time + and is being rate-limited. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -266783,12 +265462,12 @@ paths: schema: type: string style: simple - summary: Get the machine catalogs associated with a tag. + summary: Disconnect a session. tags: - - Tags APIs - /Tags/{nameOrId}/Machines: - get: - operationId: Tags_GetTagMachines + - Sessions APIs + /Sessions/{id}/$hide: + post: + operationId: Sessions_HideSession parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -266851,10 +265530,10 @@ paths: schema: type: string style: simple - - description: Name or ID of the tag. + - description: ID of the session to hide or unhide. explode: false in: path - name: nameOrId + name: id required: true schema: nullable: true @@ -266862,59 +265541,83 @@ paths: type: string style: simple x-position: 1 - - description: |- - The max number of machines returned by this query. - If not specified, the server might use a default limit of 250 items. - If the specified value is larger than 1000, the server might reject the call. - The default and maximum values depend on server settings. + - description: "If `true`, the session will be hidden as a background task." explode: true in: query - name: limit + name: async required: false schema: - format: int32 + default: false nullable: true - title: Int32 - type: integer + title: Boolean + type: boolean style: form x-position: 2 - - description: |- - If a query cannot be completed, the response will have a - ContinuationToken set. - To obtain more results from the query, pass the - continuation token back into the query to get the next - batch of results. - explode: true - in: query - name: continuationToken - required: false - schema: - nullable: true - title: String - type: string - style: form - x-position: 3 - - description: "Optional filter, removing unspecified properties that otherwise\ - \ would\nhave been sent by the server\n " - example: "Uid,AgentVersion,AllocationType" - explode: true - in: query - name: fields - required: false - schema: - nullable: true - title: String - type: string - style: form - x-position: 4 responses: - "200": - content: - application/json: + "204": + description: Operation is successful with no response content. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false schema: - $ref: '#/components/schemas/MachineResponseModelCollection' - description: List of machines. + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "202": + description: Async request was accepted and is being processed. headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -267300,6 +266003,70 @@ paths: schema: type: string style: simple + "409": + content: + application/json: + example: + https://errors-api.cloud.com/common/optimisticConcurrency: + value: + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller requested an invalid relation to be created or deleted. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple "429": content: application/json: @@ -267501,27 +266268,13 @@ paths: schema: type: string style: simple - summary: Get the machines associated with a tag. + summary: Hide a session tags: - - Tags APIs - /TimeZones/All: - get: - description: |- - Get a (non-exhaustive) list of time zones supported by the site, - with time zone names represented in the caller's locale. - - - Note that all IANA (https://www.iana.org/time-zones) time zones are - supported as inputs to time zone APIs. However sometimes callers - need a suitable list of time zones to display as options within a - UI. This API provides that capability. The options returned - represent a reasonable palette of options for a caller to choose - from when selecting a time zone. - - - The localized time zone names come from the Unicode CLDR - (http://cldr.unicode.org/) project. - operationId: TimeZones_GetTimeZones + - Sessions APIs + /Sessions/{id}/$logoff: + post: + description: Logoff a session. + operationId: Sessions_LogoffSession parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -267584,14 +266337,102 @@ paths: schema: type: string style: simple + - description: ID of the session to log off. + explode: false + in: path + name: id + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 1 + - description: |- + If `true`, the session will be logged off as a background task. + The task will have JobType . + When the task is complete it will redirect to + . + The job's will contain properties: + + + * _Id_ - ID of the session being logged off. + explode: true + in: query + name: async + required: false + schema: + default: false + nullable: true + title: Boolean + type: boolean + style: form + x-position: 2 responses: - "200": - content: - application/json: + "204": + description: Operation is successful with no response content. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false schema: - $ref: '#/components/schemas/TimeZoneResponseModelCollection' - description: List of time zones. + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "202": + description: Async request was accepted and is being processed. headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -267843,6 +266684,74 @@ paths: schema: type: string style: simple + "404": + content: + application/json: + example: + https://errors-api.cloud.com/common/notFound: + value: + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: A referenced entity was not found. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple "406": content: application/json: @@ -267909,6 +266818,70 @@ paths: schema: type: string style: simple + "409": + content: + application/json: + example: + https://errors-api.cloud.com/common/optimisticConcurrency: + value: + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller requested an invalid relation to be created or deleted. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple "429": content: application/json: @@ -268110,12 +267083,13 @@ paths: schema: type: string style: simple - summary: Get a list of time zones supported by the site. + summary: Logoff a session. tags: - - TimeZones APIs - /tokens: - get: - operationId: Trust_GetBearerTokenWithWindowsAuthentication + - Sessions APIs + /Sessions/{id}/$sendMessage: + post: + description: Send a message to a session. + operationId: Sessions_SendSessionMessage parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -268126,6 +267100,23 @@ paths: schema: type: string style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple - description: "Citrix authorization header: CWSAuth Bearer={token}" explode: false in: header @@ -268161,13 +267152,53 @@ paths: schema: type: string style: simple + - description: ID of the session to send a message to. + explode: false + in: path + name: id + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 1 + - description: |- + If `true`, the message will be sent as a background task. + The task will have JobType . + When the task is complete it will redirect to + . + The job's will contain properties: + + + * _Id_ - ID of the session to which a message is being sent. + explode: true + in: query + name: async + required: false + schema: + default: false + nullable: true + title: Boolean + type: boolean + style: form + x-position: 3 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SendMessageRequestModel' + description: Details of the message to send. + required: true + x-name: message + x-position: 2 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/AuthTokenResponseModel' - description: 'AuthTokenResponseModel object. ' + $ref: '#/components/schemas/SessionResponseModel' + description: Details of the session. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -268220,21 +267251,16 @@ paths: schema: type: string style: simple - "400": - content: - application/json: - example: - https://errors-api.cloud.com/common/outOfRange: - value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range - parameters: - - name: property - value: startTime - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + "202": + description: Async request was accepted and is being processed. headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -268286,20 +267312,20 @@ paths: schema: type: string style: simple - "401": + "400": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/outOfRange: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range parameters: - - name: reason - value: missing + - name: property + value: startTime schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: Caller passed an invalid input. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -268352,22 +267378,20 @@ paths: schema: type: string style: simple - "403": + "401": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -268420,20 +267444,22 @@ paths: schema: type: string style: simple - "406": + "403": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - - name: contentType - value: application/json + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -268486,21 +267512,22 @@ paths: schema: type: string style: simple - "429": + "404": content: application/json: example: - https://errors-api.cloud.com/common/rateLimitExceeded: + https://errors-api.cloud.com/common/notFound: value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found parameters: - - name: retryDelay - value: "4" + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. + description: A referenced entity was not found. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -268553,21 +267580,20 @@ paths: schema: type: string style: simple - "503": + "406": content: application/json: example: - https://errors-api.cloud.com/common/serviceUnavailable: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/serviceUnavailable - detail: Service is unavailable; try again in 4 seconds + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type parameters: - - name: retryDelay - value: "4" + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: "Service is temporarily unable to process the request. Caller\ - \ may attempt the operation again, with exponential back-off." + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -268620,21 +267646,18 @@ paths: schema: type: string style: simple - "500": + "409": content: application/json: example: - https://errors-api.cloud.com/common/internalServerError: + https://errors-api.cloud.com/common/optimisticConcurrency: value: - type: https://errors-api.cloud.com/common/internalServerError - detail: An internal server error has occurred; try again in 4 - seconds - parameters: - - name: retryDelay - value: "4" + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null schema: $ref: '#/components/schemas/ErrorResponse' - description: An unexpected server error occurred. + description: Caller requested an invalid relation to be created or deleted. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -268687,65 +267710,21 @@ paths: schema: type: string style: simple - summary: |- - Exchange the FMA token via Windows Authentication. - Kerberos or NTLM authentication required for current Web Api. - tags: - - Trust APIs - post: - operationId: Trust_ExchangeToken - parameters: - - description: Citrix Customer ID. Default is 'CitrixOnPremises' - example: CitrixOnPremises - explode: false - in: header - name: Citrix-CustomerId - required: true - schema: - type: string - style: simple - - description: "Citrix authorization header: CWSAuth Bearer={token}" - explode: false - in: header - name: Authorization - required: false - schema: - type: string - style: simple - - description: "Transaction ID that will be used to track this request. If not\ - \ provided, a new GUID will be generated and returned." - explode: false - in: header - name: Citrix-TransactionId - required: false - schema: - type: string - style: simple - - description: Must accept application/json. - example: application/json - explode: false - in: header - name: Accept - required: false - schema: - type: string - style: simple - - description: Locale of the request. - example: en-US - explode: false - in: header - name: Citrix-Locale - required: false - schema: - type: string - style: simple - responses: - "200": + "415": content: application/json: + example: + https://errors-api.cloud.com/common/unsupportedMediaType: + value: + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type + parameters: + - name: mediaType + value: application/xml schema: - $ref: '#/components/schemas/AuthTokenResponseModel' - description: 'AuthTokenResponseModel object. ' + $ref: '#/components/schemas/ErrorResponse' + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -268798,20 +267777,21 @@ paths: schema: type: string style: simple - "400": + "429": content: application/json: example: - https://errors-api.cloud.com/common/outOfRange: + https://errors-api.cloud.com/common/rateLimitExceeded: value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds parameters: - - name: property - value: startTime + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + description: Caller has made too many requests in a short period of time + and is being rate-limited. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -268864,20 +267844,21 @@ paths: schema: type: string style: simple - "401": + "503": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/serviceUnavailable: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds parameters: - - name: reason - value: missing + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -268930,22 +267911,21 @@ paths: schema: type: string style: simple - "403": + "500": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/internalServerError: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: An unexpected server error occurred. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -268998,20 +267978,125 @@ paths: schema: type: string style: simple - "406": + summary: Send a message to a session. + tags: + - Sessions APIs + /Sessions/{id}/$startRecording: + post: + description: start recording for a session. + operationId: Sessions_StartSessionRecording + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + - description: ID of the session. + explode: false + in: path + name: id + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 1 + - description: Whether to notify session user or not. + explode: true + in: query + name: notifyUser + required: false + schema: + default: true + nullable: true + title: Boolean + type: boolean + style: form + x-position: 2 + - description: |- + If `true`, the session will be recorded as a background task. + The task will have JobType . + When the task is complete it will redirect to + . + The job's will contain properties: + + + * _Id_ - ID of the session. + explode: true + in: query + name: async + required: false + schema: + default: false + nullable: true + title: Boolean + type: boolean + style: form + x-position: 3 + responses: + "200": content: application/json: - example: - https://errors-api.cloud.com/common/notAcceptable: - value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type - parameters: - - name: contentType - value: application/json schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + $ref: '#/components/schemas/SessionResponseModel' + description: Details of the session. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -269064,19 +268149,16 @@ paths: schema: type: string style: simple - "409": - content: - application/json: - example: - https://errors-api.cloud.com/common/optimisticConcurrency: - value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. + "202": + description: Async request was accepted and is being processed. headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -269128,21 +268210,20 @@ paths: schema: type: string style: simple - "429": + "400": content: application/json: example: - https://errors-api.cloud.com/common/rateLimitExceeded: + https://errors-api.cloud.com/common/outOfRange: value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range parameters: - - name: retryDelay - value: "4" + - name: property + value: startTime schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. + description: Caller passed an invalid input. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -269195,21 +268276,20 @@ paths: schema: type: string style: simple - "503": + "401": content: application/json: example: - https://errors-api.cloud.com/common/serviceUnavailable: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/serviceUnavailable - detail: Service is unavailable; try again in 4 seconds + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: retryDelay - value: "4" + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: "Service is temporarily unable to process the request. Caller\ - \ may attempt the operation again, with exponential back-off." + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -269262,21 +268342,22 @@ paths: schema: type: string style: simple - "500": + "403": content: application/json: example: - https://errors-api.cloud.com/common/internalServerError: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/internalServerError - detail: An internal server error has occurred; try again in 4 - seconds + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - - name: retryDelay - value: "4" + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: An unexpected server error occurred. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -269329,66 +268410,22 @@ paths: schema: type: string style: simple - summary: |- - Exchange the FMA token by using the domain credential. - Basic authentication required for current Web Api. - tags: - - Trust APIs - /tokens/$refresh: - post: - operationId: Trust_RefreshToken - parameters: - - description: Citrix Customer ID. Default is 'CitrixOnPremises' - example: CitrixOnPremises - explode: false - in: header - name: Citrix-CustomerId - required: true - schema: - type: string - style: simple - - description: "Citrix authorization header: CWSAuth Bearer={token}" - explode: false - in: header - name: Authorization - required: false - schema: - type: string - style: simple - - description: "Transaction ID that will be used to track this request. If not\ - \ provided, a new GUID will be generated and returned." - explode: false - in: header - name: Citrix-TransactionId - required: false - schema: - type: string - style: simple - - description: Must accept application/json. - example: application/json - explode: false - in: header - name: Accept - required: false - schema: - type: string - style: simple - - description: Locale of the request. - example: en-US - explode: false - in: header - name: Citrix-Locale - required: false - schema: - type: string - style: simple - responses: - "200": + "404": content: application/json: + example: + https://errors-api.cloud.com/common/notFound: + value: + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: - $ref: '#/components/schemas/AuthTokenResponseModel' - description: 'AuthTokenResponseModel object. ' + $ref: '#/components/schemas/ErrorResponse' + description: A referenced entity was not found. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -269441,20 +268478,20 @@ paths: schema: type: string style: simple - "400": + "406": content: application/json: example: - https://errors-api.cloud.com/common/outOfRange: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type parameters: - - name: property - value: startTime + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -269507,218 +268544,18 @@ paths: schema: type: string style: simple - "401": + "409": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/optimisticConcurrency: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details - parameters: - - name: reason - value: missing + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "403": - content: - application/json: - example: - https://errors-api.cloud.com/common/authorization: - value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied - parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "406": - content: - application/json: - example: - https://errors-api.cloud.com/common/notAcceptable: - value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type - parameters: - - name: contentType - value: application/json - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "409": - content: - application/json: - example: - https://errors-api.cloud.com/common/optimisticConcurrency: - value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. + description: Caller requested an invalid relation to be created or deleted. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -269972,15 +268809,13 @@ paths: schema: type: string style: simple - summary: Refresh the auth token. + summary: start recording for a session. tags: - - Trust APIs - /UserZonePreferences: - get: - description: |- - The number of users or user groups may be huge. Therefore, we support the - 'limit' and 'continuationToken' query strings. - operationId: Zones_GetUserZonePreferenceList + - Sessions APIs + /Sessions/{id}/$stopRecording: + post: + description: stop recording for a session. + operationId: Sessions_StopSessionRecording parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -270043,36 +268878,35 @@ paths: schema: type: string style: simple - - description: |- - The max number of user zone preferences returned by this query. - If not specified, the server might use a default limit of 250 items. - If the specified value is larger than 1000, the server might reject the call. - The default and maximum values depend on server settings. - explode: true - in: query - name: limit - required: false + - description: ID of the session. + explode: false + in: path + name: id + required: true schema: - format: int32 nullable: true - title: Int32 - type: integer - style: form + title: String + type: string + style: simple x-position: 1 - description: |- - If a query cannot be completed, the response will have a - ContinuationToken set. - To obtain more results from the query, pass the - continuation token back into the query to get the next - batch of results. + If `true`, the session will be recorded as a background task. + The task will have JobType . + When the task is complete it will redirect to + . + The job's will contain properties: + + + * _Id_ - ID of the session. explode: true in: query - name: continuationToken + name: async required: false schema: + default: false nullable: true - title: String - type: string + title: Boolean + type: boolean style: form x-position: 2 responses: @@ -270080,8 +268914,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UserZonePreferenceResponseModelCollection' - description: The list users and user groups. + $ref: '#/components/schemas/SessionResponseModel' + description: Details of the session. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -270134,6 +268968,67 @@ paths: schema: type: string style: simple + "202": + description: Async request was accepted and is being processed. + headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple "400": content: application/json: @@ -270334,20 +269229,152 @@ paths: schema: type: string style: simple - "406": + "404": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/notFound: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found parameters: - - name: contentType - value: application/json + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + description: A referenced entity was not found. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "409": + content: + application/json: + example: + https://errors-api.cloud.com/common/optimisticConcurrency: + value: + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller requested an invalid relation to be created or deleted. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -270601,11 +269628,12 @@ paths: schema: type: string style: simple - summary: "[DEPRECATED] Get zone preference list in this site." + summary: stop recording for a session. tags: - - Zones APIs + - Sessions APIs + /Sessions/{id}/$unhide: post: - operationId: Zones_CreateUserZonePreference + operationId: Sessions_UnhideSession parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -270668,22 +269696,32 @@ paths: schema: type: string style: simple - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CreateUserZonePreferenceModel' - description: The CreateUserZonePreferenceModel. + - description: ID of the session to hide or unhide. + explode: false + in: path + name: id required: true - x-name: request + schema: + nullable: true + title: String + type: string + style: simple x-position: 1 + - description: "If `true`, the session will be hidden as a background task." + explode: true + in: query + name: async + required: false + schema: + default: false + nullable: true + title: Boolean + type: boolean + style: form + x-position: 2 responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/UserZonePreferenceResponseModel' - description: The list users and user groups of the zone. + "204": + description: Operation is successful with no response content. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -270736,21 +269774,16 @@ paths: schema: type: string style: simple - "400": - content: - application/json: - example: - https://errors-api.cloud.com/common/outOfRange: - value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range - parameters: - - name: property - value: startTime - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + "202": + description: Async request was accepted and is being processed. headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -270802,20 +269835,20 @@ paths: schema: type: string style: simple - "401": + "400": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/outOfRange: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range parameters: - - name: reason - value: missing + - name: property + value: startTime schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: Caller passed an invalid input. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -270868,22 +269901,20 @@ paths: schema: type: string style: simple - "403": + "401": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -270936,20 +269967,22 @@ paths: schema: type: string style: simple - "406": + "403": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - - name: contentType - value: application/json + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -271002,18 +270035,22 @@ paths: schema: type: string style: simple - "409": + "404": content: application/json: example: - https://errors-api.cloud.com/common/optimisticConcurrency: + https://errors-api.cloud.com/common/notFound: value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. + description: A referenced entity was not found. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -271066,21 +270103,84 @@ paths: schema: type: string style: simple - "415": + "406": content: application/json: example: - https://errors-api.cloud.com/common/unsupportedMediaType: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/unsupportedMediaType - detail: Must use application/json;charset=utf-8 media type + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type parameters: - - name: mediaType - value: application/xml + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must send request body in utf-8 and specify request - Content-Type as utf-8. + description: Caller must specify utf-8 charset with the Accept header. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "409": + content: + application/json: + example: + https://errors-api.cloud.com/common/optimisticConcurrency: + value: + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller requested an invalid relation to be created or deleted. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -271334,15 +270434,13 @@ paths: schema: type: string style: simple - summary: "[DEPRECATED] Create a zone preference for a user or group account\ - \ in this site." + summary: Unhide a session tags: - - Zones APIs - /UserZonePreferences/{name}: - delete: - description: "If there is whitespace in the name, the whitespace must be URL\ - \ encoded." - operationId: Zones_DeleteUserZonePreference + - Sessions APIs + /Sessions/{id}/Applications: + get: + description: Get the list of applications running within a session. + operationId: Sessions_GetSessionApplications parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -271405,10 +270503,10 @@ paths: schema: type: string style: simple - - description: Name of a user or user group. + - description: ID of the session. explode: false in: path - name: name + name: id required: true schema: nullable: true @@ -271416,9 +270514,32 @@ paths: type: string style: simple x-position: 1 + - description: |- + If `true`, the get applications will be executed as a background task. + The task will have JobType GetSessionApplications. + When the task is complete it will redirect to + GetJobResults. + The job's Parameters will contain properties: + + * _Id_ - ID of the session being queried. + explode: true + in: query + name: async + required: false + schema: + default: false + nullable: true + title: Boolean + type: boolean + style: form + x-position: 2 responses: - "204": - description: Operation is successful with no response content. + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ApplicationResponseModelCollection' + description: List of applications. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -271471,21 +270592,16 @@ paths: schema: type: string style: simple - "400": - content: - application/json: - example: - https://errors-api.cloud.com/common/outOfRange: - value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range - parameters: - - name: property - value: startTime - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + "202": + description: Async request was accepted and is being processed. headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -271537,20 +270653,20 @@ paths: schema: type: string style: simple - "401": + "400": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/outOfRange: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range parameters: - - name: reason - value: missing + - name: property + value: startTime schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: Caller passed an invalid input. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -271603,22 +270719,20 @@ paths: schema: type: string style: simple - "403": + "401": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -271671,8 +270785,22 @@ paths: schema: type: string style: simple - "404": - description: A referenced entity was not found. + "403": + content: + application/json: + example: + https://errors-api.cloud.com/common/authorization: + value: + type: https://errors-api.cloud.com/common/authorization + detail: Access denied + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -271725,20 +270853,22 @@ paths: schema: type: string style: simple - "406": + "404": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/notFound: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found parameters: - - name: contentType - value: application/json + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + description: A referenced entity was not found. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -271791,18 +270921,20 @@ paths: schema: type: string style: simple - "409": + "406": content: application/json: example: - https://errors-api.cloud.com/common/optimisticConcurrency: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -272056,14 +271188,13 @@ paths: schema: type: string style: simple - summary: "[DEPRECATED] Delete a zone preference for a user or group account\ - \ in this site." + summary: Get the list of applications running within a session. tags: - - Zones APIs + - Sessions APIs + /Sessions/{id}/Machine: get: - description: "If there is whitespace in the name, the whitespace must be URL\ - \ encoded." - operationId: Zones_GetUserZonePreference + description: Get the details of the machine on which a session is running. + operationId: Sessions_GetSessionMachine parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -272126,10 +271257,10 @@ paths: schema: type: string style: simple - - description: Name of a user or user group. + - description: ID of the session. explode: false in: path - name: name + name: id required: true schema: nullable: true @@ -272142,8 +271273,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UserZonePreferenceResponseModel' - description: The UserZonePreferenceResponseModel. + $ref: '#/components/schemas/MachineDetailResponseModel' + description: Details of the machine. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -272731,14 +271862,13 @@ paths: schema: type: string style: simple - summary: "[DEPRECATED] Get a zone preference for a user or group account in\ - \ this site." + summary: Get the details of the machine on which a session is running. tags: - - Zones APIs - put: - description: "If there is whitespace in the name, the whitespace must be URL\ - \ encoded." - operationId: Zones_UpdateUserZonePreference + - Sessions APIs + /Sessions/RecordingStatus: + get: + description: get session recording status of a session. + operationId: Sessions_GetSessionRecordingStatus parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -272801,41 +271931,24 @@ paths: schema: type: string style: simple - - description: Name of a user or user group. - explode: false - in: path - name: name + - description: ID of the session. + explode: true + in: query + name: id required: true schema: nullable: true title: String type: string - style: simple + style: form x-position: 1 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/EditUserZonePreferenceRequestModel' - description: The EditUserZonePreferenceRequestModel. - required: true - x-name: request - x-position: 2 responses: - "400": + "200": content: application/json: - example: - https://errors-api.cloud.com/common/outOfRange: - value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range - parameters: - - name: property - value: startTime schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + $ref: '#/components/schemas/SessionRecordingStatusResponseModel' + description: "" headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -272888,8 +272001,20 @@ paths: schema: type: string style: simple - "204": - description: Operation is successful with no response content. + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -273076,74 +272201,6 @@ paths: schema: type: string style: simple - "404": - content: - application/json: - example: - https://errors-api.cloud.com/common/notFound: - value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found - parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 - schema: - $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple "406": content: application/json: @@ -273210,73 +272267,6 @@ paths: schema: type: string style: simple - "415": - content: - application/json: - example: - https://errors-api.cloud.com/common/unsupportedMediaType: - value: - type: https://errors-api.cloud.com/common/unsupportedMediaType - detail: Must use application/json;charset=utf-8 media type - parameters: - - name: mediaType - value: application/xml - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller must send request body in utf-8 and specify request - Content-Type as utf-8. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple "429": content: application/json: @@ -273478,14 +272468,12 @@ paths: schema: type: string style: simple - summary: "[DEPRECATED] Update a zone preference for a user or group account\ - \ in this site." + summary: get session recording status of a session. tags: - - Zones APIs - /Zones: + - Sessions APIs + /Sites: get: - description: Get the list of all zones in the site - operationId: Zones_GetZones + operationId: Sites_GetSites parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -273496,23 +272484,6 @@ paths: schema: type: string style: simple - - description: Citrix Instance (Site) ID. - explode: false - in: header - name: Citrix-InstanceId - required: true - schema: - type: string - style: simple - - description: User Agent type of the request. - example: Mozilla/5.0 - explode: false - in: header - name: User-Agent - required: false - schema: - type: string - style: simple - description: "Citrix authorization header: CWSAuth Bearer={token}" explode: false in: header @@ -273548,40 +272519,13 @@ paths: schema: type: string style: simple - - description: |- - The max number of zones returned by this query. - If not specified, the server might use a default limit of 250 items. - If the specified value is larger than 1000, the server might reject the call. - The default and maximum values depend on server settings. - explode: true - in: query - name: limit - required: false - schema: - format: int32 - nullable: true - title: Int32 - type: integer - style: form - x-position: 1 - - description: The continuationToken returned by the previous query. - explode: true - in: query - name: continuationToken - required: false - schema: - nullable: true - title: String - type: string - style: form - x-position: 2 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/ZoneResponseModelCollection' - description: List of zones. + $ref: '#/components/schemas/SiteResponseModelCollection' + description: List of sites. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -274101,11 +273045,13 @@ paths: schema: type: string style: simple - summary: Get the list of all zones in the site. + summary: Get the list of sites that are available to the customer and visible + to the admin. tags: - - Zones APIs - post: - operationId: Zones_CreateZone + - Sites APIs + /Sites/{nameOrId}: + get: + operationId: Sites_GetSite parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -274116,23 +273062,6 @@ paths: schema: type: string style: simple - - description: Citrix Instance (Site) ID. - explode: false - in: header - name: Citrix-InstanceId - required: true - schema: - type: string - style: simple - - description: User Agent type of the request. - example: Mozilla/5.0 - explode: false - in: header - name: User-Agent - required: false - schema: - type: string - style: simple - description: "Citrix authorization header: CWSAuth Bearer={token}" explode: false in: header @@ -274168,160 +273097,24 @@ paths: schema: type: string style: simple - - description: |- - If `true`, the zone will be created as a background task. - The task will have JobType CreateZone. - When the task is complete it will redirect to - GetZone. - The job's Parameters will contain properties: - - * _Id_ - ID of the zone being created, - * _Name_ - Name of the zone being created. - explode: true - in: query - name: async - required: false + - description: Name or ID of the site. + explode: false + in: path + name: nameOrId + required: true schema: - default: false nullable: true - title: Boolean - type: boolean - style: form - x-position: 2 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CreateZoneRequestModel' - description: Details about the zone to create. - required: true - x-name: request + title: String + type: string + style: simple x-position: 1 responses: - "201": - description: Resource was created. - headers: - Location: - description: Location where the newly created resource resides. - example: /services/myservice/widgets/1 - explode: false - schema: - type: string - style: simple - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "202": - description: Async request was accepted and is being processed. - headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false - schema: - type: string - style: simple - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false + "200": + content: + application/json: schema: - type: string - style: simple - "204": - description: Operation is successful with no response content. + $ref: '#/components/schemas/SiteDetailResponseModel' + description: Site details. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -274574,84 +273367,22 @@ paths: schema: type: string style: simple - "406": + "404": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/notFound: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found parameters: - - name: contentType - value: application/json - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "409": - content: - application/json: - example: - https://errors-api.cloud.com/common/optimisticConcurrency: - value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. + description: A referenced entity was not found. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -274704,21 +273435,20 @@ paths: schema: type: string style: simple - "415": + "406": content: application/json: example: - https://errors-api.cloud.com/common/unsupportedMediaType: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/unsupportedMediaType - detail: Must use application/json;charset=utf-8 media type + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type parameters: - - name: mediaType - value: application/xml + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must send request body in utf-8 and specify request - Content-Type as utf-8. + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -274972,12 +273702,15 @@ paths: schema: type: string style: simple - summary: Create a zone. + summary: Get the details about a single site. tags: - - Zones APIs - /Zones/$removeItems: + - Sites APIs + /Sites/{nameOrId}/$test: post: - operationId: Zones_RemoveItemsFromZone + description: |- + Run tests on a site and create a test report. Obtain the most recent report + from GetSiteTestReport. + operationId: Sites_TestSite parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -274988,23 +273721,6 @@ paths: schema: type: string style: simple - - description: Citrix Instance (Site) ID. - explode: false - in: header - name: Citrix-InstanceId - required: true - schema: - type: string - style: simple - - description: User Agent type of the request. - example: Mozilla/5.0 - explode: false - in: header - name: User-Agent - required: false - schema: - type: string - style: simple - description: "Citrix authorization header: CWSAuth Bearer={token}" explode: false in: header @@ -275040,9 +273756,27 @@ paths: schema: type: string style: simple + - description: Name or ID of the site. + explode: false + in: path + name: nameOrId + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 1 - description: |- - If `true`, items will be removed from the zone as a background task. - The task will have JobType RemoveItemsFromZone. + If `true`, the tests will run as a background task. This is recommended as the + tests may take some time to run, and if it exceeds 90 seconds the request may + time out. The task will have JobType TestSite. + When the task is complete it will redirect to + GetJobResults. The job's + Parameters will contain properties: + + * _Id_ - ID of the site being tested. + * _Name_ - Name of the site being tested. explode: true in: query name: async @@ -275054,18 +273788,13 @@ paths: type: boolean style: form x-position: 2 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ZonedItemsRequestModel' - description: The request. - required: true - x-name: request - x-position: 1 responses: - "204": - description: Operation is successful with no response content. + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/SiteTestResponseModel' + description: Site test details. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -275379,20 +274108,22 @@ paths: schema: type: string style: simple - "406": + "404": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/notFound: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found parameters: - - name: contentType - value: application/json + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + description: A referenced entity was not found. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -275445,18 +274176,20 @@ paths: schema: type: string style: simple - "409": + "406": content: application/json: example: - https://errors-api.cloud.com/common/optimisticConcurrency: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -275509,21 +274242,18 @@ paths: schema: type: string style: simple - "415": + "409": content: application/json: example: - https://errors-api.cloud.com/common/unsupportedMediaType: + https://errors-api.cloud.com/common/optimisticConcurrency: value: - type: https://errors-api.cloud.com/common/unsupportedMediaType - detail: Must use application/json;charset=utf-8 media type - parameters: - - name: mediaType - value: application/xml + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must send request body in utf-8 and specify request - Content-Type as utf-8. + description: Caller requested an invalid relation to be created or deleted. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -275777,15 +274507,12 @@ paths: schema: type: string style: simple - summary: Remove items from a zone. + summary: Run tests on a site and create a test report. tags: - - Zones APIs - /Zones/$search: - post: - description: |- - Perform a basic search for zoned items. - Note that the search action is used for items in zone, not for zone itself. - operationId: Zones_DoZoneSearch + - Sites APIs + /Sites/{nameOrId}/MultipleRemotePCAssignments: + get: + operationId: Sites_GetMultipleRemotePCAssignments parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -275796,23 +274523,6 @@ paths: schema: type: string style: simple - - description: Citrix Instance (Site) ID. - explode: false - in: header - name: Citrix-InstanceId - required: true - schema: - type: string - style: simple - - description: User Agent type of the request. - example: Mozilla/5.0 - explode: false - in: header - name: User-Agent - required: false - schema: - type: string - style: simple - description: "Citrix authorization header: CWSAuth Bearer={token}" explode: false in: header @@ -275848,70 +274558,26 @@ paths: schema: type: string style: simple - - description: |- - The max number of items of the same itemtype returned by this query. - If not specified, the server might use a default limit of 250 items. - If the specified value is larger than 1000, the server might reject the call. - The default and maximum values depend on server settings. - explode: true - in: query - name: limit - required: false - schema: - format: int32 - nullable: true - title: Int32 - type: integer - style: form - x-position: 2 - - description: |- - If a query cannot be completed, the response will have a - ContinuationToken set. - To obtain more results from the query, pass the - continuation token back into the query to get the next - batch of results. - explode: true - in: query - name: continuationToken - required: false + - description: Name or ID of the site. + explode: false + in: path + name: nameOrId + required: true schema: nullable: true title: String type: string - style: form - x-position: 3 - - description: |- - If `true`, the search zoned items will be executed as a background task. - The task will have JobType DoZoneSearch. - When the task is complete it will redirect to - GetJobResults. - explode: true - in: query - name: async - required: false - schema: - default: false - nullable: true - title: Boolean - type: boolean - style: form - x-position: 4 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ZonedItemSearchRequestModel' - description: Specifies the basic search parameters. - required: true - x-name: searchRequest + style: simple x-position: 1 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/ZonedItemResponseModelCollection' - description: List of zoned items that match the search criteria. + title: Boolean + type: boolean + description: The result indicating if allow multi-user auto-assignment for + Remote PC Access. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -275964,16 +274630,21 @@ paths: schema: type: string style: simple - "202": - description: Async request was accepted and is being processed. - headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime schema: - type: string - style: simple + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -276025,20 +274696,20 @@ paths: schema: type: string style: simple - "400": + "401": content: application/json: example: - https://errors-api.cloud.com/common/outOfRange: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: property - value: startTime + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -276091,20 +274762,22 @@ paths: schema: type: string style: simple - "401": + "403": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - - name: reason - value: missing + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -276157,14 +274830,14 @@ paths: schema: type: string style: simple - "403": + "404": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/notFound: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found parameters: - name: entityType value: https://identifiers-api.cloud.com/example/widget @@ -276172,7 +274845,7 @@ paths: value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: A referenced entity was not found. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -276291,137 +274964,6 @@ paths: schema: type: string style: simple - "409": - content: - application/json: - example: - https://errors-api.cloud.com/common/optimisticConcurrency: - value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "415": - content: - application/json: - example: - https://errors-api.cloud.com/common/unsupportedMediaType: - value: - type: https://errors-api.cloud.com/common/unsupportedMediaType - detail: Must use application/json;charset=utf-8 media type - parameters: - - name: mediaType - value: application/xml - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller must send request body in utf-8 and specify request - Content-Type as utf-8. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple "429": content: application/json: @@ -276623,19 +275165,11 @@ paths: schema: type: string style: simple - summary: Perform a basic search for zoned items. + summary: Get multi-user auto-assignment for Remote PC Access. tags: - - Zones APIs - /Zones/{nameOrId}: - delete: - description: |- - Only if there is no items in the zone, we may delete a zone. Items include: - - application - - controller - - host connection - - machine catalog - - user / user group - operationId: Zones_DeleteZone + - Sites APIs + patch: + operationId: Sites_PatchMultipleRemotePCAssignments parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -276646,23 +275180,6 @@ paths: schema: type: string style: simple - - description: Citrix Instance (Site) ID. - explode: false - in: header - name: Citrix-InstanceId - required: true - schema: - type: string - style: simple - - description: User Agent type of the request. - example: Mozilla/5.0 - explode: false - in: header - name: User-Agent - required: false - schema: - type: string - style: simple - description: "Citrix authorization header: CWSAuth Bearer={token}" explode: false in: header @@ -276698,7 +275215,7 @@ paths: schema: type: string style: simple - - description: 'Name or id of the zone to be deleted. ' + - description: Name or ID of the site. explode: false in: path name: nameOrId @@ -276709,16 +275226,12 @@ paths: type: string style: simple x-position: 1 - - description: |- - If `true`, the zone will be deleted as a background task. - The task will have JobType DeleteZone. + - description: specify if allow multi-user auto-assignment for Remote PC Access. explode: true in: query - name: async - required: false + name: allow + required: true schema: - default: false - nullable: true title: Boolean type: boolean style: form @@ -276778,67 +275291,6 @@ paths: schema: type: string style: simple - "202": - description: Async request was accepted and is being processed. - headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false - schema: - type: string - style: simple - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple "400": content: application/json: @@ -277040,6 +275492,20 @@ paths: type: string style: simple "404": + content: + application/json: + example: + https://errors-api.cloud.com/common/notFound: + value: + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' description: A referenced entity was not found. headers: Citrix-TransactionId: @@ -277159,70 +275625,6 @@ paths: schema: type: string style: simple - "409": - content: - application/json: - example: - https://errors-api.cloud.com/common/optimisticConcurrency: - value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple "429": content: application/json: @@ -277424,12 +275826,12 @@ paths: schema: type: string style: simple - summary: Delete a zone. + summary: Update multi-user auto-assignment for Remote PC Access. tags: - - Zones APIs + - Sites APIs + /Sites/{nameOrId}/SessionsTrend: get: - description: Get a single zone from the site - operationId: Zones_GetZone + operationId: Sites_GetSessionsTrend parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -277440,23 +275842,6 @@ paths: schema: type: string style: simple - - description: Citrix Instance (Site) ID. - explode: false - in: header - name: Citrix-InstanceId - required: true - schema: - type: string - style: simple - - description: User Agent type of the request. - example: Mozilla/5.0 - explode: false - in: header - name: User-Agent - required: false - schema: - type: string - style: simple - description: "Citrix authorization header: CWSAuth Bearer={token}" explode: false in: header @@ -277492,7 +275877,7 @@ paths: schema: type: string style: simple - - description: Name or ID of the zone. + - description: The site name or ID. explode: false in: path name: nameOrId @@ -277502,14 +275887,47 @@ paths: title: String type: string style: simple - x-position: 1 + x-position: 2 + - description: "The start date of sessions trend to query, for example '2021-11-01T12:00:00'." + explode: true + in: query + name: startDate + required: true + schema: + nullable: true + title: String + type: string + style: form + x-position: 3 + - description: "The end date of sessions trend to query, for example '2021-11-08T12:00:00'." + explode: true + in: query + name: endDate + required: true + schema: + nullable: true + title: String + type: string + style: form + x-position: 4 + - description: The minutes interval to query. + explode: true + in: query + name: intervalLength + required: true + schema: + format: int32 + title: Int32 + type: integer + style: form + x-position: 5 responses: "200": content: application/json: schema: - $ref: '#/components/schemas/ZoneDetailResponseModel' - description: Details of the zone. + $ref: '#/components/schemas/SessionsTrendResponseModel' + description: "" headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -278097,11 +276515,12 @@ paths: schema: type: string style: simple - summary: Get a single zone from the site. + summary: Get the sessions trend tags: - - Zones APIs - patch: - operationId: Zones_EditZone + - Sites APIs + /Sites/{nameOrId}/Settings: + get: + operationId: Sites_GetSiteSettings parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -278112,23 +276531,6 @@ paths: schema: type: string style: simple - - description: Citrix Instance (Site) ID. - explode: false - in: header - name: Citrix-InstanceId - required: true - schema: - type: string - style: simple - - description: User Agent type of the request. - example: Mozilla/5.0 - explode: false - in: header - name: User-Agent - required: false - schema: - type: string - style: simple - description: "Citrix authorization header: CWSAuth Bearer={token}" explode: false in: header @@ -278164,7 +276566,7 @@ paths: schema: type: string style: simple - - description: Name or ID of the zone. + - description: Name or ID of the site. explode: false in: path name: nameOrId @@ -278175,38 +276577,13 @@ paths: type: string style: simple x-position: 1 - - description: |- - If `true`, the zone will be edited as a background task. - The task will have JobType EditZone. - When the task is complete it will redirect to - GetZone. - The job's Parameters will contain properties: - - * _Id_ - ID of the zone being edited, - * _Name_ - Name of the zone being edited. - explode: true - in: query - name: async - required: false - schema: - default: false - nullable: true - title: Boolean - type: boolean - style: form - x-position: 3 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/EditZoneRequestModel' - description: The EditZoneRequestModel. - required: true - x-name: request - x-position: 2 responses: - "204": - description: Operation is successful with no response content. + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/SiteSettingsResponseModel' + description: The result of site settings. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -278259,16 +276636,21 @@ paths: schema: type: string style: simple - "202": - description: Async request was accepted and is being processed. - headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime schema: - type: string - style: simple + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the same request header or newly created. @@ -278320,20 +276702,20 @@ paths: schema: type: string style: simple - "400": + "401": content: application/json: example: - https://errors-api.cloud.com/common/outOfRange: + https://errors-api.cloud.com/common/authentication: value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details parameters: - - name: property - value: startTime + - name: reason + value: missing schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -278386,20 +276768,22 @@ paths: schema: type: string style: simple - "401": + "403": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - - name: reason - value: missing + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -278452,14 +276836,14 @@ paths: schema: type: string style: simple - "403": + "404": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/notFound: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found parameters: - name: entityType value: https://identifiers-api.cloud.com/example/widget @@ -278467,75 +276851,7 @@ paths: value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "404": - content: - application/json: - example: - https://errors-api.cloud.com/common/notFound: - value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found - parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 - schema: - $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. + description: A referenced entity was not found. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -278654,73 +276970,6 @@ paths: schema: type: string style: simple - "415": - content: - application/json: - example: - https://errors-api.cloud.com/common/unsupportedMediaType: - value: - type: https://errors-api.cloud.com/common/unsupportedMediaType - detail: Must use application/json;charset=utf-8 media type - parameters: - - name: mediaType - value: application/xml - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller must send request body in utf-8 and specify request - Content-Type as utf-8. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple "429": content: application/json: @@ -278922,12 +277171,11 @@ paths: schema: type: string style: simple - summary: Edit a zone. + summary: Get the settings for the site. tags: - - Zones APIs - /Zones/{nameOrId}/$addItems: - post: - operationId: Zones_AddItemsIntoZone + - Sites APIs + patch: + operationId: Sites_PatchSiteSettings parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -278938,23 +277186,6 @@ paths: schema: type: string style: simple - - description: Citrix Instance (Site) ID. - explode: false - in: header - name: Citrix-InstanceId - required: true - schema: - type: string - style: simple - - description: User Agent type of the request. - example: Mozilla/5.0 - explode: false - in: header - name: User-Agent - required: false - schema: - type: string - style: simple - description: "Citrix authorization header: CWSAuth Bearer={token}" explode: false in: header @@ -278990,7 +277221,7 @@ paths: schema: type: string style: simple - - description: The zone into which items will be added. + - description: Name or ID of the site. explode: false in: path name: nameOrId @@ -279001,26 +277232,12 @@ paths: type: string style: simple x-position: 1 - - description: |- - If `true`, items will be added into the zone as a background task. - The task will have JobType AddItemsIntoZone. - explode: true - in: query - name: async - required: false - schema: - default: false - nullable: true - title: Boolean - type: boolean - style: form - x-position: 3 requestBody: content: application/json: schema: - $ref: '#/components/schemas/ZonedItemsRequestModel' - description: The request. + $ref: '#/components/schemas/EditSiteSettingsRequestModel' + description: site settings request model. required: true x-name: request x-position: 2 @@ -279079,67 +277296,6 @@ paths: schema: type: string style: simple - "202": - description: Async request was accepted and is being processed. - headers: - Location: - description: Location where the async job completion status can be queried. - example: "Jobs/{id}" - explode: false - schema: - type: string - style: simple - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple "400": content: application/json: @@ -279474,85 +277630,21 @@ paths: schema: type: string style: simple - "409": + "415": content: application/json: example: - https://errors-api.cloud.com/common/optimisticConcurrency: + https://errors-api.cloud.com/common/unsupportedMediaType: value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type + parameters: + - name: mediaType + value: application/xml schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. - headers: - Citrix-TransactionId: - description: Transaction ID that is either provided by caller with the - same request header or newly created. - example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 - explode: false - schema: - type: string - style: simple - Content-Type: - description: Response Content Type. Value is always 'application/json'. - example: application/json - explode: false - schema: - type: string - style: simple - X-Content-Type-Options: - description: Content type options. Value is always 'nosniff'. - example: nosniff - explode: false - schema: - type: string - style: simple - Content-Language: - description: Content language. Value is either 'en-US' or based on client - language setting. - example: en-US - explode: false - schema: - type: string - style: simple - Cache-Control: - description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" - example: "no-cache, no-store, must-revalidate" - explode: false - schema: - type: string - style: simple - Pragma: - description: Pragma. Value is always 'no-cache'. - example: no-cache - explode: false - schema: - type: string - style: simple - Citrix-FilterScope: - description: Optional filter scope for getting scoped objects. - example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 - explode: false - schema: - type: string - style: simple - "415": - content: - application/json: - example: - https://errors-api.cloud.com/common/unsupportedMediaType: - value: - type: https://errors-api.cloud.com/common/unsupportedMediaType - detail: Must use application/json;charset=utf-8 media type - parameters: - - name: mediaType - value: application/xml - schema: - $ref: '#/components/schemas/ErrorResponse' - description: Caller must send request body in utf-8 and specify request - Content-Type as utf-8. + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -279806,12 +277898,12 @@ paths: schema: type: string style: simple - summary: Add items into a zone. + summary: Update the broker site settings. tags: - - Zones APIs - /Zones/{nameOrId}/$moveItems: - post: - operationId: Zones_MoveItemsIntoZone + - Sites APIs + /Sites/{nameOrId}/Status: + get: + operationId: Sites_GetSiteStatus parameters: - description: Citrix Customer ID. Default is 'CitrixOnPremises' example: CitrixOnPremises @@ -279822,23 +277914,6 @@ paths: schema: type: string style: simple - - description: Citrix Instance (Site) ID. - explode: false - in: header - name: Citrix-InstanceId - required: true - schema: - type: string - style: simple - - description: User Agent type of the request. - example: Mozilla/5.0 - explode: false - in: header - name: User-Agent - required: false - schema: - type: string - style: simple - description: "Citrix authorization header: CWSAuth Bearer={token}" explode: false in: header @@ -279874,7 +277949,7 @@ paths: schema: type: string style: simple - - description: The zone into which items will be moved. + - description: Name or ID of the site. explode: false in: path name: nameOrId @@ -279886,8 +277961,10 @@ paths: style: simple x-position: 1 - description: |- - If `true`, items will be moved into the zone as a background task. - The task will have JobType MoveItemsIntoZone. + If `true`, the site status query will be executed as a background task. + The task will have JobType GetSiteStatus. + When the task is complete it will redirect to + GetJobResults. explode: true in: query name: async @@ -279898,19 +277975,14 @@ paths: title: Boolean type: boolean style: form - x-position: 3 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ZonedItemsRequestModel' - description: The request. - required: true - x-name: request x-position: 2 responses: - "204": - description: Operation is successful with no response content. + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/SiteStatusResponseModel' + description: The site status. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -280358,18 +278430,21 @@ paths: schema: type: string style: simple - "409": + "429": content: application/json: example: - https://errors-api.cloud.com/common/optimisticConcurrency: + https://errors-api.cloud.com/common/rateLimitExceeded: value: - type: https://errors-api.cloud.com/common/optimisticConcurrency - detail: "Widget X was modified, please try your changes again" - parameters: null + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller requested an invalid relation to be created or deleted. + description: Caller has made too many requests in a short period of time + and is being rate-limited. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -280422,21 +278497,21 @@ paths: schema: type: string style: simple - "415": + "503": content: application/json: example: - https://errors-api.cloud.com/common/unsupportedMediaType: + https://errors-api.cloud.com/common/serviceUnavailable: value: - type: https://errors-api.cloud.com/common/unsupportedMediaType - detail: Must use application/json;charset=utf-8 media type + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds parameters: - - name: mediaType - value: application/xml + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must send request body in utf-8 and specify request - Content-Type as utf-8. + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -280489,21 +278564,21 @@ paths: schema: type: string style: simple - "429": + "500": content: application/json: example: - https://errors-api.cloud.com/common/rateLimitExceeded: + https://errors-api.cloud.com/common/internalServerError: value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds parameters: - name: retryDelay value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. + description: An unexpected server error occurred. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -280556,21 +278631,77 @@ paths: schema: type: string style: simple - "503": + summary: Get the status of a site. + tags: + - Sites APIs + /Sites/{nameOrId}/TestReport: + get: + description: Get the test report from the last run of TestSite. + operationId: Sites_GetSiteTestReport + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + - description: Name or ID of the site. + explode: false + in: path + name: nameOrId + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 1 + responses: + "200": content: application/json: - example: - https://errors-api.cloud.com/common/serviceUnavailable: - value: - type: https://errors-api.cloud.com/common/serviceUnavailable - detail: Service is unavailable; try again in 4 seconds - parameters: - - name: retryDelay - value: "4" schema: - $ref: '#/components/schemas/ErrorResponse' - description: "Service is temporarily unable to process the request. Caller\ - \ may attempt the operation again, with exponential back-off." + $ref: '#/components/schemas/TestReportResponseModel' + description: "Last test report. If no tests have been run, returns a 404\ + \ Not Found." headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -280623,21 +278754,20 @@ paths: schema: type: string style: simple - "500": + "400": content: application/json: example: - https://errors-api.cloud.com/common/internalServerError: + https://errors-api.cloud.com/common/outOfRange: value: - type: https://errors-api.cloud.com/common/internalServerError - detail: An internal server error has occurred; try again in 4 - seconds + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range parameters: - - name: retryDelay - value: "4" + - name: property + value: startTime schema: $ref: '#/components/schemas/ErrorResponse' - description: An unexpected server error occurred. + description: Caller passed an invalid input. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -280690,127 +278820,20 @@ paths: schema: type: string style: simple - summary: Move items into a zone. - tags: - - Zones APIs - /Zones/{nameOrId}/UserZonePreferences: - get: - description: |- - The number of users or user groups in a zone may be huge. Therefore, we support the - 'limit' and 'continuationToken' query strings. - operationId: Zones_GetUserZonePreferencesByZone - parameters: - - description: Citrix Customer ID. Default is 'CitrixOnPremises' - example: CitrixOnPremises - explode: false - in: header - name: Citrix-CustomerId - required: true - schema: - type: string - style: simple - - description: Citrix Instance (Site) ID. - explode: false - in: header - name: Citrix-InstanceId - required: true - schema: - type: string - style: simple - - description: User Agent type of the request. - example: Mozilla/5.0 - explode: false - in: header - name: User-Agent - required: false - schema: - type: string - style: simple - - description: "Citrix authorization header: CWSAuth Bearer={token}" - explode: false - in: header - name: Authorization - required: false - schema: - type: string - style: simple - - description: "Transaction ID that will be used to track this request. If not\ - \ provided, a new GUID will be generated and returned." - explode: false - in: header - name: Citrix-TransactionId - required: false - schema: - type: string - style: simple - - description: Must accept application/json. - example: application/json - explode: false - in: header - name: Accept - required: false - schema: - type: string - style: simple - - description: Locale of the request. - example: en-US - explode: false - in: header - name: Citrix-Locale - required: false - schema: - type: string - style: simple - - description: Name or Id of a zone. - explode: false - in: path - name: nameOrId - required: true - schema: - nullable: true - title: String - type: string - style: simple - x-position: 1 - - description: |- - The max number of user zone preferences returned by this query. - If not specified, the server might use a default limit of 250 items. - If the specified value is larger than 1000, the server might reject the call. - The default and maximum values depend on server settings. - explode: true - in: query - name: limit - required: false - schema: - format: int32 - nullable: true - title: Int32 - type: integer - style: form - x-position: 2 - - description: |- - If a query cannot be completed, the response will have a - ContinuationToken set. - To obtain more results from the query, pass the - continuation token back into the query to get the next - batch of results. - explode: true - in: query - name: continuationToken - required: false - schema: - nullable: true - title: String - type: string - style: form - x-position: 3 - responses: - "200": + "401": content: application/json: + example: + https://errors-api.cloud.com/common/authentication: + value: + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing schema: - $ref: '#/components/schemas/UserZonePreferenceResponseModelCollection' - description: The list users and user groups of the zone. + $ref: '#/components/schemas/ErrorResponse' + description: Caller did not present a valid bearer token. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -280863,20 +278886,22 @@ paths: schema: type: string style: simple - "400": + "403": content: application/json: example: - https://errors-api.cloud.com/common/outOfRange: + https://errors-api.cloud.com/common/authorization: value: - type: https://errors-api.cloud.com/common/outOfRange - detail: A parameter in the request is out of range + type: https://errors-api.cloud.com/common/authorization + detail: Access denied parameters: - - name: property - value: startTime + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller passed an invalid input. + description: Caller is not authorized to perform the operation. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -280929,20 +278954,22 @@ paths: schema: type: string style: simple - "401": + "404": content: application/json: example: - https://errors-api.cloud.com/common/authentication: + https://errors-api.cloud.com/common/notFound: value: - type: https://errors-api.cloud.com/common/authentication - detail: Missing or invalid authentication details + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found parameters: - - name: reason - value: missing + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller did not present a valid bearer token. + description: A referenced entity was not found. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -280995,22 +279022,20 @@ paths: schema: type: string style: simple - "403": + "406": content: application/json: example: - https://errors-api.cloud.com/common/authorization: + https://errors-api.cloud.com/common/notAcceptable: value: - type: https://errors-api.cloud.com/common/authorization - detail: Access denied + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: contentType + value: application/json schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller is not authorized to perform the operation. + description: Caller must specify utf-8 charset with the Accept header. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -281063,22 +279088,21 @@ paths: schema: type: string style: simple - "404": + "429": content: application/json: example: - https://errors-api.cloud.com/common/notFound: + https://errors-api.cloud.com/common/rateLimitExceeded: value: - type: https://errors-api.cloud.com/common/notFound - detail: Widget not found + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds parameters: - - name: entityType - value: https://identifiers-api.cloud.com/example/widget - - name: id - value: guid1 + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: A referenced entity was not found. + description: Caller has made too many requests in a short period of time + and is being rate-limited. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -281131,20 +279155,21 @@ paths: schema: type: string style: simple - "406": + "503": content: application/json: example: - https://errors-api.cloud.com/common/notAcceptable: + https://errors-api.cloud.com/common/serviceUnavailable: value: - type: https://errors-api.cloud.com/common/notAcceptable - detail: Must accept application/json media type + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds parameters: - - name: contentType - value: application/json + - name: retryDelay + value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller must specify utf-8 charset with the Accept header. + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -281197,21 +279222,21 @@ paths: schema: type: string style: simple - "429": + "500": content: application/json: example: - https://errors-api.cloud.com/common/rateLimitExceeded: + https://errors-api.cloud.com/common/internalServerError: value: - type: https://errors-api.cloud.com/common/rateLimitExceeded - detail: Rate limit exceeded; try again in 4 seconds + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds parameters: - name: retryDelay value: "4" schema: $ref: '#/components/schemas/ErrorResponse' - description: Caller has made too many requests in a short period of time - and is being rate-limited. + description: An unexpected server error occurred. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -281264,21 +279289,76 @@ paths: schema: type: string style: simple - "503": + summary: Get the most recent test report. + tags: + - Sites APIs + /Sites/{nameOrId}/UpgradePackageVersions: + get: + operationId: Sites_GetUpgradePackageVersions + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + - description: Name or ID of the site. + explode: false + in: path + name: nameOrId + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 1 + responses: + "200": content: application/json: - example: - https://errors-api.cloud.com/common/serviceUnavailable: - value: - type: https://errors-api.cloud.com/common/serviceUnavailable - detail: Service is unavailable; try again in 4 seconds - parameters: - - name: retryDelay - value: "4" schema: - $ref: '#/components/schemas/ErrorResponse' - description: "Service is temporarily unable to process the request. Caller\ - \ may attempt the operation again, with exponential back-off." + $ref: '#/components/schemas/UpgradePackageVersionResponseModelCollection' + description: The latest released VDA upgrade package version of each upgrade + package type. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -281331,21 +279411,28515 @@ paths: schema: type: string style: simple - "500": + "400": content: application/json: example: - https://errors-api.cloud.com/common/internalServerError: + https://errors-api.cloud.com/common/outOfRange: value: - type: https://errors-api.cloud.com/common/internalServerError - detail: An internal server error has occurred; try again in 4 - seconds + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range parameters: - - name: retryDelay - value: "4" + - name: property + value: startTime schema: $ref: '#/components/schemas/ErrorResponse' - description: An unexpected server error occurred. + description: Caller passed an invalid input. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "401": + content: + application/json: + example: + https://errors-api.cloud.com/common/authentication: + value: + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller did not present a valid bearer token. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "403": + content: + application/json: + example: + https://errors-api.cloud.com/common/authorization: + value: + type: https://errors-api.cloud.com/common/authorization + detail: Access denied + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller is not authorized to perform the operation. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "404": + content: + application/json: + example: + https://errors-api.cloud.com/common/notFound: + value: + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: A referenced entity was not found. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "429": + content: + application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller has made too many requests in a short period of time + and is being rate-limited. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "503": + content: + application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "500": + content: + application/json: + example: + https://errors-api.cloud.com/common/internalServerError: + value: + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: An unexpected server error occurred. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + summary: Get the latest released VDA upgrade package versions in the site. + tags: + - Sites APIs + /StoreFrontServers: + get: + description: |- + Get all StoreFront servers configured for use by hosted receivers + within the site. + operationId: StoreFrontServers_GetStoreFrontServers + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/StoreFrontServerResponseModelCollection' + description: List of StoreFront servers. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "401": + content: + application/json: + example: + https://errors-api.cloud.com/common/authentication: + value: + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller did not present a valid bearer token. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "403": + content: + application/json: + example: + https://errors-api.cloud.com/common/authorization: + value: + type: https://errors-api.cloud.com/common/authorization + detail: Access denied + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller is not authorized to perform the operation. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "429": + content: + application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller has made too many requests in a short period of time + and is being rate-limited. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "503": + content: + application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "500": + content: + application/json: + example: + https://errors-api.cloud.com/common/internalServerError: + value: + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: An unexpected server error occurred. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + summary: Get all StoreFront servers. + tags: + - StoreFrontServers APIs + post: + description: |- + Create a StoreFront server for use by hosted receivers within the + site. + operationId: StoreFrontServers_CreateStoreFrontServer + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + - description: |- + If `true`, the StoreFront server (and associated objects) will be + created as a background task. The task will have JobType + CreateStoreFrontServer. When the task is + complete it will redirect to + GetStoreFrontServer. The job's + Parameters will contain properties: + * _Name_ - Name of the StoreFront server being created. + explode: true + in: query + name: async + required: false + schema: + default: false + nullable: true + title: Boolean + type: boolean + style: form + x-position: 2 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StoreFrontServerRequestModel' + description: |- + Details about the StoreFront server to create. Note: the + Id property must not be + specified in the request. + required: true + x-name: request + x-position: 1 + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/StoreFrontServerResponseModel' + description: Details about the StoreFront server that was just created. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "202": + description: Async request was accepted and is being processed. + headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "401": + content: + application/json: + example: + https://errors-api.cloud.com/common/authentication: + value: + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller did not present a valid bearer token. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "403": + content: + application/json: + example: + https://errors-api.cloud.com/common/authorization: + value: + type: https://errors-api.cloud.com/common/authorization + detail: Access denied + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller is not authorized to perform the operation. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "409": + content: + application/json: + example: + https://errors-api.cloud.com/common/optimisticConcurrency: + value: + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller requested an invalid relation to be created or deleted. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "415": + content: + application/json: + example: + https://errors-api.cloud.com/common/unsupportedMediaType: + value: + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type + parameters: + - name: mediaType + value: application/xml + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "429": + content: + application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller has made too many requests in a short period of time + and is being rate-limited. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "503": + content: + application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "500": + content: + application/json: + example: + https://errors-api.cloud.com/common/internalServerError: + value: + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: An unexpected server error occurred. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + summary: Create a StoreFront server. + tags: + - StoreFrontServers APIs + /StoreFrontServers/{nameOrId}: + delete: + description: |- + Delete a StoreFront server from the site, regardless of whether it + is being used by delivery groups or not. This removes the + StoreFront server from hosted receivers. + operationId: StoreFrontServers_DeleteStoreFrontServer + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + - description: The name or ID of StoreFront server to be deleted. + explode: false + in: path + name: nameOrId + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 1 + - description: |- + If `true`, the StoreFront server (and associated objects) will be + deleted as a background task. The task will have JobType + DeleteStoreFrontServer. When the task is + complete it will redirect to + GetStoreFrontServers. The job's + Parameters will contain properties: + * _Name_ - Name of the StoreFront server being deleted. + explode: true + in: query + name: async + required: false + schema: + default: false + nullable: true + title: Boolean + type: boolean + style: form + x-position: 2 + responses: + "204": + description: Operation is successful with no response content. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "202": + description: Async request was accepted and is being processed. + headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "401": + content: + application/json: + example: + https://errors-api.cloud.com/common/authentication: + value: + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller did not present a valid bearer token. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "403": + content: + application/json: + example: + https://errors-api.cloud.com/common/authorization: + value: + type: https://errors-api.cloud.com/common/authorization + detail: Access denied + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller is not authorized to perform the operation. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "404": + description: A referenced entity was not found. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "409": + content: + application/json: + example: + https://errors-api.cloud.com/common/optimisticConcurrency: + value: + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller requested an invalid relation to be created or deleted. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "429": + content: + application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller has made too many requests in a short period of time + and is being rate-limited. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "503": + content: + application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "500": + content: + application/json: + example: + https://errors-api.cloud.com/common/internalServerError: + value: + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: An unexpected server error occurred. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + summary: Delete a StoreFront server from the site. + tags: + - StoreFrontServers APIs + get: + description: |- + Get a single StoreFront server configured for use by hosted + receivers within the site. + operationId: StoreFrontServers_GetStoreFrontServer + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + - description: The name or ID of the StoreFront server. + explode: false + in: path + name: nameOrId + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 1 + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/StoreFrontServerResponseModel' + description: Details of the StoreFront server. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "401": + content: + application/json: + example: + https://errors-api.cloud.com/common/authentication: + value: + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller did not present a valid bearer token. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "403": + content: + application/json: + example: + https://errors-api.cloud.com/common/authorization: + value: + type: https://errors-api.cloud.com/common/authorization + detail: Access denied + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller is not authorized to perform the operation. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "404": + content: + application/json: + example: + https://errors-api.cloud.com/common/notFound: + value: + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: A referenced entity was not found. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "429": + content: + application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller has made too many requests in a short period of time + and is being rate-limited. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "503": + content: + application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "500": + content: + application/json: + example: + https://errors-api.cloud.com/common/internalServerError: + value: + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: An unexpected server error occurred. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + summary: Get the details for a single StoreFront server. + tags: + - StoreFrontServers APIs + patch: + description: Update a StoreFront server. + operationId: StoreFrontServers_UpdateStoreFrontServer + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + - description: Name or ID of the StoreFront server to update. + explode: false + in: path + name: nameOrId + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 1 + - description: |- + If `true`, the StoreFront server (and associated objects) will be + updated as a background task. The task will have JobType + UpdateStoreFrontServer. When the task is + complete it will redirect to + GetStoreFrontServer. The job's + Parameters will contain properties: + * _Name_ - Name of the StoreFront server being updated. + explode: true + in: query + name: async + required: false + schema: + default: false + nullable: true + title: Boolean + type: boolean + style: form + x-position: 3 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StoreFrontServerRequestModel' + description: |- + Properties of the StoreFront server to update. Note: the + Id property must not be + specified in the request. + required: true + x-name: request + x-position: 2 + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/StoreFrontServerResponseModel' + description: New StoreFront server. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "202": + description: Async request was accepted and is being processed. + headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "204": + description: Operation is successful with no response content. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "401": + content: + application/json: + example: + https://errors-api.cloud.com/common/authentication: + value: + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller did not present a valid bearer token. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "403": + content: + application/json: + example: + https://errors-api.cloud.com/common/authorization: + value: + type: https://errors-api.cloud.com/common/authorization + detail: Access denied + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller is not authorized to perform the operation. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "404": + content: + application/json: + example: + https://errors-api.cloud.com/common/notFound: + value: + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: A referenced entity was not found. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "415": + content: + application/json: + example: + https://errors-api.cloud.com/common/unsupportedMediaType: + value: + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type + parameters: + - name: mediaType + value: application/xml + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "429": + content: + application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller has made too many requests in a short period of time + and is being rate-limited. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "503": + content: + application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "500": + content: + application/json: + example: + https://errors-api.cloud.com/common/internalServerError: + value: + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: An unexpected server error occurred. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + summary: Update a StoreFront server. + tags: + - StoreFrontServers APIs + /StoreFrontServers/{nameOrId}/DeliveryGroups: + get: + description: GET delivery groups details for a Storefront + operationId: StoreFrontServers_GetStoreFrontDeliveryGroups + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + - description: The id of the Storefront + explode: false + in: path + name: nameOrId + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 1 + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/StoreFrontDeliveryGroupResponseModelCollection' + description: The delivery groups for the Storefront with the given identifier + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "401": + content: + application/json: + example: + https://errors-api.cloud.com/common/authentication: + value: + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller did not present a valid bearer token. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "403": + content: + application/json: + example: + https://errors-api.cloud.com/common/authorization: + value: + type: https://errors-api.cloud.com/common/authorization + detail: Access denied + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller is not authorized to perform the operation. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "404": + content: + application/json: + example: + https://errors-api.cloud.com/common/notFound: + value: + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: A referenced entity was not found. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "429": + content: + application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller has made too many requests in a short period of time + and is being rate-limited. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "503": + content: + application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "500": + content: + application/json: + example: + https://errors-api.cloud.com/common/internalServerError: + value: + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: An unexpected server error occurred. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + summary: GET delivery groups details for a Storefront + tags: + - StoreFrontServers APIs + /Tags: + get: + operationId: Tags_GetTags + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + - description: |- + The max number of tags returned by this query. + If not specified, the server might use a default limit of 250 items. + If the specified value is larger than 1000, the server might reject the call. + The default and maximum values depend on server settings. + explode: true + in: query + name: limit + required: false + schema: + format: int32 + nullable: true + title: Int32 + type: integer + style: form + x-position: 1 + - description: |- + If a query cannot be completed, the response will have a + ContinuationToken set. + To obtain more results from the query, pass the + continuation token back into the query to get the next + batch of results. + explode: true + in: query + name: continuationToken + required: false + schema: + nullable: true + title: String + type: string + style: form + x-position: 2 + - description: The required fields of tag. + example: "Name,Id,Description" + explode: true + in: query + name: fields + required: false + schema: + nullable: true + title: String + type: string + style: form + x-position: 3 + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/TagResponseModelCollection' + description: List of tags. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "401": + content: + application/json: + example: + https://errors-api.cloud.com/common/authentication: + value: + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller did not present a valid bearer token. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "403": + content: + application/json: + example: + https://errors-api.cloud.com/common/authorization: + value: + type: https://errors-api.cloud.com/common/authorization + detail: Access denied + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller is not authorized to perform the operation. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "429": + content: + application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller has made too many requests in a short period of time + and is being rate-limited. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "503": + content: + application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "500": + content: + application/json: + example: + https://errors-api.cloud.com/common/internalServerError: + value: + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: An unexpected server error occurred. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + summary: Get the list of all tags in the site. + tags: + - Tags APIs + post: + operationId: Tags_CreateTag + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + - description: |- + If `true`, the tag will be created as a background task. + The task will have JobType CreateTag. + When the task is complete it will redirect to + "GetTag(string)". + The job's Parameters will contain properties: + + * _Name_ - Name of the tag being created. + explode: true + in: query + name: async + required: false + schema: + default: false + nullable: true + title: Boolean + type: boolean + style: form + x-position: 2 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TagRequestModel' + description: Details of the tag to create. + required: true + x-name: request + x-position: 1 + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/TagResponseModel' + description: Details of the tag created. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "202": + description: Async request was accepted and is being processed. + headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "401": + content: + application/json: + example: + https://errors-api.cloud.com/common/authentication: + value: + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller did not present a valid bearer token. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "403": + content: + application/json: + example: + https://errors-api.cloud.com/common/authorization: + value: + type: https://errors-api.cloud.com/common/authorization + detail: Access denied + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller is not authorized to perform the operation. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "409": + content: + application/json: + example: + https://errors-api.cloud.com/common/optimisticConcurrency: + value: + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller requested an invalid relation to be created or deleted. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "415": + content: + application/json: + example: + https://errors-api.cloud.com/common/unsupportedMediaType: + value: + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type + parameters: + - name: mediaType + value: application/xml + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "429": + content: + application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller has made too many requests in a short period of time + and is being rate-limited. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "503": + content: + application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "500": + content: + application/json: + example: + https://errors-api.cloud.com/common/internalServerError: + value: + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: An unexpected server error occurred. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + summary: Create a tag. + tags: + - Tags APIs + /Tags/{name}: + head: + description: Check for the existence of a tag by name. + operationId: Tags_CheckTagExists + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + - description: Name of the tag. + explode: false + in: path + name: name + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 1 + responses: + "204": + description: Operation is successful with no response content. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "401": + content: + application/json: + example: + https://errors-api.cloud.com/common/authentication: + value: + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller did not present a valid bearer token. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "403": + content: + application/json: + example: + https://errors-api.cloud.com/common/authorization: + value: + type: https://errors-api.cloud.com/common/authorization + detail: Access denied + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller is not authorized to perform the operation. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "404": + content: + application/json: + example: + https://errors-api.cloud.com/common/notFound: + value: + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: A referenced entity was not found. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "429": + content: + application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller has made too many requests in a short period of time + and is being rate-limited. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "503": + content: + application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "500": + content: + application/json: + example: + https://errors-api.cloud.com/common/internalServerError: + value: + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: An unexpected server error occurred. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + summary: Check for the existence of a tag by name. + tags: + - Tags APIs + /Tags/{nameOrId}: + delete: + operationId: Tags_DeleteTag + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + - description: Name or ID of the tag. + explode: false + in: path + name: nameOrId + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 1 + - description: |- + If `true`, the tag will be deleted as a background task. + The task will have JobType DeleteTag. + When the task is complete it will redirect to + GetTags. + The job's Parameters will contain properties: + + * _Id_ - ID of the tag being deleted, + * _Name_ - Name of the tag being deleted. + explode: true + in: query + name: async + required: false + schema: + default: false + nullable: true + title: Boolean + type: boolean + style: form + x-position: 2 + - description: For deleting the tag if true + explode: true + in: query + name: force + required: false + schema: + default: false + title: Boolean + type: boolean + style: form + x-position: 3 + responses: + "204": + description: Operation is successful with no response content. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "202": + description: Async request was accepted and is being processed. + headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "401": + content: + application/json: + example: + https://errors-api.cloud.com/common/authentication: + value: + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller did not present a valid bearer token. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "403": + content: + application/json: + example: + https://errors-api.cloud.com/common/authorization: + value: + type: https://errors-api.cloud.com/common/authorization + detail: Access denied + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller is not authorized to perform the operation. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "404": + description: A referenced entity was not found. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "409": + content: + application/json: + example: + https://errors-api.cloud.com/common/optimisticConcurrency: + value: + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller requested an invalid relation to be created or deleted. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "429": + content: + application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller has made too many requests in a short period of time + and is being rate-limited. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "503": + content: + application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "500": + content: + application/json: + example: + https://errors-api.cloud.com/common/internalServerError: + value: + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: An unexpected server error occurred. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + summary: Delete a tag. + tags: + - Tags APIs + get: + operationId: Tags_GetTag + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + - description: Name or ID of the tag. + explode: false + in: path + name: nameOrId + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 1 + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/TagDetailResponseModel' + description: List of tags. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "401": + content: + application/json: + example: + https://errors-api.cloud.com/common/authentication: + value: + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller did not present a valid bearer token. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "403": + content: + application/json: + example: + https://errors-api.cloud.com/common/authorization: + value: + type: https://errors-api.cloud.com/common/authorization + detail: Access denied + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller is not authorized to perform the operation. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "404": + content: + application/json: + example: + https://errors-api.cloud.com/common/notFound: + value: + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: A referenced entity was not found. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "429": + content: + application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller has made too many requests in a short period of time + and is being rate-limited. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "503": + content: + application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "500": + content: + application/json: + example: + https://errors-api.cloud.com/common/internalServerError: + value: + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: An unexpected server error occurred. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + summary: Get a single tag from the site. + tags: + - Tags APIs + patch: + operationId: Tags_PatchTag + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + - description: Name or ID of the tag. + explode: false + in: path + name: nameOrId + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 1 + - description: "If `true`, the tag will be updated as a background task.\nThe\ + \ task will have JobType UpdateTag.\nWhen the task is complete it will redirect\ + \ to\n\"GetTag(string)\".\nThe job's Parameters will contain properties:\n\ + \ \n* _Id_ - ID of the tag being updated,\n* _Name_ - Name of the tag being\ + \ updated." + explode: true + in: query + name: async + required: false + schema: + default: false + nullable: true + title: Boolean + type: boolean + style: form + x-position: 3 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TagRequestModel' + description: Details of the tag to update. + required: true + x-name: request + x-position: 2 + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/TagResponseModel' + description: Details of the tag updated. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "202": + description: Async request was accepted and is being processed. + headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "204": + description: Operation is successful with no response content. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "401": + content: + application/json: + example: + https://errors-api.cloud.com/common/authentication: + value: + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller did not present a valid bearer token. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "403": + content: + application/json: + example: + https://errors-api.cloud.com/common/authorization: + value: + type: https://errors-api.cloud.com/common/authorization + detail: Access denied + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller is not authorized to perform the operation. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "404": + content: + application/json: + example: + https://errors-api.cloud.com/common/notFound: + value: + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: A referenced entity was not found. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "415": + content: + application/json: + example: + https://errors-api.cloud.com/common/unsupportedMediaType: + value: + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type + parameters: + - name: mediaType + value: application/xml + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "429": + content: + application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller has made too many requests in a short period of time + and is being rate-limited. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "503": + content: + application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "500": + content: + application/json: + example: + https://errors-api.cloud.com/common/internalServerError: + value: + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: An unexpected server error occurred. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + summary: Update a tag. + tags: + - Tags APIs + /Tags/{nameOrId}/ApplicationGroups: + get: + operationId: Tags_GetTagApplicationGroups + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + - description: Name or ID of the tag. + explode: false + in: path + name: nameOrId + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 1 + - description: |- + The max number of application groups returned by this query. + If not specified, the server might use a default limit of 250 items. + If the specified value is larger than 1000, the server might reject the call. + The default and maximum values depend on server settings. + explode: true + in: query + name: limit + required: false + schema: + format: int32 + nullable: true + title: Int32 + type: integer + style: form + x-position: 2 + - description: |- + If a query cannot be completed, the response will have a + ContinuationToken set. + To obtain more results from the query, pass the + continuation token back into the query to get the next + batch of results. + explode: true + in: query + name: continuationToken + required: false + schema: + nullable: true + title: String + type: string + style: form + x-position: 3 + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ApplicationGroupResponseModelCollection' + description: List of application groups. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "401": + content: + application/json: + example: + https://errors-api.cloud.com/common/authentication: + value: + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller did not present a valid bearer token. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "403": + content: + application/json: + example: + https://errors-api.cloud.com/common/authorization: + value: + type: https://errors-api.cloud.com/common/authorization + detail: Access denied + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller is not authorized to perform the operation. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "404": + content: + application/json: + example: + https://errors-api.cloud.com/common/notFound: + value: + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: A referenced entity was not found. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "429": + content: + application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller has made too many requests in a short period of time + and is being rate-limited. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "503": + content: + application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "500": + content: + application/json: + example: + https://errors-api.cloud.com/common/internalServerError: + value: + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: An unexpected server error occurred. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + summary: Get the application groups associated with a tag. + tags: + - Tags APIs + /Tags/{nameOrId}/Applications: + get: + operationId: Tags_GetTagApplications + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + - description: Name or ID of the tag. + explode: false + in: path + name: nameOrId + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 1 + - description: |- + The max number of applications returned by this query. + If not specified, the server might use a default limit of 250 items. + If the specified value is larger than 1000, the server might reject the call. + The default and maximum values depend on server settings. + explode: true + in: query + name: limit + required: false + schema: + format: int32 + nullable: true + title: Int32 + type: integer + style: form + x-position: 2 + - description: |- + If a query cannot be completed, the response will have a + ContinuationToken set. + To obtain more results from the query, pass the + continuation token back into the query to get the next + batch of results. + explode: true + in: query + name: continuationToken + required: false + schema: + nullable: true + title: String + type: string + style: form + x-position: 3 + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ApplicationResponseModelCollection' + description: List of applications. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "401": + content: + application/json: + example: + https://errors-api.cloud.com/common/authentication: + value: + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller did not present a valid bearer token. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "403": + content: + application/json: + example: + https://errors-api.cloud.com/common/authorization: + value: + type: https://errors-api.cloud.com/common/authorization + detail: Access denied + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller is not authorized to perform the operation. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "404": + content: + application/json: + example: + https://errors-api.cloud.com/common/notFound: + value: + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: A referenced entity was not found. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "429": + content: + application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller has made too many requests in a short period of time + and is being rate-limited. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "503": + content: + application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "500": + content: + application/json: + example: + https://errors-api.cloud.com/common/internalServerError: + value: + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: An unexpected server error occurred. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + summary: Get the applications associated with a tag. + tags: + - Tags APIs + put: + description: Associate a tag with applications. + operationId: Tags_SetTagApplications + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + - description: Name or ID of the tag. + explode: false + in: path + name: nameOrId + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 1 + - description: |- + If `true`, the tags will be modified as a background task. + The task will have JobType SetTagApplications. + When the task is complete it will redirect to + GetTagApplications. + The job's Parameters will contain properties: + * _Id_ - ID of the tag being associated with applications, + * _Name_ - Name of the tag being associated with applications. + explode: true + in: query + name: async + required: false + schema: + default: false + nullable: true + title: Boolean + type: boolean + style: form + x-position: 3 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RefsRequestModel' + description: |- + The applications to tag. Any application + not listed will be untagged if it was previously associated with the tag. + required: true + x-name: request + x-position: 2 + responses: + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "202": + description: Async request was accepted and is being processed. + headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "204": + description: Operation is successful with no response content. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "401": + content: + application/json: + example: + https://errors-api.cloud.com/common/authentication: + value: + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller did not present a valid bearer token. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "403": + content: + application/json: + example: + https://errors-api.cloud.com/common/authorization: + value: + type: https://errors-api.cloud.com/common/authorization + detail: Access denied + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller is not authorized to perform the operation. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "404": + content: + application/json: + example: + https://errors-api.cloud.com/common/notFound: + value: + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: A referenced entity was not found. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "415": + content: + application/json: + example: + https://errors-api.cloud.com/common/unsupportedMediaType: + value: + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type + parameters: + - name: mediaType + value: application/xml + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "429": + content: + application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller has made too many requests in a short period of time + and is being rate-limited. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "503": + content: + application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "500": + content: + application/json: + example: + https://errors-api.cloud.com/common/internalServerError: + value: + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: An unexpected server error occurred. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + summary: Associate a tag with applications. + tags: + - Tags APIs + /Tags/{nameOrId}/DeliveryGroups: + get: + operationId: Tags_GetTagDeliveryGroups + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + - description: Name or ID of the tag. + explode: false + in: path + name: nameOrId + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 1 + - description: |- + The max number of delivery groups returned by this query. + If not specified, the server might use a default limit of 250 items. + If the specified value is larger than 1000, the server might reject the call. + The default and maximum values depend on server settings. + explode: true + in: query + name: limit + required: false + schema: + format: int32 + nullable: true + title: Int32 + type: integer + style: form + x-position: 2 + - description: |- + If a query cannot be completed, the response will have a + ContinuationToken set. + To obtain more results from the query, pass the + continuation token back into the query to get the next + batch of results. + explode: true + in: query + name: continuationToken + required: false + schema: + nullable: true + title: String + type: string + style: form + x-position: 3 + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DeliveryGroupResponseModelCollection' + description: List of delivery groups. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "401": + content: + application/json: + example: + https://errors-api.cloud.com/common/authentication: + value: + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller did not present a valid bearer token. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "403": + content: + application/json: + example: + https://errors-api.cloud.com/common/authorization: + value: + type: https://errors-api.cloud.com/common/authorization + detail: Access denied + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller is not authorized to perform the operation. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "404": + content: + application/json: + example: + https://errors-api.cloud.com/common/notFound: + value: + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: A referenced entity was not found. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "429": + content: + application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller has made too many requests in a short period of time + and is being rate-limited. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "503": + content: + application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "500": + content: + application/json: + example: + https://errors-api.cloud.com/common/internalServerError: + value: + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: An unexpected server error occurred. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + summary: Get the delivery groups associated with a tag. + tags: + - Tags APIs + put: + operationId: Tags_SetTagDeliveryGroups + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + - description: Name or ID of the tag. + explode: false + in: path + name: nameOrId + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 1 + - description: |- + If `true`, the tags will be modified as a background task. + The task will have JobType SetTagDeliveryGroups. + When the task is complete it will redirect to + GetTagDeliveryGroups. + The job's Parameters will contain properties: + + * _Id_ - ID of the tag being associated with delivery groups, + * _Name_ - Name of the tag being associated with delivery groups. + explode: true + in: query + name: async + required: false + schema: + default: false + nullable: true + title: Boolean + type: boolean + style: form + x-position: 3 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RefsRequestModel' + description: |- + The delivery groups to tag. Any delivery group + not listed will be untagged if it was previously associated with the tag. + required: true + x-name: request + x-position: 2 + responses: + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "202": + description: Async request was accepted and is being processed. + headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "204": + description: Operation is successful with no response content. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "401": + content: + application/json: + example: + https://errors-api.cloud.com/common/authentication: + value: + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller did not present a valid bearer token. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "403": + content: + application/json: + example: + https://errors-api.cloud.com/common/authorization: + value: + type: https://errors-api.cloud.com/common/authorization + detail: Access denied + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller is not authorized to perform the operation. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "404": + content: + application/json: + example: + https://errors-api.cloud.com/common/notFound: + value: + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: A referenced entity was not found. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "415": + content: + application/json: + example: + https://errors-api.cloud.com/common/unsupportedMediaType: + value: + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type + parameters: + - name: mediaType + value: application/xml + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "429": + content: + application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller has made too many requests in a short period of time + and is being rate-limited. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "503": + content: + application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "500": + content: + application/json: + example: + https://errors-api.cloud.com/common/internalServerError: + value: + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: An unexpected server error occurred. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + summary: Associate a tag with delivery groups. + tags: + - Tags APIs + /Tags/{nameOrId}/MachineCatalogs: + get: + operationId: Tags_GetTagMachineCatalogs + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + - description: Name or ID of the tag. + explode: false + in: path + name: nameOrId + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 1 + - description: |- + The max number of machine catalogs returned by this query. + If not specified, the server might use a default limit of 250 items. + If the specified value is larger than 1000, the server might reject the call. + The default and maximum values depend on server settings. + explode: true + in: query + name: limit + required: false + schema: + format: int32 + nullable: true + title: Int32 + type: integer + style: form + x-position: 2 + - description: |- + If a query cannot be completed, the response will have a + ContinuationToken set. + To obtain more results from the query, pass the + continuation token back into the query to get the next + batch of results. + explode: true + in: query + name: continuationToken + required: false + schema: + nullable: true + title: String + type: string + style: form + x-position: 3 + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/MachineCatalogResponseModelCollection' + description: List of machine catalogs. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "401": + content: + application/json: + example: + https://errors-api.cloud.com/common/authentication: + value: + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller did not present a valid bearer token. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "403": + content: + application/json: + example: + https://errors-api.cloud.com/common/authorization: + value: + type: https://errors-api.cloud.com/common/authorization + detail: Access denied + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller is not authorized to perform the operation. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "404": + content: + application/json: + example: + https://errors-api.cloud.com/common/notFound: + value: + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: A referenced entity was not found. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "429": + content: + application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller has made too many requests in a short period of time + and is being rate-limited. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "503": + content: + application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "500": + content: + application/json: + example: + https://errors-api.cloud.com/common/internalServerError: + value: + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: An unexpected server error occurred. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + summary: Get the machine catalogs associated with a tag. + tags: + - Tags APIs + /Tags/{nameOrId}/Machines: + get: + operationId: Tags_GetTagMachines + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + - description: Name or ID of the tag. + explode: false + in: path + name: nameOrId + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 1 + - description: |- + The max number of machines returned by this query. + If not specified, the server might use a default limit of 250 items. + If the specified value is larger than 1000, the server might reject the call. + The default and maximum values depend on server settings. + explode: true + in: query + name: limit + required: false + schema: + format: int32 + nullable: true + title: Int32 + type: integer + style: form + x-position: 2 + - description: |- + If a query cannot be completed, the response will have a + ContinuationToken set. + To obtain more results from the query, pass the + continuation token back into the query to get the next + batch of results. + explode: true + in: query + name: continuationToken + required: false + schema: + nullable: true + title: String + type: string + style: form + x-position: 3 + - description: "Optional filter, removing unspecified properties that otherwise\ + \ would\nhave been sent by the server\n " + example: "Uid,AgentVersion,AllocationType" + explode: true + in: query + name: fields + required: false + schema: + nullable: true + title: String + type: string + style: form + x-position: 4 + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/MachineResponseModelCollection' + description: List of machines. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "401": + content: + application/json: + example: + https://errors-api.cloud.com/common/authentication: + value: + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller did not present a valid bearer token. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "403": + content: + application/json: + example: + https://errors-api.cloud.com/common/authorization: + value: + type: https://errors-api.cloud.com/common/authorization + detail: Access denied + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller is not authorized to perform the operation. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "404": + content: + application/json: + example: + https://errors-api.cloud.com/common/notFound: + value: + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: A referenced entity was not found. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "429": + content: + application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller has made too many requests in a short period of time + and is being rate-limited. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "503": + content: + application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "500": + content: + application/json: + example: + https://errors-api.cloud.com/common/internalServerError: + value: + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: An unexpected server error occurred. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + summary: Get the machines associated with a tag. + tags: + - Tags APIs + /TimeZones/All: + get: + description: |- + Get a (non-exhaustive) list of time zones supported by the site, + with time zone names represented in the caller's locale. + + + Note that all IANA (https://www.iana.org/time-zones) time zones are + supported as inputs to time zone APIs. However sometimes callers + need a suitable list of time zones to display as options within a + UI. This API provides that capability. The options returned + represent a reasonable palette of options for a caller to choose + from when selecting a time zone. + + + The localized time zone names come from the Unicode CLDR + (http://cldr.unicode.org/) project. + operationId: TimeZones_GetTimeZones + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/TimeZoneResponseModelCollection' + description: List of time zones. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "401": + content: + application/json: + example: + https://errors-api.cloud.com/common/authentication: + value: + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller did not present a valid bearer token. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "403": + content: + application/json: + example: + https://errors-api.cloud.com/common/authorization: + value: + type: https://errors-api.cloud.com/common/authorization + detail: Access denied + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller is not authorized to perform the operation. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "429": + content: + application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller has made too many requests in a short period of time + and is being rate-limited. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "503": + content: + application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "500": + content: + application/json: + example: + https://errors-api.cloud.com/common/internalServerError: + value: + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: An unexpected server error occurred. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + summary: Get a list of time zones supported by the site. + tags: + - TimeZones APIs + /tokens: + get: + operationId: Trust_GetBearerTokenWithWindowsAuthentication + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/AuthTokenResponseModel' + description: 'AuthTokenResponseModel object. ' + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "401": + content: + application/json: + example: + https://errors-api.cloud.com/common/authentication: + value: + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller did not present a valid bearer token. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "403": + content: + application/json: + example: + https://errors-api.cloud.com/common/authorization: + value: + type: https://errors-api.cloud.com/common/authorization + detail: Access denied + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller is not authorized to perform the operation. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "429": + content: + application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller has made too many requests in a short period of time + and is being rate-limited. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "503": + content: + application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "500": + content: + application/json: + example: + https://errors-api.cloud.com/common/internalServerError: + value: + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: An unexpected server error occurred. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + summary: |- + Exchange the FMA token via Windows Authentication. + Kerberos or NTLM authentication required for current Web Api. + tags: + - Trust APIs + post: + operationId: Trust_ExchangeToken + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/AuthTokenResponseModel' + description: 'AuthTokenResponseModel object. ' + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "401": + content: + application/json: + example: + https://errors-api.cloud.com/common/authentication: + value: + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller did not present a valid bearer token. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "403": + content: + application/json: + example: + https://errors-api.cloud.com/common/authorization: + value: + type: https://errors-api.cloud.com/common/authorization + detail: Access denied + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller is not authorized to perform the operation. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "409": + content: + application/json: + example: + https://errors-api.cloud.com/common/optimisticConcurrency: + value: + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller requested an invalid relation to be created or deleted. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "429": + content: + application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller has made too many requests in a short period of time + and is being rate-limited. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "503": + content: + application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "500": + content: + application/json: + example: + https://errors-api.cloud.com/common/internalServerError: + value: + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: An unexpected server error occurred. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + summary: |- + Exchange the FMA token by using the domain credential. + Basic authentication required for current Web Api. + tags: + - Trust APIs + /tokens/$refresh: + post: + operationId: Trust_RefreshToken + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/AuthTokenResponseModel' + description: 'AuthTokenResponseModel object. ' + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "401": + content: + application/json: + example: + https://errors-api.cloud.com/common/authentication: + value: + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller did not present a valid bearer token. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "403": + content: + application/json: + example: + https://errors-api.cloud.com/common/authorization: + value: + type: https://errors-api.cloud.com/common/authorization + detail: Access denied + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller is not authorized to perform the operation. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "409": + content: + application/json: + example: + https://errors-api.cloud.com/common/optimisticConcurrency: + value: + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller requested an invalid relation to be created or deleted. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "429": + content: + application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller has made too many requests in a short period of time + and is being rate-limited. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "503": + content: + application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "500": + content: + application/json: + example: + https://errors-api.cloud.com/common/internalServerError: + value: + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: An unexpected server error occurred. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + summary: Refresh the auth token. + tags: + - Trust APIs + /UserZonePreferences: + get: + description: |- + The number of users or user groups may be huge. Therefore, we support the + 'limit' and 'continuationToken' query strings. + operationId: Zones_GetUserZonePreferenceList + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + - description: |- + The max number of user zone preferences returned by this query. + If not specified, the server might use a default limit of 250 items. + If the specified value is larger than 1000, the server might reject the call. + The default and maximum values depend on server settings. + explode: true + in: query + name: limit + required: false + schema: + format: int32 + nullable: true + title: Int32 + type: integer + style: form + x-position: 1 + - description: |- + If a query cannot be completed, the response will have a + ContinuationToken set. + To obtain more results from the query, pass the + continuation token back into the query to get the next + batch of results. + explode: true + in: query + name: continuationToken + required: false + schema: + nullable: true + title: String + type: string + style: form + x-position: 2 + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/UserZonePreferenceResponseModelCollection' + description: The list users and user groups. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "401": + content: + application/json: + example: + https://errors-api.cloud.com/common/authentication: + value: + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller did not present a valid bearer token. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "403": + content: + application/json: + example: + https://errors-api.cloud.com/common/authorization: + value: + type: https://errors-api.cloud.com/common/authorization + detail: Access denied + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller is not authorized to perform the operation. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "429": + content: + application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller has made too many requests in a short period of time + and is being rate-limited. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "503": + content: + application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "500": + content: + application/json: + example: + https://errors-api.cloud.com/common/internalServerError: + value: + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: An unexpected server error occurred. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + summary: "[DEPRECATED] Get zone preference list in this site." + tags: + - Zones APIs + post: + operationId: Zones_CreateUserZonePreference + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateUserZonePreferenceModel' + description: The CreateUserZonePreferenceModel. + required: true + x-name: request + x-position: 1 + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/UserZonePreferenceResponseModel' + description: The list users and user groups of the zone. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "401": + content: + application/json: + example: + https://errors-api.cloud.com/common/authentication: + value: + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller did not present a valid bearer token. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "403": + content: + application/json: + example: + https://errors-api.cloud.com/common/authorization: + value: + type: https://errors-api.cloud.com/common/authorization + detail: Access denied + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller is not authorized to perform the operation. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "409": + content: + application/json: + example: + https://errors-api.cloud.com/common/optimisticConcurrency: + value: + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller requested an invalid relation to be created or deleted. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "415": + content: + application/json: + example: + https://errors-api.cloud.com/common/unsupportedMediaType: + value: + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type + parameters: + - name: mediaType + value: application/xml + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "429": + content: + application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller has made too many requests in a short period of time + and is being rate-limited. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "503": + content: + application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "500": + content: + application/json: + example: + https://errors-api.cloud.com/common/internalServerError: + value: + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: An unexpected server error occurred. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + summary: "[DEPRECATED] Create a zone preference for a user or group account\ + \ in this site." + tags: + - Zones APIs + /UserZonePreferences/{name}: + delete: + description: "If there is whitespace in the name, the whitespace must be URL\ + \ encoded." + operationId: Zones_DeleteUserZonePreference + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + - description: Name of a user or user group. + explode: false + in: path + name: name + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 1 + responses: + "204": + description: Operation is successful with no response content. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "401": + content: + application/json: + example: + https://errors-api.cloud.com/common/authentication: + value: + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller did not present a valid bearer token. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "403": + content: + application/json: + example: + https://errors-api.cloud.com/common/authorization: + value: + type: https://errors-api.cloud.com/common/authorization + detail: Access denied + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller is not authorized to perform the operation. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "404": + description: A referenced entity was not found. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "409": + content: + application/json: + example: + https://errors-api.cloud.com/common/optimisticConcurrency: + value: + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller requested an invalid relation to be created or deleted. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "429": + content: + application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller has made too many requests in a short period of time + and is being rate-limited. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "503": + content: + application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "500": + content: + application/json: + example: + https://errors-api.cloud.com/common/internalServerError: + value: + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: An unexpected server error occurred. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + summary: "[DEPRECATED] Delete a zone preference for a user or group account\ + \ in this site." + tags: + - Zones APIs + get: + description: "If there is whitespace in the name, the whitespace must be URL\ + \ encoded." + operationId: Zones_GetUserZonePreference + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + - description: Name of a user or user group. + explode: false + in: path + name: name + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 1 + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/UserZonePreferenceResponseModel' + description: The UserZonePreferenceResponseModel. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "401": + content: + application/json: + example: + https://errors-api.cloud.com/common/authentication: + value: + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller did not present a valid bearer token. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "403": + content: + application/json: + example: + https://errors-api.cloud.com/common/authorization: + value: + type: https://errors-api.cloud.com/common/authorization + detail: Access denied + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller is not authorized to perform the operation. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "404": + content: + application/json: + example: + https://errors-api.cloud.com/common/notFound: + value: + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: A referenced entity was not found. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "429": + content: + application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller has made too many requests in a short period of time + and is being rate-limited. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "503": + content: + application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "500": + content: + application/json: + example: + https://errors-api.cloud.com/common/internalServerError: + value: + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: An unexpected server error occurred. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + summary: "[DEPRECATED] Get a zone preference for a user or group account in\ + \ this site." + tags: + - Zones APIs + put: + description: "If there is whitespace in the name, the whitespace must be URL\ + \ encoded." + operationId: Zones_UpdateUserZonePreference + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + - description: Name of a user or user group. + explode: false + in: path + name: name + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 1 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EditUserZonePreferenceRequestModel' + description: The EditUserZonePreferenceRequestModel. + required: true + x-name: request + x-position: 2 + responses: + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "204": + description: Operation is successful with no response content. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "401": + content: + application/json: + example: + https://errors-api.cloud.com/common/authentication: + value: + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller did not present a valid bearer token. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "403": + content: + application/json: + example: + https://errors-api.cloud.com/common/authorization: + value: + type: https://errors-api.cloud.com/common/authorization + detail: Access denied + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller is not authorized to perform the operation. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "404": + content: + application/json: + example: + https://errors-api.cloud.com/common/notFound: + value: + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: A referenced entity was not found. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "415": + content: + application/json: + example: + https://errors-api.cloud.com/common/unsupportedMediaType: + value: + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type + parameters: + - name: mediaType + value: application/xml + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "429": + content: + application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller has made too many requests in a short period of time + and is being rate-limited. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "503": + content: + application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "500": + content: + application/json: + example: + https://errors-api.cloud.com/common/internalServerError: + value: + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: An unexpected server error occurred. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + summary: "[DEPRECATED] Update a zone preference for a user or group account\ + \ in this site." + tags: + - Zones APIs + /Zones: + get: + description: Get the list of all zones in the site + operationId: Zones_GetZones + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + - description: |- + The max number of zones returned by this query. + If not specified, the server might use a default limit of 250 items. + If the specified value is larger than 1000, the server might reject the call. + The default and maximum values depend on server settings. + explode: true + in: query + name: limit + required: false + schema: + format: int32 + nullable: true + title: Int32 + type: integer + style: form + x-position: 1 + - description: The continuationToken returned by the previous query. + explode: true + in: query + name: continuationToken + required: false + schema: + nullable: true + title: String + type: string + style: form + x-position: 2 + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ZoneResponseModelCollection' + description: List of zones. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "401": + content: + application/json: + example: + https://errors-api.cloud.com/common/authentication: + value: + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller did not present a valid bearer token. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "403": + content: + application/json: + example: + https://errors-api.cloud.com/common/authorization: + value: + type: https://errors-api.cloud.com/common/authorization + detail: Access denied + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller is not authorized to perform the operation. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "429": + content: + application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller has made too many requests in a short period of time + and is being rate-limited. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "503": + content: + application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "500": + content: + application/json: + example: + https://errors-api.cloud.com/common/internalServerError: + value: + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: An unexpected server error occurred. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + summary: Get the list of all zones in the site. + tags: + - Zones APIs + post: + operationId: Zones_CreateZone + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + - description: |- + If `true`, the zone will be created as a background task. + The task will have JobType CreateZone. + When the task is complete it will redirect to + GetZone. + The job's Parameters will contain properties: + + * _Id_ - ID of the zone being created, + * _Name_ - Name of the zone being created. + explode: true + in: query + name: async + required: false + schema: + default: false + nullable: true + title: Boolean + type: boolean + style: form + x-position: 2 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateZoneRequestModel' + description: Details about the zone to create. + required: true + x-name: request + x-position: 1 + responses: + "201": + description: Resource was created. + headers: + Location: + description: Location where the newly created resource resides. + example: /services/myservice/widgets/1 + explode: false + schema: + type: string + style: simple + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "202": + description: Async request was accepted and is being processed. + headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "204": + description: Operation is successful with no response content. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "401": + content: + application/json: + example: + https://errors-api.cloud.com/common/authentication: + value: + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller did not present a valid bearer token. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "403": + content: + application/json: + example: + https://errors-api.cloud.com/common/authorization: + value: + type: https://errors-api.cloud.com/common/authorization + detail: Access denied + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller is not authorized to perform the operation. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "409": + content: + application/json: + example: + https://errors-api.cloud.com/common/optimisticConcurrency: + value: + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller requested an invalid relation to be created or deleted. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "415": + content: + application/json: + example: + https://errors-api.cloud.com/common/unsupportedMediaType: + value: + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type + parameters: + - name: mediaType + value: application/xml + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "429": + content: + application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller has made too many requests in a short period of time + and is being rate-limited. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "503": + content: + application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "500": + content: + application/json: + example: + https://errors-api.cloud.com/common/internalServerError: + value: + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: An unexpected server error occurred. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + summary: Create a zone. + tags: + - Zones APIs + /Zones/$removeItems: + post: + operationId: Zones_RemoveItemsFromZone + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + - description: |- + If `true`, items will be removed from the zone as a background task. + The task will have JobType RemoveItemsFromZone. + explode: true + in: query + name: async + required: false + schema: + default: false + nullable: true + title: Boolean + type: boolean + style: form + x-position: 2 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZonedItemsRequestModel' + description: The request. + required: true + x-name: request + x-position: 1 + responses: + "204": + description: Operation is successful with no response content. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "202": + description: Async request was accepted and is being processed. + headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "401": + content: + application/json: + example: + https://errors-api.cloud.com/common/authentication: + value: + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller did not present a valid bearer token. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "403": + content: + application/json: + example: + https://errors-api.cloud.com/common/authorization: + value: + type: https://errors-api.cloud.com/common/authorization + detail: Access denied + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller is not authorized to perform the operation. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "409": + content: + application/json: + example: + https://errors-api.cloud.com/common/optimisticConcurrency: + value: + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller requested an invalid relation to be created or deleted. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "415": + content: + application/json: + example: + https://errors-api.cloud.com/common/unsupportedMediaType: + value: + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type + parameters: + - name: mediaType + value: application/xml + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "429": + content: + application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller has made too many requests in a short period of time + and is being rate-limited. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "503": + content: + application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "500": + content: + application/json: + example: + https://errors-api.cloud.com/common/internalServerError: + value: + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: An unexpected server error occurred. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + summary: Remove items from a zone. + tags: + - Zones APIs + /Zones/$search: + post: + description: |- + Perform a basic search for zoned items. + Note that the search action is used for items in zone, not for zone itself. + operationId: Zones_DoZoneSearch + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + - description: |- + The max number of items of the same itemtype returned by this query. + If not specified, the server might use a default limit of 250 items. + If the specified value is larger than 1000, the server might reject the call. + The default and maximum values depend on server settings. + explode: true + in: query + name: limit + required: false + schema: + format: int32 + nullable: true + title: Int32 + type: integer + style: form + x-position: 2 + - description: |- + If a query cannot be completed, the response will have a + ContinuationToken set. + To obtain more results from the query, pass the + continuation token back into the query to get the next + batch of results. + explode: true + in: query + name: continuationToken + required: false + schema: + nullable: true + title: String + type: string + style: form + x-position: 3 + - description: |- + If `true`, the search zoned items will be executed as a background task. + The task will have JobType DoZoneSearch. + When the task is complete it will redirect to + GetJobResults. + explode: true + in: query + name: async + required: false + schema: + default: false + nullable: true + title: Boolean + type: boolean + style: form + x-position: 4 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZonedItemSearchRequestModel' + description: Specifies the basic search parameters. + required: true + x-name: searchRequest + x-position: 1 + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ZonedItemResponseModelCollection' + description: List of zoned items that match the search criteria. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "202": + description: Async request was accepted and is being processed. + headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "401": + content: + application/json: + example: + https://errors-api.cloud.com/common/authentication: + value: + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller did not present a valid bearer token. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "403": + content: + application/json: + example: + https://errors-api.cloud.com/common/authorization: + value: + type: https://errors-api.cloud.com/common/authorization + detail: Access denied + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller is not authorized to perform the operation. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "409": + content: + application/json: + example: + https://errors-api.cloud.com/common/optimisticConcurrency: + value: + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller requested an invalid relation to be created or deleted. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "415": + content: + application/json: + example: + https://errors-api.cloud.com/common/unsupportedMediaType: + value: + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type + parameters: + - name: mediaType + value: application/xml + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "429": + content: + application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller has made too many requests in a short period of time + and is being rate-limited. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "503": + content: + application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "500": + content: + application/json: + example: + https://errors-api.cloud.com/common/internalServerError: + value: + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: An unexpected server error occurred. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + summary: Perform a basic search for zoned items. + tags: + - Zones APIs + /Zones/{nameOrId}: + delete: + description: |- + Only if there is no items in the zone, we may delete a zone. Items include: + - application + - controller + - host connection + - machine catalog + - user / user group + operationId: Zones_DeleteZone + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + - description: 'Name or id of the zone to be deleted. ' + explode: false + in: path + name: nameOrId + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 1 + - description: |- + If `true`, the zone will be deleted as a background task. + The task will have JobType DeleteZone. + explode: true + in: query + name: async + required: false + schema: + default: false + nullable: true + title: Boolean + type: boolean + style: form + x-position: 2 + responses: + "204": + description: Operation is successful with no response content. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "202": + description: Async request was accepted and is being processed. + headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "401": + content: + application/json: + example: + https://errors-api.cloud.com/common/authentication: + value: + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller did not present a valid bearer token. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "403": + content: + application/json: + example: + https://errors-api.cloud.com/common/authorization: + value: + type: https://errors-api.cloud.com/common/authorization + detail: Access denied + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller is not authorized to perform the operation. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "404": + description: A referenced entity was not found. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "409": + content: + application/json: + example: + https://errors-api.cloud.com/common/optimisticConcurrency: + value: + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller requested an invalid relation to be created or deleted. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "429": + content: + application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller has made too many requests in a short period of time + and is being rate-limited. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "503": + content: + application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "500": + content: + application/json: + example: + https://errors-api.cloud.com/common/internalServerError: + value: + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: An unexpected server error occurred. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + summary: Delete a zone. + tags: + - Zones APIs + get: + description: Get a single zone from the site + operationId: Zones_GetZone + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + - description: Name or ID of the zone. + explode: false + in: path + name: nameOrId + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 1 + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ZoneDetailResponseModel' + description: Details of the zone. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "401": + content: + application/json: + example: + https://errors-api.cloud.com/common/authentication: + value: + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller did not present a valid bearer token. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "403": + content: + application/json: + example: + https://errors-api.cloud.com/common/authorization: + value: + type: https://errors-api.cloud.com/common/authorization + detail: Access denied + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller is not authorized to perform the operation. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "404": + content: + application/json: + example: + https://errors-api.cloud.com/common/notFound: + value: + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: A referenced entity was not found. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "429": + content: + application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller has made too many requests in a short period of time + and is being rate-limited. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "503": + content: + application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "500": + content: + application/json: + example: + https://errors-api.cloud.com/common/internalServerError: + value: + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: An unexpected server error occurred. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + summary: Get a single zone from the site. + tags: + - Zones APIs + patch: + operationId: Zones_EditZone + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + - description: Name or ID of the zone. + explode: false + in: path + name: nameOrId + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 1 + - description: |- + If `true`, the zone will be edited as a background task. + The task will have JobType EditZone. + When the task is complete it will redirect to + GetZone. + The job's Parameters will contain properties: + + * _Id_ - ID of the zone being edited, + * _Name_ - Name of the zone being edited. + explode: true + in: query + name: async + required: false + schema: + default: false + nullable: true + title: Boolean + type: boolean + style: form + x-position: 3 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EditZoneRequestModel' + description: The EditZoneRequestModel. + required: true + x-name: request + x-position: 2 + responses: + "204": + description: Operation is successful with no response content. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "202": + description: Async request was accepted and is being processed. + headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "401": + content: + application/json: + example: + https://errors-api.cloud.com/common/authentication: + value: + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller did not present a valid bearer token. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "403": + content: + application/json: + example: + https://errors-api.cloud.com/common/authorization: + value: + type: https://errors-api.cloud.com/common/authorization + detail: Access denied + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller is not authorized to perform the operation. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "404": + content: + application/json: + example: + https://errors-api.cloud.com/common/notFound: + value: + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: A referenced entity was not found. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "415": + content: + application/json: + example: + https://errors-api.cloud.com/common/unsupportedMediaType: + value: + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type + parameters: + - name: mediaType + value: application/xml + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "429": + content: + application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller has made too many requests in a short period of time + and is being rate-limited. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "503": + content: + application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "500": + content: + application/json: + example: + https://errors-api.cloud.com/common/internalServerError: + value: + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: An unexpected server error occurred. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + summary: Edit a zone. + tags: + - Zones APIs + /Zones/{nameOrId}/$addItems: + post: + operationId: Zones_AddItemsIntoZone + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + - description: The zone into which items will be added. + explode: false + in: path + name: nameOrId + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 1 + - description: |- + If `true`, items will be added into the zone as a background task. + The task will have JobType AddItemsIntoZone. + explode: true + in: query + name: async + required: false + schema: + default: false + nullable: true + title: Boolean + type: boolean + style: form + x-position: 3 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZonedItemsRequestModel' + description: The request. + required: true + x-name: request + x-position: 2 + responses: + "204": + description: Operation is successful with no response content. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "202": + description: Async request was accepted and is being processed. + headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "401": + content: + application/json: + example: + https://errors-api.cloud.com/common/authentication: + value: + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller did not present a valid bearer token. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "403": + content: + application/json: + example: + https://errors-api.cloud.com/common/authorization: + value: + type: https://errors-api.cloud.com/common/authorization + detail: Access denied + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller is not authorized to perform the operation. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "404": + content: + application/json: + example: + https://errors-api.cloud.com/common/notFound: + value: + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: A referenced entity was not found. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "409": + content: + application/json: + example: + https://errors-api.cloud.com/common/optimisticConcurrency: + value: + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller requested an invalid relation to be created or deleted. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "415": + content: + application/json: + example: + https://errors-api.cloud.com/common/unsupportedMediaType: + value: + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type + parameters: + - name: mediaType + value: application/xml + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "429": + content: + application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller has made too many requests in a short period of time + and is being rate-limited. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "503": + content: + application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "500": + content: + application/json: + example: + https://errors-api.cloud.com/common/internalServerError: + value: + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: An unexpected server error occurred. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + summary: Add items into a zone. + tags: + - Zones APIs + /Zones/{nameOrId}/$moveItems: + post: + operationId: Zones_MoveItemsIntoZone + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + - description: The zone into which items will be moved. + explode: false + in: path + name: nameOrId + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 1 + - description: |- + If `true`, items will be moved into the zone as a background task. + The task will have JobType MoveItemsIntoZone. + explode: true + in: query + name: async + required: false + schema: + default: false + nullable: true + title: Boolean + type: boolean + style: form + x-position: 3 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZonedItemsRequestModel' + description: The request. + required: true + x-name: request + x-position: 2 + responses: + "204": + description: Operation is successful with no response content. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "202": + description: Async request was accepted and is being processed. + headers: + Location: + description: Location where the async job completion status can be queried. + example: "Jobs/{id}" + explode: false + schema: + type: string + style: simple + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "401": + content: + application/json: + example: + https://errors-api.cloud.com/common/authentication: + value: + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller did not present a valid bearer token. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "403": + content: + application/json: + example: + https://errors-api.cloud.com/common/authorization: + value: + type: https://errors-api.cloud.com/common/authorization + detail: Access denied + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller is not authorized to perform the operation. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "404": + content: + application/json: + example: + https://errors-api.cloud.com/common/notFound: + value: + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: A referenced entity was not found. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "409": + content: + application/json: + example: + https://errors-api.cloud.com/common/optimisticConcurrency: + value: + type: https://errors-api.cloud.com/common/optimisticConcurrency + detail: "Widget X was modified, please try your changes again" + parameters: null + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller requested an invalid relation to be created or deleted. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "415": + content: + application/json: + example: + https://errors-api.cloud.com/common/unsupportedMediaType: + value: + type: https://errors-api.cloud.com/common/unsupportedMediaType + detail: Must use application/json;charset=utf-8 media type + parameters: + - name: mediaType + value: application/xml + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must send request body in utf-8 and specify request + Content-Type as utf-8. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "429": + content: + application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller has made too many requests in a short period of time + and is being rate-limited. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "503": + content: + application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "500": + content: + application/json: + example: + https://errors-api.cloud.com/common/internalServerError: + value: + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: An unexpected server error occurred. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + summary: Move items into a zone. + tags: + - Zones APIs + /Zones/{nameOrId}/UserZonePreferences: + get: + description: |- + The number of users or user groups in a zone may be huge. Therefore, we support the + 'limit' and 'continuationToken' query strings. + operationId: Zones_GetUserZonePreferencesByZone + parameters: + - description: Citrix Customer ID. Default is 'CitrixOnPremises' + example: CitrixOnPremises + explode: false + in: header + name: Citrix-CustomerId + required: true + schema: + type: string + style: simple + - description: Citrix Instance (Site) ID. + explode: false + in: header + name: Citrix-InstanceId + required: true + schema: + type: string + style: simple + - description: User Agent type of the request. + example: Mozilla/5.0 + explode: false + in: header + name: User-Agent + required: false + schema: + type: string + style: simple + - description: "Citrix authorization header: CWSAuth Bearer={token}" + explode: false + in: header + name: Authorization + required: false + schema: + type: string + style: simple + - description: "Transaction ID that will be used to track this request. If not\ + \ provided, a new GUID will be generated and returned." + explode: false + in: header + name: Citrix-TransactionId + required: false + schema: + type: string + style: simple + - description: Must accept application/json. + example: application/json + explode: false + in: header + name: Accept + required: false + schema: + type: string + style: simple + - description: Locale of the request. + example: en-US + explode: false + in: header + name: Citrix-Locale + required: false + schema: + type: string + style: simple + - description: Name or Id of a zone. + explode: false + in: path + name: nameOrId + required: true + schema: + nullable: true + title: String + type: string + style: simple + x-position: 1 + - description: |- + The max number of user zone preferences returned by this query. + If not specified, the server might use a default limit of 250 items. + If the specified value is larger than 1000, the server might reject the call. + The default and maximum values depend on server settings. + explode: true + in: query + name: limit + required: false + schema: + format: int32 + nullable: true + title: Int32 + type: integer + style: form + x-position: 2 + - description: |- + If a query cannot be completed, the response will have a + ContinuationToken set. + To obtain more results from the query, pass the + continuation token back into the query to get the next + batch of results. + explode: true + in: query + name: continuationToken + required: false + schema: + nullable: true + title: String + type: string + style: form + x-position: 3 + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/UserZonePreferenceResponseModelCollection' + description: The list users and user groups of the zone. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "400": + content: + application/json: + example: + https://errors-api.cloud.com/common/outOfRange: + value: + type: https://errors-api.cloud.com/common/outOfRange + detail: A parameter in the request is out of range + parameters: + - name: property + value: startTime + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller passed an invalid input. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "401": + content: + application/json: + example: + https://errors-api.cloud.com/common/authentication: + value: + type: https://errors-api.cloud.com/common/authentication + detail: Missing or invalid authentication details + parameters: + - name: reason + value: missing + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller did not present a valid bearer token. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "403": + content: + application/json: + example: + https://errors-api.cloud.com/common/authorization: + value: + type: https://errors-api.cloud.com/common/authorization + detail: Access denied + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller is not authorized to perform the operation. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "404": + content: + application/json: + example: + https://errors-api.cloud.com/common/notFound: + value: + type: https://errors-api.cloud.com/common/notFound + detail: Widget not found + parameters: + - name: entityType + value: https://identifiers-api.cloud.com/example/widget + - name: id + value: guid1 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: A referenced entity was not found. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "406": + content: + application/json: + example: + https://errors-api.cloud.com/common/notAcceptable: + value: + type: https://errors-api.cloud.com/common/notAcceptable + detail: Must accept application/json media type + parameters: + - name: contentType + value: application/json + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller must specify utf-8 charset with the Accept header. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "429": + content: + application/json: + example: + https://errors-api.cloud.com/common/rateLimitExceeded: + value: + type: https://errors-api.cloud.com/common/rateLimitExceeded + detail: Rate limit exceeded; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Caller has made too many requests in a short period of time + and is being rate-limited. + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "503": + content: + application/json: + example: + https://errors-api.cloud.com/common/serviceUnavailable: + value: + type: https://errors-api.cloud.com/common/serviceUnavailable + detail: Service is unavailable; try again in 4 seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: "Service is temporarily unable to process the request. Caller\ + \ may attempt the operation again, with exponential back-off." + headers: + Citrix-TransactionId: + description: Transaction ID that is either provided by caller with the + same request header or newly created. + example: 57AB53D9-589A-4AA8-8879-6B1DACF3A868 + explode: false + schema: + type: string + style: simple + Content-Type: + description: Response Content Type. Value is always 'application/json'. + example: application/json + explode: false + schema: + type: string + style: simple + X-Content-Type-Options: + description: Content type options. Value is always 'nosniff'. + example: nosniff + explode: false + schema: + type: string + style: simple + Content-Language: + description: Content language. Value is either 'en-US' or based on client + language setting. + example: en-US + explode: false + schema: + type: string + style: simple + Cache-Control: + description: "Cache Control. Value is always 'no-cache, no-store, must-revalidate.'" + example: "no-cache, no-store, must-revalidate" + explode: false + schema: + type: string + style: simple + Pragma: + description: Pragma. Value is always 'no-cache'. + example: no-cache + explode: false + schema: + type: string + style: simple + Citrix-FilterScope: + description: Optional filter scope for getting scoped objects. + example: b79aadf4-a0e6-11eb-bcbc-0242ac130002 + explode: false + schema: + type: string + style: simple + "500": + content: + application/json: + example: + https://errors-api.cloud.com/common/internalServerError: + value: + type: https://errors-api.cloud.com/common/internalServerError + detail: An internal server error has occurred; try again in 4 + seconds + parameters: + - name: retryDelay + value: "4" + schema: + $ref: '#/components/schemas/ErrorResponse' + description: An unexpected server error occurred. headers: Citrix-TransactionId: description: Transaction ID that is either provided by caller with the @@ -282184,6 +308758,11 @@ components: HostedMachineId: Id of a hosted machine MachineName: "For example, test.local\\machine001" AssignedIPAddress: "For example, 1.1.1.1" + Metadata: + - Value: Value + Name: Name + - Value: Value + Name: Name AssignedClientName: Name of an assigned client AssignedUsers: - Name of an assigned user @@ -282250,6 +308829,13 @@ components: nullable: true title: Boolean type: boolean + Metadata: + description: The metadata of machine. + items: + $ref: '#/components/schemas/NameValueStringPairModel' + nullable: true + title: "NameValueStringPairModel[]" + type: array title: AddMachineToMachineCatalogRequestModel type: object ADDomainResponseModel: @@ -283429,6 +310015,7 @@ components: description: Request model to create an AppLib Package Discovery Profile. example: Path: Path + DiscoverFlexApp: false PublishingServer: PublishingServer DiscoverMsix: false DiscoverAppV: true @@ -283520,6 +310107,13 @@ components: nullable: true title: Boolean type: boolean + DiscoverFlexApp: + default: false + description: A value indicating whether or not to search should discover + FlexApp Packages. + nullable: true + title: Boolean + type: boolean AutomateDiscovery: default: false description: A value indicating whether or not the discovery should run @@ -283547,6 +310141,7 @@ components: description: PackageDiscoveryProfile response model. example: Path: Path + DiscoverFlexApp: true PublishingServer: PublishingServer DiscoverMsix: true DiscoverAppV: true @@ -283620,6 +310215,11 @@ components: AppAttach Packages. title: Boolean type: boolean + DiscoverFlexApp: + description: A value indicating whether or not to search should Discover + FlexApp Packages. + title: Boolean + type: boolean AutomateDiscovery: description: A value indicating whether or not the discovery should run automatically. @@ -283650,6 +310250,7 @@ components: description: Request model to create an AppLib Package Discovery Session. example: Path: Path + DiscoverFlexApp: false PublishingServer: PublishingServer DiscoverMsiX: false DiscoverAppV: false @@ -283711,6 +310312,12 @@ components: nullable: true title: Boolean type: boolean + DiscoverFlexApp: + default: false + description: A value indicating whether or not to discover FlexApp packages + nullable: true + title: Boolean + type: boolean ManagementServer: description: The url of the App-V Management Server that packages will be discovered from. @@ -284492,7 +311099,7 @@ components: Used to be: Uuid Needs to be globally unique This is likely to contain a guid but the property type should be string for future flexibility - minLength: 1 + nullable: true title: String type: string Uid: @@ -284509,6 +311116,7 @@ components: application group reside. items: $ref: '#/components/schemas/ContainerScopeResponseModel' + nullable: true title: "ContainerScopeResponseModel[]" type: array Description: @@ -284548,6 +311156,7 @@ components: the application group belongs. items: $ref: '#/components/schemas/ScopeResponseModel' + nullable: true title: "ScopeResponseModel[]" type: array Metadata: @@ -284600,18 +311209,11 @@ components: description: Delivery groups associated with the application group. items: $ref: '#/components/schemas/ApplicationGroupDeliveryGroupRefResponseModel' + nullable: true title: "ApplicationGroupDeliveryGroupRefResponseModel[]" type: array AdminFolder: $ref: '#/components/schemas/RefResponseModel' - required: - - ContainerScopes - - DeliveryGroups - - Enabled - - Id - - NumApplications - - NumMachines - - Scopes title: ApplicationGroupResponseModel type: object ApplicationGroupResponseModelCollection: @@ -284646,7 +311248,7 @@ components: Used to be: Uuid Needs to be globally unique This is likely to contain a guid but the property type should be string for future flexibility - minLength: 1 + nullable: true title: String type: string Uid: @@ -284675,6 +311277,7 @@ components: application reside. items: $ref: '#/components/schemas/ContainerScopeResponseModel' + nullable: true title: "ContainerScopeResponseModel[]" type: array Description: @@ -284696,7 +311299,7 @@ components: Used to be: IconUid (and it was not globally unique) Needs to be globally unique Might be constructed from site ID + internal Uid - minLength: 1 + nullable: true title: String type: string InstalledAppProperties: @@ -284712,12 +311315,12 @@ components: type: string Name: description: Name of the application. Only seen by administrators. - minLength: 1 + nullable: true title: String type: string PublishedName: description: The name seen by end users who have access to the application. - minLength: 1 + nullable: true title: String type: string Metadata: @@ -284791,18 +311394,6 @@ components: nullable: true title: String type: string - required: - - ApplicationFolder - - ApplicationType - - ContainerScopes - - Enabled - - IconId - - Id - - Name - - PackagedApplicationType - - PublishedName - - SharingKind - - Visible title: ApplicationResponseModel type: object ApplicationResponseModelCollection: @@ -284918,6 +311509,7 @@ components: - AppLibraryAppV - Msix - AppAttach + - FlexApp - PackagedApplication title: ApplicationType type: string @@ -284931,10 +311523,20 @@ components: - AppLibraryAppV - Msix - AppAttach + - FlexApp - PackagedApplication AppliedPolicy: additionalProperties: false description: Information about an applied policy. + example: + Reasons: + key: + - Reasons + - Reasons + PolicyIdentity: + PolicySetGuid: PolicySetGuid + PolicyName: PolicyName + PolicyGuid: PolicyGuid properties: PolicyIdentity: $ref: '#/components/schemas/PolicyIdentity' @@ -284995,6 +311597,13 @@ components: AppliedSetting: additionalProperties: false description: Winning setting information. + example: + SettingValue: SettingValue + SettingName: SettingName + PolicyIdentity: + PolicySetGuid: PolicySetGuid + PolicyName: PolicyName + PolicyGuid: PolicyGuid properties: SettingName: description: Setting name. @@ -285132,6 +311741,7 @@ components: description: "Application properties can be used for advanced application searches.\n\ \ " enum: + - Uid - ClientFolder - ApplicationGroup - Name @@ -285155,6 +311765,7 @@ components: title: AppSearchProperty type: string x-enumNames: + - Uid - ClientFolder - ApplicationGroup - Name @@ -287375,6 +313986,11 @@ components: nullable: true title: List`1 type: array + Fixups: + description: Fixups from backups or restores + nullable: true + title: String + type: string RestoreType: $ref: '#/components/schemas/BackupRestoreRestoreTypes' required: @@ -288111,6 +314727,20 @@ components: CollectionEnvelopeOfFilterDefinition: additionalProperties: false description: Response object for collections of items. + example: + totalItems: 0 + items: + - filterName: filterName + isUserFilter: true + isSingleton: true + filterType: null + explanation: explanation + - filterName: filterName + isUserFilter: true + isSingleton: true + filterType: null + explanation: explanation + continuationToken: continuationToken properties: items: description: Items in the collection. @@ -288139,6 +314769,22 @@ components: CollectionEnvelopeOfFilterResponse: additionalProperties: false description: Response object for collections of items. + example: + totalItems: 0 + items: + - isAllowed: true + filterData: filterData + isEnabled: true + filterGuid: filterGuid + filterType: filterType + policyGuid: policyGuid + - isAllowed: true + filterData: filterData + isEnabled: true + filterGuid: filterGuid + filterType: filterType + policyGuid: policyGuid + continuationToken: continuationToken properties: items: description: Items in the collection. @@ -288167,6 +314813,70 @@ components: CollectionEnvelopeOfPolicyResponse: additionalProperties: false description: Response object for collections of items. + example: + totalItems: 6 + items: + - settings: + - settingValue: settingValue + settingGuid: settingGuid + useDefault: true + policyGuid: policyGuid + settingName: settingName + - settingValue: settingValue + settingGuid: settingGuid + useDefault: true + policyGuid: policyGuid + settingName: settingName + policySetGuid: policySetGuid + policyName: policyName + isEnabled: true + description: description + filters: + - isAllowed: true + filterData: filterData + isEnabled: true + filterGuid: filterGuid + filterType: filterType + policyGuid: policyGuid + - isAllowed: true + filterData: filterData + isEnabled: true + filterGuid: filterGuid + filterType: filterType + policyGuid: policyGuid + priority: 0 + policyGuid: policyGuid + - settings: + - settingValue: settingValue + settingGuid: settingGuid + useDefault: true + policyGuid: policyGuid + settingName: settingName + - settingValue: settingValue + settingGuid: settingGuid + useDefault: true + policyGuid: policyGuid + settingName: settingName + policySetGuid: policySetGuid + policyName: policyName + isEnabled: true + description: description + filters: + - isAllowed: true + filterData: filterData + isEnabled: true + filterGuid: filterGuid + filterType: filterType + policyGuid: policyGuid + - isAllowed: true + filterData: filterData + isEnabled: true + filterGuid: filterGuid + filterType: filterType + policyGuid: policyGuid + priority: 0 + policyGuid: policyGuid + continuationToken: continuationToken properties: items: description: Items in the collection. @@ -288195,6 +314905,150 @@ components: CollectionEnvelopeOfPolicySetResponse: additionalProperties: false description: Response object for collections of items. + example: + totalItems: 6 + items: + - isAssigned: true + policySetGuid: policySetGuid + policyCount: 0 + policySetType: null + name: name + policies: + - settings: + - settingValue: settingValue + settingGuid: settingGuid + useDefault: true + policyGuid: policyGuid + settingName: settingName + - settingValue: settingValue + settingGuid: settingGuid + useDefault: true + policyGuid: policyGuid + settingName: settingName + policySetGuid: policySetGuid + policyName: policyName + isEnabled: true + description: description + filters: + - isAllowed: true + filterData: filterData + isEnabled: true + filterGuid: filterGuid + filterType: filterType + policyGuid: policyGuid + - isAllowed: true + filterData: filterData + isEnabled: true + filterGuid: filterGuid + filterType: filterType + policyGuid: policyGuid + priority: 0 + policyGuid: policyGuid + - settings: + - settingValue: settingValue + settingGuid: settingGuid + useDefault: true + policyGuid: policyGuid + settingName: settingName + - settingValue: settingValue + settingGuid: settingGuid + useDefault: true + policyGuid: policyGuid + settingName: settingName + policySetGuid: policySetGuid + policyName: policyName + isEnabled: true + description: description + filters: + - isAllowed: true + filterData: filterData + isEnabled: true + filterGuid: filterGuid + filterType: filterType + policyGuid: policyGuid + - isAllowed: true + filterData: filterData + isEnabled: true + filterGuid: filterGuid + filterType: filterType + policyGuid: policyGuid + priority: 0 + policyGuid: policyGuid + description: description + scopes: + - scopes + - scopes + - isAssigned: true + policySetGuid: policySetGuid + policyCount: 0 + policySetType: null + name: name + policies: + - settings: + - settingValue: settingValue + settingGuid: settingGuid + useDefault: true + policyGuid: policyGuid + settingName: settingName + - settingValue: settingValue + settingGuid: settingGuid + useDefault: true + policyGuid: policyGuid + settingName: settingName + policySetGuid: policySetGuid + policyName: policyName + isEnabled: true + description: description + filters: + - isAllowed: true + filterData: filterData + isEnabled: true + filterGuid: filterGuid + filterType: filterType + policyGuid: policyGuid + - isAllowed: true + filterData: filterData + isEnabled: true + filterGuid: filterGuid + filterType: filterType + policyGuid: policyGuid + priority: 0 + policyGuid: policyGuid + - settings: + - settingValue: settingValue + settingGuid: settingGuid + useDefault: true + policyGuid: policyGuid + settingName: settingName + - settingValue: settingValue + settingGuid: settingGuid + useDefault: true + policyGuid: policyGuid + settingName: settingName + policySetGuid: policySetGuid + policyName: policyName + isEnabled: true + description: description + filters: + - isAllowed: true + filterData: filterData + isEnabled: true + filterGuid: filterGuid + filterType: filterType + policyGuid: policyGuid + - isAllowed: true + filterData: filterData + isEnabled: true + filterGuid: filterGuid + filterType: filterType + policyGuid: policyGuid + priority: 0 + policyGuid: policyGuid + description: description + scopes: + - scopes + - scopes + continuationToken: continuationToken properties: items: description: Items in the collection. @@ -288223,6 +315077,20 @@ components: CollectionEnvelopeOfSettingResponse: additionalProperties: false description: Response object for collections of items. + example: + totalItems: 0 + items: + - settingValue: settingValue + settingGuid: settingGuid + useDefault: true + policyGuid: policyGuid + settingName: settingName + - settingValue: settingValue + settingGuid: settingGuid + useDefault: true + policyGuid: policyGuid + settingName: settingName + continuationToken: continuationToken properties: items: description: Items in the collection. @@ -288775,46 +315643,170 @@ components: - Items title: CollectionModel`1 type: object - CollectionModelOfBackupRestoreBackupResponseModel: - additionalProperties: false - description: Response object for collections of items. - properties: - Items: - description: List of items. - items: - $ref: '#/components/schemas/BackupRestoreBackupResponseModel' - title: "BackupRestoreBackupResponseModel[]" - type: array - ContinuationToken: - description: |- - If present, indicates to the caller that the query was not complete, - and they should call the API again specifying the continuation token - as a query parameter. - nullable: true - title: String - type: string - TotalItems: - description: |- - Indicates the total number of items in the collection, which may be - more than the number of Items returned, if there is a - ContinuationToken. Only returned in the response to `$search` APIs. - format: int32 - nullable: true - title: Int32 - type: integer - required: - - Items - title: CollectionModel`1 - type: object - CollectionModelOfBackupRestoreHistoryInformation: + CollectionModelOfBackupRestoreBackupResponseModel: + additionalProperties: false + description: Response object for collections of items. + properties: + Items: + description: List of items. + items: + $ref: '#/components/schemas/BackupRestoreBackupResponseModel' + title: "BackupRestoreBackupResponseModel[]" + type: array + ContinuationToken: + description: |- + If present, indicates to the caller that the query was not complete, + and they should call the API again specifying the continuation token + as a query parameter. + nullable: true + title: String + type: string + TotalItems: + description: |- + Indicates the total number of items in the collection, which may be + more than the number of Items returned, if there is a + ContinuationToken. Only returned in the response to `$search` APIs. + format: int32 + nullable: true + title: Int32 + type: integer + required: + - Items + title: CollectionModel`1 + type: object + CollectionModelOfBackupRestoreHistoryInformation: + additionalProperties: false + description: Response object for collections of items. + properties: + Items: + description: List of items. + items: + $ref: '#/components/schemas/BackupRestoreHistoryInformation' + title: "BackupRestoreHistoryInformation[]" + type: array + ContinuationToken: + description: |- + If present, indicates to the caller that the query was not complete, + and they should call the API again specifying the continuation token + as a query parameter. + nullable: true + title: String + type: string + TotalItems: + description: |- + Indicates the total number of items in the collection, which may be + more than the number of Items returned, if there is a + ContinuationToken. Only returned in the response to `$search` APIs. + format: int32 + nullable: true + title: Int32 + type: integer + required: + - Items + title: CollectionModel`1 + type: object + CollectionModelOfBackupRestoreMemberResponseModel: + additionalProperties: false + description: Response object for collections of items. + properties: + Items: + description: List of items. + items: + $ref: '#/components/schemas/BackupRestoreMemberResponseModel' + title: "BackupRestoreMemberResponseModel[]" + type: array + ContinuationToken: + description: |- + If present, indicates to the caller that the query was not complete, + and they should call the API again specifying the continuation token + as a query parameter. + nullable: true + title: String + type: string + TotalItems: + description: |- + Indicates the total number of items in the collection, which may be + more than the number of Items returned, if there is a + ContinuationToken. Only returned in the response to `$search` APIs. + format: int32 + nullable: true + title: Int32 + type: integer + required: + - Items + title: CollectionModel`1 + type: object + CollectionModelOfBackupRestoreScheduleModel: + additionalProperties: false + description: Response object for collections of items. + properties: + Items: + description: List of items. + items: + $ref: '#/components/schemas/BackupRestoreScheduleModel' + title: "BackupRestoreScheduleModel[]" + type: array + ContinuationToken: + description: |- + If present, indicates to the caller that the query was not complete, + and they should call the API again specifying the continuation token + as a query parameter. + nullable: true + title: String + type: string + TotalItems: + description: |- + Indicates the total number of items in the collection, which may be + more than the number of Items returned, if there is a + ContinuationToken. Only returned in the response to `$search` APIs. + format: int32 + nullable: true + title: Int32 + type: integer + required: + - Items + title: CollectionModel`1 + type: object + CollectionModelOfCatalogSearchResponseModel: + additionalProperties: false + description: Response object for collections of items. + properties: + Items: + description: List of items. + items: + $ref: '#/components/schemas/CatalogSearchResponseModel' + title: "CatalogSearchResponseModel[]" + type: array + ContinuationToken: + description: |- + If present, indicates to the caller that the query was not complete, + and they should call the API again specifying the continuation token + as a query parameter. + nullable: true + title: String + type: string + TotalItems: + description: |- + Indicates the total number of items in the collection, which may be + more than the number of Items returned, if there is a + ContinuationToken. Only returned in the response to `$search` APIs. + format: int32 + nullable: true + title: Int32 + type: integer + required: + - Items + title: CollectionModel`1 + type: object + CollectionModelOfConfigurationSlotResponseModel: additionalProperties: false description: Response object for collections of items. properties: Items: description: List of items. items: - $ref: '#/components/schemas/BackupRestoreHistoryInformation' - title: "BackupRestoreHistoryInformation[]" + $ref: '#/components/schemas/ConfigurationSlotResponseModel' + title: "ConfigurationSlotResponseModel[]" type: array ContinuationToken: description: |- @@ -288837,15 +315829,15 @@ components: - Items title: CollectionModel`1 type: object - CollectionModelOfBackupRestoreMemberResponseModel: + CollectionModelOfDatabaseChangeScriptModel: additionalProperties: false description: Response object for collections of items. properties: Items: description: List of items. items: - $ref: '#/components/schemas/BackupRestoreMemberResponseModel' - title: "BackupRestoreMemberResponseModel[]" + $ref: '#/components/schemas/DatabaseChangeScriptModel' + title: "DatabaseChangeScriptModel[]" type: array ContinuationToken: description: |- @@ -288868,15 +315860,15 @@ components: - Items title: CollectionModel`1 type: object - CollectionModelOfBackupRestoreScheduleModel: + CollectionModelOfDatabaseResponseModel: additionalProperties: false description: Response object for collections of items. properties: Items: description: List of items. items: - $ref: '#/components/schemas/BackupRestoreScheduleModel' - title: "BackupRestoreScheduleModel[]" + $ref: '#/components/schemas/DatabaseResponseModel' + title: "DatabaseResponseModel[]" type: array ContinuationToken: description: |- @@ -288899,15 +315891,15 @@ components: - Items title: CollectionModel`1 type: object - CollectionModelOfCatalogSearchResponseModel: + CollectionModelOfDeliveryControllerDeleteScriptModel: additionalProperties: false description: Response object for collections of items. properties: Items: description: List of items. items: - $ref: '#/components/schemas/CatalogSearchResponseModel' - title: "CatalogSearchResponseModel[]" + $ref: '#/components/schemas/DeliveryControllerDeleteScriptModel' + title: "DeliveryControllerDeleteScriptModel[]" type: array ContinuationToken: description: |- @@ -288930,15 +315922,15 @@ components: - Items title: CollectionModel`1 type: object - CollectionModelOfConfigurationSlotResponseModel: + CollectionModelOfDeliveryControllerResponseModel: additionalProperties: false description: Response object for collections of items. properties: Items: description: List of items. items: - $ref: '#/components/schemas/ConfigurationSlotResponseModel' - title: "ConfigurationSlotResponseModel[]" + $ref: '#/components/schemas/DeliveryControllerResponseModel' + title: "DeliveryControllerResponseModel[]" type: array ContinuationToken: description: |- @@ -288961,15 +315953,15 @@ components: - Items title: CollectionModel`1 type: object - CollectionModelOfDatabaseChangeScriptModel: + CollectionModelOfDeliveryGroupAssociationResponseModel: additionalProperties: false description: Response object for collections of items. properties: Items: description: List of items. items: - $ref: '#/components/schemas/DatabaseChangeScriptModel' - title: "DatabaseChangeScriptModel[]" + $ref: '#/components/schemas/DeliveryGroupAssociationResponseModel' + title: "DeliveryGroupAssociationResponseModel[]" type: array ContinuationToken: description: |- @@ -288992,15 +315984,15 @@ components: - Items title: CollectionModel`1 type: object - CollectionModelOfDatabaseResponseModel: + CollectionModelOfDeliveryGroupResponseModel: additionalProperties: false description: Response object for collections of items. properties: Items: description: List of items. items: - $ref: '#/components/schemas/DatabaseResponseModel' - title: "DatabaseResponseModel[]" + $ref: '#/components/schemas/DeliveryGroupResponseModel' + title: "DeliveryGroupResponseModel[]" type: array ContinuationToken: description: |- @@ -289023,15 +316015,15 @@ components: - Items title: CollectionModel`1 type: object - CollectionModelOfDeliveryControllerDeleteScriptModel: + CollectionModelOfDesktopResponseModel: additionalProperties: false description: Response object for collections of items. properties: Items: description: List of items. items: - $ref: '#/components/schemas/DeliveryControllerDeleteScriptModel' - title: "DeliveryControllerDeleteScriptModel[]" + $ref: '#/components/schemas/DesktopResponseModel' + title: "DesktopResponseModel[]" type: array ContinuationToken: description: |- @@ -289054,15 +316046,15 @@ components: - Items title: CollectionModel`1 type: object - CollectionModelOfDeliveryControllerResponseModel: + CollectionModelOfDesktopUsageResponseModel: additionalProperties: false description: Response object for collections of items. properties: Items: description: List of items. items: - $ref: '#/components/schemas/DeliveryControllerResponseModel' - title: "DeliveryControllerResponseModel[]" + $ref: '#/components/schemas/DesktopUsageResponseModel' + title: "DesktopUsageResponseModel[]" type: array ContinuationToken: description: |- @@ -289085,15 +316077,15 @@ components: - Items title: CollectionModel`1 type: object - CollectionModelOfDeliveryGroupAssociationResponseModel: + CollectionModelOfEnrollmentResponseModel: additionalProperties: false description: Response object for collections of items. properties: Items: description: List of items. items: - $ref: '#/components/schemas/DeliveryGroupAssociationResponseModel' - title: "DeliveryGroupAssociationResponseModel[]" + $ref: '#/components/schemas/EnrollmentResponseModel' + title: "EnrollmentResponseModel[]" type: array ContinuationToken: description: |- @@ -289116,15 +316108,15 @@ components: - Items title: CollectionModel`1 type: object - CollectionModelOfDeliveryGroupResponseModel: + CollectionModelOfFtaResponseModel: additionalProperties: false description: Response object for collections of items. properties: Items: description: List of items. items: - $ref: '#/components/schemas/DeliveryGroupResponseModel' - title: "DeliveryGroupResponseModel[]" + $ref: '#/components/schemas/FtaResponseModel' + title: "FtaResponseModel[]" type: array ContinuationToken: description: |- @@ -289147,15 +316139,15 @@ components: - Items title: CollectionModel`1 type: object - CollectionModelOfDesktopResponseModel: + CollectionModelOfHypervisorMachineCatalogResponseModel: additionalProperties: false description: Response object for collections of items. properties: Items: description: List of items. items: - $ref: '#/components/schemas/DesktopResponseModel' - title: "DesktopResponseModel[]" + $ref: '#/components/schemas/HypervisorMachineCatalogResponseModel' + title: "HypervisorMachineCatalogResponseModel[]" type: array ContinuationToken: description: |- @@ -289178,15 +316170,15 @@ components: - Items title: CollectionModel`1 type: object - CollectionModelOfDesktopUsageResponseModel: + CollectionModelOfHypervisorPluginResponseModel: additionalProperties: false description: Response object for collections of items. properties: Items: description: List of items. items: - $ref: '#/components/schemas/DesktopUsageResponseModel' - title: "DesktopUsageResponseModel[]" + $ref: '#/components/schemas/HypervisorPluginResponseModel' + title: "HypervisorPluginResponseModel[]" type: array ContinuationToken: description: |- @@ -289209,15 +316201,15 @@ components: - Items title: CollectionModel`1 type: object - CollectionModelOfEnrollmentResponseModel: + CollectionModelOfHypervisorResourcePoolDetailResponseModel: additionalProperties: false description: Response object for collections of items. properties: Items: description: List of items. items: - $ref: '#/components/schemas/EnrollmentResponseModel' - title: "EnrollmentResponseModel[]" + $ref: '#/components/schemas/HypervisorResourcePoolDetailResponseModel' + title: "HypervisorResourcePoolDetailResponseModel[]" type: array ContinuationToken: description: |- @@ -289240,15 +316232,15 @@ components: - Items title: CollectionModel`1 type: object - CollectionModelOfFtaResponseModel: + CollectionModelOfHypervisorResourceResponseModel: additionalProperties: false description: Response object for collections of items. properties: Items: description: List of items. items: - $ref: '#/components/schemas/FtaResponseModel' - title: "FtaResponseModel[]" + $ref: '#/components/schemas/HypervisorResourceResponseModel' + title: "HypervisorResourceResponseModel[]" type: array ContinuationToken: description: |- @@ -289271,15 +316263,15 @@ components: - Items title: CollectionModel`1 type: object - CollectionModelOfHypervisorMachineCatalogResponseModel: + CollectionModelOfHypervisorResponseModel: additionalProperties: false description: Response object for collections of items. properties: Items: description: List of items. items: - $ref: '#/components/schemas/HypervisorMachineCatalogResponseModel' - title: "HypervisorMachineCatalogResponseModel[]" + $ref: '#/components/schemas/HypervisorResponseModel' + title: "HypervisorResponseModel[]" type: array ContinuationToken: description: |- @@ -289302,15 +316294,15 @@ components: - Items title: CollectionModel`1 type: object - CollectionModelOfHypervisorPluginResponseModel: + CollectionModelOfHypervisorsAndResourcePoolsResponseModel: additionalProperties: false description: Response object for collections of items. properties: Items: description: List of items. items: - $ref: '#/components/schemas/HypervisorPluginResponseModel' - title: "HypervisorPluginResponseModel[]" + $ref: '#/components/schemas/HypervisorsAndResourcePoolsResponseModel' + title: "HypervisorsAndResourcePoolsResponseModel[]" type: array ContinuationToken: description: |- @@ -289333,15 +316325,15 @@ components: - Items title: CollectionModel`1 type: object - CollectionModelOfHypervisorResourcePoolDetailResponseModel: + CollectionModelOfHypervisorVmValidationResponseModel: additionalProperties: false description: Response object for collections of items. properties: Items: description: List of items. items: - $ref: '#/components/schemas/HypervisorResourcePoolDetailResponseModel' - title: "HypervisorResourcePoolDetailResponseModel[]" + $ref: '#/components/schemas/HypervisorVmValidationResponseModel' + title: "HypervisorVmValidationResponseModel[]" type: array ContinuationToken: description: |- @@ -289364,15 +316356,15 @@ components: - Items title: CollectionModel`1 type: object - CollectionModelOfHypervisorResourceResponseModel: + CollectionModelOfIconResponseModel: additionalProperties: false description: Response object for collections of items. properties: Items: description: List of items. items: - $ref: '#/components/schemas/HypervisorResourceResponseModel' - title: "HypervisorResourceResponseModel[]" + $ref: '#/components/schemas/IconResponseModel' + title: "IconResponseModel[]" type: array ContinuationToken: description: |- @@ -289395,15 +316387,15 @@ components: - Items title: CollectionModel`1 type: object - CollectionModelOfHypervisorResponseModel: + CollectionModelOfIdentityContainerResponseModel: additionalProperties: false description: Response object for collections of items. properties: Items: description: List of items. items: - $ref: '#/components/schemas/HypervisorResponseModel' - title: "HypervisorResponseModel[]" + $ref: '#/components/schemas/IdentityContainerResponseModel' + title: "IdentityContainerResponseModel[]" type: array ContinuationToken: description: |- @@ -289426,15 +316418,15 @@ components: - Items title: CollectionModel`1 type: object - CollectionModelOfHypervisorsAndResourcePoolsResponseModel: + CollectionModelOfIdentityDirectoryResponseModel: additionalProperties: false description: Response object for collections of items. properties: Items: description: List of items. items: - $ref: '#/components/schemas/HypervisorsAndResourcePoolsResponseModel' - title: "HypervisorsAndResourcePoolsResponseModel[]" + $ref: '#/components/schemas/IdentityDirectoryResponseModel' + title: "IdentityDirectoryResponseModel[]" type: array ContinuationToken: description: |- @@ -289457,15 +316449,15 @@ components: - Items title: CollectionModel`1 type: object - CollectionModelOfHypervisorVmValidationResponseModel: + CollectionModelOfIdentityDomainResponseModel: additionalProperties: false description: Response object for collections of items. properties: Items: description: List of items. items: - $ref: '#/components/schemas/HypervisorVmValidationResponseModel' - title: "HypervisorVmValidationResponseModel[]" + $ref: '#/components/schemas/IdentityDomainResponseModel' + title: "IdentityDomainResponseModel[]" type: array ContinuationToken: description: |- @@ -289488,15 +316480,15 @@ components: - Items title: CollectionModel`1 type: object - CollectionModelOfIconResponseModel: + CollectionModelOfIdentityForestResponseModel: additionalProperties: false description: Response object for collections of items. properties: Items: description: List of items. items: - $ref: '#/components/schemas/IconResponseModel' - title: "IconResponseModel[]" + $ref: '#/components/schemas/IdentityForestResponseModel' + title: "IdentityForestResponseModel[]" type: array ContinuationToken: description: |- @@ -289519,15 +316511,15 @@ components: - Items title: CollectionModel`1 type: object - CollectionModelOfIdentityContainerResponseModel: + CollectionModelOfIdentityMachineResponseModel: additionalProperties: false description: Response object for collections of items. properties: Items: description: List of items. items: - $ref: '#/components/schemas/IdentityContainerResponseModel' - title: "IdentityContainerResponseModel[]" + $ref: '#/components/schemas/IdentityMachineResponseModel' + title: "IdentityMachineResponseModel[]" type: array ContinuationToken: description: |- @@ -289550,15 +316542,15 @@ components: - Items title: CollectionModel`1 type: object - CollectionModelOfIdentityDirectoryResponseModel: + CollectionModelOfIdentitySiteResponseModel: additionalProperties: false description: Response object for collections of items. properties: Items: description: List of items. items: - $ref: '#/components/schemas/IdentityDirectoryResponseModel' - title: "IdentityDirectoryResponseModel[]" + $ref: '#/components/schemas/IdentitySiteResponseModel' + title: "IdentitySiteResponseModel[]" type: array ContinuationToken: description: |- @@ -289581,15 +316573,15 @@ components: - Items title: CollectionModel`1 type: object - CollectionModelOfIdentityDomainResponseModel: + CollectionModelOfIdentityUserResponseModel: additionalProperties: false description: Response object for collections of items. properties: Items: description: List of items. items: - $ref: '#/components/schemas/IdentityDomainResponseModel' - title: "IdentityDomainResponseModel[]" + $ref: '#/components/schemas/IdentityUserResponseModel' + title: "IdentityUserResponseModel[]" type: array ContinuationToken: description: |- @@ -289612,15 +316604,15 @@ components: - Items title: CollectionModel`1 type: object - CollectionModelOfIdentityForestResponseModel: + CollectionModelOfImageDefinitionResponseModel: additionalProperties: false description: Response object for collections of items. properties: Items: description: List of items. items: - $ref: '#/components/schemas/IdentityForestResponseModel' - title: "IdentityForestResponseModel[]" + $ref: '#/components/schemas/ImageDefinitionResponseModel' + title: "ImageDefinitionResponseModel[]" type: array ContinuationToken: description: |- @@ -289643,15 +316635,15 @@ components: - Items title: CollectionModel`1 type: object - CollectionModelOfIdentityMachineResponseModel: + CollectionModelOfImageVersionCatalogResponseModel: additionalProperties: false description: Response object for collections of items. properties: Items: description: List of items. items: - $ref: '#/components/schemas/IdentityMachineResponseModel' - title: "IdentityMachineResponseModel[]" + $ref: '#/components/schemas/ImageVersionCatalogResponseModel' + title: "ImageVersionCatalogResponseModel[]" type: array ContinuationToken: description: |- @@ -289674,15 +316666,15 @@ components: - Items title: CollectionModel`1 type: object - CollectionModelOfIdentitySiteResponseModel: + CollectionModelOfImageVersionResponseModel: additionalProperties: false description: Response object for collections of items. properties: Items: description: List of items. items: - $ref: '#/components/schemas/IdentitySiteResponseModel' - title: "IdentitySiteResponseModel[]" + $ref: '#/components/schemas/ImageVersionResponseModel' + title: "ImageVersionResponseModel[]" type: array ContinuationToken: description: |- @@ -289705,15 +316697,15 @@ components: - Items title: CollectionModel`1 type: object - CollectionModelOfIdentityUserResponseModel: + CollectionModelOfImportProvisionedVirtualMachineResponseModel: additionalProperties: false description: Response object for collections of items. properties: Items: description: List of items. items: - $ref: '#/components/schemas/IdentityUserResponseModel' - title: "IdentityUserResponseModel[]" + $ref: '#/components/schemas/ImportProvisionedVirtualMachineResponseModel' + title: "ImportProvisionedVirtualMachineResponseModel[]" type: array ContinuationToken: description: |- @@ -289736,15 +316728,15 @@ components: - Items title: CollectionModel`1 type: object - CollectionModelOfImageDefinitionResponseModel: + CollectionModelOfJobResponseModel: additionalProperties: false description: Response object for collections of items. properties: Items: description: List of items. items: - $ref: '#/components/schemas/ImageDefinitionResponseModel' - title: "ImageDefinitionResponseModel[]" + $ref: '#/components/schemas/JobResponseModel' + title: "JobResponseModel[]" type: array ContinuationToken: description: |- @@ -289767,15 +316759,15 @@ components: - Items title: CollectionModel`1 type: object - CollectionModelOfImageVersionCatalogResponseModel: + CollectionModelOfLicenseEntitlementResponseModel: additionalProperties: false description: Response object for collections of items. properties: Items: description: List of items. items: - $ref: '#/components/schemas/ImageVersionCatalogResponseModel' - title: "ImageVersionCatalogResponseModel[]" + $ref: '#/components/schemas/LicenseEntitlementResponseModel' + title: "LicenseEntitlementResponseModel[]" type: array ContinuationToken: description: |- @@ -289798,15 +316790,15 @@ components: - Items title: CollectionModel`1 type: object - CollectionModelOfImageVersionResponseModel: + CollectionModelOfLicenseResponseModel: additionalProperties: false description: Response object for collections of items. properties: Items: description: List of items. items: - $ref: '#/components/schemas/ImageVersionResponseModel' - title: "ImageVersionResponseModel[]" + $ref: '#/components/schemas/LicenseResponseModel' + title: "LicenseResponseModel[]" type: array ContinuationToken: description: |- @@ -289829,15 +316821,15 @@ components: - Items title: CollectionModel`1 type: object - CollectionModelOfImportProvisionedVirtualMachineResponseModel: + CollectionModelOfLicensingUserResponseModel: additionalProperties: false description: Response object for collections of items. properties: Items: description: List of items. items: - $ref: '#/components/schemas/ImportProvisionedVirtualMachineResponseModel' - title: "ImportProvisionedVirtualMachineResponseModel[]" + $ref: '#/components/schemas/LicensingUserResponseModel' + title: "LicensingUserResponseModel[]" type: array ContinuationToken: description: |- @@ -289860,15 +316852,15 @@ components: - Items title: CollectionModel`1 type: object - CollectionModelOfJobResponseModel: + CollectionModelOfLogOperationResponseModel: additionalProperties: false description: Response object for collections of items. properties: Items: description: List of items. items: - $ref: '#/components/schemas/JobResponseModel' - title: "JobResponseModel[]" + $ref: '#/components/schemas/LogOperationResponseModel' + title: "LogOperationResponseModel[]" type: array ContinuationToken: description: |- @@ -289891,15 +316883,15 @@ components: - Items title: CollectionModel`1 type: object - CollectionModelOfLicenseEntitlementResponseModel: + CollectionModelOfLowLevelOperationResponseModel: additionalProperties: false description: Response object for collections of items. properties: Items: description: List of items. items: - $ref: '#/components/schemas/LicenseEntitlementResponseModel' - title: "LicenseEntitlementResponseModel[]" + $ref: '#/components/schemas/LowLevelOperationResponseModel' + title: "LowLevelOperationResponseModel[]" type: array ContinuationToken: description: |- @@ -289922,15 +316914,15 @@ components: - Items title: CollectionModel`1 type: object - CollectionModelOfLicenseResponseModel: + CollectionModelOfMachineApplicationResponseModel: additionalProperties: false description: Response object for collections of items. properties: Items: description: List of items. items: - $ref: '#/components/schemas/LicenseResponseModel' - title: "LicenseResponseModel[]" + $ref: '#/components/schemas/MachineApplicationResponseModel' + title: "MachineApplicationResponseModel[]" type: array ContinuationToken: description: |- @@ -289953,15 +316945,15 @@ components: - Items title: CollectionModel`1 type: object - CollectionModelOfLicensingUserResponseModel: + CollectionModelOfMachineCatalogResponseModel: additionalProperties: false description: Response object for collections of items. properties: Items: description: List of items. items: - $ref: '#/components/schemas/LicensingUserResponseModel' - title: "LicensingUserResponseModel[]" + $ref: '#/components/schemas/MachineCatalogResponseModel' + title: "MachineCatalogResponseModel[]" type: array ContinuationToken: description: |- @@ -289984,15 +316976,15 @@ components: - Items title: CollectionModel`1 type: object - CollectionModelOfLogOperationResponseModel: + CollectionModelOfMachineConfigurationResponseModel: additionalProperties: false description: Response object for collections of items. properties: Items: description: List of items. items: - $ref: '#/components/schemas/LogOperationResponseModel' - title: "LogOperationResponseModel[]" + $ref: '#/components/schemas/MachineConfigurationResponseModel' + title: "MachineConfigurationResponseModel[]" type: array ContinuationToken: description: |- @@ -290015,77 +317007,15 @@ components: - Items title: CollectionModel`1 type: object - CollectionModelOfLowLevelOperationResponseModel: - additionalProperties: false - description: Response object for collections of items. - properties: - Items: - description: List of items. - items: - $ref: '#/components/schemas/LowLevelOperationResponseModel' - title: "LowLevelOperationResponseModel[]" - type: array - ContinuationToken: - description: |- - If present, indicates to the caller that the query was not complete, - and they should call the API again specifying the continuation token - as a query parameter. - nullable: true - title: String - type: string - TotalItems: - description: |- - Indicates the total number of items in the collection, which may be - more than the number of Items returned, if there is a - ContinuationToken. Only returned in the response to `$search` APIs. - format: int32 - nullable: true - title: Int32 - type: integer - required: - - Items - title: CollectionModel`1 - type: object - CollectionModelOfMachineApplicationResponseModel: - additionalProperties: false - description: Response object for collections of items. - properties: - Items: - description: List of items. - items: - $ref: '#/components/schemas/MachineApplicationResponseModel' - title: "MachineApplicationResponseModel[]" - type: array - ContinuationToken: - description: |- - If present, indicates to the caller that the query was not complete, - and they should call the API again specifying the continuation token - as a query parameter. - nullable: true - title: String - type: string - TotalItems: - description: |- - Indicates the total number of items in the collection, which may be - more than the number of Items returned, if there is a - ContinuationToken. Only returned in the response to `$search` APIs. - format: int32 - nullable: true - title: Int32 - type: integer - required: - - Items - title: CollectionModel`1 - type: object - CollectionModelOfMachineCatalogResponseModel: + CollectionModelOfMachineIdentityPoolResponseModel: additionalProperties: false description: Response object for collections of items. properties: Items: description: List of items. items: - $ref: '#/components/schemas/MachineCatalogResponseModel' - title: "MachineCatalogResponseModel[]" + $ref: '#/components/schemas/MachineIdentityPoolResponseModel' + title: "MachineIdentityPoolResponseModel[]" type: array ContinuationToken: description: |- @@ -290108,15 +317038,15 @@ components: - Items title: CollectionModel`1 type: object - CollectionModelOfMachineConfigurationResponseModel: + CollectionModelOfMachineResponseModel: additionalProperties: false description: Response object for collections of items. properties: Items: description: List of items. items: - $ref: '#/components/schemas/MachineConfigurationResponseModel' - title: "MachineConfigurationResponseModel[]" + $ref: '#/components/schemas/MachineResponseModel' + title: "MachineResponseModel[]" type: array ContinuationToken: description: |- @@ -290139,15 +317069,15 @@ components: - Items title: CollectionModel`1 type: object - CollectionModelOfMachineIdentityPoolResponseModel: + CollectionModelOfNameValueStringPairModel: additionalProperties: false description: Response object for collections of items. properties: Items: description: List of items. items: - $ref: '#/components/schemas/MachineIdentityPoolResponseModel' - title: "MachineIdentityPoolResponseModel[]" + $ref: '#/components/schemas/NameValueStringPairModel' + title: "NameValueStringPairModel[]" type: array ContinuationToken: description: |- @@ -290170,15 +317100,15 @@ components: - Items title: CollectionModel`1 type: object - CollectionModelOfMachineResponseModel: + CollectionModelOfPowerActionScheduleResponseModel: additionalProperties: false description: Response object for collections of items. properties: Items: description: List of items. items: - $ref: '#/components/schemas/MachineResponseModel' - title: "MachineResponseModel[]" + $ref: '#/components/schemas/PowerActionScheduleResponseModel' + title: "PowerActionScheduleResponseModel[]" type: array ContinuationToken: description: |- @@ -290201,15 +317131,15 @@ components: - Items title: CollectionModel`1 type: object - CollectionModelOfNameValueStringPairModel: + CollectionModelOfPowerShellHistoryResponseModel: additionalProperties: false description: Response object for collections of items. properties: Items: description: List of items. items: - $ref: '#/components/schemas/NameValueStringPairModel' - title: "NameValueStringPairModel[]" + $ref: '#/components/schemas/PowerShellHistoryResponseModel' + title: "PowerShellHistoryResponseModel[]" type: array ContinuationToken: description: |- @@ -290232,15 +317162,15 @@ components: - Items title: CollectionModel`1 type: object - CollectionModelOfPowerActionScheduleResponseModel: + CollectionModelOfPowerTimeSchemeResponseModel: additionalProperties: false description: Response object for collections of items. properties: Items: description: List of items. items: - $ref: '#/components/schemas/PowerActionScheduleResponseModel' - title: "PowerActionScheduleResponseModel[]" + $ref: '#/components/schemas/PowerTimeSchemeResponseModel' + title: "PowerTimeSchemeResponseModel[]" type: array ContinuationToken: description: |- @@ -290263,15 +317193,15 @@ components: - Items title: CollectionModel`1 type: object - CollectionModelOfPowerShellHistoryResponseModel: + CollectionModelOfPredefinedPermissionGroupResponseModel: additionalProperties: false description: Response object for collections of items. properties: Items: description: List of items. items: - $ref: '#/components/schemas/PowerShellHistoryResponseModel' - title: "PowerShellHistoryResponseModel[]" + $ref: '#/components/schemas/PredefinedPermissionGroupResponseModel' + title: "PredefinedPermissionGroupResponseModel[]" type: array ContinuationToken: description: |- @@ -290294,15 +317224,15 @@ components: - Items title: CollectionModel`1 type: object - CollectionModelOfPowerTimeSchemeResponseModel: + CollectionModelOfPredefinedPermissionResponseModel: additionalProperties: false description: Response object for collections of items. properties: Items: description: List of items. items: - $ref: '#/components/schemas/PowerTimeSchemeResponseModel' - title: "PowerTimeSchemeResponseModel[]" + $ref: '#/components/schemas/PredefinedPermissionResponseModel' + title: "PredefinedPermissionResponseModel[]" type: array ContinuationToken: description: |- @@ -290325,46 +317255,15 @@ components: - Items title: CollectionModel`1 type: object - CollectionModelOfPredefinedPermissionGroupResponseModel: + CollectionModelOfProvisionedVirtualMachineSearchResponseModel: additionalProperties: false description: Response object for collections of items. properties: Items: description: List of items. items: - $ref: '#/components/schemas/PredefinedPermissionGroupResponseModel' - title: "PredefinedPermissionGroupResponseModel[]" - type: array - ContinuationToken: - description: |- - If present, indicates to the caller that the query was not complete, - and they should call the API again specifying the continuation token - as a query parameter. - nullable: true - title: String - type: string - TotalItems: - description: |- - Indicates the total number of items in the collection, which may be - more than the number of Items returned, if there is a - ContinuationToken. Only returned in the response to `$search` APIs. - format: int32 - nullable: true - title: Int32 - type: integer - required: - - Items - title: CollectionModel`1 - type: object - CollectionModelOfPredefinedPermissionResponseModel: - additionalProperties: false - description: Response object for collections of items. - properties: - Items: - description: List of items. - items: - $ref: '#/components/schemas/PredefinedPermissionResponseModel' - title: "PredefinedPermissionResponseModel[]" + $ref: '#/components/schemas/ProvisionedVirtualMachineSearchResponseModel' + title: "ProvisionedVirtualMachineSearchResponseModel[]" type: array ContinuationToken: description: |- @@ -291212,6 +318111,34 @@ components: ComparisonResponseContract: additionalProperties: false description: Comparison report/result. + example: + Targets: + - Targets + - Targets + WithDefaults: true + Result: + - DefaultValue: DefaultValue + IsDifferent: true + Category: Category + IsSetting: true + IsInUse: + - true + - true + SettingName: SettingName + Values: + - Values + - Values + - DefaultValue: DefaultValue + IsDifferent: true + Category: Category + IsSetting: true + IsInUse: + - true + - true + SettingName: SettingName + Values: + - Values + - Values properties: Targets: description: A target is either a policy or template. This list stores the @@ -291238,6 +318165,18 @@ components: ComparisonRowContract: additionalProperties: false description: A row in a comparison report. + example: + DefaultValue: DefaultValue + IsDifferent: true + Category: Category + IsSetting: true + IsInUse: + - true + - true + SettingName: SettingName + Values: + - Values + - Values properties: SettingName: description: Can be either a category name or setting name. @@ -291503,11 +318442,13 @@ components: - Orch - Trust - AppV + - Vus - Config - Log - Analytics - Admin - AppLib + - Identity title: ControllerServiceType type: string x-enumNames: @@ -291524,14 +318465,23 @@ components: - Orch - Trust - AppV + - Vus - Config - Log - Analytics - Admin - AppLib + - Identity CopyPoliciesRequest: additionalProperties: false description: Data for copying policies to other policy sets. + example: + policyGuids: + - policyGuids + - policyGuids + toPolicySets: + - toPolicySets + - toPolicySets properties: policyGuids: description: GUIDs of some of the policies of a policy set. @@ -292372,6 +319322,7 @@ components: - Name of a user Machine: "For example, Domain01\\Machine001" MachineCatalog: f254399c-6b4c-46fd-86e0-c03ade9135a2 + SessionSupport: null ProductCode: ProductCode PolicySetGuid: PolicySetGuid AppProtectionKeyLoggingRequired: true @@ -292467,8 +319418,10 @@ components: PeakLogOffAction: null ShutdownDesktopsAfterUse: false InMaintenanceMode: false + SharingKind: null AutoscaleLogOffReminderIntervalSecondsPeak: 1470350420 PeakBufferSizePercent: 11 + IsRemotePC: true LimitSecondsToForceLogOffUserDuringPeak: 890262545 HdxSslEnabled: false PeakAutoscaleAssignedPowerOnIdleTimeoutMinutes: 1601538494 @@ -292734,8 +319687,20 @@ components: the newly created delivery group. items: $ref: '#/components/schemas/DeliveryGroupAddMachinesRequestModel' + nullable: true title: "DeliveryGroupAddMachinesRequestModel[]" type: array + SessionSupport: + $ref: '#/components/schemas/SessionSupport' + SharingKind: + $ref: '#/components/schemas/SharingKind' + IsRemotePC: + description: |- + Optional, specifies whether this is to be a Remote PC delivery group. + Default comes from the machine catalog, only needs to be specified when creating a delivery group without machine catalog. + nullable: true + title: Boolean + type: boolean MinimumFunctionalLevel: $ref: '#/components/schemas/FunctionalLevel' Name: @@ -293266,7 +320231,6 @@ components: RequiredSleepCapability: $ref: '#/components/schemas/RequiredSleepCapability' required: - - MachineCatalogs - Name title: CreateDeliveryGroupRequestModel type: object @@ -294498,6 +321462,11 @@ components: HostedMachineId: Id of a hosted machine MachineName: "For example, test.local\\machine001" AssignedIPAddress: "For example, 1.1.1.1" + Metadata: + - Value: Value + Name: Name + - Value: Value + Name: Name AssignedClientName: Name of an assigned client AssignedUsers: - Name of an assigned user @@ -294506,6 +321475,11 @@ components: HostedMachineId: Id of a hosted machine MachineName: "For example, test.local\\machine001" AssignedIPAddress: "For example, 1.1.1.1" + Metadata: + - Value: Value + Name: Name + - Value: Value + Name: Name AssignedClientName: Name of an assigned client AssignedUsers: - Name of an assigned user @@ -297346,6 +324320,7 @@ components: description: Request object for editing applib package discovery profile. example: Path: Path + DiscoverFlexApp: true PublishingServer: PublishingServer DiscoverMsix: true DiscoverAppV: true @@ -297433,6 +324408,12 @@ components: nullable: true title: Boolean type: boolean + DiscoverFlexApp: + description: A value indicating whether or not to search should discover + FlexApp Packages. + nullable: true + title: Boolean + type: boolean AutomateDiscovery: description: A value indicating whether or not the discovery should run automatically. @@ -300044,30 +327025,35 @@ components: VdaInstanceId: description: The id for the vda's key pair registered with the MFA trust service. - nullable: true + minLength: 1 title: String type: string VdaInstanceName: description: The instance name for the key. it is also used as the machine's name for non-domain joined vda. - nullable: true + minLength: 1 title: String type: string ServicePublicKey: description: The vda's public service key to be registered with FMA Trust Service. - nullable: true + minLength: 1 title: String type: string MachineSid: description: |- Real sid of AD machine for domain joined; or virtual sid if non-domain joined this parameter will be used to create machine - nullable: true + minLength: 1 title: String type: string MachineMetadata: $ref: '#/components/schemas/EnrollMachineMetaDataModel' + required: + - MachineSid + - ServicePublicKey + - VdaInstanceId + - VdaInstanceName title: EnrollMachineRequestModel type: object EnrollMachineResponseModel: @@ -300246,6 +327232,10 @@ components: EnumerationMember: additionalProperties: false description: Member of enum type. + example: + displayName: displayName + name: name + value: 0 properties: name: description: Member name. @@ -300288,6 +327278,15 @@ components: EnumerationType: additionalProperties: false description: Enumeration type + example: + members: + - displayName: displayName + name: name + value: 0 + - displayName: displayName + name: name + value: 0 + typeName: typeName properties: typeName: description: Name of the type. @@ -300636,6 +327635,12 @@ components: FilterDefinition: additionalProperties: false description: Filter definition. + example: + filterName: filterName + isUserFilter: true + isSingleton: true + filterType: null + explanation: explanation properties: filterType: $ref: '#/components/schemas/FilterType' @@ -300747,6 +327752,11 @@ components: FilterRequest: additionalProperties: false description: Data for specifying a filter request. + example: + isAllowed: true + filterData: filterData + isEnabled: true + filterType: filterType properties: filterType: description: The filter type. @@ -300806,6 +327816,13 @@ components: FilterResponse: additionalProperties: false description: Filter response. + example: + isAllowed: true + filterData: filterData + isEnabled: true + filterGuid: filterGuid + filterType: filterType + policyGuid: policyGuid properties: policyGuid: description: GUID of the policy that owns this filter. @@ -300897,6 +327914,17 @@ components: FilterSearch: additionalProperties: false description: Filter search data. + example: + SortCriteria: + SortDirection: null + Property: null + SearchFilters: + - Operator: null + Value: Value + Property: null + - Operator: null + Value: Value + Property: null properties: SearchFilters: description: List of advanced search filters. @@ -303703,12 +330731,14 @@ components: - Template - Vm - LaunchTemplateVersion + - Folder title: HypervisorResourceSearchResourceType type: string x-enumNames: - Template - Vm - LaunchTemplateVersion + - Folder HypervisorResourceValidationRequestModel: additionalProperties: false description: The resource validation request. @@ -306556,6 +333586,8 @@ components: - RepairMachineCatalogAccounts - ImportProvisionedVirtualMachines - ValidateMachineCatalogCreation + - SearchProvisionedVirtualMachines + - GetProvisionedVirtualMachineDetails title: JobType type: string x-enumNames: @@ -306802,6 +333834,8 @@ components: - RepairMachineCatalogAccounts - ImportProvisionedVirtualMachines - ValidateMachineCatalogCreation + - SearchProvisionedVirtualMachines + - GetProvisionedVirtualMachineDetails LeasingBehavior: description: Leasing behavior. enum: @@ -307633,6 +334667,27 @@ components: LosingPolicy: additionalProperties: false description: Policy that should be applied but not applied due to various reasons. + example: + Priority: 0 + Reasons: + key: + - Reasons + - Reasons + Settings: + - SettingName: SettingName + WinningPolicy: + PolicySetGuid: PolicySetGuid + PolicyName: PolicyName + PolicyGuid: PolicyGuid + - SettingName: SettingName + WinningPolicy: + PolicySetGuid: PolicySetGuid + PolicyName: PolicyName + PolicyGuid: PolicyGuid + PolicyIdentity: + PolicySetGuid: PolicySetGuid + PolicyName: PolicyName + PolicyGuid: PolicyGuid properties: PolicyIdentity: $ref: '#/components/schemas/PolicyIdentity' @@ -307695,6 +334750,12 @@ components: LosingSetting: additionalProperties: false description: Setting that is not applied. + example: + SettingName: SettingName + PolicyIdentity: + PolicySetGuid: PolicySetGuid + PolicyName: PolicyName + PolicyGuid: PolicyGuid properties: PolicyIdentity: $ref: '#/components/schemas/PolicyIdentity' @@ -308516,7 +335577,7 @@ components: description: |- Simple administrative name of catalog within parent admin folder (if any). This property is not guaranteed unique across all catalogs. - minLength: 1 + nullable: true title: String type: string FullName: @@ -308526,7 +335587,7 @@ components: type: string Id: description: Id of the machine catalog. - minLength: 1 + nullable: true title: String type: string Uid: @@ -308732,26 +335793,6 @@ components: $ref: '#/components/schemas/RefResponseModel' AdminFolder: $ref: '#/components/schemas/RefResponseModel' - required: - - AllocationType - - AvailableCount - - CanRecreateCatalog - - CanRollbackVMImage - - HasBeenPromoted - - Id - - IsBroken - - IsRemotePC - - MachineType - - MinimumFunctionalLevel - - Name - - PersistChanges - - ProvisioningType - - SessionSupport - - SharingKind - - TotalCount - - UnassignedCount - - UsedCount - - Zone title: MachineCatalogResponseModel type: object MachineCatalogResponseModelCollection: @@ -309869,6 +336910,13 @@ components: type: boolean UpgradeDetail: $ref: '#/components/schemas/MachineUpgradeDetail' + Metadata: + description: The meta data of this machine. + items: + $ref: '#/components/schemas/NameValueStringPairModel' + nullable: true + title: "NameValueStringPairModel[]" + type: array type: object title: MachineResponseModel MachineResponseModelCollection: @@ -310589,6 +337637,7 @@ components: - AppVDualAdmin - Msix - AppAttach + - FlexApp title: PackagedApplicationType type: string x-enumNames: @@ -310597,6 +337646,7 @@ components: - AppVDualAdmin - Msix - AppAttach + - FlexApp PagingFileSettingResponseModel: additionalProperties: false description: "Paging file location like: ?:\\pagefile.sys, C:\\pagefile.sys" @@ -310641,6 +337691,10 @@ components: PolicyBodyRequest: additionalProperties: false description: Data for policy request. + example: + isEnabled: true + name: name + description: description properties: name: description: Policy name. @@ -310661,6 +337715,10 @@ components: PolicyIdentity: additionalProperties: false description: Identity of a policy. + example: + PolicySetGuid: PolicySetGuid + PolicyName: PolicyName + PolicyGuid: PolicyGuid properties: PolicySetGuid: description: GUID of the policy set. @@ -310696,6 +337754,26 @@ components: PolicyRequest: additionalProperties: false description: Data for policy request. + example: + settings: + - settingValue: settingValue + useDefault: true + settingName: settingName + - settingValue: settingValue + useDefault: true + settingName: settingName + isEnabled: true + name: name + description: description + filters: + - isAllowed: true + filterData: filterData + isEnabled: true + filterType: filterType + - isAllowed: true + filterData: filterData + isEnabled: true + filterType: filterType properties: name: description: Policy name. @@ -310772,6 +337850,37 @@ components: PolicyResponse: additionalProperties: false description: Policy response. + example: + settings: + - settingValue: settingValue + settingGuid: settingGuid + useDefault: true + policyGuid: policyGuid + settingName: settingName + - settingValue: settingValue + settingGuid: settingGuid + useDefault: true + policyGuid: policyGuid + settingName: settingName + policySetGuid: policySetGuid + policyName: policyName + isEnabled: true + description: description + filters: + - isAllowed: true + filterData: filterData + isEnabled: true + filterGuid: filterGuid + filterType: filterType + policyGuid: policyGuid + - isAllowed: true + filterData: filterData + isEnabled: true + filterGuid: filterGuid + filterType: filterType + policyGuid: policyGuid + priority: 0 + policyGuid: policyGuid properties: policySetGuid: description: The policy set that this policy belongs to. @@ -310864,6 +337973,17 @@ components: PolicySearch: additionalProperties: false description: Policy search data. + example: + SortCriteria: + SortDirection: null + Property: null + SearchFilters: + - Operator: null + Value: Value + Property: null + - Operator: null + Value: Value + Property: null properties: SearchFilters: description: List of advanced search filters. @@ -310879,6 +337999,13 @@ components: PolicySetRequest: additionalProperties: false description: Policy set request. + example: + policySetType: policySetType + name: name + description: description + scopes: + - scopes + - scopes properties: policySetType: description: The policy set type. @@ -310908,6 +338035,77 @@ components: PolicySetResponse: additionalProperties: false description: GPO policy set data. + example: + isAssigned: true + policySetGuid: policySetGuid + policyCount: 0 + policySetType: null + name: name + policies: + - settings: + - settingValue: settingValue + settingGuid: settingGuid + useDefault: true + policyGuid: policyGuid + settingName: settingName + - settingValue: settingValue + settingGuid: settingGuid + useDefault: true + policyGuid: policyGuid + settingName: settingName + policySetGuid: policySetGuid + policyName: policyName + isEnabled: true + description: description + filters: + - isAllowed: true + filterData: filterData + isEnabled: true + filterGuid: filterGuid + filterType: filterType + policyGuid: policyGuid + - isAllowed: true + filterData: filterData + isEnabled: true + filterGuid: filterGuid + filterType: filterType + policyGuid: policyGuid + priority: 0 + policyGuid: policyGuid + - settings: + - settingValue: settingValue + settingGuid: settingGuid + useDefault: true + policyGuid: policyGuid + settingName: settingName + - settingValue: settingValue + settingGuid: settingGuid + useDefault: true + policyGuid: policyGuid + settingName: settingName + policySetGuid: policySetGuid + policyName: policyName + isEnabled: true + description: description + filters: + - isAllowed: true + filterData: filterData + isEnabled: true + filterGuid: filterGuid + filterType: filterType + policyGuid: policyGuid + - isAllowed: true + filterData: filterData + isEnabled: true + filterGuid: filterGuid + filterType: filterType + policyGuid: policyGuid + priority: 0 + policyGuid: policyGuid + description: description + scopes: + - scopes + - scopes properties: policySetGuid: description: Guid of the policy set. @@ -310956,6 +338154,17 @@ components: PolicySetSearch: additionalProperties: false description: Policy set search data. + example: + SortCriteria: + SortDirection: null + Property: null + SearchFilters: + - Operator: null + Value: Value + Property: null + - Operator: null + Value: Value + Property: null properties: SearchFilters: description: List of advanced search filters. @@ -312186,6 +339395,610 @@ components: - Hdx - Rdp - Console + ProvisionedVirtualMachineCustomVmDataResponseModel: + additionalProperties: false + description: Provisioned Virtual Machine CustomVmData response model + properties: + AvailabilityZone: + description: Availability Zones + nullable: true + title: String + type: string + DataDiskId: + description: WBCDiskId + nullable: true + title: String + type: string + DataDiskStorageType: + description: Data Disk Storage Type + nullable: true + title: String + type: string + EphemeralOsDiskMode: + description: Ephemeral OS Disk Mode + nullable: true + title: String + type: string + EncryptionSettingDESI: + description: Disk Encryption Set Id + nullable: true + title: String + type: string + FailSafeStorageType: + description: Storage Type - Fail Safe + title: Boolean + type: boolean + HostGroupId: + description: Host Group + nullable: true + title: String + type: string + IdentityDiskId: + description: Identity Disk full path + nullable: true + title: String + type: string + IdentityDiskStorageType: + description: Identity Disk Storage Type + nullable: true + title: String + type: string + IsOSDiskAzureTempDisk: + description: OS Disk Use Temp Disk + title: Boolean + type: boolean + IsSharedImageGalleryUsed: + description: Use Shared Image Gallery + nullable: true + title: Boolean + type: boolean + IsUsingEphemeralOsDisk: + description: Ephemeral OS Disk + title: Boolean + type: boolean + LicenseType: + description: License Type + nullable: true + title: String + type: string + MachineSizeId: + description: Machine Size + nullable: true + title: String + type: string + NetworkInterfaceIds: + description: Network Maps + items: + title: String + type: string + nullable: true + title: "String[]" + type: array + OSDiskId: + description: OS Disk full path + nullable: true + title: String + type: string + OsDiskStorageType: + description: OS Disk Storage Type + nullable: true + title: String + type: string + OsType: + description: Operation System + nullable: true + title: String + type: string + PersistOsDisk: + description: Retaining System Disk + nullable: true + title: Boolean + type: boolean + PersistWbc: + description: Retaining Write-back Cache Disk + nullable: true + title: Boolean + type: boolean + RegionId: + description: Region Id + nullable: true + title: String + type: string + ResourceGroupName: + description: Resource Group + nullable: true + title: String + type: string + SecurityType: + description: Security Type + nullable: true + title: String + type: string + SIGMachineToReplicaRatio: + description: Azure Shared Image Gallery Machine To Replica Ratio + format: int32 + nullable: true + title: Int32 + type: integer + SIGReplicaMaximum: + description: Azure Shared Image Replica Maximum + format: int32 + nullable: true + title: Int32 + type: integer + StorageTypeAtShutdown: + description: Storage Type At Shutdown + nullable: true + title: String + type: string + SupportsHibernation: + description: VmMetadata hibernation configuration. + nullable: true + title: Boolean + type: boolean + title: ProvisionedVirtualMachineCustomVmDataResponseModel + type: object + ProvisionedVirtualMachineDetailsResponseModel: + additionalProperties: false + description: Response model for machine. + properties: + AcceleratedNetwork: + description: Accelerated Network + nullable: true + title: Boolean + type: boolean + ADAccountName: + description: Active Directory Account Name + nullable: true + title: String + type: string + VMSid: + description: Virtual Machine Sid + nullable: true + title: String + type: string + AssignedImage: + description: Assigned Image + nullable: true + title: String + type: string + BootedImage: + description: Booted Image + nullable: true + title: String + type: string + CustomVmData: + $ref: '#/components/schemas/ProvisionedVirtualMachineCustomVmDataResponseModel' + CpuCount: + description: Cpu Count + format: int32 + title: Int32 + type: integer + CreationDate: + description: Creation Date + nullable: true + title: String + type: string + Domain: + description: Domain + nullable: true + title: String + type: string + EnableIntegrityMonitoring: + description: IntegrityMonitoring + nullable: true + title: Boolean + type: boolean + EnableSecureBoot: + description: From ProvScheme VMMetaData + nullable: true + title: Boolean + type: boolean + EnableVTPM: + description: From ProvScheme VMMetaData + nullable: true + title: Boolean + type: boolean + EncryptionAtHost: + description: From ProvScheme VMMetaData + nullable: true + title: Boolean + type: boolean + Errors: + description: 'The Errors of provisioned virtual machine ' + items: + title: String + type: string + nullable: true + title: "String[]" + type: array + PluginId: + description: Broker Hypervisor Connection Type - Plugin Factory Name + nullable: true + title: String + type: string + ImageOutOfDate: + description: "Image Out Of Date, booted image name doesn't equal assigned\ + \ image name" + title: Boolean + type: boolean + MemoryMB: + description: MemoryMB + format: int32 + title: Int32 + type: integer + HostingUnitUid: + description: Hosting Unit Uid + format: guid + title: Guid + type: string + HypervisorConnectionUid: + description: Hypervisor Connection Uid + format: guid + title: Guid + type: string + IdentityDiskId: + description: Identity Disk Id + nullable: true + title: String + type: string + LastBootTime: + description: Last Boot Time + nullable: true + title: String + type: string + ProvisioningSchemeType: + description: "Provisioning Scheme Type: MCS, PVS" + nullable: true + title: String + type: string + ProvisioningSchemeUpdateRequested: + description: Provisioning Scheme Update Requested + nullable: true + title: String + type: string + ProvisioningSchemeVersion: + description: Provisioning SchemeVersion + format: int32 + title: Int32 + type: integer + UseFullDiskCloneProvisioning: + description: Use Full Disk Clone Provisioning + title: Boolean + type: boolean + VMId: + description: "VMId, Azure - resourcegroup/VMName" + nullable: true + title: String + type: string + VMName: + description: VM Name on the hypervisor + nullable: true + title: String + type: string + Warnings: + description: "Warnings, decode CustomVMData failed reason" + items: + $ref: '#/components/schemas/ProvisionedVirtualMachineDetailsWarningReponseModel' + nullable: true + title: "ProvisionedVirtualMachineDetailsWarningReponseModel[]" + type: array + WindowsActivationStatus: + description: Windows Activation Status + nullable: true + title: String + type: string + WindowsActivationStatusErrorCode: + description: Windows Activation Status Error Code + nullable: true + title: String + type: string + WindowsActivationStatusVirtualMachineError: + description: Windows Activation Status Virtual Machine Error + nullable: true + title: String + type: string + WindowsActivationTypeProvisionedVirtualMachine: + description: Windows Activation Type Provisioned Virtual Machine + nullable: true + title: String + type: string + WriteBackCacheDiskSize: + description: Write Back Cache(WBC) Disk Size + format: int32 + title: Int32 + type: integer + WriteBackCacheMemorySize: + description: Write Back Cache(WBC) Memory Size + format: int32 + title: Int32 + type: integer + title: ProvisionedVirtualMachineDetailsResponseModel + type: object + ProvisionedVirtualMachineDetailsWarningReponseModel: + additionalProperties: false + properties: + Type: + $ref: '#/components/schemas/ProvisionedVirtualMachineDetailsWarningType' + Message: + description: Message associated with warning + nullable: true + title: String + type: string + title: ProvisionedVirtualMachineDetailsWarningReponseModel + type: object + ProvisionedVirtualMachineDetailsWarningType: + description: "" + enum: + - Unknown + - GetProvisionedVirtualMachineCustomVMDataFailed + - GetProvisioningSchemeVMMetadataFailed + title: ProvisionedVirtualMachineDetailsWarningType + type: string + x-enumNames: + - Unknown + - GetProvisionedVirtualMachineCustomVMDataFailed + - GetProvisioningSchemeVMMetadataFailed + ProvisionedVirtualMachineSearchFilterGroupRequestModel: + additionalProperties: false + description: Advanced search filter group for machines and sessions + properties: + SearchFilterGroupType: + $ref: '#/components/schemas/ProvisionedVirtualMachineSearchFilterGroupType' + SearchFilters: + description: The search filters in search filter group + items: + $ref: '#/components/schemas/ProvisionedVirtualMachineSearchFilterRequestModel' + nullable: true + title: "ProvisionedVirtualMachineSearchFilterRequestModel[]" + type: array + SearchFilterGroupsType: + $ref: '#/components/schemas/ProvisionedVirtualMachineSearchFilterGroupsType' + SearchFilterGroups: + description: The search filter group in search filter groups + items: + $ref: '#/components/schemas/ProvisionedVirtualMachineSearchFilterGroupRequestModel' + nullable: true + title: "ProvisionedVirtualMachineSearchFilterGroupRequestModel[]" + type: array + title: ProvisionedVirtualMachineSearchFilterGroupRequestModel + type: object + ProvisionedVirtualMachineSearchFilterGroupsType: + description: The search filter groups type + enum: + - Or + - And + title: ProvisionedVirtualMachineSearchFilterGroupsType + type: string + x-enumNames: + - Or + - And + ProvisionedVirtualMachineSearchFilterGroupType: + description: The search filter group type + enum: + - Or + - And + title: ProvisionedVirtualMachineSearchFilterGroupType + type: string + x-enumNames: + - Or + - And + ProvisionedVirtualMachineSearchFilterRequestModel: + additionalProperties: false + description: Advanced search filter for machines. + properties: + Property: + $ref: '#/components/schemas/ProvisionedVirtualMachineSearchProperty' + Value: + description: Value to match. + example: "For example, test" + nullable: true + title: String + type: string + Operator: + $ref: '#/components/schemas/SearchOperator' + required: + - Operator + - Property + title: ProvisionedVirtualMachineSearchFilterRequestModel + type: object + ProvisionedVirtualMachineSearchProperty: + description: "Properties which can be used for provisioned virtual machines.\n\ + \ " + enum: + - ActiveOperation + - VMSid + - CpuCount + - IdentityType + - Identities + - ImageOutOfDate + - LastBootTime + - MemoryMB + - Persistency + - ProvisioningSchemeName + - ProvisioningSchemeVersion + - ProvVMConfigurationVersion + - VMName + - WindowsActivationTypeProvisionedVirtualMachine + - UseWriteBackCache + - WriteBackCacheDiskSize + - WriteBackCacheDiskDriveLetter + - WriteBackCacheMemorySize + title: ProvisionedVirtualMachineSearchProperty + type: string + x-enumNames: + - ActiveOperation + - VMSid + - CpuCount + - IdentityType + - Identities + - ImageOutOfDate + - LastBootTime + - MemoryMB + - Persistency + - ProvisioningSchemeName + - ProvisioningSchemeVersion + - ProvVMConfigurationVersion + - VMName + - WindowsActivationTypeProvisionedVirtualMachine + - UseWriteBackCache + - WriteBackCacheDiskSize + - WriteBackCacheDiskDriveLetter + - WriteBackCacheMemorySize + ProvisionedVirtualMachineSearchRequestModel: + additionalProperties: false + description: Request model for defining provisioned virtual machine. + properties: + BasicSearchString: + description: |- + Basic search string. Specify a string which will match + if contained within some string property of the machine. + example: "For example, name of a machine" + nullable: true + title: String + type: string + SearchFilters: + description: List of advanced search filters. + items: + $ref: '#/components/schemas/ProvisionedVirtualMachineSearchFilterRequestModel' + nullable: true + title: "ProvisionedVirtualMachineSearchFilterRequestModel[]" + type: array + SearchFilterGroups: + description: List of advanced search filter groups. + items: + $ref: '#/components/schemas/ProvisionedVirtualMachineSearchFilterGroupRequestModel' + nullable: true + title: "ProvisionedVirtualMachineSearchFilterGroupRequestModel[]" + type: array + SearchFilterGroupsType: + $ref: '#/components/schemas/ProvisionedVirtualMachineSearchFilterGroupsType' + SortCriteriaItems: + description: "Sort criteria for the results, multiple sorting criteria can\ + \ be specified here." + items: + $ref: '#/components/schemas/ProvisionedVirtualMachineSortCriteriaRequestModel' + nullable: true + title: "ProvisionedVirtualMachineSortCriteriaRequestModel[]" + type: array + title: ProvisionedVirtualMachineSearchRequestModel + type: object + ProvisionedVirtualMachineSearchResponseModel: + additionalProperties: false + description: Response model for provisioned virtual machine. + properties: + ActiveOperation: + description: Active Operation. + nullable: true + title: String + type: string + VMSid: + description: Provisioned Virtual Machine Sid. + nullable: true + title: String + type: string + CpuCount: + description: Cpu Count. + format: int32 + title: Int32 + type: integer + IdentityType: + description: "Identity Type:ActiveDirectory, AzureAD, HybridAzureAD, Workgroup." + nullable: true + title: String + type: string + Identities: + description: |- + ActiveDirectory, HybridAzureAD - Domain. + AzureAD - TenantId. + Workgroup - null. + nullable: true + title: String + type: string + ImageOutOfDate: + description: Booted image isn't same as assigned image. + title: Boolean + type: boolean + LastBootTime: + description: Last boot time. + nullable: true + title: String + type: string + MemoryMB: + description: Memory(MB). + format: int32 + title: Int32 + type: integer + Persistency: + description: Persistency. + title: Boolean + type: boolean + ProvisioningSchemeName: + description: Provision Scheme Name. + nullable: true + title: String + type: string + ProvisioningSchemeVersion: + description: Provision Scheme Version. + format: int32 + title: Int32 + type: integer + ProvVMConfigurationVersion: + description: Provisioned Virtual Machine Configuration Version. + format: int32 + title: Int32 + type: integer + VMName: + description: Provisioned virtual machine name on hypervisor. + nullable: true + title: String + type: string + WindowsActivationTypeProvisionedVirtualMachine: + description: Windows Activation Type. + nullable: true + title: String + type: string + UseWriteBackCache: + description: 'Whether use write back cache. ' + title: Boolean + type: boolean + WriteBackCacheDiskSize: + description: Write back cache disk size. + format: int32 + title: Int32 + type: integer + WriteBackCacheDiskDriveLetter: + description: Write back cache disk drive letter. + format: int32 + title: Int32 + type: integer + WriteBackCacheMemorySize: + description: Write back cache memory size. + format: int32 + title: Int32 + type: integer + title: ProvisionedVirtualMachineSearchResponseModel + type: object + ProvisionedVirtualMachineSearchResponseModelCollection: + allOf: + - $ref: '#/components/schemas/CollectionModelOfProvisionedVirtualMachineSearchResponseModel' + - additionalProperties: false + description: Response object for collections of MachineResponseMode. + type: object + title: ProvisionedVirtualMachineSearchResponseModelCollection + ProvisionedVirtualMachineSortCriteriaRequestModel: + additionalProperties: false + description: Machine sort criteria. + properties: + Property: + $ref: '#/components/schemas/ProvisionedVirtualMachineSearchProperty' + SortDirection: + $ref: '#/components/schemas/ListSortDirection' + required: + - Property + - SortDirection + title: ProvisionedVirtualMachineSortCriteriaRequestModel + type: object ProvisioningProgressResponseModel: additionalProperties: false description: Progress of machine catalog provisioning. @@ -312592,6 +340405,21 @@ components: nullable: true title: String type: string + EnableSecureBoot: + description: VmMetadata VirtualMachine.Resources.Properties.SecurityProfile.UefiSettings.secureBootEnabled + nullable: true + title: Boolean + type: boolean + EnableVTPM: + description: VmMetadata VirtualMachine.Resources.Properties.SecurityProfile.UefiSettings.vTpmEnabled + nullable: true + title: Boolean + type: boolean + EncryptionAtHost: + description: VmMetadata VirtualMachine.Resources.Properties.SecurityProfile.EncryptionAtHost + nullable: true + title: Boolean + type: boolean Labels: description: VmMetadata Labels nullable: true @@ -312602,6 +340430,16 @@ components: nullable: true title: String type: string + StorageType: + description: VmMetadata storage type + nullable: true + title: String + type: string + EncryptionKeyId: + description: VmMetadata encryption key + nullable: true + title: String + type: string title: ProvisioningSchemeVmMetadataResponseModel type: object ProvisioningSchemeWarningReponseModel: @@ -314034,6 +341872,10 @@ components: SearchFilter: additionalProperties: false description: Search filter for policy sets. + example: + Operator: null + Value: Value + Property: null properties: Property: $ref: '#/components/schemas/SearchProperty' @@ -314055,6 +341897,10 @@ components: SearchFilter2: additionalProperties: false description: Search filter for policies. + example: + Operator: null + Value: Value + Property: null properties: Property: $ref: '#/components/schemas/PolicyProperty' @@ -314076,6 +341922,10 @@ components: SearchFilter3: additionalProperties: false description: Search filter for settings. + example: + Operator: null + Value: Value + Property: null properties: Property: $ref: '#/components/schemas/SettingProperty' @@ -314097,6 +341947,10 @@ components: SearchFilter4: additionalProperties: false description: Search filter for filters. + example: + Operator: null + Value: Value + Property: null properties: Property: $ref: '#/components/schemas/FilterProperty' @@ -314922,6 +342776,57 @@ components: SettingDefinition: additionalProperties: false description: Setting definition. + example: + displayName: displayName + defaultValue: defaultValue + valueAsArray: true + enumType: + members: + - displayName: displayName + name: name + value: 0 + - displayName: displayName + name: name + value: 0 + typeName: typeName + valueUnit: valueUnit + deniedText: deniedText + explanation: explanation + isEnableDisable: true + settingName: settingName + isToggled: true + relatedSettings: + key: relatedSettings + valueMinimum: valueMinimum + valueType: valueType + defaultSnip: defaultSnip + hideValueHint: true + allowedText: allowedText + valueMaximum: valueMaximum + initialValue: initialValue + editorName: editorName + dependsOn: dependsOn + disabledValue: disabledValue + versionDetails: + - product: product + displayName: displayName + edition: edition + version: version + - product: product + displayName: displayName + edition: edition + version: version + isUserSetting: true + versionCode: versionCode + validatorError: validatorError + secureDefaultValue: secureDefaultValue + gpoScope: gpoScope + productGroup: productGroup + category: category + valueValidator: valueValidator + vdaVersions: + - vdaVersions + - vdaVersions properties: settingName: description: Setting name. This is globally unique. @@ -315225,6 +343130,109 @@ components: additionalProperties: false description: Top level object for setting definitions. Should support paging. Should support HATEOAS links. + example: + items: + - displayName: displayName + defaultValue: defaultValue + valueAsArray: true + enumType: + members: + - displayName: displayName + name: name + value: 0 + - displayName: displayName + name: name + value: 0 + typeName: typeName + valueUnit: valueUnit + deniedText: deniedText + explanation: explanation + isEnableDisable: true + settingName: settingName + isToggled: true + relatedSettings: + key: relatedSettings + valueMinimum: valueMinimum + valueType: valueType + defaultSnip: defaultSnip + hideValueHint: true + allowedText: allowedText + valueMaximum: valueMaximum + initialValue: initialValue + editorName: editorName + dependsOn: dependsOn + disabledValue: disabledValue + versionDetails: + - product: product + displayName: displayName + edition: edition + version: version + - product: product + displayName: displayName + edition: edition + version: version + isUserSetting: true + versionCode: versionCode + validatorError: validatorError + secureDefaultValue: secureDefaultValue + gpoScope: gpoScope + productGroup: productGroup + category: category + valueValidator: valueValidator + vdaVersions: + - vdaVersions + - vdaVersions + - displayName: displayName + defaultValue: defaultValue + valueAsArray: true + enumType: + members: + - displayName: displayName + name: name + value: 0 + - displayName: displayName + name: name + value: 0 + typeName: typeName + valueUnit: valueUnit + deniedText: deniedText + explanation: explanation + isEnableDisable: true + settingName: settingName + isToggled: true + relatedSettings: + key: relatedSettings + valueMinimum: valueMinimum + valueType: valueType + defaultSnip: defaultSnip + hideValueHint: true + allowedText: allowedText + valueMaximum: valueMaximum + initialValue: initialValue + editorName: editorName + dependsOn: dependsOn + disabledValue: disabledValue + versionDetails: + - product: product + displayName: displayName + edition: edition + version: version + - product: product + displayName: displayName + edition: edition + version: version + isUserSetting: true + versionCode: versionCode + validatorError: validatorError + secureDefaultValue: secureDefaultValue + gpoScope: gpoScope + productGroup: productGroup + category: category + valueValidator: valueValidator + vdaVersions: + - vdaVersions + - vdaVersions + continuationToken: continuationToken properties: items: description: Items of collection. @@ -315257,6 +343265,10 @@ components: SettingRequest: additionalProperties: false description: Setting request. + example: + settingValue: settingValue + useDefault: true + settingName: settingName properties: settingName: description: Setting type. Is globally unique. @@ -315306,6 +343318,12 @@ components: SettingResponse: additionalProperties: false description: Setting response. + example: + settingValue: settingValue + settingGuid: settingGuid + useDefault: true + policyGuid: policyGuid + settingName: settingName properties: policyGuid: description: The GUID of the policy that owns this setting. @@ -315361,6 +343379,17 @@ components: SettingSearch: additionalProperties: false description: Setting search data. + example: + SortCriteria: + SortDirection: null + Property: null + SearchFilters: + - Operator: null + Value: Value + Property: null + - Operator: null + Value: Value + Property: null properties: SearchFilters: description: List of advanced search filters. @@ -315634,6 +343663,26 @@ components: SimulationRequestContract: additionalProperties: false description: Simulation request. This is basically the filter evidence. + example: + OrganizationalUnit: OrganizationalUnit + IsUsingAccessGateway: true + AccessGatewayFarm: AccessGatewayFarm + GroupSids: + - GroupSids + - GroupSids + IsUsingWanScaler: true + DeliveryGroupType: DeliveryGroupType + UserSid: UserSid + DeliveryGroupGuid: DeliveryGroupGuid + ClientName: ClientName + ClientIpAddress: ClientIpAddress + ComputerName: ComputerName + AccessGatewayTags: + - AccessGatewayTags + - AccessGatewayTags + Tags: + - Tags + - Tags properties: ComputerName: description: Name of the selected computer. @@ -315713,6 +343762,92 @@ components: SimulationResponseContract: additionalProperties: false description: Result of a simulation run. + example: + IsUserRsop: true + AppliedSettings: + - SettingValue: SettingValue + SettingName: SettingName + PolicyIdentity: + PolicySetGuid: PolicySetGuid + PolicyName: PolicyName + PolicyGuid: PolicyGuid + - SettingValue: SettingValue + SettingName: SettingName + PolicyIdentity: + PolicySetGuid: PolicySetGuid + PolicyName: PolicyName + PolicyGuid: PolicyGuid + LosingSettings: + - SettingName: SettingName + PolicyIdentity: + PolicySetGuid: PolicySetGuid + PolicyName: PolicyName + PolicyGuid: PolicyGuid + - SettingName: SettingName + PolicyIdentity: + PolicySetGuid: PolicySetGuid + PolicyName: PolicyName + PolicyGuid: PolicyGuid + AppliedPolicies: + - Reasons: + key: + - Reasons + - Reasons + PolicyIdentity: + PolicySetGuid: PolicySetGuid + PolicyName: PolicyName + PolicyGuid: PolicyGuid + - Reasons: + key: + - Reasons + - Reasons + PolicyIdentity: + PolicySetGuid: PolicySetGuid + PolicyName: PolicyName + PolicyGuid: PolicyGuid + FilterEvidence: + key: FilterEvidence + LosingPolicies: + - Priority: 0 + Reasons: + key: + - Reasons + - Reasons + Settings: + - SettingName: SettingName + WinningPolicy: + PolicySetGuid: PolicySetGuid + PolicyName: PolicyName + PolicyGuid: PolicyGuid + - SettingName: SettingName + WinningPolicy: + PolicySetGuid: PolicySetGuid + PolicyName: PolicyName + PolicyGuid: PolicyGuid + PolicyIdentity: + PolicySetGuid: PolicySetGuid + PolicyName: PolicyName + PolicyGuid: PolicyGuid + - Priority: 0 + Reasons: + key: + - Reasons + - Reasons + Settings: + - SettingName: SettingName + WinningPolicy: + PolicySetGuid: PolicySetGuid + PolicyName: PolicyName + PolicyGuid: PolicyGuid + - SettingName: SettingName + WinningPolicy: + PolicySetGuid: PolicySetGuid + PolicyName: PolicyName + PolicyGuid: PolicyGuid + PolicyIdentity: + PolicySetGuid: PolicySetGuid + PolicyName: PolicyName + PolicyGuid: PolicyGuid properties: IsUserRsop: description: The report is for machine or user. @@ -316256,6 +344391,9 @@ components: SortingMethod: additionalProperties: false description: Policy set search result sort criteria. + example: + SortDirection: null + Property: null properties: Property: $ref: '#/components/schemas/SearchProperty' @@ -316269,6 +344407,9 @@ components: SortingMethod2: additionalProperties: false description: Policy search result sort criteria. + example: + SortDirection: null + Property: null properties: Property: $ref: '#/components/schemas/PolicyProperty' @@ -316282,6 +344423,9 @@ components: SortingMethod3: additionalProperties: false description: Setting search result sort criteria. + example: + SortDirection: null + Property: null properties: Property: $ref: '#/components/schemas/SettingProperty' @@ -316295,6 +344439,9 @@ components: SortingMethod4: additionalProperties: false description: Filter search result sort criteria. + example: + SortDirection: null + Property: null properties: Property: $ref: '#/components/schemas/FilterProperty' @@ -318263,6 +346410,11 @@ components: HostedMachineId: Id of a hosted machine PublishedName: PublishedName AssignedIPAddress: "For example, 1.1.1.1" + Metadata: + - Value: Value + Name: Name + - Value: Value + Name: Name AssignedClientName: Name of an assigned client AssignedUsers: - For example @@ -318332,6 +346484,16 @@ components: nullable: true title: String type: string + Metadata: + description: |- + The metadata of machine. Set the value of the NameValueStringPairModel is null or empty will be remove this metadata. + Not existing Name and Value NameValueStringPairModel object will be added. + The same Name but different value object will be updated. + items: + $ref: '#/components/schemas/NameValueStringPairModel' + nullable: true + title: "NameValueStringPairModel[]" + type: array title: UpdateMachineRequestModel type: object UpdateUpgradeScheduleRequestModel: @@ -318781,6 +346943,11 @@ components: VersionDetail: additionalProperties: false description: Detailed VDA version information. + example: + product: product + displayName: displayName + edition: edition + version: version properties: product: description: "XA or XD, no other values." @@ -318912,6 +347079,12 @@ components: additionalProperties: false description: The reason why a setting lost. Just the name of one of the winning policies that have this setting. + example: + SettingName: SettingName + WinningPolicy: + PolicySetGuid: PolicySetGuid + PolicyName: PolicyName + PolicyGuid: PolicyGuid properties: SettingName: description: Name of the setting. diff --git a/citrixorchestration/api_applications_apis.go b/citrixorchestration/api_applications_apis.go index 623d228..06f7087 100644 --- a/citrixorchestration/api_applications_apis.go +++ b/citrixorchestration/api_applications_apis.go @@ -3696,7 +3696,8 @@ HostedOnDesktop, AppV, or AppLibraryAppV, or Msix, or -AppAttach +AppAttach, or +FlexApp @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param nameOrId Name or ID of the application. If the application is present in an application folder, specify the name in this format: {application folder path plus application name}. For example, FolderName1|FolderName2|ApplicationName. @@ -3999,7 +4000,8 @@ HostedOnDesktop, AppV, or AppLibraryAppV, or Msix, or -AppAttach +AppAttach, or +FlexApp @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param nameOrId Name or ID of the application. If the application is present in an application folder, specify the name in this format: {application folder path plus application name}. For example, FolderName1|FolderName2|ApplicationName. diff --git a/citrixorchestration/api_gpo.go b/citrixorchestration/api_gpo.go new file mode 100644 index 0000000..271c108 --- /dev/null +++ b/citrixorchestration/api_gpo.go @@ -0,0 +1,10693 @@ +/* +Citrix Virtual Apps and Desktops Rest API for Developer Portal + +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + +API version: devportal-onprem-ga +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package citrixorchestration + +import ( + "bytes" + "context" + "io" + "net/http" + "net/url" + "strings" +) + + +// GpoDAASService GpoDAAS service +type GpoDAASService service + +type ApiGpoComparePoliciesRequest struct { + ctx context.Context + ApiService *GpoDAASService + citrixCustomerId *string + citrixInstanceId *string + withDefaults *bool + requestBody *[]string + userAgent *string + authorization *string + citrixTransactionId *string + accept *string + citrixLocale *string +} + +// Citrix Customer ID. Default is 'CitrixOnPremises' +func (r ApiGpoComparePoliciesRequest) CitrixCustomerId(citrixCustomerId string) ApiGpoComparePoliciesRequest { + r.citrixCustomerId = &citrixCustomerId + return r +} + +// Citrix Instance (Site) ID. +func (r ApiGpoComparePoliciesRequest) CitrixInstanceId(citrixInstanceId string) ApiGpoComparePoliciesRequest { + r.citrixInstanceId = &citrixInstanceId + return r +} + +// Include defaults in comparison +func (r ApiGpoComparePoliciesRequest) WithDefaults(withDefaults bool) ApiGpoComparePoliciesRequest { + r.withDefaults = &withDefaults + return r +} + +// GUIDs of policies +func (r ApiGpoComparePoliciesRequest) RequestBody(requestBody []string) ApiGpoComparePoliciesRequest { + r.requestBody = &requestBody + return r +} + +// User Agent type of the request. +func (r ApiGpoComparePoliciesRequest) UserAgent(userAgent string) ApiGpoComparePoliciesRequest { + r.userAgent = &userAgent + return r +} + +// Citrix authorization header: CWSAuth Bearer={token} +func (r ApiGpoComparePoliciesRequest) Authorization(authorization string) ApiGpoComparePoliciesRequest { + r.authorization = &authorization + return r +} + +// Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. +func (r ApiGpoComparePoliciesRequest) CitrixTransactionId(citrixTransactionId string) ApiGpoComparePoliciesRequest { + r.citrixTransactionId = &citrixTransactionId + return r +} + +// Must accept application/json. +func (r ApiGpoComparePoliciesRequest) Accept(accept string) ApiGpoComparePoliciesRequest { + r.accept = &accept + return r +} + +// Locale of the request. +func (r ApiGpoComparePoliciesRequest) CitrixLocale(citrixLocale string) ApiGpoComparePoliciesRequest { + r.citrixLocale = &citrixLocale + return r +} + +func (r ApiGpoComparePoliciesRequest) Execute() (*ComparisonResponseContract, *http.Response, error) { + return r.ApiService.GpoComparePoliciesExecute(r) +} + +/* +GpoComparePolicies Compare policies. The policies can be from different policy sets. + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @return ApiGpoComparePoliciesRequest +*/ +func (a *GpoDAASService) GpoComparePolicies(ctx context.Context) ApiGpoComparePoliciesRequest { + return ApiGpoComparePoliciesRequest{ + ApiService: a, + ctx: ctx, + } +} + +// Execute executes the request +// @return ComparisonResponseContract +func (a *GpoDAASService) GpoComparePoliciesExecute(r ApiGpoComparePoliciesRequest) (*ComparisonResponseContract, *http.Response, error) { + var ( + localVarHTTPMethod = http.MethodPost + localVarPostBody interface{} + formFiles []formFile + localVarReturnValue *ComparisonResponseContract + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GpoDAASService.GpoComparePolicies") + if err != nil { + return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/gpo/comparePolicies" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.citrixCustomerId == nil { + return localVarReturnValue, nil, reportError("citrixCustomerId is required and must be specified") + } + if r.citrixInstanceId == nil { + return localVarReturnValue, nil, reportError("citrixInstanceId is required and must be specified") + } + if r.withDefaults == nil { + return localVarReturnValue, nil, reportError("withDefaults is required and must be specified") + } + if r.requestBody == nil { + return localVarReturnValue, nil, reportError("requestBody is required and must be specified") + } + + parameterAddToHeaderOrQuery(localVarQueryParams, "withDefaults", r.withDefaults, "") + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-CustomerId", r.citrixCustomerId, "") + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-InstanceId", r.citrixInstanceId, "") + if r.userAgent != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "User-Agent", r.userAgent, "") + } + if r.authorization != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Authorization", r.authorization, "") + } + if r.citrixTransactionId != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-TransactionId", r.citrixTransactionId, "") + } + if r.accept != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Accept", r.accept, "") + } + if r.citrixLocale != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-Locale", r.citrixLocale, "") + } + // body params + localVarPostBody = r.requestBody + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["BearerAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 406 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 409 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 415 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 429 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 503 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiGpoCopyGpoPoliciesRequest struct { + ctx context.Context + ApiService *GpoDAASService + citrixCustomerId *string + citrixInstanceId *string + withFilters *bool + copyPoliciesRequest *CopyPoliciesRequest + userAgent *string + authorization *string + citrixTransactionId *string + accept *string + citrixLocale *string +} + +// Citrix Customer ID. Default is 'CitrixOnPremises' +func (r ApiGpoCopyGpoPoliciesRequest) CitrixCustomerId(citrixCustomerId string) ApiGpoCopyGpoPoliciesRequest { + r.citrixCustomerId = &citrixCustomerId + return r +} + +// Citrix Instance (Site) ID. +func (r ApiGpoCopyGpoPoliciesRequest) CitrixInstanceId(citrixInstanceId string) ApiGpoCopyGpoPoliciesRequest { + r.citrixInstanceId = &citrixInstanceId + return r +} + +// Specify if policy filters should be included +func (r ApiGpoCopyGpoPoliciesRequest) WithFilters(withFilters bool) ApiGpoCopyGpoPoliciesRequest { + r.withFilters = &withFilters + return r +} + +func (r ApiGpoCopyGpoPoliciesRequest) CopyPoliciesRequest(copyPoliciesRequest CopyPoliciesRequest) ApiGpoCopyGpoPoliciesRequest { + r.copyPoliciesRequest = ©PoliciesRequest + return r +} + +// User Agent type of the request. +func (r ApiGpoCopyGpoPoliciesRequest) UserAgent(userAgent string) ApiGpoCopyGpoPoliciesRequest { + r.userAgent = &userAgent + return r +} + +// Citrix authorization header: CWSAuth Bearer={token} +func (r ApiGpoCopyGpoPoliciesRequest) Authorization(authorization string) ApiGpoCopyGpoPoliciesRequest { + r.authorization = &authorization + return r +} + +// Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. +func (r ApiGpoCopyGpoPoliciesRequest) CitrixTransactionId(citrixTransactionId string) ApiGpoCopyGpoPoliciesRequest { + r.citrixTransactionId = &citrixTransactionId + return r +} + +// Must accept application/json. +func (r ApiGpoCopyGpoPoliciesRequest) Accept(accept string) ApiGpoCopyGpoPoliciesRequest { + r.accept = &accept + return r +} + +// Locale of the request. +func (r ApiGpoCopyGpoPoliciesRequest) CitrixLocale(citrixLocale string) ApiGpoCopyGpoPoliciesRequest { + r.citrixLocale = &citrixLocale + return r +} + +func (r ApiGpoCopyGpoPoliciesRequest) Execute() (*http.Response, error) { + return r.ApiService.GpoCopyGpoPoliciesExecute(r) +} + +/* +GpoCopyGpoPolicies Copy some policies of a policy set to other policy sets. + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @return ApiGpoCopyGpoPoliciesRequest +*/ +func (a *GpoDAASService) GpoCopyGpoPolicies(ctx context.Context) ApiGpoCopyGpoPoliciesRequest { + return ApiGpoCopyGpoPoliciesRequest{ + ApiService: a, + ctx: ctx, + } +} + +// Execute executes the request +func (a *GpoDAASService) GpoCopyGpoPoliciesExecute(r ApiGpoCopyGpoPoliciesRequest) (*http.Response, error) { + var ( + localVarHTTPMethod = http.MethodPost + localVarPostBody interface{} + formFiles []formFile + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GpoDAASService.GpoCopyGpoPolicies") + if err != nil { + return nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/gpo/policies/$copy" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.citrixCustomerId == nil { + return nil, reportError("citrixCustomerId is required and must be specified") + } + if r.citrixInstanceId == nil { + return nil, reportError("citrixInstanceId is required and must be specified") + } + if r.withFilters == nil { + return nil, reportError("withFilters is required and must be specified") + } + if r.copyPoliciesRequest == nil { + return nil, reportError("copyPoliciesRequest is required and must be specified") + } + + parameterAddToHeaderOrQuery(localVarQueryParams, "withFilters", r.withFilters, "") + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-CustomerId", r.citrixCustomerId, "") + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-InstanceId", r.citrixInstanceId, "") + if r.userAgent != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "User-Agent", r.userAgent, "") + } + if r.authorization != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Authorization", r.authorization, "") + } + if r.citrixTransactionId != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-TransactionId", r.citrixTransactionId, "") + } + if r.accept != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Accept", r.accept, "") + } + if r.citrixLocale != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-Locale", r.citrixLocale, "") + } + // body params + localVarPostBody = r.copyPoliciesRequest + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["BearerAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarHTTPResponse, err + } + + localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 406 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 409 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 415 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 429 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 503 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarHTTPResponse, newErr + } + + return localVarHTTPResponse, nil +} + +type ApiGpoCopyGpoPolicySetRequest struct { + ctx context.Context + ApiService *GpoDAASService + citrixCustomerId *string + citrixInstanceId *string + policySetGuid string + name *string + withFilters *bool + userAgent *string + authorization *string + citrixTransactionId *string + accept *string + citrixLocale *string +} + +// Citrix Customer ID. Default is 'CitrixOnPremises' +func (r ApiGpoCopyGpoPolicySetRequest) CitrixCustomerId(citrixCustomerId string) ApiGpoCopyGpoPolicySetRequest { + r.citrixCustomerId = &citrixCustomerId + return r +} + +// Citrix Instance (Site) ID. +func (r ApiGpoCopyGpoPolicySetRequest) CitrixInstanceId(citrixInstanceId string) ApiGpoCopyGpoPolicySetRequest { + r.citrixInstanceId = &citrixInstanceId + return r +} + +// The name of the new policy set +func (r ApiGpoCopyGpoPolicySetRequest) Name(name string) ApiGpoCopyGpoPolicySetRequest { + r.name = &name + return r +} + +// Indicate if filters in the policies should be copied +func (r ApiGpoCopyGpoPolicySetRequest) WithFilters(withFilters bool) ApiGpoCopyGpoPolicySetRequest { + r.withFilters = &withFilters + return r +} + +// User Agent type of the request. +func (r ApiGpoCopyGpoPolicySetRequest) UserAgent(userAgent string) ApiGpoCopyGpoPolicySetRequest { + r.userAgent = &userAgent + return r +} + +// Citrix authorization header: CWSAuth Bearer={token} +func (r ApiGpoCopyGpoPolicySetRequest) Authorization(authorization string) ApiGpoCopyGpoPolicySetRequest { + r.authorization = &authorization + return r +} + +// Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. +func (r ApiGpoCopyGpoPolicySetRequest) CitrixTransactionId(citrixTransactionId string) ApiGpoCopyGpoPolicySetRequest { + r.citrixTransactionId = &citrixTransactionId + return r +} + +// Must accept application/json. +func (r ApiGpoCopyGpoPolicySetRequest) Accept(accept string) ApiGpoCopyGpoPolicySetRequest { + r.accept = &accept + return r +} + +// Locale of the request. +func (r ApiGpoCopyGpoPolicySetRequest) CitrixLocale(citrixLocale string) ApiGpoCopyGpoPolicySetRequest { + r.citrixLocale = &citrixLocale + return r +} + +func (r ApiGpoCopyGpoPolicySetRequest) Execute() (*PolicySetResponse, *http.Response, error) { + return r.ApiService.GpoCopyGpoPolicySetExecute(r) +} + +/* +GpoCopyGpoPolicySet Create a new GPO policy set by copying an existing policy set. The policies and settings in each policy are copied to the new policy set. Optionally, the filters in the policies may be copied. Regardless of the type of the source policy set, the resulting policy set is always of type DeliveryGroupPolicies. + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param policySetGuid GUID of the existing policy set + @return ApiGpoCopyGpoPolicySetRequest +*/ +func (a *GpoDAASService) GpoCopyGpoPolicySet(ctx context.Context, policySetGuid string) ApiGpoCopyGpoPolicySetRequest { + return ApiGpoCopyGpoPolicySetRequest{ + ApiService: a, + ctx: ctx, + policySetGuid: policySetGuid, + } +} + +// Execute executes the request +// @return PolicySetResponse +func (a *GpoDAASService) GpoCopyGpoPolicySetExecute(r ApiGpoCopyGpoPolicySetRequest) (*PolicySetResponse, *http.Response, error) { + var ( + localVarHTTPMethod = http.MethodPost + localVarPostBody interface{} + formFiles []formFile + localVarReturnValue *PolicySetResponse + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GpoDAASService.GpoCopyGpoPolicySet") + if err != nil { + return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/gpo/policySets/{policySetGuid}" + localVarPath = strings.Replace(localVarPath, "{"+"policySetGuid"+"}", url.PathEscape(parameterValueToString(r.policySetGuid, "policySetGuid")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.citrixCustomerId == nil { + return localVarReturnValue, nil, reportError("citrixCustomerId is required and must be specified") + } + if r.citrixInstanceId == nil { + return localVarReturnValue, nil, reportError("citrixInstanceId is required and must be specified") + } + if r.name == nil { + return localVarReturnValue, nil, reportError("name is required and must be specified") + } + if r.withFilters == nil { + return localVarReturnValue, nil, reportError("withFilters is required and must be specified") + } + + parameterAddToHeaderOrQuery(localVarQueryParams, "name", r.name, "") + parameterAddToHeaderOrQuery(localVarQueryParams, "withFilters", r.withFilters, "") + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-CustomerId", r.citrixCustomerId, "") + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-InstanceId", r.citrixInstanceId, "") + if r.userAgent != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "User-Agent", r.userAgent, "") + } + if r.authorization != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Authorization", r.authorization, "") + } + if r.citrixTransactionId != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-TransactionId", r.citrixTransactionId, "") + } + if r.accept != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Accept", r.accept, "") + } + if r.citrixLocale != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-Locale", r.citrixLocale, "") + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["BearerAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 404 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 406 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 409 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 429 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 503 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiGpoCreateGpoFilterRequest struct { + ctx context.Context + ApiService *GpoDAASService + citrixCustomerId *string + citrixInstanceId *string + policyGuid *string + filterRequest *FilterRequest + userAgent *string + authorization *string + citrixTransactionId *string + accept *string + citrixLocale *string +} + +// Citrix Customer ID. Default is 'CitrixOnPremises' +func (r ApiGpoCreateGpoFilterRequest) CitrixCustomerId(citrixCustomerId string) ApiGpoCreateGpoFilterRequest { + r.citrixCustomerId = &citrixCustomerId + return r +} + +// Citrix Instance (Site) ID. +func (r ApiGpoCreateGpoFilterRequest) CitrixInstanceId(citrixInstanceId string) ApiGpoCreateGpoFilterRequest { + r.citrixInstanceId = &citrixInstanceId + return r +} + +// The GUID of the policy to which the new filter belongs +func (r ApiGpoCreateGpoFilterRequest) PolicyGuid(policyGuid string) ApiGpoCreateGpoFilterRequest { + r.policyGuid = &policyGuid + return r +} + +// Filter data +func (r ApiGpoCreateGpoFilterRequest) FilterRequest(filterRequest FilterRequest) ApiGpoCreateGpoFilterRequest { + r.filterRequest = &filterRequest + return r +} + +// User Agent type of the request. +func (r ApiGpoCreateGpoFilterRequest) UserAgent(userAgent string) ApiGpoCreateGpoFilterRequest { + r.userAgent = &userAgent + return r +} + +// Citrix authorization header: CWSAuth Bearer={token} +func (r ApiGpoCreateGpoFilterRequest) Authorization(authorization string) ApiGpoCreateGpoFilterRequest { + r.authorization = &authorization + return r +} + +// Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. +func (r ApiGpoCreateGpoFilterRequest) CitrixTransactionId(citrixTransactionId string) ApiGpoCreateGpoFilterRequest { + r.citrixTransactionId = &citrixTransactionId + return r +} + +// Must accept application/json. +func (r ApiGpoCreateGpoFilterRequest) Accept(accept string) ApiGpoCreateGpoFilterRequest { + r.accept = &accept + return r +} + +// Locale of the request. +func (r ApiGpoCreateGpoFilterRequest) CitrixLocale(citrixLocale string) ApiGpoCreateGpoFilterRequest { + r.citrixLocale = &citrixLocale + return r +} + +func (r ApiGpoCreateGpoFilterRequest) Execute() (*FilterResponse, *http.Response, error) { + return r.ApiService.GpoCreateGpoFilterExecute(r) +} + +/* +GpoCreateGpoFilter Create a filter in a policy. Filters cannot be created in a policy in a policy set of type SiteTemplates or CustomTemplates. + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @return ApiGpoCreateGpoFilterRequest +*/ +func (a *GpoDAASService) GpoCreateGpoFilter(ctx context.Context) ApiGpoCreateGpoFilterRequest { + return ApiGpoCreateGpoFilterRequest{ + ApiService: a, + ctx: ctx, + } +} + +// Execute executes the request +// @return FilterResponse +func (a *GpoDAASService) GpoCreateGpoFilterExecute(r ApiGpoCreateGpoFilterRequest) (*FilterResponse, *http.Response, error) { + var ( + localVarHTTPMethod = http.MethodPost + localVarPostBody interface{} + formFiles []formFile + localVarReturnValue *FilterResponse + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GpoDAASService.GpoCreateGpoFilter") + if err != nil { + return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/gpo/filters" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.citrixCustomerId == nil { + return localVarReturnValue, nil, reportError("citrixCustomerId is required and must be specified") + } + if r.citrixInstanceId == nil { + return localVarReturnValue, nil, reportError("citrixInstanceId is required and must be specified") + } + if r.policyGuid == nil { + return localVarReturnValue, nil, reportError("policyGuid is required and must be specified") + } + if r.filterRequest == nil { + return localVarReturnValue, nil, reportError("filterRequest is required and must be specified") + } + + parameterAddToHeaderOrQuery(localVarQueryParams, "policyGuid", r.policyGuid, "") + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-CustomerId", r.citrixCustomerId, "") + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-InstanceId", r.citrixInstanceId, "") + if r.userAgent != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "User-Agent", r.userAgent, "") + } + if r.authorization != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Authorization", r.authorization, "") + } + if r.citrixTransactionId != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-TransactionId", r.citrixTransactionId, "") + } + if r.accept != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Accept", r.accept, "") + } + if r.citrixLocale != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-Locale", r.citrixLocale, "") + } + // body params + localVarPostBody = r.filterRequest + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["BearerAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 406 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 409 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 415 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 429 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 503 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiGpoCreateGpoPolicyRequest struct { + ctx context.Context + ApiService *GpoDAASService + citrixCustomerId *string + citrixInstanceId *string + policySetGuid *string + policyRequest *PolicyRequest + userAgent *string + authorization *string + citrixTransactionId *string + accept *string + citrixLocale *string +} + +// Citrix Customer ID. Default is 'CitrixOnPremises' +func (r ApiGpoCreateGpoPolicyRequest) CitrixCustomerId(citrixCustomerId string) ApiGpoCreateGpoPolicyRequest { + r.citrixCustomerId = &citrixCustomerId + return r +} + +// Citrix Instance (Site) ID. +func (r ApiGpoCreateGpoPolicyRequest) CitrixInstanceId(citrixInstanceId string) ApiGpoCreateGpoPolicyRequest { + r.citrixInstanceId = &citrixInstanceId + return r +} + +// GUID of the policy set in which the new policy is created +func (r ApiGpoCreateGpoPolicyRequest) PolicySetGuid(policySetGuid string) ApiGpoCreateGpoPolicyRequest { + r.policySetGuid = &policySetGuid + return r +} + +// Data for the new policy +func (r ApiGpoCreateGpoPolicyRequest) PolicyRequest(policyRequest PolicyRequest) ApiGpoCreateGpoPolicyRequest { + r.policyRequest = &policyRequest + return r +} + +// User Agent type of the request. +func (r ApiGpoCreateGpoPolicyRequest) UserAgent(userAgent string) ApiGpoCreateGpoPolicyRequest { + r.userAgent = &userAgent + return r +} + +// Citrix authorization header: CWSAuth Bearer={token} +func (r ApiGpoCreateGpoPolicyRequest) Authorization(authorization string) ApiGpoCreateGpoPolicyRequest { + r.authorization = &authorization + return r +} + +// Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. +func (r ApiGpoCreateGpoPolicyRequest) CitrixTransactionId(citrixTransactionId string) ApiGpoCreateGpoPolicyRequest { + r.citrixTransactionId = &citrixTransactionId + return r +} + +// Must accept application/json. +func (r ApiGpoCreateGpoPolicyRequest) Accept(accept string) ApiGpoCreateGpoPolicyRequest { + r.accept = &accept + return r +} + +// Locale of the request. +func (r ApiGpoCreateGpoPolicyRequest) CitrixLocale(citrixLocale string) ApiGpoCreateGpoPolicyRequest { + r.citrixLocale = &citrixLocale + return r +} + +func (r ApiGpoCreateGpoPolicyRequest) Execute() (*PolicyResponse, *http.Response, error) { + return r.ApiService.GpoCreateGpoPolicyExecute(r) +} + +/* +GpoCreateGpoPolicy Create a new policy. Policies cannot be created in the policy set of type SiteTemplates. + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @return ApiGpoCreateGpoPolicyRequest +*/ +func (a *GpoDAASService) GpoCreateGpoPolicy(ctx context.Context) ApiGpoCreateGpoPolicyRequest { + return ApiGpoCreateGpoPolicyRequest{ + ApiService: a, + ctx: ctx, + } +} + +// Execute executes the request +// @return PolicyResponse +func (a *GpoDAASService) GpoCreateGpoPolicyExecute(r ApiGpoCreateGpoPolicyRequest) (*PolicyResponse, *http.Response, error) { + var ( + localVarHTTPMethod = http.MethodPost + localVarPostBody interface{} + formFiles []formFile + localVarReturnValue *PolicyResponse + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GpoDAASService.GpoCreateGpoPolicy") + if err != nil { + return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/gpo/policies" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.citrixCustomerId == nil { + return localVarReturnValue, nil, reportError("citrixCustomerId is required and must be specified") + } + if r.citrixInstanceId == nil { + return localVarReturnValue, nil, reportError("citrixInstanceId is required and must be specified") + } + if r.policySetGuid == nil { + return localVarReturnValue, nil, reportError("policySetGuid is required and must be specified") + } + if r.policyRequest == nil { + return localVarReturnValue, nil, reportError("policyRequest is required and must be specified") + } + + parameterAddToHeaderOrQuery(localVarQueryParams, "policySetGuid", r.policySetGuid, "") + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-CustomerId", r.citrixCustomerId, "") + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-InstanceId", r.citrixInstanceId, "") + if r.userAgent != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "User-Agent", r.userAgent, "") + } + if r.authorization != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Authorization", r.authorization, "") + } + if r.citrixTransactionId != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-TransactionId", r.citrixTransactionId, "") + } + if r.accept != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Accept", r.accept, "") + } + if r.citrixLocale != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-Locale", r.citrixLocale, "") + } + // body params + localVarPostBody = r.policyRequest + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["BearerAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 406 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 409 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 415 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 429 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 503 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiGpoCreateGpoPolicySetRequest struct { + ctx context.Context + ApiService *GpoDAASService + citrixCustomerId *string + citrixInstanceId *string + policySetRequest *PolicySetRequest + userAgent *string + authorization *string + citrixTransactionId *string + accept *string + citrixLocale *string +} + +// Citrix Customer ID. Default is 'CitrixOnPremises' +func (r ApiGpoCreateGpoPolicySetRequest) CitrixCustomerId(citrixCustomerId string) ApiGpoCreateGpoPolicySetRequest { + r.citrixCustomerId = &citrixCustomerId + return r +} + +// Citrix Instance (Site) ID. +func (r ApiGpoCreateGpoPolicySetRequest) CitrixInstanceId(citrixInstanceId string) ApiGpoCreateGpoPolicySetRequest { + r.citrixInstanceId = &citrixInstanceId + return r +} + +// Parameters for the new policy set +func (r ApiGpoCreateGpoPolicySetRequest) PolicySetRequest(policySetRequest PolicySetRequest) ApiGpoCreateGpoPolicySetRequest { + r.policySetRequest = &policySetRequest + return r +} + +// User Agent type of the request. +func (r ApiGpoCreateGpoPolicySetRequest) UserAgent(userAgent string) ApiGpoCreateGpoPolicySetRequest { + r.userAgent = &userAgent + return r +} + +// Citrix authorization header: CWSAuth Bearer={token} +func (r ApiGpoCreateGpoPolicySetRequest) Authorization(authorization string) ApiGpoCreateGpoPolicySetRequest { + r.authorization = &authorization + return r +} + +// Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. +func (r ApiGpoCreateGpoPolicySetRequest) CitrixTransactionId(citrixTransactionId string) ApiGpoCreateGpoPolicySetRequest { + r.citrixTransactionId = &citrixTransactionId + return r +} + +// Must accept application/json. +func (r ApiGpoCreateGpoPolicySetRequest) Accept(accept string) ApiGpoCreateGpoPolicySetRequest { + r.accept = &accept + return r +} + +// Locale of the request. +func (r ApiGpoCreateGpoPolicySetRequest) CitrixLocale(citrixLocale string) ApiGpoCreateGpoPolicySetRequest { + r.citrixLocale = &citrixLocale + return r +} + +func (r ApiGpoCreateGpoPolicySetRequest) Execute() (*PolicySetResponse, *http.Response, error) { + return r.ApiService.GpoCreateGpoPolicySetExecute(r) +} + +/* +GpoCreateGpoPolicySet Create a new GPO policy set. Only a policy set of type DeliveryGroupPolicies can be created. + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @return ApiGpoCreateGpoPolicySetRequest +*/ +func (a *GpoDAASService) GpoCreateGpoPolicySet(ctx context.Context) ApiGpoCreateGpoPolicySetRequest { + return ApiGpoCreateGpoPolicySetRequest{ + ApiService: a, + ctx: ctx, + } +} + +// Execute executes the request +// @return PolicySetResponse +func (a *GpoDAASService) GpoCreateGpoPolicySetExecute(r ApiGpoCreateGpoPolicySetRequest) (*PolicySetResponse, *http.Response, error) { + var ( + localVarHTTPMethod = http.MethodPost + localVarPostBody interface{} + formFiles []formFile + localVarReturnValue *PolicySetResponse + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GpoDAASService.GpoCreateGpoPolicySet") + if err != nil { + return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/gpo/policySets" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.citrixCustomerId == nil { + return localVarReturnValue, nil, reportError("citrixCustomerId is required and must be specified") + } + if r.citrixInstanceId == nil { + return localVarReturnValue, nil, reportError("citrixInstanceId is required and must be specified") + } + if r.policySetRequest == nil { + return localVarReturnValue, nil, reportError("policySetRequest is required and must be specified") + } + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-CustomerId", r.citrixCustomerId, "") + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-InstanceId", r.citrixInstanceId, "") + if r.userAgent != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "User-Agent", r.userAgent, "") + } + if r.authorization != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Authorization", r.authorization, "") + } + if r.citrixTransactionId != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-TransactionId", r.citrixTransactionId, "") + } + if r.accept != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Accept", r.accept, "") + } + if r.citrixLocale != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-Locale", r.citrixLocale, "") + } + // body params + localVarPostBody = r.policySetRequest + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["BearerAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 406 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 409 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 415 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 429 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 503 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiGpoCreateGpoSettingRequest struct { + ctx context.Context + ApiService *GpoDAASService + citrixCustomerId *string + citrixInstanceId *string + policyGuid *string + settingRequest *SettingRequest + userAgent *string + authorization *string + citrixTransactionId *string + accept *string + citrixLocale *string +} + +// Citrix Customer ID. Default is 'CitrixOnPremises' +func (r ApiGpoCreateGpoSettingRequest) CitrixCustomerId(citrixCustomerId string) ApiGpoCreateGpoSettingRequest { + r.citrixCustomerId = &citrixCustomerId + return r +} + +// Citrix Instance (Site) ID. +func (r ApiGpoCreateGpoSettingRequest) CitrixInstanceId(citrixInstanceId string) ApiGpoCreateGpoSettingRequest { + r.citrixInstanceId = &citrixInstanceId + return r +} + +// GUID of the policy to which the setting belongs +func (r ApiGpoCreateGpoSettingRequest) PolicyGuid(policyGuid string) ApiGpoCreateGpoSettingRequest { + r.policyGuid = &policyGuid + return r +} + +// Data for the new setting +func (r ApiGpoCreateGpoSettingRequest) SettingRequest(settingRequest SettingRequest) ApiGpoCreateGpoSettingRequest { + r.settingRequest = &settingRequest + return r +} + +// User Agent type of the request. +func (r ApiGpoCreateGpoSettingRequest) UserAgent(userAgent string) ApiGpoCreateGpoSettingRequest { + r.userAgent = &userAgent + return r +} + +// Citrix authorization header: CWSAuth Bearer={token} +func (r ApiGpoCreateGpoSettingRequest) Authorization(authorization string) ApiGpoCreateGpoSettingRequest { + r.authorization = &authorization + return r +} + +// Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. +func (r ApiGpoCreateGpoSettingRequest) CitrixTransactionId(citrixTransactionId string) ApiGpoCreateGpoSettingRequest { + r.citrixTransactionId = &citrixTransactionId + return r +} + +// Must accept application/json. +func (r ApiGpoCreateGpoSettingRequest) Accept(accept string) ApiGpoCreateGpoSettingRequest { + r.accept = &accept + return r +} + +// Locale of the request. +func (r ApiGpoCreateGpoSettingRequest) CitrixLocale(citrixLocale string) ApiGpoCreateGpoSettingRequest { + r.citrixLocale = &citrixLocale + return r +} + +func (r ApiGpoCreateGpoSettingRequest) Execute() (*SettingResponse, *http.Response, error) { + return r.ApiService.GpoCreateGpoSettingExecute(r) +} + +/* +GpoCreateGpoSetting Create a setting in a policy. Settings cannot be created in the policy set of type SiteTemplates. + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @return ApiGpoCreateGpoSettingRequest +*/ +func (a *GpoDAASService) GpoCreateGpoSetting(ctx context.Context) ApiGpoCreateGpoSettingRequest { + return ApiGpoCreateGpoSettingRequest{ + ApiService: a, + ctx: ctx, + } +} + +// Execute executes the request +// @return SettingResponse +func (a *GpoDAASService) GpoCreateGpoSettingExecute(r ApiGpoCreateGpoSettingRequest) (*SettingResponse, *http.Response, error) { + var ( + localVarHTTPMethod = http.MethodPost + localVarPostBody interface{} + formFiles []formFile + localVarReturnValue *SettingResponse + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GpoDAASService.GpoCreateGpoSetting") + if err != nil { + return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/gpo/settings" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.citrixCustomerId == nil { + return localVarReturnValue, nil, reportError("citrixCustomerId is required and must be specified") + } + if r.citrixInstanceId == nil { + return localVarReturnValue, nil, reportError("citrixInstanceId is required and must be specified") + } + if r.policyGuid == nil { + return localVarReturnValue, nil, reportError("policyGuid is required and must be specified") + } + if r.settingRequest == nil { + return localVarReturnValue, nil, reportError("settingRequest is required and must be specified") + } + + parameterAddToHeaderOrQuery(localVarQueryParams, "policyGuid", r.policyGuid, "") + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-CustomerId", r.citrixCustomerId, "") + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-InstanceId", r.citrixInstanceId, "") + if r.userAgent != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "User-Agent", r.userAgent, "") + } + if r.authorization != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Authorization", r.authorization, "") + } + if r.citrixTransactionId != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-TransactionId", r.citrixTransactionId, "") + } + if r.accept != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Accept", r.accept, "") + } + if r.citrixLocale != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-Locale", r.citrixLocale, "") + } + // body params + localVarPostBody = r.settingRequest + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["BearerAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 406 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 409 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 415 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 429 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 503 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiGpoDeleteGpoFilterRequest struct { + ctx context.Context + ApiService *GpoDAASService + citrixCustomerId *string + citrixInstanceId *string + filterGuid string + userAgent *string + authorization *string + citrixTransactionId *string + accept *string + citrixLocale *string +} + +// Citrix Customer ID. Default is 'CitrixOnPremises' +func (r ApiGpoDeleteGpoFilterRequest) CitrixCustomerId(citrixCustomerId string) ApiGpoDeleteGpoFilterRequest { + r.citrixCustomerId = &citrixCustomerId + return r +} + +// Citrix Instance (Site) ID. +func (r ApiGpoDeleteGpoFilterRequest) CitrixInstanceId(citrixInstanceId string) ApiGpoDeleteGpoFilterRequest { + r.citrixInstanceId = &citrixInstanceId + return r +} + +// User Agent type of the request. +func (r ApiGpoDeleteGpoFilterRequest) UserAgent(userAgent string) ApiGpoDeleteGpoFilterRequest { + r.userAgent = &userAgent + return r +} + +// Citrix authorization header: CWSAuth Bearer={token} +func (r ApiGpoDeleteGpoFilterRequest) Authorization(authorization string) ApiGpoDeleteGpoFilterRequest { + r.authorization = &authorization + return r +} + +// Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. +func (r ApiGpoDeleteGpoFilterRequest) CitrixTransactionId(citrixTransactionId string) ApiGpoDeleteGpoFilterRequest { + r.citrixTransactionId = &citrixTransactionId + return r +} + +// Must accept application/json. +func (r ApiGpoDeleteGpoFilterRequest) Accept(accept string) ApiGpoDeleteGpoFilterRequest { + r.accept = &accept + return r +} + +// Locale of the request. +func (r ApiGpoDeleteGpoFilterRequest) CitrixLocale(citrixLocale string) ApiGpoDeleteGpoFilterRequest { + r.citrixLocale = &citrixLocale + return r +} + +func (r ApiGpoDeleteGpoFilterRequest) Execute() (*http.Response, error) { + return r.ApiService.GpoDeleteGpoFilterExecute(r) +} + +/* +GpoDeleteGpoFilter Delete an existing filter. + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param filterGuid The GUID of the filter to be deleted + @return ApiGpoDeleteGpoFilterRequest +*/ +func (a *GpoDAASService) GpoDeleteGpoFilter(ctx context.Context, filterGuid string) ApiGpoDeleteGpoFilterRequest { + return ApiGpoDeleteGpoFilterRequest{ + ApiService: a, + ctx: ctx, + filterGuid: filterGuid, + } +} + +// Execute executes the request +func (a *GpoDAASService) GpoDeleteGpoFilterExecute(r ApiGpoDeleteGpoFilterRequest) (*http.Response, error) { + var ( + localVarHTTPMethod = http.MethodDelete + localVarPostBody interface{} + formFiles []formFile + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GpoDAASService.GpoDeleteGpoFilter") + if err != nil { + return nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/gpo/filters/{filterGuid}" + localVarPath = strings.Replace(localVarPath, "{"+"filterGuid"+"}", url.PathEscape(parameterValueToString(r.filterGuid, "filterGuid")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.citrixCustomerId == nil { + return nil, reportError("citrixCustomerId is required and must be specified") + } + if r.citrixInstanceId == nil { + return nil, reportError("citrixInstanceId is required and must be specified") + } + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-CustomerId", r.citrixCustomerId, "") + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-InstanceId", r.citrixInstanceId, "") + if r.userAgent != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "User-Agent", r.userAgent, "") + } + if r.authorization != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Authorization", r.authorization, "") + } + if r.citrixTransactionId != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-TransactionId", r.citrixTransactionId, "") + } + if r.accept != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Accept", r.accept, "") + } + if r.citrixLocale != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-Locale", r.citrixLocale, "") + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["BearerAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarHTTPResponse, err + } + + localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 406 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 409 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 429 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 503 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarHTTPResponse, newErr + } + + return localVarHTTPResponse, nil +} + +type ApiGpoDeleteGpoPolicyRequest struct { + ctx context.Context + ApiService *GpoDAASService + citrixCustomerId *string + citrixInstanceId *string + policyGuid string + userAgent *string + authorization *string + citrixTransactionId *string + accept *string + citrixLocale *string +} + +// Citrix Customer ID. Default is 'CitrixOnPremises' +func (r ApiGpoDeleteGpoPolicyRequest) CitrixCustomerId(citrixCustomerId string) ApiGpoDeleteGpoPolicyRequest { + r.citrixCustomerId = &citrixCustomerId + return r +} + +// Citrix Instance (Site) ID. +func (r ApiGpoDeleteGpoPolicyRequest) CitrixInstanceId(citrixInstanceId string) ApiGpoDeleteGpoPolicyRequest { + r.citrixInstanceId = &citrixInstanceId + return r +} + +// User Agent type of the request. +func (r ApiGpoDeleteGpoPolicyRequest) UserAgent(userAgent string) ApiGpoDeleteGpoPolicyRequest { + r.userAgent = &userAgent + return r +} + +// Citrix authorization header: CWSAuth Bearer={token} +func (r ApiGpoDeleteGpoPolicyRequest) Authorization(authorization string) ApiGpoDeleteGpoPolicyRequest { + r.authorization = &authorization + return r +} + +// Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. +func (r ApiGpoDeleteGpoPolicyRequest) CitrixTransactionId(citrixTransactionId string) ApiGpoDeleteGpoPolicyRequest { + r.citrixTransactionId = &citrixTransactionId + return r +} + +// Must accept application/json. +func (r ApiGpoDeleteGpoPolicyRequest) Accept(accept string) ApiGpoDeleteGpoPolicyRequest { + r.accept = &accept + return r +} + +// Locale of the request. +func (r ApiGpoDeleteGpoPolicyRequest) CitrixLocale(citrixLocale string) ApiGpoDeleteGpoPolicyRequest { + r.citrixLocale = &citrixLocale + return r +} + +func (r ApiGpoDeleteGpoPolicyRequest) Execute() (*http.Response, error) { + return r.ApiService.GpoDeleteGpoPolicyExecute(r) +} + +/* +GpoDeleteGpoPolicy Delete an existing GPO policy. A policy in the policy set of type SiteTemplates cannot be deleted. The Unfiltered policy in the policy set of type SitePolicies cannot be deleted. + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param policyGuid GUID of the policy to be deleted + @return ApiGpoDeleteGpoPolicyRequest +*/ +func (a *GpoDAASService) GpoDeleteGpoPolicy(ctx context.Context, policyGuid string) ApiGpoDeleteGpoPolicyRequest { + return ApiGpoDeleteGpoPolicyRequest{ + ApiService: a, + ctx: ctx, + policyGuid: policyGuid, + } +} + +// Execute executes the request +func (a *GpoDAASService) GpoDeleteGpoPolicyExecute(r ApiGpoDeleteGpoPolicyRequest) (*http.Response, error) { + var ( + localVarHTTPMethod = http.MethodDelete + localVarPostBody interface{} + formFiles []formFile + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GpoDAASService.GpoDeleteGpoPolicy") + if err != nil { + return nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/gpo/policies/{policyGuid}" + localVarPath = strings.Replace(localVarPath, "{"+"policyGuid"+"}", url.PathEscape(parameterValueToString(r.policyGuid, "policyGuid")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.citrixCustomerId == nil { + return nil, reportError("citrixCustomerId is required and must be specified") + } + if r.citrixInstanceId == nil { + return nil, reportError("citrixInstanceId is required and must be specified") + } + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-CustomerId", r.citrixCustomerId, "") + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-InstanceId", r.citrixInstanceId, "") + if r.userAgent != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "User-Agent", r.userAgent, "") + } + if r.authorization != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Authorization", r.authorization, "") + } + if r.citrixTransactionId != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-TransactionId", r.citrixTransactionId, "") + } + if r.accept != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Accept", r.accept, "") + } + if r.citrixLocale != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-Locale", r.citrixLocale, "") + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["BearerAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarHTTPResponse, err + } + + localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 406 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 409 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 429 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 503 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarHTTPResponse, newErr + } + + return localVarHTTPResponse, nil +} + +type ApiGpoDeleteGpoPolicySetRequest struct { + ctx context.Context + ApiService *GpoDAASService + citrixCustomerId *string + citrixInstanceId *string + policySetGuid string + userAgent *string + authorization *string + citrixTransactionId *string + accept *string + citrixLocale *string +} + +// Citrix Customer ID. Default is 'CitrixOnPremises' +func (r ApiGpoDeleteGpoPolicySetRequest) CitrixCustomerId(citrixCustomerId string) ApiGpoDeleteGpoPolicySetRequest { + r.citrixCustomerId = &citrixCustomerId + return r +} + +// Citrix Instance (Site) ID. +func (r ApiGpoDeleteGpoPolicySetRequest) CitrixInstanceId(citrixInstanceId string) ApiGpoDeleteGpoPolicySetRequest { + r.citrixInstanceId = &citrixInstanceId + return r +} + +// User Agent type of the request. +func (r ApiGpoDeleteGpoPolicySetRequest) UserAgent(userAgent string) ApiGpoDeleteGpoPolicySetRequest { + r.userAgent = &userAgent + return r +} + +// Citrix authorization header: CWSAuth Bearer={token} +func (r ApiGpoDeleteGpoPolicySetRequest) Authorization(authorization string) ApiGpoDeleteGpoPolicySetRequest { + r.authorization = &authorization + return r +} + +// Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. +func (r ApiGpoDeleteGpoPolicySetRequest) CitrixTransactionId(citrixTransactionId string) ApiGpoDeleteGpoPolicySetRequest { + r.citrixTransactionId = &citrixTransactionId + return r +} + +// Must accept application/json. +func (r ApiGpoDeleteGpoPolicySetRequest) Accept(accept string) ApiGpoDeleteGpoPolicySetRequest { + r.accept = &accept + return r +} + +// Locale of the request. +func (r ApiGpoDeleteGpoPolicySetRequest) CitrixLocale(citrixLocale string) ApiGpoDeleteGpoPolicySetRequest { + r.citrixLocale = &citrixLocale + return r +} + +func (r ApiGpoDeleteGpoPolicySetRequest) Execute() (*http.Response, error) { + return r.ApiService.GpoDeleteGpoPolicySetExecute(r) +} + +/* +GpoDeleteGpoPolicySet Delete an existing GPO policy set. Only policy sets of type DeliveryGroupPolicies can be deleted. Policies in the policy set are deleted if a policy set is deleted. + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param policySetGuid The GUID of the policy set to be deleted + @return ApiGpoDeleteGpoPolicySetRequest +*/ +func (a *GpoDAASService) GpoDeleteGpoPolicySet(ctx context.Context, policySetGuid string) ApiGpoDeleteGpoPolicySetRequest { + return ApiGpoDeleteGpoPolicySetRequest{ + ApiService: a, + ctx: ctx, + policySetGuid: policySetGuid, + } +} + +// Execute executes the request +func (a *GpoDAASService) GpoDeleteGpoPolicySetExecute(r ApiGpoDeleteGpoPolicySetRequest) (*http.Response, error) { + var ( + localVarHTTPMethod = http.MethodDelete + localVarPostBody interface{} + formFiles []formFile + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GpoDAASService.GpoDeleteGpoPolicySet") + if err != nil { + return nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/gpo/policySets/{policySetGuid}" + localVarPath = strings.Replace(localVarPath, "{"+"policySetGuid"+"}", url.PathEscape(parameterValueToString(r.policySetGuid, "policySetGuid")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.citrixCustomerId == nil { + return nil, reportError("citrixCustomerId is required and must be specified") + } + if r.citrixInstanceId == nil { + return nil, reportError("citrixInstanceId is required and must be specified") + } + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-CustomerId", r.citrixCustomerId, "") + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-InstanceId", r.citrixInstanceId, "") + if r.userAgent != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "User-Agent", r.userAgent, "") + } + if r.authorization != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Authorization", r.authorization, "") + } + if r.citrixTransactionId != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-TransactionId", r.citrixTransactionId, "") + } + if r.accept != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Accept", r.accept, "") + } + if r.citrixLocale != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-Locale", r.citrixLocale, "") + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["BearerAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarHTTPResponse, err + } + + localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 406 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 409 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 429 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 503 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarHTTPResponse, newErr + } + + return localVarHTTPResponse, nil +} + +type ApiGpoDeleteGpoSettingRequest struct { + ctx context.Context + ApiService *GpoDAASService + citrixCustomerId *string + citrixInstanceId *string + settingGuid string + userAgent *string + authorization *string + citrixTransactionId *string + accept *string + citrixLocale *string +} + +// Citrix Customer ID. Default is 'CitrixOnPremises' +func (r ApiGpoDeleteGpoSettingRequest) CitrixCustomerId(citrixCustomerId string) ApiGpoDeleteGpoSettingRequest { + r.citrixCustomerId = &citrixCustomerId + return r +} + +// Citrix Instance (Site) ID. +func (r ApiGpoDeleteGpoSettingRequest) CitrixInstanceId(citrixInstanceId string) ApiGpoDeleteGpoSettingRequest { + r.citrixInstanceId = &citrixInstanceId + return r +} + +// User Agent type of the request. +func (r ApiGpoDeleteGpoSettingRequest) UserAgent(userAgent string) ApiGpoDeleteGpoSettingRequest { + r.userAgent = &userAgent + return r +} + +// Citrix authorization header: CWSAuth Bearer={token} +func (r ApiGpoDeleteGpoSettingRequest) Authorization(authorization string) ApiGpoDeleteGpoSettingRequest { + r.authorization = &authorization + return r +} + +// Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. +func (r ApiGpoDeleteGpoSettingRequest) CitrixTransactionId(citrixTransactionId string) ApiGpoDeleteGpoSettingRequest { + r.citrixTransactionId = &citrixTransactionId + return r +} + +// Must accept application/json. +func (r ApiGpoDeleteGpoSettingRequest) Accept(accept string) ApiGpoDeleteGpoSettingRequest { + r.accept = &accept + return r +} + +// Locale of the request. +func (r ApiGpoDeleteGpoSettingRequest) CitrixLocale(citrixLocale string) ApiGpoDeleteGpoSettingRequest { + r.citrixLocale = &citrixLocale + return r +} + +func (r ApiGpoDeleteGpoSettingRequest) Execute() (*http.Response, error) { + return r.ApiService.GpoDeleteGpoSettingExecute(r) +} + +/* +GpoDeleteGpoSetting Delete a setting. Settings in the policy set of type SiteTemplates cannot be deleted. + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param settingGuid GUID of the setting to be deleted + @return ApiGpoDeleteGpoSettingRequest +*/ +func (a *GpoDAASService) GpoDeleteGpoSetting(ctx context.Context, settingGuid string) ApiGpoDeleteGpoSettingRequest { + return ApiGpoDeleteGpoSettingRequest{ + ApiService: a, + ctx: ctx, + settingGuid: settingGuid, + } +} + +// Execute executes the request +func (a *GpoDAASService) GpoDeleteGpoSettingExecute(r ApiGpoDeleteGpoSettingRequest) (*http.Response, error) { + var ( + localVarHTTPMethod = http.MethodDelete + localVarPostBody interface{} + formFiles []formFile + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GpoDAASService.GpoDeleteGpoSetting") + if err != nil { + return nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/gpo/settings/{settingGuid}" + localVarPath = strings.Replace(localVarPath, "{"+"settingGuid"+"}", url.PathEscape(parameterValueToString(r.settingGuid, "settingGuid")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.citrixCustomerId == nil { + return nil, reportError("citrixCustomerId is required and must be specified") + } + if r.citrixInstanceId == nil { + return nil, reportError("citrixInstanceId is required and must be specified") + } + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-CustomerId", r.citrixCustomerId, "") + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-InstanceId", r.citrixInstanceId, "") + if r.userAgent != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "User-Agent", r.userAgent, "") + } + if r.authorization != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Authorization", r.authorization, "") + } + if r.citrixTransactionId != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-TransactionId", r.citrixTransactionId, "") + } + if r.accept != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Accept", r.accept, "") + } + if r.citrixLocale != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-Locale", r.citrixLocale, "") + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["BearerAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarHTTPResponse, err + } + + localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 406 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 409 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 429 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 503 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarHTTPResponse, newErr + } + + return localVarHTTPResponse, nil +} + +type ApiGpoDisableGpoPoliciesRequest struct { + ctx context.Context + ApiService *GpoDAASService + citrixCustomerId *string + citrixInstanceId *string + requestBody *[]string + userAgent *string + authorization *string + citrixTransactionId *string + accept *string + citrixLocale *string +} + +// Citrix Customer ID. Default is 'CitrixOnPremises' +func (r ApiGpoDisableGpoPoliciesRequest) CitrixCustomerId(citrixCustomerId string) ApiGpoDisableGpoPoliciesRequest { + r.citrixCustomerId = &citrixCustomerId + return r +} + +// Citrix Instance (Site) ID. +func (r ApiGpoDisableGpoPoliciesRequest) CitrixInstanceId(citrixInstanceId string) ApiGpoDisableGpoPoliciesRequest { + r.citrixInstanceId = &citrixInstanceId + return r +} + +// GUIDs of the policies to be disabled +func (r ApiGpoDisableGpoPoliciesRequest) RequestBody(requestBody []string) ApiGpoDisableGpoPoliciesRequest { + r.requestBody = &requestBody + return r +} + +// User Agent type of the request. +func (r ApiGpoDisableGpoPoliciesRequest) UserAgent(userAgent string) ApiGpoDisableGpoPoliciesRequest { + r.userAgent = &userAgent + return r +} + +// Citrix authorization header: CWSAuth Bearer={token} +func (r ApiGpoDisableGpoPoliciesRequest) Authorization(authorization string) ApiGpoDisableGpoPoliciesRequest { + r.authorization = &authorization + return r +} + +// Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. +func (r ApiGpoDisableGpoPoliciesRequest) CitrixTransactionId(citrixTransactionId string) ApiGpoDisableGpoPoliciesRequest { + r.citrixTransactionId = &citrixTransactionId + return r +} + +// Must accept application/json. +func (r ApiGpoDisableGpoPoliciesRequest) Accept(accept string) ApiGpoDisableGpoPoliciesRequest { + r.accept = &accept + return r +} + +// Locale of the request. +func (r ApiGpoDisableGpoPoliciesRequest) CitrixLocale(citrixLocale string) ApiGpoDisableGpoPoliciesRequest { + r.citrixLocale = &citrixLocale + return r +} + +func (r ApiGpoDisableGpoPoliciesRequest) Execute() (*http.Response, error) { + return r.ApiService.GpoDisableGpoPoliciesExecute(r) +} + +/* +GpoDisableGpoPolicies Disable some policies of a policy set. + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @return ApiGpoDisableGpoPoliciesRequest +*/ +func (a *GpoDAASService) GpoDisableGpoPolicies(ctx context.Context) ApiGpoDisableGpoPoliciesRequest { + return ApiGpoDisableGpoPoliciesRequest{ + ApiService: a, + ctx: ctx, + } +} + +// Execute executes the request +func (a *GpoDAASService) GpoDisableGpoPoliciesExecute(r ApiGpoDisableGpoPoliciesRequest) (*http.Response, error) { + var ( + localVarHTTPMethod = http.MethodPost + localVarPostBody interface{} + formFiles []formFile + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GpoDAASService.GpoDisableGpoPolicies") + if err != nil { + return nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/gpo/policies/$disable" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.citrixCustomerId == nil { + return nil, reportError("citrixCustomerId is required and must be specified") + } + if r.citrixInstanceId == nil { + return nil, reportError("citrixInstanceId is required and must be specified") + } + if r.requestBody == nil { + return nil, reportError("requestBody is required and must be specified") + } + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-CustomerId", r.citrixCustomerId, "") + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-InstanceId", r.citrixInstanceId, "") + if r.userAgent != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "User-Agent", r.userAgent, "") + } + if r.authorization != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Authorization", r.authorization, "") + } + if r.citrixTransactionId != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-TransactionId", r.citrixTransactionId, "") + } + if r.accept != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Accept", r.accept, "") + } + if r.citrixLocale != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-Locale", r.citrixLocale, "") + } + // body params + localVarPostBody = r.requestBody + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["BearerAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarHTTPResponse, err + } + + localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 406 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 409 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 415 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 429 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 503 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarHTTPResponse, newErr + } + + return localVarHTTPResponse, nil +} + +type ApiGpoEnableGpoPoliciesRequest struct { + ctx context.Context + ApiService *GpoDAASService + citrixCustomerId *string + citrixInstanceId *string + requestBody *[]string + userAgent *string + authorization *string + citrixTransactionId *string + accept *string + citrixLocale *string +} + +// Citrix Customer ID. Default is 'CitrixOnPremises' +func (r ApiGpoEnableGpoPoliciesRequest) CitrixCustomerId(citrixCustomerId string) ApiGpoEnableGpoPoliciesRequest { + r.citrixCustomerId = &citrixCustomerId + return r +} + +// Citrix Instance (Site) ID. +func (r ApiGpoEnableGpoPoliciesRequest) CitrixInstanceId(citrixInstanceId string) ApiGpoEnableGpoPoliciesRequest { + r.citrixInstanceId = &citrixInstanceId + return r +} + +// GUIDs of the policies to be enabled +func (r ApiGpoEnableGpoPoliciesRequest) RequestBody(requestBody []string) ApiGpoEnableGpoPoliciesRequest { + r.requestBody = &requestBody + return r +} + +// User Agent type of the request. +func (r ApiGpoEnableGpoPoliciesRequest) UserAgent(userAgent string) ApiGpoEnableGpoPoliciesRequest { + r.userAgent = &userAgent + return r +} + +// Citrix authorization header: CWSAuth Bearer={token} +func (r ApiGpoEnableGpoPoliciesRequest) Authorization(authorization string) ApiGpoEnableGpoPoliciesRequest { + r.authorization = &authorization + return r +} + +// Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. +func (r ApiGpoEnableGpoPoliciesRequest) CitrixTransactionId(citrixTransactionId string) ApiGpoEnableGpoPoliciesRequest { + r.citrixTransactionId = &citrixTransactionId + return r +} + +// Must accept application/json. +func (r ApiGpoEnableGpoPoliciesRequest) Accept(accept string) ApiGpoEnableGpoPoliciesRequest { + r.accept = &accept + return r +} + +// Locale of the request. +func (r ApiGpoEnableGpoPoliciesRequest) CitrixLocale(citrixLocale string) ApiGpoEnableGpoPoliciesRequest { + r.citrixLocale = &citrixLocale + return r +} + +func (r ApiGpoEnableGpoPoliciesRequest) Execute() (*http.Response, error) { + return r.ApiService.GpoEnableGpoPoliciesExecute(r) +} + +/* +GpoEnableGpoPolicies Enable some policies of a policy set. + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @return ApiGpoEnableGpoPoliciesRequest +*/ +func (a *GpoDAASService) GpoEnableGpoPolicies(ctx context.Context) ApiGpoEnableGpoPoliciesRequest { + return ApiGpoEnableGpoPoliciesRequest{ + ApiService: a, + ctx: ctx, + } +} + +// Execute executes the request +func (a *GpoDAASService) GpoEnableGpoPoliciesExecute(r ApiGpoEnableGpoPoliciesRequest) (*http.Response, error) { + var ( + localVarHTTPMethod = http.MethodPost + localVarPostBody interface{} + formFiles []formFile + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GpoDAASService.GpoEnableGpoPolicies") + if err != nil { + return nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/gpo/policies/$enable" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.citrixCustomerId == nil { + return nil, reportError("citrixCustomerId is required and must be specified") + } + if r.citrixInstanceId == nil { + return nil, reportError("citrixInstanceId is required and must be specified") + } + if r.requestBody == nil { + return nil, reportError("requestBody is required and must be specified") + } + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-CustomerId", r.citrixCustomerId, "") + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-InstanceId", r.citrixInstanceId, "") + if r.userAgent != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "User-Agent", r.userAgent, "") + } + if r.authorization != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Authorization", r.authorization, "") + } + if r.citrixTransactionId != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-TransactionId", r.citrixTransactionId, "") + } + if r.accept != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Accept", r.accept, "") + } + if r.citrixLocale != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-Locale", r.citrixLocale, "") + } + // body params + localVarPostBody = r.requestBody + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["BearerAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarHTTPResponse, err + } + + localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 406 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 409 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 415 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 429 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 503 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarHTTPResponse, newErr + } + + return localVarHTTPResponse, nil +} + +type ApiGpoGetFilterDefinitionsRequest struct { + ctx context.Context + ApiService *GpoDAASService + citrixCustomerId *string + citrixInstanceId *string + userAgent *string + authorization *string + citrixTransactionId *string + accept *string + citrixLocale *string +} + +// Citrix Customer ID. Default is 'CitrixOnPremises' +func (r ApiGpoGetFilterDefinitionsRequest) CitrixCustomerId(citrixCustomerId string) ApiGpoGetFilterDefinitionsRequest { + r.citrixCustomerId = &citrixCustomerId + return r +} + +// Citrix Instance (Site) ID. +func (r ApiGpoGetFilterDefinitionsRequest) CitrixInstanceId(citrixInstanceId string) ApiGpoGetFilterDefinitionsRequest { + r.citrixInstanceId = &citrixInstanceId + return r +} + +// User Agent type of the request. +func (r ApiGpoGetFilterDefinitionsRequest) UserAgent(userAgent string) ApiGpoGetFilterDefinitionsRequest { + r.userAgent = &userAgent + return r +} + +// Citrix authorization header: CWSAuth Bearer={token} +func (r ApiGpoGetFilterDefinitionsRequest) Authorization(authorization string) ApiGpoGetFilterDefinitionsRequest { + r.authorization = &authorization + return r +} + +// Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. +func (r ApiGpoGetFilterDefinitionsRequest) CitrixTransactionId(citrixTransactionId string) ApiGpoGetFilterDefinitionsRequest { + r.citrixTransactionId = &citrixTransactionId + return r +} + +// Must accept application/json. +func (r ApiGpoGetFilterDefinitionsRequest) Accept(accept string) ApiGpoGetFilterDefinitionsRequest { + r.accept = &accept + return r +} + +// Locale of the request. +func (r ApiGpoGetFilterDefinitionsRequest) CitrixLocale(citrixLocale string) ApiGpoGetFilterDefinitionsRequest { + r.citrixLocale = &citrixLocale + return r +} + +func (r ApiGpoGetFilterDefinitionsRequest) Execute() (*CollectionEnvelopeOfFilterDefinition, *http.Response, error) { + return r.ApiService.GpoGetFilterDefinitionsExecute(r) +} + +/* +GpoGetFilterDefinitions Get all filter definitions. + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @return ApiGpoGetFilterDefinitionsRequest +*/ +func (a *GpoDAASService) GpoGetFilterDefinitions(ctx context.Context) ApiGpoGetFilterDefinitionsRequest { + return ApiGpoGetFilterDefinitionsRequest{ + ApiService: a, + ctx: ctx, + } +} + +// Execute executes the request +// @return CollectionEnvelopeOfFilterDefinition +func (a *GpoDAASService) GpoGetFilterDefinitionsExecute(r ApiGpoGetFilterDefinitionsRequest) (*CollectionEnvelopeOfFilterDefinition, *http.Response, error) { + var ( + localVarHTTPMethod = http.MethodGet + localVarPostBody interface{} + formFiles []formFile + localVarReturnValue *CollectionEnvelopeOfFilterDefinition + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GpoDAASService.GpoGetFilterDefinitions") + if err != nil { + return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/gpo/filterDefinitions" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.citrixCustomerId == nil { + return localVarReturnValue, nil, reportError("citrixCustomerId is required and must be specified") + } + if r.citrixInstanceId == nil { + return localVarReturnValue, nil, reportError("citrixInstanceId is required and must be specified") + } + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-CustomerId", r.citrixCustomerId, "") + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-InstanceId", r.citrixInstanceId, "") + if r.userAgent != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "User-Agent", r.userAgent, "") + } + if r.authorization != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Authorization", r.authorization, "") + } + if r.citrixTransactionId != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-TransactionId", r.citrixTransactionId, "") + } + if r.accept != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Accept", r.accept, "") + } + if r.citrixLocale != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-Locale", r.citrixLocale, "") + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["BearerAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 406 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 429 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 503 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiGpoGetSettingDefinitionsRequest struct { + ctx context.Context + ApiService *GpoDAASService + citrixCustomerId *string + citrixInstanceId *string + userAgent *string + authorization *string + citrixTransactionId *string + accept *string + citrixLocale *string + isLean *bool + limit *int32 + isAscending *bool + namePattern *string + isUserSetting *bool + continuationToken *string +} + +// Citrix Customer ID. Default is 'CitrixOnPremises' +func (r ApiGpoGetSettingDefinitionsRequest) CitrixCustomerId(citrixCustomerId string) ApiGpoGetSettingDefinitionsRequest { + r.citrixCustomerId = &citrixCustomerId + return r +} + +// Citrix Instance (Site) ID. +func (r ApiGpoGetSettingDefinitionsRequest) CitrixInstanceId(citrixInstanceId string) ApiGpoGetSettingDefinitionsRequest { + r.citrixInstanceId = &citrixInstanceId + return r +} + +// User Agent type of the request. +func (r ApiGpoGetSettingDefinitionsRequest) UserAgent(userAgent string) ApiGpoGetSettingDefinitionsRequest { + r.userAgent = &userAgent + return r +} + +// Citrix authorization header: CWSAuth Bearer={token} +func (r ApiGpoGetSettingDefinitionsRequest) Authorization(authorization string) ApiGpoGetSettingDefinitionsRequest { + r.authorization = &authorization + return r +} + +// Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. +func (r ApiGpoGetSettingDefinitionsRequest) CitrixTransactionId(citrixTransactionId string) ApiGpoGetSettingDefinitionsRequest { + r.citrixTransactionId = &citrixTransactionId + return r +} + +// Must accept application/json. +func (r ApiGpoGetSettingDefinitionsRequest) Accept(accept string) ApiGpoGetSettingDefinitionsRequest { + r.accept = &accept + return r +} + +// Locale of the request. +func (r ApiGpoGetSettingDefinitionsRequest) CitrixLocale(citrixLocale string) ApiGpoGetSettingDefinitionsRequest { + r.citrixLocale = &citrixLocale + return r +} + +// Get lean parts of setting definitions, the default is set to true +func (r ApiGpoGetSettingDefinitionsRequest) IsLean(isLean bool) ApiGpoGetSettingDefinitionsRequest { + r.isLean = &isLean + return r +} + +// Specify the number of entries to retrieve, the default is all entries +func (r ApiGpoGetSettingDefinitionsRequest) Limit(limit int32) ApiGpoGetSettingDefinitionsRequest { + r.limit = &limit + return r +} + +// Specify sort order, default is true +func (r ApiGpoGetSettingDefinitionsRequest) IsAscending(isAscending bool) ApiGpoGetSettingDefinitionsRequest { + r.isAscending = &isAscending + return r +} + +// Specify a regular expression to match the internal setting name. The default is match all names. +func (r ApiGpoGetSettingDefinitionsRequest) NamePattern(namePattern string) ApiGpoGetSettingDefinitionsRequest { + r.namePattern = &namePattern + return r +} + +// Specify the target of applying the settings. If it's set to true, only user settings are retrieved. If it's set to false, only computer settings are retrieved. If not specified, both kinds of settings are retrieved. The default is to retrieve both kinds of settings. +func (r ApiGpoGetSettingDefinitionsRequest) IsUserSetting(isUserSetting bool) ApiGpoGetSettingDefinitionsRequest { + r.isUserSetting = &isUserSetting + return r +} + +// Continuation token from a previous retrieval +func (r ApiGpoGetSettingDefinitionsRequest) ContinuationToken(continuationToken string) ApiGpoGetSettingDefinitionsRequest { + r.continuationToken = &continuationToken + return r +} + +func (r ApiGpoGetSettingDefinitionsRequest) Execute() (*SettingDefinitionEnvelope, *http.Response, error) { + return r.ApiService.GpoGetSettingDefinitionsExecute(r) +} + +/* +GpoGetSettingDefinitions Get setting definitions. If isLean is set to true, only basic session information is returned. EnumType, VdaVersions, VersionDetails, and Explanation are not retrieved. If limit is set to -1 or a number larger than the number of settings available, all entries are retrieved. If limit is set to a positive integer smaller than the number of settings available, the specified number of settings are retrieved. + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @return ApiGpoGetSettingDefinitionsRequest +*/ +func (a *GpoDAASService) GpoGetSettingDefinitions(ctx context.Context) ApiGpoGetSettingDefinitionsRequest { + return ApiGpoGetSettingDefinitionsRequest{ + ApiService: a, + ctx: ctx, + } +} + +// Execute executes the request +// @return SettingDefinitionEnvelope +func (a *GpoDAASService) GpoGetSettingDefinitionsExecute(r ApiGpoGetSettingDefinitionsRequest) (*SettingDefinitionEnvelope, *http.Response, error) { + var ( + localVarHTTPMethod = http.MethodGet + localVarPostBody interface{} + formFiles []formFile + localVarReturnValue *SettingDefinitionEnvelope + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GpoDAASService.GpoGetSettingDefinitions") + if err != nil { + return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/gpo/settingDefinitions" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.citrixCustomerId == nil { + return localVarReturnValue, nil, reportError("citrixCustomerId is required and must be specified") + } + if r.citrixInstanceId == nil { + return localVarReturnValue, nil, reportError("citrixInstanceId is required and must be specified") + } + + if r.isLean != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "isLean", r.isLean, "") + } + if r.limit != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "limit", r.limit, "") + } + if r.isAscending != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "isAscending", r.isAscending, "") + } + if r.namePattern != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "namePattern", r.namePattern, "") + } + if r.isUserSetting != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "isUserSetting", r.isUserSetting, "") + } + if r.continuationToken != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "continuationToken", r.continuationToken, "") + } + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-CustomerId", r.citrixCustomerId, "") + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-InstanceId", r.citrixInstanceId, "") + if r.userAgent != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "User-Agent", r.userAgent, "") + } + if r.authorization != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Authorization", r.authorization, "") + } + if r.citrixTransactionId != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-TransactionId", r.citrixTransactionId, "") + } + if r.accept != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Accept", r.accept, "") + } + if r.citrixLocale != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-Locale", r.citrixLocale, "") + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["BearerAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 406 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 429 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 503 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiGpoGetSettingFullDetailRequest struct { + ctx context.Context + ApiService *GpoDAASService + citrixCustomerId *string + citrixInstanceId *string + settingName *string + userAgent *string + authorization *string + citrixTransactionId *string + accept *string + citrixLocale *string +} + +// Citrix Customer ID. Default is 'CitrixOnPremises' +func (r ApiGpoGetSettingFullDetailRequest) CitrixCustomerId(citrixCustomerId string) ApiGpoGetSettingFullDetailRequest { + r.citrixCustomerId = &citrixCustomerId + return r +} + +// Citrix Instance (Site) ID. +func (r ApiGpoGetSettingFullDetailRequest) CitrixInstanceId(citrixInstanceId string) ApiGpoGetSettingFullDetailRequest { + r.citrixInstanceId = &citrixInstanceId + return r +} + +// The internal name of the setting +func (r ApiGpoGetSettingFullDetailRequest) SettingName(settingName string) ApiGpoGetSettingFullDetailRequest { + r.settingName = &settingName + return r +} + +// User Agent type of the request. +func (r ApiGpoGetSettingFullDetailRequest) UserAgent(userAgent string) ApiGpoGetSettingFullDetailRequest { + r.userAgent = &userAgent + return r +} + +// Citrix authorization header: CWSAuth Bearer={token} +func (r ApiGpoGetSettingFullDetailRequest) Authorization(authorization string) ApiGpoGetSettingFullDetailRequest { + r.authorization = &authorization + return r +} + +// Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. +func (r ApiGpoGetSettingFullDetailRequest) CitrixTransactionId(citrixTransactionId string) ApiGpoGetSettingFullDetailRequest { + r.citrixTransactionId = &citrixTransactionId + return r +} + +// Must accept application/json. +func (r ApiGpoGetSettingFullDetailRequest) Accept(accept string) ApiGpoGetSettingFullDetailRequest { + r.accept = &accept + return r +} + +// Locale of the request. +func (r ApiGpoGetSettingFullDetailRequest) CitrixLocale(citrixLocale string) ApiGpoGetSettingFullDetailRequest { + r.citrixLocale = &citrixLocale + return r +} + +func (r ApiGpoGetSettingFullDetailRequest) Execute() (*SettingDefinition, *http.Response, error) { + return r.ApiService.GpoGetSettingFullDetailExecute(r) +} + +/* +GpoGetSettingFullDetail Get full detail of a setting definition. + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @return ApiGpoGetSettingFullDetailRequest +*/ +func (a *GpoDAASService) GpoGetSettingFullDetail(ctx context.Context) ApiGpoGetSettingFullDetailRequest { + return ApiGpoGetSettingFullDetailRequest{ + ApiService: a, + ctx: ctx, + } +} + +// Execute executes the request +// @return SettingDefinition +func (a *GpoDAASService) GpoGetSettingFullDetailExecute(r ApiGpoGetSettingFullDetailRequest) (*SettingDefinition, *http.Response, error) { + var ( + localVarHTTPMethod = http.MethodGet + localVarPostBody interface{} + formFiles []formFile + localVarReturnValue *SettingDefinition + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GpoDAASService.GpoGetSettingFullDetail") + if err != nil { + return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/gpo/settingFullDetail" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.citrixCustomerId == nil { + return localVarReturnValue, nil, reportError("citrixCustomerId is required and must be specified") + } + if r.citrixInstanceId == nil { + return localVarReturnValue, nil, reportError("citrixInstanceId is required and must be specified") + } + if r.settingName == nil { + return localVarReturnValue, nil, reportError("settingName is required and must be specified") + } + + parameterAddToHeaderOrQuery(localVarQueryParams, "settingName", r.settingName, "") + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-CustomerId", r.citrixCustomerId, "") + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-InstanceId", r.citrixInstanceId, "") + if r.userAgent != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "User-Agent", r.userAgent, "") + } + if r.authorization != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Authorization", r.authorization, "") + } + if r.citrixTransactionId != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-TransactionId", r.citrixTransactionId, "") + } + if r.accept != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Accept", r.accept, "") + } + if r.citrixLocale != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-Locale", r.citrixLocale, "") + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["BearerAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 406 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 429 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 503 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiGpoMoveGpoPoliciesRequest struct { + ctx context.Context + ApiService *GpoDAASService + citrixCustomerId *string + citrixInstanceId *string + toPolicySet *string + requestBody *[]string + userAgent *string + authorization *string + citrixTransactionId *string + accept *string + citrixLocale *string +} + +// Citrix Customer ID. Default is 'CitrixOnPremises' +func (r ApiGpoMoveGpoPoliciesRequest) CitrixCustomerId(citrixCustomerId string) ApiGpoMoveGpoPoliciesRequest { + r.citrixCustomerId = &citrixCustomerId + return r +} + +// Citrix Instance (Site) ID. +func (r ApiGpoMoveGpoPoliciesRequest) CitrixInstanceId(citrixInstanceId string) ApiGpoMoveGpoPoliciesRequest { + r.citrixInstanceId = &citrixInstanceId + return r +} + +// GUID of the destination policy set +func (r ApiGpoMoveGpoPoliciesRequest) ToPolicySet(toPolicySet string) ApiGpoMoveGpoPoliciesRequest { + r.toPolicySet = &toPolicySet + return r +} + +// GUIDs of the policies to be removed +func (r ApiGpoMoveGpoPoliciesRequest) RequestBody(requestBody []string) ApiGpoMoveGpoPoliciesRequest { + r.requestBody = &requestBody + return r +} + +// User Agent type of the request. +func (r ApiGpoMoveGpoPoliciesRequest) UserAgent(userAgent string) ApiGpoMoveGpoPoliciesRequest { + r.userAgent = &userAgent + return r +} + +// Citrix authorization header: CWSAuth Bearer={token} +func (r ApiGpoMoveGpoPoliciesRequest) Authorization(authorization string) ApiGpoMoveGpoPoliciesRequest { + r.authorization = &authorization + return r +} + +// Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. +func (r ApiGpoMoveGpoPoliciesRequest) CitrixTransactionId(citrixTransactionId string) ApiGpoMoveGpoPoliciesRequest { + r.citrixTransactionId = &citrixTransactionId + return r +} + +// Must accept application/json. +func (r ApiGpoMoveGpoPoliciesRequest) Accept(accept string) ApiGpoMoveGpoPoliciesRequest { + r.accept = &accept + return r +} + +// Locale of the request. +func (r ApiGpoMoveGpoPoliciesRequest) CitrixLocale(citrixLocale string) ApiGpoMoveGpoPoliciesRequest { + r.citrixLocale = &citrixLocale + return r +} + +func (r ApiGpoMoveGpoPoliciesRequest) Execute() (*http.Response, error) { + return r.ApiService.GpoMoveGpoPoliciesExecute(r) +} + +/* +GpoMoveGpoPolicies Move some policies of a policy set to another policy set. + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @return ApiGpoMoveGpoPoliciesRequest +*/ +func (a *GpoDAASService) GpoMoveGpoPolicies(ctx context.Context) ApiGpoMoveGpoPoliciesRequest { + return ApiGpoMoveGpoPoliciesRequest{ + ApiService: a, + ctx: ctx, + } +} + +// Execute executes the request +func (a *GpoDAASService) GpoMoveGpoPoliciesExecute(r ApiGpoMoveGpoPoliciesRequest) (*http.Response, error) { + var ( + localVarHTTPMethod = http.MethodPost + localVarPostBody interface{} + formFiles []formFile + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GpoDAASService.GpoMoveGpoPolicies") + if err != nil { + return nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/gpo/policies/$move" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.citrixCustomerId == nil { + return nil, reportError("citrixCustomerId is required and must be specified") + } + if r.citrixInstanceId == nil { + return nil, reportError("citrixInstanceId is required and must be specified") + } + if r.toPolicySet == nil { + return nil, reportError("toPolicySet is required and must be specified") + } + if r.requestBody == nil { + return nil, reportError("requestBody is required and must be specified") + } + + parameterAddToHeaderOrQuery(localVarQueryParams, "toPolicySet", r.toPolicySet, "") + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-CustomerId", r.citrixCustomerId, "") + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-InstanceId", r.citrixInstanceId, "") + if r.userAgent != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "User-Agent", r.userAgent, "") + } + if r.authorization != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Authorization", r.authorization, "") + } + if r.citrixTransactionId != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-TransactionId", r.citrixTransactionId, "") + } + if r.accept != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Accept", r.accept, "") + } + if r.citrixLocale != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-Locale", r.citrixLocale, "") + } + // body params + localVarPostBody = r.requestBody + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["BearerAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarHTTPResponse, err + } + + localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 406 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 409 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 415 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 429 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 503 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarHTTPResponse, newErr + } + + return localVarHTTPResponse, nil +} + +type ApiGpoRankGpoPoliciesRequest struct { + ctx context.Context + ApiService *GpoDAASService + citrixCustomerId *string + citrixInstanceId *string + policySetGuid *string + requestBody *[]string + userAgent *string + authorization *string + citrixTransactionId *string + accept *string + citrixLocale *string +} + +// Citrix Customer ID. Default is 'CitrixOnPremises' +func (r ApiGpoRankGpoPoliciesRequest) CitrixCustomerId(citrixCustomerId string) ApiGpoRankGpoPoliciesRequest { + r.citrixCustomerId = &citrixCustomerId + return r +} + +// Citrix Instance (Site) ID. +func (r ApiGpoRankGpoPoliciesRequest) CitrixInstanceId(citrixInstanceId string) ApiGpoRankGpoPoliciesRequest { + r.citrixInstanceId = &citrixInstanceId + return r +} + +// Guid of the policy set that contains the policies +func (r ApiGpoRankGpoPoliciesRequest) PolicySetGuid(policySetGuid string) ApiGpoRankGpoPoliciesRequest { + r.policySetGuid = &policySetGuid + return r +} + +// GUIDs of the policies to be re-prioritized +func (r ApiGpoRankGpoPoliciesRequest) RequestBody(requestBody []string) ApiGpoRankGpoPoliciesRequest { + r.requestBody = &requestBody + return r +} + +// User Agent type of the request. +func (r ApiGpoRankGpoPoliciesRequest) UserAgent(userAgent string) ApiGpoRankGpoPoliciesRequest { + r.userAgent = &userAgent + return r +} + +// Citrix authorization header: CWSAuth Bearer={token} +func (r ApiGpoRankGpoPoliciesRequest) Authorization(authorization string) ApiGpoRankGpoPoliciesRequest { + r.authorization = &authorization + return r +} + +// Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. +func (r ApiGpoRankGpoPoliciesRequest) CitrixTransactionId(citrixTransactionId string) ApiGpoRankGpoPoliciesRequest { + r.citrixTransactionId = &citrixTransactionId + return r +} + +// Must accept application/json. +func (r ApiGpoRankGpoPoliciesRequest) Accept(accept string) ApiGpoRankGpoPoliciesRequest { + r.accept = &accept + return r +} + +// Locale of the request. +func (r ApiGpoRankGpoPoliciesRequest) CitrixLocale(citrixLocale string) ApiGpoRankGpoPoliciesRequest { + r.citrixLocale = &citrixLocale + return r +} + +func (r ApiGpoRankGpoPoliciesRequest) Execute() (bool, *http.Response, error) { + return r.ApiService.GpoRankGpoPoliciesExecute(r) +} + +/* +GpoRankGpoPolicies Specify new priority order for all existing policies in a policy set. All the policies in the policy set must be specified, even if the priorities of only some of the policies are changed. + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @return ApiGpoRankGpoPoliciesRequest +*/ +func (a *GpoDAASService) GpoRankGpoPolicies(ctx context.Context) ApiGpoRankGpoPoliciesRequest { + return ApiGpoRankGpoPoliciesRequest{ + ApiService: a, + ctx: ctx, + } +} + +// Execute executes the request +// @return bool +func (a *GpoDAASService) GpoRankGpoPoliciesExecute(r ApiGpoRankGpoPoliciesRequest) (bool, *http.Response, error) { + var ( + localVarHTTPMethod = http.MethodPost + localVarPostBody interface{} + formFiles []formFile + localVarReturnValue bool + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GpoDAASService.GpoRankGpoPolicies") + if err != nil { + return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/gpo/policyPriorities" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.citrixCustomerId == nil { + return localVarReturnValue, nil, reportError("citrixCustomerId is required and must be specified") + } + if r.citrixInstanceId == nil { + return localVarReturnValue, nil, reportError("citrixInstanceId is required and must be specified") + } + if r.policySetGuid == nil { + return localVarReturnValue, nil, reportError("policySetGuid is required and must be specified") + } + if r.requestBody == nil { + return localVarReturnValue, nil, reportError("requestBody is required and must be specified") + } + + parameterAddToHeaderOrQuery(localVarQueryParams, "policySetGuid", r.policySetGuid, "") + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-CustomerId", r.citrixCustomerId, "") + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-InstanceId", r.citrixInstanceId, "") + if r.userAgent != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "User-Agent", r.userAgent, "") + } + if r.authorization != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Authorization", r.authorization, "") + } + if r.citrixTransactionId != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-TransactionId", r.citrixTransactionId, "") + } + if r.accept != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Accept", r.accept, "") + } + if r.citrixLocale != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-Locale", r.citrixLocale, "") + } + // body params + localVarPostBody = r.requestBody + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["BearerAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 406 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 409 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 415 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 429 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 503 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiGpoReadGpoFilterRequest struct { + ctx context.Context + ApiService *GpoDAASService + citrixCustomerId *string + citrixInstanceId *string + filterGuid string + userAgent *string + authorization *string + citrixTransactionId *string + accept *string + citrixLocale *string +} + +// Citrix Customer ID. Default is 'CitrixOnPremises' +func (r ApiGpoReadGpoFilterRequest) CitrixCustomerId(citrixCustomerId string) ApiGpoReadGpoFilterRequest { + r.citrixCustomerId = &citrixCustomerId + return r +} + +// Citrix Instance (Site) ID. +func (r ApiGpoReadGpoFilterRequest) CitrixInstanceId(citrixInstanceId string) ApiGpoReadGpoFilterRequest { + r.citrixInstanceId = &citrixInstanceId + return r +} + +// User Agent type of the request. +func (r ApiGpoReadGpoFilterRequest) UserAgent(userAgent string) ApiGpoReadGpoFilterRequest { + r.userAgent = &userAgent + return r +} + +// Citrix authorization header: CWSAuth Bearer={token} +func (r ApiGpoReadGpoFilterRequest) Authorization(authorization string) ApiGpoReadGpoFilterRequest { + r.authorization = &authorization + return r +} + +// Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. +func (r ApiGpoReadGpoFilterRequest) CitrixTransactionId(citrixTransactionId string) ApiGpoReadGpoFilterRequest { + r.citrixTransactionId = &citrixTransactionId + return r +} + +// Must accept application/json. +func (r ApiGpoReadGpoFilterRequest) Accept(accept string) ApiGpoReadGpoFilterRequest { + r.accept = &accept + return r +} + +// Locale of the request. +func (r ApiGpoReadGpoFilterRequest) CitrixLocale(citrixLocale string) ApiGpoReadGpoFilterRequest { + r.citrixLocale = &citrixLocale + return r +} + +func (r ApiGpoReadGpoFilterRequest) Execute() (*FilterResponse, *http.Response, error) { + return r.ApiService.GpoReadGpoFilterExecute(r) +} + +/* +GpoReadGpoFilter Read a specific filter. + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param filterGuid The GUID of the filter to be read + @return ApiGpoReadGpoFilterRequest +*/ +func (a *GpoDAASService) GpoReadGpoFilter(ctx context.Context, filterGuid string) ApiGpoReadGpoFilterRequest { + return ApiGpoReadGpoFilterRequest{ + ApiService: a, + ctx: ctx, + filterGuid: filterGuid, + } +} + +// Execute executes the request +// @return FilterResponse +func (a *GpoDAASService) GpoReadGpoFilterExecute(r ApiGpoReadGpoFilterRequest) (*FilterResponse, *http.Response, error) { + var ( + localVarHTTPMethod = http.MethodGet + localVarPostBody interface{} + formFiles []formFile + localVarReturnValue *FilterResponse + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GpoDAASService.GpoReadGpoFilter") + if err != nil { + return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/gpo/filters/{filterGuid}" + localVarPath = strings.Replace(localVarPath, "{"+"filterGuid"+"}", url.PathEscape(parameterValueToString(r.filterGuid, "filterGuid")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.citrixCustomerId == nil { + return localVarReturnValue, nil, reportError("citrixCustomerId is required and must be specified") + } + if r.citrixInstanceId == nil { + return localVarReturnValue, nil, reportError("citrixInstanceId is required and must be specified") + } + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-CustomerId", r.citrixCustomerId, "") + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-InstanceId", r.citrixInstanceId, "") + if r.userAgent != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "User-Agent", r.userAgent, "") + } + if r.authorization != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Authorization", r.authorization, "") + } + if r.citrixTransactionId != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-TransactionId", r.citrixTransactionId, "") + } + if r.accept != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Accept", r.accept, "") + } + if r.citrixLocale != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-Locale", r.citrixLocale, "") + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["BearerAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 404 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 406 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 429 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 503 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiGpoReadGpoFiltersRequest struct { + ctx context.Context + ApiService *GpoDAASService + citrixCustomerId *string + citrixInstanceId *string + policyGuid *string + userAgent *string + authorization *string + citrixTransactionId *string + accept *string + citrixLocale *string +} + +// Citrix Customer ID. Default is 'CitrixOnPremises' +func (r ApiGpoReadGpoFiltersRequest) CitrixCustomerId(citrixCustomerId string) ApiGpoReadGpoFiltersRequest { + r.citrixCustomerId = &citrixCustomerId + return r +} + +// Citrix Instance (Site) ID. +func (r ApiGpoReadGpoFiltersRequest) CitrixInstanceId(citrixInstanceId string) ApiGpoReadGpoFiltersRequest { + r.citrixInstanceId = &citrixInstanceId + return r +} + +// The GUID of the policy from which filters are read +func (r ApiGpoReadGpoFiltersRequest) PolicyGuid(policyGuid string) ApiGpoReadGpoFiltersRequest { + r.policyGuid = &policyGuid + return r +} + +// User Agent type of the request. +func (r ApiGpoReadGpoFiltersRequest) UserAgent(userAgent string) ApiGpoReadGpoFiltersRequest { + r.userAgent = &userAgent + return r +} + +// Citrix authorization header: CWSAuth Bearer={token} +func (r ApiGpoReadGpoFiltersRequest) Authorization(authorization string) ApiGpoReadGpoFiltersRequest { + r.authorization = &authorization + return r +} + +// Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. +func (r ApiGpoReadGpoFiltersRequest) CitrixTransactionId(citrixTransactionId string) ApiGpoReadGpoFiltersRequest { + r.citrixTransactionId = &citrixTransactionId + return r +} + +// Must accept application/json. +func (r ApiGpoReadGpoFiltersRequest) Accept(accept string) ApiGpoReadGpoFiltersRequest { + r.accept = &accept + return r +} + +// Locale of the request. +func (r ApiGpoReadGpoFiltersRequest) CitrixLocale(citrixLocale string) ApiGpoReadGpoFiltersRequest { + r.citrixLocale = &citrixLocale + return r +} + +func (r ApiGpoReadGpoFiltersRequest) Execute() (*CollectionEnvelopeOfFilterResponse, *http.Response, error) { + return r.ApiService.GpoReadGpoFiltersExecute(r) +} + +/* +GpoReadGpoFilters Read filters defined in a policy. A policy in a policy set of type SiteTemplates or CustomTemplates does not have filters. + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @return ApiGpoReadGpoFiltersRequest +*/ +func (a *GpoDAASService) GpoReadGpoFilters(ctx context.Context) ApiGpoReadGpoFiltersRequest { + return ApiGpoReadGpoFiltersRequest{ + ApiService: a, + ctx: ctx, + } +} + +// Execute executes the request +// @return CollectionEnvelopeOfFilterResponse +func (a *GpoDAASService) GpoReadGpoFiltersExecute(r ApiGpoReadGpoFiltersRequest) (*CollectionEnvelopeOfFilterResponse, *http.Response, error) { + var ( + localVarHTTPMethod = http.MethodGet + localVarPostBody interface{} + formFiles []formFile + localVarReturnValue *CollectionEnvelopeOfFilterResponse + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GpoDAASService.GpoReadGpoFilters") + if err != nil { + return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/gpo/filters" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.citrixCustomerId == nil { + return localVarReturnValue, nil, reportError("citrixCustomerId is required and must be specified") + } + if r.citrixInstanceId == nil { + return localVarReturnValue, nil, reportError("citrixInstanceId is required and must be specified") + } + if r.policyGuid == nil { + return localVarReturnValue, nil, reportError("policyGuid is required and must be specified") + } + + parameterAddToHeaderOrQuery(localVarQueryParams, "policyGuid", r.policyGuid, "") + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-CustomerId", r.citrixCustomerId, "") + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-InstanceId", r.citrixInstanceId, "") + if r.userAgent != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "User-Agent", r.userAgent, "") + } + if r.authorization != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Authorization", r.authorization, "") + } + if r.citrixTransactionId != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-TransactionId", r.citrixTransactionId, "") + } + if r.accept != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Accept", r.accept, "") + } + if r.citrixLocale != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-Locale", r.citrixLocale, "") + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["BearerAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 406 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 429 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 503 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiGpoReadGpoPoliciesRequest struct { + ctx context.Context + ApiService *GpoDAASService + citrixCustomerId *string + citrixInstanceId *string + policySetGuid *string + userAgent *string + authorization *string + citrixTransactionId *string + accept *string + citrixLocale *string + withSettings *bool + withFilters *bool +} + +// Citrix Customer ID. Default is 'CitrixOnPremises' +func (r ApiGpoReadGpoPoliciesRequest) CitrixCustomerId(citrixCustomerId string) ApiGpoReadGpoPoliciesRequest { + r.citrixCustomerId = &citrixCustomerId + return r +} + +// Citrix Instance (Site) ID. +func (r ApiGpoReadGpoPoliciesRequest) CitrixInstanceId(citrixInstanceId string) ApiGpoReadGpoPoliciesRequest { + r.citrixInstanceId = &citrixInstanceId + return r +} + +// The GUID of the policy set from which policies are read +func (r ApiGpoReadGpoPoliciesRequest) PolicySetGuid(policySetGuid string) ApiGpoReadGpoPoliciesRequest { + r.policySetGuid = &policySetGuid + return r +} + +// User Agent type of the request. +func (r ApiGpoReadGpoPoliciesRequest) UserAgent(userAgent string) ApiGpoReadGpoPoliciesRequest { + r.userAgent = &userAgent + return r +} + +// Citrix authorization header: CWSAuth Bearer={token} +func (r ApiGpoReadGpoPoliciesRequest) Authorization(authorization string) ApiGpoReadGpoPoliciesRequest { + r.authorization = &authorization + return r +} + +// Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. +func (r ApiGpoReadGpoPoliciesRequest) CitrixTransactionId(citrixTransactionId string) ApiGpoReadGpoPoliciesRequest { + r.citrixTransactionId = &citrixTransactionId + return r +} + +// Must accept application/json. +func (r ApiGpoReadGpoPoliciesRequest) Accept(accept string) ApiGpoReadGpoPoliciesRequest { + r.accept = &accept + return r +} + +// Locale of the request. +func (r ApiGpoReadGpoPoliciesRequest) CitrixLocale(citrixLocale string) ApiGpoReadGpoPoliciesRequest { + r.citrixLocale = &citrixLocale + return r +} + +// If set to true, settings in the policy are read +func (r ApiGpoReadGpoPoliciesRequest) WithSettings(withSettings bool) ApiGpoReadGpoPoliciesRequest { + r.withSettings = &withSettings + return r +} + +// If set to true, filters in the policy are read +func (r ApiGpoReadGpoPoliciesRequest) WithFilters(withFilters bool) ApiGpoReadGpoPoliciesRequest { + r.withFilters = &withFilters + return r +} + +func (r ApiGpoReadGpoPoliciesRequest) Execute() (*CollectionEnvelopeOfPolicyResponse, *http.Response, error) { + return r.ApiService.GpoReadGpoPoliciesExecute(r) +} + +/* +GpoReadGpoPolicies Read all policies defined in a policy set. Policy templates don't have filters. + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @return ApiGpoReadGpoPoliciesRequest +*/ +func (a *GpoDAASService) GpoReadGpoPolicies(ctx context.Context) ApiGpoReadGpoPoliciesRequest { + return ApiGpoReadGpoPoliciesRequest{ + ApiService: a, + ctx: ctx, + } +} + +// Execute executes the request +// @return CollectionEnvelopeOfPolicyResponse +func (a *GpoDAASService) GpoReadGpoPoliciesExecute(r ApiGpoReadGpoPoliciesRequest) (*CollectionEnvelopeOfPolicyResponse, *http.Response, error) { + var ( + localVarHTTPMethod = http.MethodGet + localVarPostBody interface{} + formFiles []formFile + localVarReturnValue *CollectionEnvelopeOfPolicyResponse + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GpoDAASService.GpoReadGpoPolicies") + if err != nil { + return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/gpo/policies" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.citrixCustomerId == nil { + return localVarReturnValue, nil, reportError("citrixCustomerId is required and must be specified") + } + if r.citrixInstanceId == nil { + return localVarReturnValue, nil, reportError("citrixInstanceId is required and must be specified") + } + if r.policySetGuid == nil { + return localVarReturnValue, nil, reportError("policySetGuid is required and must be specified") + } + + parameterAddToHeaderOrQuery(localVarQueryParams, "policySetGuid", r.policySetGuid, "") + if r.withSettings != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "withSettings", r.withSettings, "") + } + if r.withFilters != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "withFilters", r.withFilters, "") + } + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-CustomerId", r.citrixCustomerId, "") + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-InstanceId", r.citrixInstanceId, "") + if r.userAgent != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "User-Agent", r.userAgent, "") + } + if r.authorization != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Authorization", r.authorization, "") + } + if r.citrixTransactionId != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-TransactionId", r.citrixTransactionId, "") + } + if r.accept != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Accept", r.accept, "") + } + if r.citrixLocale != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-Locale", r.citrixLocale, "") + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["BearerAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 406 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 429 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 503 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiGpoReadGpoPolicyRequest struct { + ctx context.Context + ApiService *GpoDAASService + citrixCustomerId *string + citrixInstanceId *string + policyGuid string + userAgent *string + authorization *string + citrixTransactionId *string + accept *string + citrixLocale *string + withSettings *bool + withFilters *bool +} + +// Citrix Customer ID. Default is 'CitrixOnPremises' +func (r ApiGpoReadGpoPolicyRequest) CitrixCustomerId(citrixCustomerId string) ApiGpoReadGpoPolicyRequest { + r.citrixCustomerId = &citrixCustomerId + return r +} + +// Citrix Instance (Site) ID. +func (r ApiGpoReadGpoPolicyRequest) CitrixInstanceId(citrixInstanceId string) ApiGpoReadGpoPolicyRequest { + r.citrixInstanceId = &citrixInstanceId + return r +} + +// User Agent type of the request. +func (r ApiGpoReadGpoPolicyRequest) UserAgent(userAgent string) ApiGpoReadGpoPolicyRequest { + r.userAgent = &userAgent + return r +} + +// Citrix authorization header: CWSAuth Bearer={token} +func (r ApiGpoReadGpoPolicyRequest) Authorization(authorization string) ApiGpoReadGpoPolicyRequest { + r.authorization = &authorization + return r +} + +// Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. +func (r ApiGpoReadGpoPolicyRequest) CitrixTransactionId(citrixTransactionId string) ApiGpoReadGpoPolicyRequest { + r.citrixTransactionId = &citrixTransactionId + return r +} + +// Must accept application/json. +func (r ApiGpoReadGpoPolicyRequest) Accept(accept string) ApiGpoReadGpoPolicyRequest { + r.accept = &accept + return r +} + +// Locale of the request. +func (r ApiGpoReadGpoPolicyRequest) CitrixLocale(citrixLocale string) ApiGpoReadGpoPolicyRequest { + r.citrixLocale = &citrixLocale + return r +} + +// If set to true, read policy settings +func (r ApiGpoReadGpoPolicyRequest) WithSettings(withSettings bool) ApiGpoReadGpoPolicyRequest { + r.withSettings = &withSettings + return r +} + +// If set to true, read policy filters +func (r ApiGpoReadGpoPolicyRequest) WithFilters(withFilters bool) ApiGpoReadGpoPolicyRequest { + r.withFilters = &withFilters + return r +} + +func (r ApiGpoReadGpoPolicyRequest) Execute() (*PolicyResponse, *http.Response, error) { + return r.ApiService.GpoReadGpoPolicyExecute(r) +} + +/* +GpoReadGpoPolicy Read a policy. A policy template doesn't have filters. + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param policyGuid GUID of the policy to be read + @return ApiGpoReadGpoPolicyRequest +*/ +func (a *GpoDAASService) GpoReadGpoPolicy(ctx context.Context, policyGuid string) ApiGpoReadGpoPolicyRequest { + return ApiGpoReadGpoPolicyRequest{ + ApiService: a, + ctx: ctx, + policyGuid: policyGuid, + } +} + +// Execute executes the request +// @return PolicyResponse +func (a *GpoDAASService) GpoReadGpoPolicyExecute(r ApiGpoReadGpoPolicyRequest) (*PolicyResponse, *http.Response, error) { + var ( + localVarHTTPMethod = http.MethodGet + localVarPostBody interface{} + formFiles []formFile + localVarReturnValue *PolicyResponse + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GpoDAASService.GpoReadGpoPolicy") + if err != nil { + return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/gpo/policies/{policyGuid}" + localVarPath = strings.Replace(localVarPath, "{"+"policyGuid"+"}", url.PathEscape(parameterValueToString(r.policyGuid, "policyGuid")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.citrixCustomerId == nil { + return localVarReturnValue, nil, reportError("citrixCustomerId is required and must be specified") + } + if r.citrixInstanceId == nil { + return localVarReturnValue, nil, reportError("citrixInstanceId is required and must be specified") + } + + if r.withSettings != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "withSettings", r.withSettings, "") + } + if r.withFilters != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "withFilters", r.withFilters, "") + } + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-CustomerId", r.citrixCustomerId, "") + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-InstanceId", r.citrixInstanceId, "") + if r.userAgent != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "User-Agent", r.userAgent, "") + } + if r.authorization != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Authorization", r.authorization, "") + } + if r.citrixTransactionId != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-TransactionId", r.citrixTransactionId, "") + } + if r.accept != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Accept", r.accept, "") + } + if r.citrixLocale != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-Locale", r.citrixLocale, "") + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["BearerAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 404 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 406 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 429 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 503 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiGpoReadGpoPolicySetRequest struct { + ctx context.Context + ApiService *GpoDAASService + citrixCustomerId *string + citrixInstanceId *string + policySetGuid string + userAgent *string + authorization *string + citrixTransactionId *string + accept *string + citrixLocale *string + withPolicies *bool +} + +// Citrix Customer ID. Default is 'CitrixOnPremises' +func (r ApiGpoReadGpoPolicySetRequest) CitrixCustomerId(citrixCustomerId string) ApiGpoReadGpoPolicySetRequest { + r.citrixCustomerId = &citrixCustomerId + return r +} + +// Citrix Instance (Site) ID. +func (r ApiGpoReadGpoPolicySetRequest) CitrixInstanceId(citrixInstanceId string) ApiGpoReadGpoPolicySetRequest { + r.citrixInstanceId = &citrixInstanceId + return r +} + +// User Agent type of the request. +func (r ApiGpoReadGpoPolicySetRequest) UserAgent(userAgent string) ApiGpoReadGpoPolicySetRequest { + r.userAgent = &userAgent + return r +} + +// Citrix authorization header: CWSAuth Bearer={token} +func (r ApiGpoReadGpoPolicySetRequest) Authorization(authorization string) ApiGpoReadGpoPolicySetRequest { + r.authorization = &authorization + return r +} + +// Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. +func (r ApiGpoReadGpoPolicySetRequest) CitrixTransactionId(citrixTransactionId string) ApiGpoReadGpoPolicySetRequest { + r.citrixTransactionId = &citrixTransactionId + return r +} + +// Must accept application/json. +func (r ApiGpoReadGpoPolicySetRequest) Accept(accept string) ApiGpoReadGpoPolicySetRequest { + r.accept = &accept + return r +} + +// Locale of the request. +func (r ApiGpoReadGpoPolicySetRequest) CitrixLocale(citrixLocale string) ApiGpoReadGpoPolicySetRequest { + r.citrixLocale = &citrixLocale + return r +} + +// If set to true, read the policies in the policy set +func (r ApiGpoReadGpoPolicySetRequest) WithPolicies(withPolicies bool) ApiGpoReadGpoPolicySetRequest { + r.withPolicies = &withPolicies + return r +} + +func (r ApiGpoReadGpoPolicySetRequest) Execute() (*PolicySetResponse, *http.Response, error) { + return r.ApiService.GpoReadGpoPolicySetExecute(r) +} + +/* +GpoReadGpoPolicySet Read a GPO policy set. + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param policySetGuid GUID of the policy set to read + @return ApiGpoReadGpoPolicySetRequest +*/ +func (a *GpoDAASService) GpoReadGpoPolicySet(ctx context.Context, policySetGuid string) ApiGpoReadGpoPolicySetRequest { + return ApiGpoReadGpoPolicySetRequest{ + ApiService: a, + ctx: ctx, + policySetGuid: policySetGuid, + } +} + +// Execute executes the request +// @return PolicySetResponse +func (a *GpoDAASService) GpoReadGpoPolicySetExecute(r ApiGpoReadGpoPolicySetRequest) (*PolicySetResponse, *http.Response, error) { + var ( + localVarHTTPMethod = http.MethodGet + localVarPostBody interface{} + formFiles []formFile + localVarReturnValue *PolicySetResponse + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GpoDAASService.GpoReadGpoPolicySet") + if err != nil { + return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/gpo/policySets/{policySetGuid}" + localVarPath = strings.Replace(localVarPath, "{"+"policySetGuid"+"}", url.PathEscape(parameterValueToString(r.policySetGuid, "policySetGuid")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.citrixCustomerId == nil { + return localVarReturnValue, nil, reportError("citrixCustomerId is required and must be specified") + } + if r.citrixInstanceId == nil { + return localVarReturnValue, nil, reportError("citrixInstanceId is required and must be specified") + } + + if r.withPolicies != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "withPolicies", r.withPolicies, "") + } + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-CustomerId", r.citrixCustomerId, "") + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-InstanceId", r.citrixInstanceId, "") + if r.userAgent != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "User-Agent", r.userAgent, "") + } + if r.authorization != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Authorization", r.authorization, "") + } + if r.citrixTransactionId != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-TransactionId", r.citrixTransactionId, "") + } + if r.accept != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Accept", r.accept, "") + } + if r.citrixLocale != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-Locale", r.citrixLocale, "") + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["BearerAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 404 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 406 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 429 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 503 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiGpoReadGpoPolicySetsRequest struct { + ctx context.Context + ApiService *GpoDAASService + citrixCustomerId *string + citrixInstanceId *string + userAgent *string + authorization *string + citrixTransactionId *string + accept *string + citrixLocale *string +} + +// Citrix Customer ID. Default is 'CitrixOnPremises' +func (r ApiGpoReadGpoPolicySetsRequest) CitrixCustomerId(citrixCustomerId string) ApiGpoReadGpoPolicySetsRequest { + r.citrixCustomerId = &citrixCustomerId + return r +} + +// Citrix Instance (Site) ID. +func (r ApiGpoReadGpoPolicySetsRequest) CitrixInstanceId(citrixInstanceId string) ApiGpoReadGpoPolicySetsRequest { + r.citrixInstanceId = &citrixInstanceId + return r +} + +// User Agent type of the request. +func (r ApiGpoReadGpoPolicySetsRequest) UserAgent(userAgent string) ApiGpoReadGpoPolicySetsRequest { + r.userAgent = &userAgent + return r +} + +// Citrix authorization header: CWSAuth Bearer={token} +func (r ApiGpoReadGpoPolicySetsRequest) Authorization(authorization string) ApiGpoReadGpoPolicySetsRequest { + r.authorization = &authorization + return r +} + +// Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. +func (r ApiGpoReadGpoPolicySetsRequest) CitrixTransactionId(citrixTransactionId string) ApiGpoReadGpoPolicySetsRequest { + r.citrixTransactionId = &citrixTransactionId + return r +} + +// Must accept application/json. +func (r ApiGpoReadGpoPolicySetsRequest) Accept(accept string) ApiGpoReadGpoPolicySetsRequest { + r.accept = &accept + return r +} + +// Locale of the request. +func (r ApiGpoReadGpoPolicySetsRequest) CitrixLocale(citrixLocale string) ApiGpoReadGpoPolicySetsRequest { + r.citrixLocale = &citrixLocale + return r +} + +func (r ApiGpoReadGpoPolicySetsRequest) Execute() (*CollectionEnvelopeOfPolicySetResponse, *http.Response, error) { + return r.ApiService.GpoReadGpoPolicySetsExecute(r) +} + +/* +GpoReadGpoPolicySets Get all GPO policy sets in the site. + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @return ApiGpoReadGpoPolicySetsRequest +*/ +func (a *GpoDAASService) GpoReadGpoPolicySets(ctx context.Context) ApiGpoReadGpoPolicySetsRequest { + return ApiGpoReadGpoPolicySetsRequest{ + ApiService: a, + ctx: ctx, + } +} + +// Execute executes the request +// @return CollectionEnvelopeOfPolicySetResponse +func (a *GpoDAASService) GpoReadGpoPolicySetsExecute(r ApiGpoReadGpoPolicySetsRequest) (*CollectionEnvelopeOfPolicySetResponse, *http.Response, error) { + var ( + localVarHTTPMethod = http.MethodGet + localVarPostBody interface{} + formFiles []formFile + localVarReturnValue *CollectionEnvelopeOfPolicySetResponse + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GpoDAASService.GpoReadGpoPolicySets") + if err != nil { + return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/gpo/policySets" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.citrixCustomerId == nil { + return localVarReturnValue, nil, reportError("citrixCustomerId is required and must be specified") + } + if r.citrixInstanceId == nil { + return localVarReturnValue, nil, reportError("citrixInstanceId is required and must be specified") + } + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-CustomerId", r.citrixCustomerId, "") + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-InstanceId", r.citrixInstanceId, "") + if r.userAgent != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "User-Agent", r.userAgent, "") + } + if r.authorization != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Authorization", r.authorization, "") + } + if r.citrixTransactionId != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-TransactionId", r.citrixTransactionId, "") + } + if r.accept != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Accept", r.accept, "") + } + if r.citrixLocale != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-Locale", r.citrixLocale, "") + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["BearerAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 406 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 429 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 503 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiGpoReadGpoSettingRequest struct { + ctx context.Context + ApiService *GpoDAASService + citrixCustomerId *string + citrixInstanceId *string + settingGuid string + userAgent *string + authorization *string + citrixTransactionId *string + accept *string + citrixLocale *string +} + +// Citrix Customer ID. Default is 'CitrixOnPremises' +func (r ApiGpoReadGpoSettingRequest) CitrixCustomerId(citrixCustomerId string) ApiGpoReadGpoSettingRequest { + r.citrixCustomerId = &citrixCustomerId + return r +} + +// Citrix Instance (Site) ID. +func (r ApiGpoReadGpoSettingRequest) CitrixInstanceId(citrixInstanceId string) ApiGpoReadGpoSettingRequest { + r.citrixInstanceId = &citrixInstanceId + return r +} + +// User Agent type of the request. +func (r ApiGpoReadGpoSettingRequest) UserAgent(userAgent string) ApiGpoReadGpoSettingRequest { + r.userAgent = &userAgent + return r +} + +// Citrix authorization header: CWSAuth Bearer={token} +func (r ApiGpoReadGpoSettingRequest) Authorization(authorization string) ApiGpoReadGpoSettingRequest { + r.authorization = &authorization + return r +} + +// Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. +func (r ApiGpoReadGpoSettingRequest) CitrixTransactionId(citrixTransactionId string) ApiGpoReadGpoSettingRequest { + r.citrixTransactionId = &citrixTransactionId + return r +} + +// Must accept application/json. +func (r ApiGpoReadGpoSettingRequest) Accept(accept string) ApiGpoReadGpoSettingRequest { + r.accept = &accept + return r +} + +// Locale of the request. +func (r ApiGpoReadGpoSettingRequest) CitrixLocale(citrixLocale string) ApiGpoReadGpoSettingRequest { + r.citrixLocale = &citrixLocale + return r +} + +func (r ApiGpoReadGpoSettingRequest) Execute() (*SettingResponse, *http.Response, error) { + return r.ApiService.GpoReadGpoSettingExecute(r) +} + +/* +GpoReadGpoSetting Read a specific setting. + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param settingGuid GUID of the setting to be read + @return ApiGpoReadGpoSettingRequest +*/ +func (a *GpoDAASService) GpoReadGpoSetting(ctx context.Context, settingGuid string) ApiGpoReadGpoSettingRequest { + return ApiGpoReadGpoSettingRequest{ + ApiService: a, + ctx: ctx, + settingGuid: settingGuid, + } +} + +// Execute executes the request +// @return SettingResponse +func (a *GpoDAASService) GpoReadGpoSettingExecute(r ApiGpoReadGpoSettingRequest) (*SettingResponse, *http.Response, error) { + var ( + localVarHTTPMethod = http.MethodGet + localVarPostBody interface{} + formFiles []formFile + localVarReturnValue *SettingResponse + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GpoDAASService.GpoReadGpoSetting") + if err != nil { + return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/gpo/settings/{settingGuid}" + localVarPath = strings.Replace(localVarPath, "{"+"settingGuid"+"}", url.PathEscape(parameterValueToString(r.settingGuid, "settingGuid")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.citrixCustomerId == nil { + return localVarReturnValue, nil, reportError("citrixCustomerId is required and must be specified") + } + if r.citrixInstanceId == nil { + return localVarReturnValue, nil, reportError("citrixInstanceId is required and must be specified") + } + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-CustomerId", r.citrixCustomerId, "") + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-InstanceId", r.citrixInstanceId, "") + if r.userAgent != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "User-Agent", r.userAgent, "") + } + if r.authorization != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Authorization", r.authorization, "") + } + if r.citrixTransactionId != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-TransactionId", r.citrixTransactionId, "") + } + if r.accept != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Accept", r.accept, "") + } + if r.citrixLocale != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-Locale", r.citrixLocale, "") + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["BearerAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 404 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 406 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 429 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 503 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiGpoReadGpoSettingsRequest struct { + ctx context.Context + ApiService *GpoDAASService + citrixCustomerId *string + citrixInstanceId *string + policyGuid *string + userAgent *string + authorization *string + citrixTransactionId *string + accept *string + citrixLocale *string +} + +// Citrix Customer ID. Default is 'CitrixOnPremises' +func (r ApiGpoReadGpoSettingsRequest) CitrixCustomerId(citrixCustomerId string) ApiGpoReadGpoSettingsRequest { + r.citrixCustomerId = &citrixCustomerId + return r +} + +// Citrix Instance (Site) ID. +func (r ApiGpoReadGpoSettingsRequest) CitrixInstanceId(citrixInstanceId string) ApiGpoReadGpoSettingsRequest { + r.citrixInstanceId = &citrixInstanceId + return r +} + +// GUID of the policy from which settings are read +func (r ApiGpoReadGpoSettingsRequest) PolicyGuid(policyGuid string) ApiGpoReadGpoSettingsRequest { + r.policyGuid = &policyGuid + return r +} + +// User Agent type of the request. +func (r ApiGpoReadGpoSettingsRequest) UserAgent(userAgent string) ApiGpoReadGpoSettingsRequest { + r.userAgent = &userAgent + return r +} + +// Citrix authorization header: CWSAuth Bearer={token} +func (r ApiGpoReadGpoSettingsRequest) Authorization(authorization string) ApiGpoReadGpoSettingsRequest { + r.authorization = &authorization + return r +} + +// Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. +func (r ApiGpoReadGpoSettingsRequest) CitrixTransactionId(citrixTransactionId string) ApiGpoReadGpoSettingsRequest { + r.citrixTransactionId = &citrixTransactionId + return r +} + +// Must accept application/json. +func (r ApiGpoReadGpoSettingsRequest) Accept(accept string) ApiGpoReadGpoSettingsRequest { + r.accept = &accept + return r +} + +// Locale of the request. +func (r ApiGpoReadGpoSettingsRequest) CitrixLocale(citrixLocale string) ApiGpoReadGpoSettingsRequest { + r.citrixLocale = &citrixLocale + return r +} + +func (r ApiGpoReadGpoSettingsRequest) Execute() (*CollectionEnvelopeOfSettingResponse, *http.Response, error) { + return r.ApiService.GpoReadGpoSettingsExecute(r) +} + +/* +GpoReadGpoSettings Read settings defined in a policy. + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @return ApiGpoReadGpoSettingsRequest +*/ +func (a *GpoDAASService) GpoReadGpoSettings(ctx context.Context) ApiGpoReadGpoSettingsRequest { + return ApiGpoReadGpoSettingsRequest{ + ApiService: a, + ctx: ctx, + } +} + +// Execute executes the request +// @return CollectionEnvelopeOfSettingResponse +func (a *GpoDAASService) GpoReadGpoSettingsExecute(r ApiGpoReadGpoSettingsRequest) (*CollectionEnvelopeOfSettingResponse, *http.Response, error) { + var ( + localVarHTTPMethod = http.MethodGet + localVarPostBody interface{} + formFiles []formFile + localVarReturnValue *CollectionEnvelopeOfSettingResponse + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GpoDAASService.GpoReadGpoSettings") + if err != nil { + return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/gpo/settings" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.citrixCustomerId == nil { + return localVarReturnValue, nil, reportError("citrixCustomerId is required and must be specified") + } + if r.citrixInstanceId == nil { + return localVarReturnValue, nil, reportError("citrixInstanceId is required and must be specified") + } + if r.policyGuid == nil { + return localVarReturnValue, nil, reportError("policyGuid is required and must be specified") + } + + parameterAddToHeaderOrQuery(localVarQueryParams, "policyGuid", r.policyGuid, "") + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-CustomerId", r.citrixCustomerId, "") + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-InstanceId", r.citrixInstanceId, "") + if r.userAgent != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "User-Agent", r.userAgent, "") + } + if r.authorization != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Authorization", r.authorization, "") + } + if r.citrixTransactionId != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-TransactionId", r.citrixTransactionId, "") + } + if r.accept != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Accept", r.accept, "") + } + if r.citrixLocale != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-Locale", r.citrixLocale, "") + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["BearerAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 406 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 429 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 503 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiGpoRemoveGpoPoliciesRequest struct { + ctx context.Context + ApiService *GpoDAASService + citrixCustomerId *string + citrixInstanceId *string + requestBody *[]string + userAgent *string + authorization *string + citrixTransactionId *string + accept *string + citrixLocale *string +} + +// Citrix Customer ID. Default is 'CitrixOnPremises' +func (r ApiGpoRemoveGpoPoliciesRequest) CitrixCustomerId(citrixCustomerId string) ApiGpoRemoveGpoPoliciesRequest { + r.citrixCustomerId = &citrixCustomerId + return r +} + +// Citrix Instance (Site) ID. +func (r ApiGpoRemoveGpoPoliciesRequest) CitrixInstanceId(citrixInstanceId string) ApiGpoRemoveGpoPoliciesRequest { + r.citrixInstanceId = &citrixInstanceId + return r +} + +// GUIDs of the policies to be removed +func (r ApiGpoRemoveGpoPoliciesRequest) RequestBody(requestBody []string) ApiGpoRemoveGpoPoliciesRequest { + r.requestBody = &requestBody + return r +} + +// User Agent type of the request. +func (r ApiGpoRemoveGpoPoliciesRequest) UserAgent(userAgent string) ApiGpoRemoveGpoPoliciesRequest { + r.userAgent = &userAgent + return r +} + +// Citrix authorization header: CWSAuth Bearer={token} +func (r ApiGpoRemoveGpoPoliciesRequest) Authorization(authorization string) ApiGpoRemoveGpoPoliciesRequest { + r.authorization = &authorization + return r +} + +// Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. +func (r ApiGpoRemoveGpoPoliciesRequest) CitrixTransactionId(citrixTransactionId string) ApiGpoRemoveGpoPoliciesRequest { + r.citrixTransactionId = &citrixTransactionId + return r +} + +// Must accept application/json. +func (r ApiGpoRemoveGpoPoliciesRequest) Accept(accept string) ApiGpoRemoveGpoPoliciesRequest { + r.accept = &accept + return r +} + +// Locale of the request. +func (r ApiGpoRemoveGpoPoliciesRequest) CitrixLocale(citrixLocale string) ApiGpoRemoveGpoPoliciesRequest { + r.citrixLocale = &citrixLocale + return r +} + +func (r ApiGpoRemoveGpoPoliciesRequest) Execute() (*http.Response, error) { + return r.ApiService.GpoRemoveGpoPoliciesExecute(r) +} + +/* +GpoRemoveGpoPolicies Remove some policies of a policy set. + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @return ApiGpoRemoveGpoPoliciesRequest +*/ +func (a *GpoDAASService) GpoRemoveGpoPolicies(ctx context.Context) ApiGpoRemoveGpoPoliciesRequest { + return ApiGpoRemoveGpoPoliciesRequest{ + ApiService: a, + ctx: ctx, + } +} + +// Execute executes the request +func (a *GpoDAASService) GpoRemoveGpoPoliciesExecute(r ApiGpoRemoveGpoPoliciesRequest) (*http.Response, error) { + var ( + localVarHTTPMethod = http.MethodPost + localVarPostBody interface{} + formFiles []formFile + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GpoDAASService.GpoRemoveGpoPolicies") + if err != nil { + return nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/gpo/policies/$remove" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.citrixCustomerId == nil { + return nil, reportError("citrixCustomerId is required and must be specified") + } + if r.citrixInstanceId == nil { + return nil, reportError("citrixInstanceId is required and must be specified") + } + if r.requestBody == nil { + return nil, reportError("requestBody is required and must be specified") + } + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-CustomerId", r.citrixCustomerId, "") + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-InstanceId", r.citrixInstanceId, "") + if r.userAgent != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "User-Agent", r.userAgent, "") + } + if r.authorization != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Authorization", r.authorization, "") + } + if r.citrixTransactionId != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-TransactionId", r.citrixTransactionId, "") + } + if r.accept != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Accept", r.accept, "") + } + if r.citrixLocale != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-Locale", r.citrixLocale, "") + } + // body params + localVarPostBody = r.requestBody + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["BearerAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarHTTPResponse, err + } + + localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 406 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 409 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 415 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 429 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 503 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarHTTPResponse, newErr + } + + return localVarHTTPResponse, nil +} + +type ApiGpoRunSimulationRequest struct { + ctx context.Context + ApiService *GpoDAASService + citrixCustomerId *string + citrixInstanceId *string + policySetGuid *string + simulationRequestContract *SimulationRequestContract + userAgent *string + authorization *string + citrixTransactionId *string + accept *string + citrixLocale *string +} + +// Citrix Customer ID. Default is 'CitrixOnPremises' +func (r ApiGpoRunSimulationRequest) CitrixCustomerId(citrixCustomerId string) ApiGpoRunSimulationRequest { + r.citrixCustomerId = &citrixCustomerId + return r +} + +// Citrix Instance (Site) ID. +func (r ApiGpoRunSimulationRequest) CitrixInstanceId(citrixInstanceId string) ApiGpoRunSimulationRequest { + r.citrixInstanceId = &citrixInstanceId + return r +} + +// The GUID of the policy set, on which this simulation is run +func (r ApiGpoRunSimulationRequest) PolicySetGuid(policySetGuid string) ApiGpoRunSimulationRequest { + r.policySetGuid = &policySetGuid + return r +} + +// Modeling request +func (r ApiGpoRunSimulationRequest) SimulationRequestContract(simulationRequestContract SimulationRequestContract) ApiGpoRunSimulationRequest { + r.simulationRequestContract = &simulationRequestContract + return r +} + +// User Agent type of the request. +func (r ApiGpoRunSimulationRequest) UserAgent(userAgent string) ApiGpoRunSimulationRequest { + r.userAgent = &userAgent + return r +} + +// Citrix authorization header: CWSAuth Bearer={token} +func (r ApiGpoRunSimulationRequest) Authorization(authorization string) ApiGpoRunSimulationRequest { + r.authorization = &authorization + return r +} + +// Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. +func (r ApiGpoRunSimulationRequest) CitrixTransactionId(citrixTransactionId string) ApiGpoRunSimulationRequest { + r.citrixTransactionId = &citrixTransactionId + return r +} + +// Must accept application/json. +func (r ApiGpoRunSimulationRequest) Accept(accept string) ApiGpoRunSimulationRequest { + r.accept = &accept + return r +} + +// Locale of the request. +func (r ApiGpoRunSimulationRequest) CitrixLocale(citrixLocale string) ApiGpoRunSimulationRequest { + r.citrixLocale = &citrixLocale + return r +} + +func (r ApiGpoRunSimulationRequest) Execute() ([]SimulationResponseContract, *http.Response, error) { + return r.ApiService.GpoRunSimulationExecute(r) +} + +/* +GpoRunSimulation Simulate policy application. + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @return ApiGpoRunSimulationRequest +*/ +func (a *GpoDAASService) GpoRunSimulation(ctx context.Context) ApiGpoRunSimulationRequest { + return ApiGpoRunSimulationRequest{ + ApiService: a, + ctx: ctx, + } +} + +// Execute executes the request +// @return []SimulationResponseContract +func (a *GpoDAASService) GpoRunSimulationExecute(r ApiGpoRunSimulationRequest) ([]SimulationResponseContract, *http.Response, error) { + var ( + localVarHTTPMethod = http.MethodPost + localVarPostBody interface{} + formFiles []formFile + localVarReturnValue []SimulationResponseContract + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GpoDAASService.GpoRunSimulation") + if err != nil { + return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/gpo/simulation" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.citrixCustomerId == nil { + return localVarReturnValue, nil, reportError("citrixCustomerId is required and must be specified") + } + if r.citrixInstanceId == nil { + return localVarReturnValue, nil, reportError("citrixInstanceId is required and must be specified") + } + if r.policySetGuid == nil { + return localVarReturnValue, nil, reportError("policySetGuid is required and must be specified") + } + if r.simulationRequestContract == nil { + return localVarReturnValue, nil, reportError("simulationRequestContract is required and must be specified") + } + + parameterAddToHeaderOrQuery(localVarQueryParams, "policySetGuid", r.policySetGuid, "") + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-CustomerId", r.citrixCustomerId, "") + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-InstanceId", r.citrixInstanceId, "") + if r.userAgent != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "User-Agent", r.userAgent, "") + } + if r.authorization != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Authorization", r.authorization, "") + } + if r.citrixTransactionId != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-TransactionId", r.citrixTransactionId, "") + } + if r.accept != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Accept", r.accept, "") + } + if r.citrixLocale != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-Locale", r.citrixLocale, "") + } + // body params + localVarPostBody = r.simulationRequestContract + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["BearerAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 406 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 409 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 415 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 429 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 503 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiGpoSearchFiltersRequest struct { + ctx context.Context + ApiService *GpoDAASService + citrixCustomerId *string + citrixInstanceId *string + filterSearch *FilterSearch + userAgent *string + authorization *string + citrixTransactionId *string + accept *string + citrixLocale *string + limit *int32 + continuationToken *string + async *bool +} + +// Citrix Customer ID. Default is 'CitrixOnPremises' +func (r ApiGpoSearchFiltersRequest) CitrixCustomerId(citrixCustomerId string) ApiGpoSearchFiltersRequest { + r.citrixCustomerId = &citrixCustomerId + return r +} + +// Citrix Instance (Site) ID. +func (r ApiGpoSearchFiltersRequest) CitrixInstanceId(citrixInstanceId string) ApiGpoSearchFiltersRequest { + r.citrixInstanceId = &citrixInstanceId + return r +} + +// Specifies the advanced search parameters. +func (r ApiGpoSearchFiltersRequest) FilterSearch(filterSearch FilterSearch) ApiGpoSearchFiltersRequest { + r.filterSearch = &filterSearch + return r +} + +// User Agent type of the request. +func (r ApiGpoSearchFiltersRequest) UserAgent(userAgent string) ApiGpoSearchFiltersRequest { + r.userAgent = &userAgent + return r +} + +// Citrix authorization header: CWSAuth Bearer={token} +func (r ApiGpoSearchFiltersRequest) Authorization(authorization string) ApiGpoSearchFiltersRequest { + r.authorization = &authorization + return r +} + +// Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. +func (r ApiGpoSearchFiltersRequest) CitrixTransactionId(citrixTransactionId string) ApiGpoSearchFiltersRequest { + r.citrixTransactionId = &citrixTransactionId + return r +} + +// Must accept application/json. +func (r ApiGpoSearchFiltersRequest) Accept(accept string) ApiGpoSearchFiltersRequest { + r.accept = &accept + return r +} + +// Locale of the request. +func (r ApiGpoSearchFiltersRequest) CitrixLocale(citrixLocale string) ApiGpoSearchFiltersRequest { + r.citrixLocale = &citrixLocale + return r +} + +// Maximum number of objects, which must not exceed 1000, to return. If not specified, the default value is 250. +func (r ApiGpoSearchFiltersRequest) Limit(limit int32) ApiGpoSearchFiltersRequest { + r.limit = &limit + return r +} + +// If a previous call didn't return all the records expected, pass the continuation token returned from the previous response to this current query to continue retrieving the remaining objects. +func (r ApiGpoSearchFiltersRequest) ContinuationToken(continuationToken string) ApiGpoSearchFiltersRequest { + r.continuationToken = &continuationToken + return r +} + +// If `true`, the search operations will be executed as a background task. +func (r ApiGpoSearchFiltersRequest) Async(async bool) ApiGpoSearchFiltersRequest { + r.async = &async + return r +} + +func (r ApiGpoSearchFiltersRequest) Execute() (*CollectionEnvelopeOfFilterResponse, *http.Response, error) { + return r.ApiService.GpoSearchFiltersExecute(r) +} + +/* +GpoSearchFilters Perform an advanced search for GPO filters. + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @return ApiGpoSearchFiltersRequest +*/ +func (a *GpoDAASService) GpoSearchFilters(ctx context.Context) ApiGpoSearchFiltersRequest { + return ApiGpoSearchFiltersRequest{ + ApiService: a, + ctx: ctx, + } +} + +// Execute executes the request +// @return CollectionEnvelopeOfFilterResponse +func (a *GpoDAASService) GpoSearchFiltersExecute(r ApiGpoSearchFiltersRequest) (*CollectionEnvelopeOfFilterResponse, *http.Response, error) { + var ( + localVarHTTPMethod = http.MethodPost + localVarPostBody interface{} + formFiles []formFile + localVarReturnValue *CollectionEnvelopeOfFilterResponse + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GpoDAASService.GpoSearchFilters") + if err != nil { + return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/gpo/filters/$search" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.citrixCustomerId == nil { + return localVarReturnValue, nil, reportError("citrixCustomerId is required and must be specified") + } + if r.citrixInstanceId == nil { + return localVarReturnValue, nil, reportError("citrixInstanceId is required and must be specified") + } + if r.filterSearch == nil { + return localVarReturnValue, nil, reportError("filterSearch is required and must be specified") + } + + if r.limit != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "limit", r.limit, "") + } + if r.continuationToken != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "continuationToken", r.continuationToken, "") + } + if r.async != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "async", r.async, "") + } + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-CustomerId", r.citrixCustomerId, "") + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-InstanceId", r.citrixInstanceId, "") + if r.userAgent != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "User-Agent", r.userAgent, "") + } + if r.authorization != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Authorization", r.authorization, "") + } + if r.citrixTransactionId != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-TransactionId", r.citrixTransactionId, "") + } + if r.accept != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Accept", r.accept, "") + } + if r.citrixLocale != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-Locale", r.citrixLocale, "") + } + // body params + localVarPostBody = r.filterSearch + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["BearerAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 406 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 409 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 415 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 429 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 503 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiGpoSearchPoliciesRequest struct { + ctx context.Context + ApiService *GpoDAASService + citrixCustomerId *string + citrixInstanceId *string + policySearch *PolicySearch + userAgent *string + authorization *string + citrixTransactionId *string + accept *string + citrixLocale *string + limit *int32 + continuationToken *string + async *bool +} + +// Citrix Customer ID. Default is 'CitrixOnPremises' +func (r ApiGpoSearchPoliciesRequest) CitrixCustomerId(citrixCustomerId string) ApiGpoSearchPoliciesRequest { + r.citrixCustomerId = &citrixCustomerId + return r +} + +// Citrix Instance (Site) ID. +func (r ApiGpoSearchPoliciesRequest) CitrixInstanceId(citrixInstanceId string) ApiGpoSearchPoliciesRequest { + r.citrixInstanceId = &citrixInstanceId + return r +} + +// Specifies the advanced search parameters. +func (r ApiGpoSearchPoliciesRequest) PolicySearch(policySearch PolicySearch) ApiGpoSearchPoliciesRequest { + r.policySearch = &policySearch + return r +} + +// User Agent type of the request. +func (r ApiGpoSearchPoliciesRequest) UserAgent(userAgent string) ApiGpoSearchPoliciesRequest { + r.userAgent = &userAgent + return r +} + +// Citrix authorization header: CWSAuth Bearer={token} +func (r ApiGpoSearchPoliciesRequest) Authorization(authorization string) ApiGpoSearchPoliciesRequest { + r.authorization = &authorization + return r +} + +// Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. +func (r ApiGpoSearchPoliciesRequest) CitrixTransactionId(citrixTransactionId string) ApiGpoSearchPoliciesRequest { + r.citrixTransactionId = &citrixTransactionId + return r +} + +// Must accept application/json. +func (r ApiGpoSearchPoliciesRequest) Accept(accept string) ApiGpoSearchPoliciesRequest { + r.accept = &accept + return r +} + +// Locale of the request. +func (r ApiGpoSearchPoliciesRequest) CitrixLocale(citrixLocale string) ApiGpoSearchPoliciesRequest { + r.citrixLocale = &citrixLocale + return r +} + +// Maximum number of objects, which must not exceed 1000, to return. If not specified, the default value is 250. +func (r ApiGpoSearchPoliciesRequest) Limit(limit int32) ApiGpoSearchPoliciesRequest { + r.limit = &limit + return r +} + +// If a previous call didn't return all the records expected, pass the continuation token returned from the previous response to this current query to continue retrieving the remaining objects. +func (r ApiGpoSearchPoliciesRequest) ContinuationToken(continuationToken string) ApiGpoSearchPoliciesRequest { + r.continuationToken = &continuationToken + return r +} + +// If `true`, the search operations will be executed as a background task. +func (r ApiGpoSearchPoliciesRequest) Async(async bool) ApiGpoSearchPoliciesRequest { + r.async = &async + return r +} + +func (r ApiGpoSearchPoliciesRequest) Execute() (*CollectionEnvelopeOfPolicyResponse, *http.Response, error) { + return r.ApiService.GpoSearchPoliciesExecute(r) +} + +/* +GpoSearchPolicies Perform an advanced search for GPO policies. + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @return ApiGpoSearchPoliciesRequest +*/ +func (a *GpoDAASService) GpoSearchPolicies(ctx context.Context) ApiGpoSearchPoliciesRequest { + return ApiGpoSearchPoliciesRequest{ + ApiService: a, + ctx: ctx, + } +} + +// Execute executes the request +// @return CollectionEnvelopeOfPolicyResponse +func (a *GpoDAASService) GpoSearchPoliciesExecute(r ApiGpoSearchPoliciesRequest) (*CollectionEnvelopeOfPolicyResponse, *http.Response, error) { + var ( + localVarHTTPMethod = http.MethodPost + localVarPostBody interface{} + formFiles []formFile + localVarReturnValue *CollectionEnvelopeOfPolicyResponse + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GpoDAASService.GpoSearchPolicies") + if err != nil { + return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/gpo/policies/$search" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.citrixCustomerId == nil { + return localVarReturnValue, nil, reportError("citrixCustomerId is required and must be specified") + } + if r.citrixInstanceId == nil { + return localVarReturnValue, nil, reportError("citrixInstanceId is required and must be specified") + } + if r.policySearch == nil { + return localVarReturnValue, nil, reportError("policySearch is required and must be specified") + } + + if r.limit != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "limit", r.limit, "") + } + if r.continuationToken != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "continuationToken", r.continuationToken, "") + } + if r.async != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "async", r.async, "") + } + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-CustomerId", r.citrixCustomerId, "") + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-InstanceId", r.citrixInstanceId, "") + if r.userAgent != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "User-Agent", r.userAgent, "") + } + if r.authorization != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Authorization", r.authorization, "") + } + if r.citrixTransactionId != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-TransactionId", r.citrixTransactionId, "") + } + if r.accept != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Accept", r.accept, "") + } + if r.citrixLocale != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-Locale", r.citrixLocale, "") + } + // body params + localVarPostBody = r.policySearch + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["BearerAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 406 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 409 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 415 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 429 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 503 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiGpoSearchPolicySetsRequest struct { + ctx context.Context + ApiService *GpoDAASService + citrixCustomerId *string + citrixInstanceId *string + policySetSearch *PolicySetSearch + userAgent *string + authorization *string + citrixTransactionId *string + accept *string + citrixLocale *string + limit *int32 + continuationToken *string + async *bool +} + +// Citrix Customer ID. Default is 'CitrixOnPremises' +func (r ApiGpoSearchPolicySetsRequest) CitrixCustomerId(citrixCustomerId string) ApiGpoSearchPolicySetsRequest { + r.citrixCustomerId = &citrixCustomerId + return r +} + +// Citrix Instance (Site) ID. +func (r ApiGpoSearchPolicySetsRequest) CitrixInstanceId(citrixInstanceId string) ApiGpoSearchPolicySetsRequest { + r.citrixInstanceId = &citrixInstanceId + return r +} + +// Specifies the advanced search parameters. +func (r ApiGpoSearchPolicySetsRequest) PolicySetSearch(policySetSearch PolicySetSearch) ApiGpoSearchPolicySetsRequest { + r.policySetSearch = &policySetSearch + return r +} + +// User Agent type of the request. +func (r ApiGpoSearchPolicySetsRequest) UserAgent(userAgent string) ApiGpoSearchPolicySetsRequest { + r.userAgent = &userAgent + return r +} + +// Citrix authorization header: CWSAuth Bearer={token} +func (r ApiGpoSearchPolicySetsRequest) Authorization(authorization string) ApiGpoSearchPolicySetsRequest { + r.authorization = &authorization + return r +} + +// Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. +func (r ApiGpoSearchPolicySetsRequest) CitrixTransactionId(citrixTransactionId string) ApiGpoSearchPolicySetsRequest { + r.citrixTransactionId = &citrixTransactionId + return r +} + +// Must accept application/json. +func (r ApiGpoSearchPolicySetsRequest) Accept(accept string) ApiGpoSearchPolicySetsRequest { + r.accept = &accept + return r +} + +// Locale of the request. +func (r ApiGpoSearchPolicySetsRequest) CitrixLocale(citrixLocale string) ApiGpoSearchPolicySetsRequest { + r.citrixLocale = &citrixLocale + return r +} + +// Maximum number of objects, which must not exceed 1000, to return. If not specified, the default value is 250. +func (r ApiGpoSearchPolicySetsRequest) Limit(limit int32) ApiGpoSearchPolicySetsRequest { + r.limit = &limit + return r +} + +// If a previous call didn't return all the records expected, pass the continuation token returned from the previous response to this current query to continue retrieving the remaining objects. +func (r ApiGpoSearchPolicySetsRequest) ContinuationToken(continuationToken string) ApiGpoSearchPolicySetsRequest { + r.continuationToken = &continuationToken + return r +} + +// If `true`, the search operations will be executed as a background task. +func (r ApiGpoSearchPolicySetsRequest) Async(async bool) ApiGpoSearchPolicySetsRequest { + r.async = &async + return r +} + +func (r ApiGpoSearchPolicySetsRequest) Execute() (*CollectionEnvelopeOfPolicySetResponse, *http.Response, error) { + return r.ApiService.GpoSearchPolicySetsExecute(r) +} + +/* +GpoSearchPolicySets Perform an advanced search for GPO policy sets. + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @return ApiGpoSearchPolicySetsRequest +*/ +func (a *GpoDAASService) GpoSearchPolicySets(ctx context.Context) ApiGpoSearchPolicySetsRequest { + return ApiGpoSearchPolicySetsRequest{ + ApiService: a, + ctx: ctx, + } +} + +// Execute executes the request +// @return CollectionEnvelopeOfPolicySetResponse +func (a *GpoDAASService) GpoSearchPolicySetsExecute(r ApiGpoSearchPolicySetsRequest) (*CollectionEnvelopeOfPolicySetResponse, *http.Response, error) { + var ( + localVarHTTPMethod = http.MethodPost + localVarPostBody interface{} + formFiles []formFile + localVarReturnValue *CollectionEnvelopeOfPolicySetResponse + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GpoDAASService.GpoSearchPolicySets") + if err != nil { + return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/gpo/policySets/$search" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.citrixCustomerId == nil { + return localVarReturnValue, nil, reportError("citrixCustomerId is required and must be specified") + } + if r.citrixInstanceId == nil { + return localVarReturnValue, nil, reportError("citrixInstanceId is required and must be specified") + } + if r.policySetSearch == nil { + return localVarReturnValue, nil, reportError("policySetSearch is required and must be specified") + } + + if r.limit != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "limit", r.limit, "") + } + if r.continuationToken != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "continuationToken", r.continuationToken, "") + } + if r.async != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "async", r.async, "") + } + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-CustomerId", r.citrixCustomerId, "") + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-InstanceId", r.citrixInstanceId, "") + if r.userAgent != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "User-Agent", r.userAgent, "") + } + if r.authorization != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Authorization", r.authorization, "") + } + if r.citrixTransactionId != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-TransactionId", r.citrixTransactionId, "") + } + if r.accept != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Accept", r.accept, "") + } + if r.citrixLocale != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-Locale", r.citrixLocale, "") + } + // body params + localVarPostBody = r.policySetSearch + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["BearerAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 406 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 409 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 415 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 429 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 503 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiGpoSearchSettingsRequest struct { + ctx context.Context + ApiService *GpoDAASService + citrixCustomerId *string + citrixInstanceId *string + settingSearch *SettingSearch + userAgent *string + authorization *string + citrixTransactionId *string + accept *string + citrixLocale *string + limit *int32 + continuationToken *string + async *bool +} + +// Citrix Customer ID. Default is 'CitrixOnPremises' +func (r ApiGpoSearchSettingsRequest) CitrixCustomerId(citrixCustomerId string) ApiGpoSearchSettingsRequest { + r.citrixCustomerId = &citrixCustomerId + return r +} + +// Citrix Instance (Site) ID. +func (r ApiGpoSearchSettingsRequest) CitrixInstanceId(citrixInstanceId string) ApiGpoSearchSettingsRequest { + r.citrixInstanceId = &citrixInstanceId + return r +} + +// Specifies the advanced search parameters. +func (r ApiGpoSearchSettingsRequest) SettingSearch(settingSearch SettingSearch) ApiGpoSearchSettingsRequest { + r.settingSearch = &settingSearch + return r +} + +// User Agent type of the request. +func (r ApiGpoSearchSettingsRequest) UserAgent(userAgent string) ApiGpoSearchSettingsRequest { + r.userAgent = &userAgent + return r +} + +// Citrix authorization header: CWSAuth Bearer={token} +func (r ApiGpoSearchSettingsRequest) Authorization(authorization string) ApiGpoSearchSettingsRequest { + r.authorization = &authorization + return r +} + +// Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. +func (r ApiGpoSearchSettingsRequest) CitrixTransactionId(citrixTransactionId string) ApiGpoSearchSettingsRequest { + r.citrixTransactionId = &citrixTransactionId + return r +} + +// Must accept application/json. +func (r ApiGpoSearchSettingsRequest) Accept(accept string) ApiGpoSearchSettingsRequest { + r.accept = &accept + return r +} + +// Locale of the request. +func (r ApiGpoSearchSettingsRequest) CitrixLocale(citrixLocale string) ApiGpoSearchSettingsRequest { + r.citrixLocale = &citrixLocale + return r +} + +// Maximum number of objects, which must not exceed 1000, to return. If not specified, the default value is 250. +func (r ApiGpoSearchSettingsRequest) Limit(limit int32) ApiGpoSearchSettingsRequest { + r.limit = &limit + return r +} + +// If a previous call didn't return all the records expected, pass the continuation token returned from the previous response to this current query to continue retrieving the remaining objects. +func (r ApiGpoSearchSettingsRequest) ContinuationToken(continuationToken string) ApiGpoSearchSettingsRequest { + r.continuationToken = &continuationToken + return r +} + +// If `true`, the search operations will be executed as a background task. +func (r ApiGpoSearchSettingsRequest) Async(async bool) ApiGpoSearchSettingsRequest { + r.async = &async + return r +} + +func (r ApiGpoSearchSettingsRequest) Execute() (*CollectionEnvelopeOfSettingResponse, *http.Response, error) { + return r.ApiService.GpoSearchSettingsExecute(r) +} + +/* +GpoSearchSettings Perform an advanced search for GPO settings. + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @return ApiGpoSearchSettingsRequest +*/ +func (a *GpoDAASService) GpoSearchSettings(ctx context.Context) ApiGpoSearchSettingsRequest { + return ApiGpoSearchSettingsRequest{ + ApiService: a, + ctx: ctx, + } +} + +// Execute executes the request +// @return CollectionEnvelopeOfSettingResponse +func (a *GpoDAASService) GpoSearchSettingsExecute(r ApiGpoSearchSettingsRequest) (*CollectionEnvelopeOfSettingResponse, *http.Response, error) { + var ( + localVarHTTPMethod = http.MethodPost + localVarPostBody interface{} + formFiles []formFile + localVarReturnValue *CollectionEnvelopeOfSettingResponse + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GpoDAASService.GpoSearchSettings") + if err != nil { + return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/gpo/settings/$search" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.citrixCustomerId == nil { + return localVarReturnValue, nil, reportError("citrixCustomerId is required and must be specified") + } + if r.citrixInstanceId == nil { + return localVarReturnValue, nil, reportError("citrixInstanceId is required and must be specified") + } + if r.settingSearch == nil { + return localVarReturnValue, nil, reportError("settingSearch is required and must be specified") + } + + if r.limit != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "limit", r.limit, "") + } + if r.continuationToken != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "continuationToken", r.continuationToken, "") + } + if r.async != nil { + parameterAddToHeaderOrQuery(localVarQueryParams, "async", r.async, "") + } + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-CustomerId", r.citrixCustomerId, "") + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-InstanceId", r.citrixInstanceId, "") + if r.userAgent != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "User-Agent", r.userAgent, "") + } + if r.authorization != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Authorization", r.authorization, "") + } + if r.citrixTransactionId != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-TransactionId", r.citrixTransactionId, "") + } + if r.accept != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Accept", r.accept, "") + } + if r.citrixLocale != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-Locale", r.citrixLocale, "") + } + // body params + localVarPostBody = r.settingSearch + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["BearerAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 406 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 409 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 415 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 429 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 503 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type ApiGpoUpdateGpoFilterRequest struct { + ctx context.Context + ApiService *GpoDAASService + citrixCustomerId *string + citrixInstanceId *string + filterGuid string + filterRequest *FilterRequest + userAgent *string + authorization *string + citrixTransactionId *string + accept *string + citrixLocale *string +} + +// Citrix Customer ID. Default is 'CitrixOnPremises' +func (r ApiGpoUpdateGpoFilterRequest) CitrixCustomerId(citrixCustomerId string) ApiGpoUpdateGpoFilterRequest { + r.citrixCustomerId = &citrixCustomerId + return r +} + +// Citrix Instance (Site) ID. +func (r ApiGpoUpdateGpoFilterRequest) CitrixInstanceId(citrixInstanceId string) ApiGpoUpdateGpoFilterRequest { + r.citrixInstanceId = &citrixInstanceId + return r +} + +// Filter data. The filter type is ignored +func (r ApiGpoUpdateGpoFilterRequest) FilterRequest(filterRequest FilterRequest) ApiGpoUpdateGpoFilterRequest { + r.filterRequest = &filterRequest + return r +} + +// User Agent type of the request. +func (r ApiGpoUpdateGpoFilterRequest) UserAgent(userAgent string) ApiGpoUpdateGpoFilterRequest { + r.userAgent = &userAgent + return r +} + +// Citrix authorization header: CWSAuth Bearer={token} +func (r ApiGpoUpdateGpoFilterRequest) Authorization(authorization string) ApiGpoUpdateGpoFilterRequest { + r.authorization = &authorization + return r +} + +// Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. +func (r ApiGpoUpdateGpoFilterRequest) CitrixTransactionId(citrixTransactionId string) ApiGpoUpdateGpoFilterRequest { + r.citrixTransactionId = &citrixTransactionId + return r +} + +// Must accept application/json. +func (r ApiGpoUpdateGpoFilterRequest) Accept(accept string) ApiGpoUpdateGpoFilterRequest { + r.accept = &accept + return r +} + +// Locale of the request. +func (r ApiGpoUpdateGpoFilterRequest) CitrixLocale(citrixLocale string) ApiGpoUpdateGpoFilterRequest { + r.citrixLocale = &citrixLocale + return r +} + +func (r ApiGpoUpdateGpoFilterRequest) Execute() (*http.Response, error) { + return r.ApiService.GpoUpdateGpoFilterExecute(r) +} + +/* +GpoUpdateGpoFilter Update an existing filter. + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param filterGuid The GUID of the filter to be updated + @return ApiGpoUpdateGpoFilterRequest +*/ +func (a *GpoDAASService) GpoUpdateGpoFilter(ctx context.Context, filterGuid string) ApiGpoUpdateGpoFilterRequest { + return ApiGpoUpdateGpoFilterRequest{ + ApiService: a, + ctx: ctx, + filterGuid: filterGuid, + } +} + +// Execute executes the request +func (a *GpoDAASService) GpoUpdateGpoFilterExecute(r ApiGpoUpdateGpoFilterRequest) (*http.Response, error) { + var ( + localVarHTTPMethod = http.MethodPatch + localVarPostBody interface{} + formFiles []formFile + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GpoDAASService.GpoUpdateGpoFilter") + if err != nil { + return nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/gpo/filters/{filterGuid}" + localVarPath = strings.Replace(localVarPath, "{"+"filterGuid"+"}", url.PathEscape(parameterValueToString(r.filterGuid, "filterGuid")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.citrixCustomerId == nil { + return nil, reportError("citrixCustomerId is required and must be specified") + } + if r.citrixInstanceId == nil { + return nil, reportError("citrixInstanceId is required and must be specified") + } + if r.filterRequest == nil { + return nil, reportError("filterRequest is required and must be specified") + } + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-CustomerId", r.citrixCustomerId, "") + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-InstanceId", r.citrixInstanceId, "") + if r.userAgent != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "User-Agent", r.userAgent, "") + } + if r.authorization != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Authorization", r.authorization, "") + } + if r.citrixTransactionId != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-TransactionId", r.citrixTransactionId, "") + } + if r.accept != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Accept", r.accept, "") + } + if r.citrixLocale != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-Locale", r.citrixLocale, "") + } + // body params + localVarPostBody = r.filterRequest + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["BearerAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarHTTPResponse, err + } + + localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 404 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 406 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 415 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 429 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 503 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarHTTPResponse, newErr + } + + return localVarHTTPResponse, nil +} + +type ApiGpoUpdateGpoPolicyRequest struct { + ctx context.Context + ApiService *GpoDAASService + citrixCustomerId *string + citrixInstanceId *string + policyGuid string + policyBodyRequest *PolicyBodyRequest + userAgent *string + authorization *string + citrixTransactionId *string + accept *string + citrixLocale *string +} + +// Citrix Customer ID. Default is 'CitrixOnPremises' +func (r ApiGpoUpdateGpoPolicyRequest) CitrixCustomerId(citrixCustomerId string) ApiGpoUpdateGpoPolicyRequest { + r.citrixCustomerId = &citrixCustomerId + return r +} + +// Citrix Instance (Site) ID. +func (r ApiGpoUpdateGpoPolicyRequest) CitrixInstanceId(citrixInstanceId string) ApiGpoUpdateGpoPolicyRequest { + r.citrixInstanceId = &citrixInstanceId + return r +} + +// New policy data +func (r ApiGpoUpdateGpoPolicyRequest) PolicyBodyRequest(policyBodyRequest PolicyBodyRequest) ApiGpoUpdateGpoPolicyRequest { + r.policyBodyRequest = &policyBodyRequest + return r +} + +// User Agent type of the request. +func (r ApiGpoUpdateGpoPolicyRequest) UserAgent(userAgent string) ApiGpoUpdateGpoPolicyRequest { + r.userAgent = &userAgent + return r +} + +// Citrix authorization header: CWSAuth Bearer={token} +func (r ApiGpoUpdateGpoPolicyRequest) Authorization(authorization string) ApiGpoUpdateGpoPolicyRequest { + r.authorization = &authorization + return r +} + +// Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. +func (r ApiGpoUpdateGpoPolicyRequest) CitrixTransactionId(citrixTransactionId string) ApiGpoUpdateGpoPolicyRequest { + r.citrixTransactionId = &citrixTransactionId + return r +} + +// Must accept application/json. +func (r ApiGpoUpdateGpoPolicyRequest) Accept(accept string) ApiGpoUpdateGpoPolicyRequest { + r.accept = &accept + return r +} + +// Locale of the request. +func (r ApiGpoUpdateGpoPolicyRequest) CitrixLocale(citrixLocale string) ApiGpoUpdateGpoPolicyRequest { + r.citrixLocale = &citrixLocale + return r +} + +func (r ApiGpoUpdateGpoPolicyRequest) Execute() (*http.Response, error) { + return r.ApiService.GpoUpdateGpoPolicyExecute(r) +} + +/* +GpoUpdateGpoPolicy Update a policy. Only the policy body is updated. + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param policyGuid GUID of the policy to be updated + @return ApiGpoUpdateGpoPolicyRequest +*/ +func (a *GpoDAASService) GpoUpdateGpoPolicy(ctx context.Context, policyGuid string) ApiGpoUpdateGpoPolicyRequest { + return ApiGpoUpdateGpoPolicyRequest{ + ApiService: a, + ctx: ctx, + policyGuid: policyGuid, + } +} + +// Execute executes the request +func (a *GpoDAASService) GpoUpdateGpoPolicyExecute(r ApiGpoUpdateGpoPolicyRequest) (*http.Response, error) { + var ( + localVarHTTPMethod = http.MethodPatch + localVarPostBody interface{} + formFiles []formFile + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GpoDAASService.GpoUpdateGpoPolicy") + if err != nil { + return nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/gpo/policies/{policyGuid}" + localVarPath = strings.Replace(localVarPath, "{"+"policyGuid"+"}", url.PathEscape(parameterValueToString(r.policyGuid, "policyGuid")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.citrixCustomerId == nil { + return nil, reportError("citrixCustomerId is required and must be specified") + } + if r.citrixInstanceId == nil { + return nil, reportError("citrixInstanceId is required and must be specified") + } + if r.policyBodyRequest == nil { + return nil, reportError("policyBodyRequest is required and must be specified") + } + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-CustomerId", r.citrixCustomerId, "") + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-InstanceId", r.citrixInstanceId, "") + if r.userAgent != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "User-Agent", r.userAgent, "") + } + if r.authorization != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Authorization", r.authorization, "") + } + if r.citrixTransactionId != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-TransactionId", r.citrixTransactionId, "") + } + if r.accept != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Accept", r.accept, "") + } + if r.citrixLocale != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-Locale", r.citrixLocale, "") + } + // body params + localVarPostBody = r.policyBodyRequest + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["BearerAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarHTTPResponse, err + } + + localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 404 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 406 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 415 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 429 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 503 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarHTTPResponse, newErr + } + + return localVarHTTPResponse, nil +} + +type ApiGpoUpdateGpoPolicySetRequest struct { + ctx context.Context + ApiService *GpoDAASService + citrixCustomerId *string + citrixInstanceId *string + policySetGuid string + policySetRequest *PolicySetRequest + userAgent *string + authorization *string + citrixTransactionId *string + accept *string + citrixLocale *string +} + +// Citrix Customer ID. Default is 'CitrixOnPremises' +func (r ApiGpoUpdateGpoPolicySetRequest) CitrixCustomerId(citrixCustomerId string) ApiGpoUpdateGpoPolicySetRequest { + r.citrixCustomerId = &citrixCustomerId + return r +} + +// Citrix Instance (Site) ID. +func (r ApiGpoUpdateGpoPolicySetRequest) CitrixInstanceId(citrixInstanceId string) ApiGpoUpdateGpoPolicySetRequest { + r.citrixInstanceId = &citrixInstanceId + return r +} + +// New description of the policy set +func (r ApiGpoUpdateGpoPolicySetRequest) PolicySetRequest(policySetRequest PolicySetRequest) ApiGpoUpdateGpoPolicySetRequest { + r.policySetRequest = &policySetRequest + return r +} + +// User Agent type of the request. +func (r ApiGpoUpdateGpoPolicySetRequest) UserAgent(userAgent string) ApiGpoUpdateGpoPolicySetRequest { + r.userAgent = &userAgent + return r +} + +// Citrix authorization header: CWSAuth Bearer={token} +func (r ApiGpoUpdateGpoPolicySetRequest) Authorization(authorization string) ApiGpoUpdateGpoPolicySetRequest { + r.authorization = &authorization + return r +} + +// Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. +func (r ApiGpoUpdateGpoPolicySetRequest) CitrixTransactionId(citrixTransactionId string) ApiGpoUpdateGpoPolicySetRequest { + r.citrixTransactionId = &citrixTransactionId + return r +} + +// Must accept application/json. +func (r ApiGpoUpdateGpoPolicySetRequest) Accept(accept string) ApiGpoUpdateGpoPolicySetRequest { + r.accept = &accept + return r +} + +// Locale of the request. +func (r ApiGpoUpdateGpoPolicySetRequest) CitrixLocale(citrixLocale string) ApiGpoUpdateGpoPolicySetRequest { + r.citrixLocale = &citrixLocale + return r +} + +func (r ApiGpoUpdateGpoPolicySetRequest) Execute() (*http.Response, error) { + return r.ApiService.GpoUpdateGpoPolicySetExecute(r) +} + +/* +GpoUpdateGpoPolicySet Update an existing GPO policy set. + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param policySetGuid The GUID of the policy set to update + @return ApiGpoUpdateGpoPolicySetRequest +*/ +func (a *GpoDAASService) GpoUpdateGpoPolicySet(ctx context.Context, policySetGuid string) ApiGpoUpdateGpoPolicySetRequest { + return ApiGpoUpdateGpoPolicySetRequest{ + ApiService: a, + ctx: ctx, + policySetGuid: policySetGuid, + } +} + +// Execute executes the request +func (a *GpoDAASService) GpoUpdateGpoPolicySetExecute(r ApiGpoUpdateGpoPolicySetRequest) (*http.Response, error) { + var ( + localVarHTTPMethod = http.MethodPatch + localVarPostBody interface{} + formFiles []formFile + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GpoDAASService.GpoUpdateGpoPolicySet") + if err != nil { + return nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/gpo/policySets/{policySetGuid}" + localVarPath = strings.Replace(localVarPath, "{"+"policySetGuid"+"}", url.PathEscape(parameterValueToString(r.policySetGuid, "policySetGuid")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.citrixCustomerId == nil { + return nil, reportError("citrixCustomerId is required and must be specified") + } + if r.citrixInstanceId == nil { + return nil, reportError("citrixInstanceId is required and must be specified") + } + if r.policySetRequest == nil { + return nil, reportError("policySetRequest is required and must be specified") + } + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-CustomerId", r.citrixCustomerId, "") + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-InstanceId", r.citrixInstanceId, "") + if r.userAgent != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "User-Agent", r.userAgent, "") + } + if r.authorization != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Authorization", r.authorization, "") + } + if r.citrixTransactionId != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-TransactionId", r.citrixTransactionId, "") + } + if r.accept != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Accept", r.accept, "") + } + if r.citrixLocale != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-Locale", r.citrixLocale, "") + } + // body params + localVarPostBody = r.policySetRequest + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["BearerAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarHTTPResponse, err + } + + localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 404 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 406 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 415 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 429 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 503 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarHTTPResponse, newErr + } + + return localVarHTTPResponse, nil +} + +type ApiGpoUpdateGpoSettingRequest struct { + ctx context.Context + ApiService *GpoDAASService + citrixCustomerId *string + citrixInstanceId *string + settingGuid string + settingRequest *SettingRequest + userAgent *string + authorization *string + citrixTransactionId *string + accept *string + citrixLocale *string +} + +// Citrix Customer ID. Default is 'CitrixOnPremises' +func (r ApiGpoUpdateGpoSettingRequest) CitrixCustomerId(citrixCustomerId string) ApiGpoUpdateGpoSettingRequest { + r.citrixCustomerId = &citrixCustomerId + return r +} + +// Citrix Instance (Site) ID. +func (r ApiGpoUpdateGpoSettingRequest) CitrixInstanceId(citrixInstanceId string) ApiGpoUpdateGpoSettingRequest { + r.citrixInstanceId = &citrixInstanceId + return r +} + +// New setting value +func (r ApiGpoUpdateGpoSettingRequest) SettingRequest(settingRequest SettingRequest) ApiGpoUpdateGpoSettingRequest { + r.settingRequest = &settingRequest + return r +} + +// User Agent type of the request. +func (r ApiGpoUpdateGpoSettingRequest) UserAgent(userAgent string) ApiGpoUpdateGpoSettingRequest { + r.userAgent = &userAgent + return r +} + +// Citrix authorization header: CWSAuth Bearer={token} +func (r ApiGpoUpdateGpoSettingRequest) Authorization(authorization string) ApiGpoUpdateGpoSettingRequest { + r.authorization = &authorization + return r +} + +// Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. +func (r ApiGpoUpdateGpoSettingRequest) CitrixTransactionId(citrixTransactionId string) ApiGpoUpdateGpoSettingRequest { + r.citrixTransactionId = &citrixTransactionId + return r +} + +// Must accept application/json. +func (r ApiGpoUpdateGpoSettingRequest) Accept(accept string) ApiGpoUpdateGpoSettingRequest { + r.accept = &accept + return r +} + +// Locale of the request. +func (r ApiGpoUpdateGpoSettingRequest) CitrixLocale(citrixLocale string) ApiGpoUpdateGpoSettingRequest { + r.citrixLocale = &citrixLocale + return r +} + +func (r ApiGpoUpdateGpoSettingRequest) Execute() (*http.Response, error) { + return r.ApiService.GpoUpdateGpoSettingExecute(r) +} + +/* +GpoUpdateGpoSetting Update a setting. Settings in the policy set of type SiteTemplates cannot be updated. + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param settingGuid GUID of the setting to be updated + @return ApiGpoUpdateGpoSettingRequest +*/ +func (a *GpoDAASService) GpoUpdateGpoSetting(ctx context.Context, settingGuid string) ApiGpoUpdateGpoSettingRequest { + return ApiGpoUpdateGpoSettingRequest{ + ApiService: a, + ctx: ctx, + settingGuid: settingGuid, + } +} + +// Execute executes the request +func (a *GpoDAASService) GpoUpdateGpoSettingExecute(r ApiGpoUpdateGpoSettingRequest) (*http.Response, error) { + var ( + localVarHTTPMethod = http.MethodPatch + localVarPostBody interface{} + formFiles []formFile + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GpoDAASService.GpoUpdateGpoSetting") + if err != nil { + return nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/gpo/settings/{settingGuid}" + localVarPath = strings.Replace(localVarPath, "{"+"settingGuid"+"}", url.PathEscape(parameterValueToString(r.settingGuid, "settingGuid")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.citrixCustomerId == nil { + return nil, reportError("citrixCustomerId is required and must be specified") + } + if r.citrixInstanceId == nil { + return nil, reportError("citrixInstanceId is required and must be specified") + } + if r.settingRequest == nil { + return nil, reportError("settingRequest is required and must be specified") + } + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-CustomerId", r.citrixCustomerId, "") + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-InstanceId", r.citrixInstanceId, "") + if r.userAgent != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "User-Agent", r.userAgent, "") + } + if r.authorization != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Authorization", r.authorization, "") + } + if r.citrixTransactionId != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-TransactionId", r.citrixTransactionId, "") + } + if r.accept != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Accept", r.accept, "") + } + if r.citrixLocale != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-Locale", r.citrixLocale, "") + } + // body params + localVarPostBody = r.settingRequest + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["BearerAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarHTTPResponse, err + } + + localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 404 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 406 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 415 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 429 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 503 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarHTTPResponse, newErr + } + + return localVarHTTPResponse, nil +} + +type ApiGpoUpdatePolicySetBlobRequest struct { + ctx context.Context + ApiService *GpoDAASService + citrixCustomerId *string + citrixInstanceId *string + policySetGuid string + userAgent *string + authorization *string + citrixTransactionId *string + accept *string + citrixLocale *string +} + +// Citrix Customer ID. Default is 'CitrixOnPremises' +func (r ApiGpoUpdatePolicySetBlobRequest) CitrixCustomerId(citrixCustomerId string) ApiGpoUpdatePolicySetBlobRequest { + r.citrixCustomerId = &citrixCustomerId + return r +} + +// Citrix Instance (Site) ID. +func (r ApiGpoUpdatePolicySetBlobRequest) CitrixInstanceId(citrixInstanceId string) ApiGpoUpdatePolicySetBlobRequest { + r.citrixInstanceId = &citrixInstanceId + return r +} + +// User Agent type of the request. +func (r ApiGpoUpdatePolicySetBlobRequest) UserAgent(userAgent string) ApiGpoUpdatePolicySetBlobRequest { + r.userAgent = &userAgent + return r +} + +// Citrix authorization header: CWSAuth Bearer={token} +func (r ApiGpoUpdatePolicySetBlobRequest) Authorization(authorization string) ApiGpoUpdatePolicySetBlobRequest { + r.authorization = &authorization + return r +} + +// Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. +func (r ApiGpoUpdatePolicySetBlobRequest) CitrixTransactionId(citrixTransactionId string) ApiGpoUpdatePolicySetBlobRequest { + r.citrixTransactionId = &citrixTransactionId + return r +} + +// Must accept application/json. +func (r ApiGpoUpdatePolicySetBlobRequest) Accept(accept string) ApiGpoUpdatePolicySetBlobRequest { + r.accept = &accept + return r +} + +// Locale of the request. +func (r ApiGpoUpdatePolicySetBlobRequest) CitrixLocale(citrixLocale string) ApiGpoUpdatePolicySetBlobRequest { + r.citrixLocale = &citrixLocale + return r +} + +func (r ApiGpoUpdatePolicySetBlobRequest) Execute() (*http.Response, error) { + return r.ApiService.GpoUpdatePolicySetBlobExecute(r) +} + +/* +GpoUpdatePolicySetBlob Force serialization of policy set. The data of a policy set is serialized into a byte stream before it is sent to VDAs. The serialization is done automatically in the background at 5 minute intervals. A change made to the data in a policy set may not be in the serialized data for up to 5 minutes. This call tells the background thread to serialize the data immediately. No serialization is done if there have been no changes to the policy set data since the last time the data was serialized. + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + @param policySetGuid The GUID of the policy set whose data is to be serialized + @return ApiGpoUpdatePolicySetBlobRequest +*/ +func (a *GpoDAASService) GpoUpdatePolicySetBlob(ctx context.Context, policySetGuid string) ApiGpoUpdatePolicySetBlobRequest { + return ApiGpoUpdatePolicySetBlobRequest{ + ApiService: a, + ctx: ctx, + policySetGuid: policySetGuid, + } +} + +// Execute executes the request +func (a *GpoDAASService) GpoUpdatePolicySetBlobExecute(r ApiGpoUpdatePolicySetBlobRequest) (*http.Response, error) { + var ( + localVarHTTPMethod = http.MethodPut + localVarPostBody interface{} + formFiles []formFile + ) + + localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "GpoDAASService.GpoUpdatePolicySetBlob") + if err != nil { + return nil, &GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/gpo/policySets/{policySetGuid}" + localVarPath = strings.Replace(localVarPath, "{"+"policySetGuid"+"}", url.PathEscape(parameterValueToString(r.policySetGuid, "policySetGuid")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := url.Values{} + localVarFormParams := url.Values{} + if r.citrixCustomerId == nil { + return nil, reportError("citrixCustomerId is required and must be specified") + } + if r.citrixInstanceId == nil { + return nil, reportError("citrixInstanceId is required and must be specified") + } + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-CustomerId", r.citrixCustomerId, "") + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-InstanceId", r.citrixInstanceId, "") + if r.userAgent != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "User-Agent", r.userAgent, "") + } + if r.authorization != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Authorization", r.authorization, "") + } + if r.citrixTransactionId != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-TransactionId", r.citrixTransactionId, "") + } + if r.accept != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Accept", r.accept, "") + } + if r.citrixLocale != nil { + parameterAddToHeaderOrQuery(localVarHeaderParams, "Citrix-Locale", r.citrixLocale, "") + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if apiKey, ok := auth["BearerAuth"]; ok { + var key string + if apiKey.Prefix != "" { + key = apiKey.Prefix + " " + apiKey.Key + } else { + key = apiKey.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles) + if err != nil { + return nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarHTTPResponse, err + } + + localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) + if err != nil { + return localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := &GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 404 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 406 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 429 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 503 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarHTTPResponse, newErr + } + + return localVarHTTPResponse, nil +} diff --git a/citrixorchestration/client.go b/citrixorchestration/client.go index b047ab1..c51def0 100644 --- a/citrixorchestration/client.go +++ b/citrixorchestration/client.go @@ -77,6 +77,8 @@ type APIClient struct { DeliveryGroupsAPIsDAAS *DeliveryGroupsAPIsDAASService + GpoDAAS *GpoDAASService + HealthCheckAPIsDAAS *HealthCheckAPIsDAASService HypervisorsAPIsDAAS *HypervisorsAPIsDAASService @@ -138,6 +140,7 @@ func NewAPIClient(cfg *Configuration) *APIClient { c.BatchAPIsDAAS = (*BatchAPIsDAASService)(&c.common) c.ConfigLogAPIsDAAS = (*ConfigLogAPIsDAASService)(&c.common) c.DeliveryGroupsAPIsDAAS = (*DeliveryGroupsAPIsDAASService)(&c.common) + c.GpoDAAS = (*GpoDAASService)(&c.common) c.HealthCheckAPIsDAAS = (*HealthCheckAPIsDAASService)(&c.common) c.HypervisorsAPIsDAAS = (*HypervisorsAPIsDAASService)(&c.common) c.IconsAPIsDAAS = (*IconsAPIsDAASService)(&c.common) diff --git a/citrixorchestration/docs/AddMachineToMachineCatalogDetailRequestModel.md b/citrixorchestration/docs/AddMachineToMachineCatalogDetailRequestModel.md index 71281e3..3ace834 100644 --- a/citrixorchestration/docs/AddMachineToMachineCatalogDetailRequestModel.md +++ b/citrixorchestration/docs/AddMachineToMachineCatalogDetailRequestModel.md @@ -11,6 +11,7 @@ Name | Type | Description | Notes **HostedMachineId** | Pointer to **NullableString** | The unique ID by which the hypervisor recognizes the machine. Omit this for machines that are not power-managed. | [optional] **HypervisorConnection** | Pointer to **NullableString** | Hypervisor connection to use for power management of the machine. | [optional] **InMaintenanceMode** | Pointer to **NullableBool** | Specifies whether the machine is initially in maintenance mode. A machine in maintenance mode is not available for new sessions, and for managed machines all automatic power management is disabled. Optional; default is `false`. | [optional] [default to false] +**Metadata** | Pointer to [**[]NameValueStringPairModel**](NameValueStringPairModel.md) | The metadata of machine. | [optional] **PvsAddress** | Pointer to **NullableString** | IP address of the PVS server to be used. This only applies if the ProvisioningType is PVS. | [optional] **PvsDomain** | Pointer to **NullableString** | The domain of the PVS server to be used. This only applies if the ProvisioningType is PVS. | [optional] **PvsCollectionIds** | Pointer to **[]string** | Collection IDs of PVS collections containing machines that should be added to the catalog. This only applies if the ProvisioningType is PVS, and is required in that case. Each item must be a valid PVS collection ID residing on the PVS server located at the specified . | [optional] @@ -281,6 +282,41 @@ HasInMaintenanceMode returns a boolean if a field has been set. `func (o *AddMachineToMachineCatalogDetailRequestModel) UnsetInMaintenanceMode()` UnsetInMaintenanceMode ensures that no value is present for InMaintenanceMode, not even an explicit nil +### GetMetadata + +`func (o *AddMachineToMachineCatalogDetailRequestModel) GetMetadata() []NameValueStringPairModel` + +GetMetadata returns the Metadata field if non-nil, zero value otherwise. + +### GetMetadataOk + +`func (o *AddMachineToMachineCatalogDetailRequestModel) GetMetadataOk() (*[]NameValueStringPairModel, bool)` + +GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetadata + +`func (o *AddMachineToMachineCatalogDetailRequestModel) SetMetadata(v []NameValueStringPairModel)` + +SetMetadata sets Metadata field to given value. + +### HasMetadata + +`func (o *AddMachineToMachineCatalogDetailRequestModel) HasMetadata() bool` + +HasMetadata returns a boolean if a field has been set. + +### SetMetadataNil + +`func (o *AddMachineToMachineCatalogDetailRequestModel) SetMetadataNil(b bool)` + + SetMetadataNil sets the value for Metadata to be an explicit nil + +### UnsetMetadata +`func (o *AddMachineToMachineCatalogDetailRequestModel) UnsetMetadata()` + +UnsetMetadata ensures that no value is present for Metadata, not even an explicit nil ### GetPvsAddress `func (o *AddMachineToMachineCatalogDetailRequestModel) GetPvsAddress() string` diff --git a/citrixorchestration/docs/AddMachineToMachineCatalogRequestModel.md b/citrixorchestration/docs/AddMachineToMachineCatalogRequestModel.md index 37b6c02..662df75 100644 --- a/citrixorchestration/docs/AddMachineToMachineCatalogRequestModel.md +++ b/citrixorchestration/docs/AddMachineToMachineCatalogRequestModel.md @@ -11,6 +11,7 @@ Name | Type | Description | Notes **HostedMachineId** | Pointer to **NullableString** | The unique ID by which the hypervisor recognizes the machine. Omit this for machines that are not power-managed. | [optional] **HypervisorConnection** | Pointer to **NullableString** | Hypervisor connection to use for power management of the machine. | [optional] **InMaintenanceMode** | Pointer to **NullableBool** | Specifies whether the machine is initially in maintenance mode. A machine in maintenance mode is not available for new sessions, and for managed machines all automatic power management is disabled. Optional; default is `false`. | [optional] [default to false] +**Metadata** | Pointer to [**[]NameValueStringPairModel**](NameValueStringPairModel.md) | The metadata of machine. | [optional] ## Methods @@ -276,6 +277,41 @@ HasInMaintenanceMode returns a boolean if a field has been set. `func (o *AddMachineToMachineCatalogRequestModel) UnsetInMaintenanceMode()` UnsetInMaintenanceMode ensures that no value is present for InMaintenanceMode, not even an explicit nil +### GetMetadata + +`func (o *AddMachineToMachineCatalogRequestModel) GetMetadata() []NameValueStringPairModel` + +GetMetadata returns the Metadata field if non-nil, zero value otherwise. + +### GetMetadataOk + +`func (o *AddMachineToMachineCatalogRequestModel) GetMetadataOk() (*[]NameValueStringPairModel, bool)` + +GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetadata + +`func (o *AddMachineToMachineCatalogRequestModel) SetMetadata(v []NameValueStringPairModel)` + +SetMetadata sets Metadata field to given value. + +### HasMetadata + +`func (o *AddMachineToMachineCatalogRequestModel) HasMetadata() bool` + +HasMetadata returns a boolean if a field has been set. + +### SetMetadataNil + +`func (o *AddMachineToMachineCatalogRequestModel) SetMetadataNil(b bool)` + + SetMetadataNil sets the value for Metadata to be an explicit nil + +### UnsetMetadata +`func (o *AddMachineToMachineCatalogRequestModel) UnsetMetadata()` + +UnsetMetadata ensures that no value is present for Metadata, not even an explicit nil [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/citrixorchestration/docs/AppLibPackageDiscoveryProfileRequestModel.md b/citrixorchestration/docs/AppLibPackageDiscoveryProfileRequestModel.md index 5f317fb..178ad0f 100644 --- a/citrixorchestration/docs/AppLibPackageDiscoveryProfileRequestModel.md +++ b/citrixorchestration/docs/AppLibPackageDiscoveryProfileRequestModel.md @@ -17,6 +17,7 @@ Name | Type | Description | Notes **DiscoverAppV** | Pointer to **NullableBool** | A value indicating whether or not to search should Discover App-V Packages. | [optional] [default to true] **DiscoverMsix** | Pointer to **NullableBool** | A value indicating whether or not to search should Discover MSIX Packages. | [optional] [default to false] **DiscoverAppAttach** | Pointer to **NullableBool** | A value indicating whether or not to search should discover AppAttach Packages. | [optional] [default to false] +**DiscoverFlexApp** | Pointer to **NullableBool** | A value indicating whether or not to search should discover FlexApp Packages. | [optional] [default to false] **AutomateDiscovery** | Pointer to **NullableBool** | A value indicating whether or not the discovery should run automatically. | [optional] [default to false] **AutoDiscoveryPeriod** | Pointer to [**AutoDiscoveryPeriod**](AutoDiscoveryPeriod.md) | | [optional] **AutoDiscoveryCadence** | Pointer to **int32** | A value indicating how often to trigger the discovery. | [optional] @@ -440,6 +441,41 @@ HasDiscoverAppAttach returns a boolean if a field has been set. `func (o *AppLibPackageDiscoveryProfileRequestModel) UnsetDiscoverAppAttach()` UnsetDiscoverAppAttach ensures that no value is present for DiscoverAppAttach, not even an explicit nil +### GetDiscoverFlexApp + +`func (o *AppLibPackageDiscoveryProfileRequestModel) GetDiscoverFlexApp() bool` + +GetDiscoverFlexApp returns the DiscoverFlexApp field if non-nil, zero value otherwise. + +### GetDiscoverFlexAppOk + +`func (o *AppLibPackageDiscoveryProfileRequestModel) GetDiscoverFlexAppOk() (*bool, bool)` + +GetDiscoverFlexAppOk returns a tuple with the DiscoverFlexApp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiscoverFlexApp + +`func (o *AppLibPackageDiscoveryProfileRequestModel) SetDiscoverFlexApp(v bool)` + +SetDiscoverFlexApp sets DiscoverFlexApp field to given value. + +### HasDiscoverFlexApp + +`func (o *AppLibPackageDiscoveryProfileRequestModel) HasDiscoverFlexApp() bool` + +HasDiscoverFlexApp returns a boolean if a field has been set. + +### SetDiscoverFlexAppNil + +`func (o *AppLibPackageDiscoveryProfileRequestModel) SetDiscoverFlexAppNil(b bool)` + + SetDiscoverFlexAppNil sets the value for DiscoverFlexApp to be an explicit nil + +### UnsetDiscoverFlexApp +`func (o *AppLibPackageDiscoveryProfileRequestModel) UnsetDiscoverFlexApp()` + +UnsetDiscoverFlexApp ensures that no value is present for DiscoverFlexApp, not even an explicit nil ### GetAutomateDiscovery `func (o *AppLibPackageDiscoveryProfileRequestModel) GetAutomateDiscovery() bool` diff --git a/citrixorchestration/docs/AppLibPackageDiscoveryProfileResponseModel.md b/citrixorchestration/docs/AppLibPackageDiscoveryProfileResponseModel.md index 6116ffc..162e678 100644 --- a/citrixorchestration/docs/AppLibPackageDiscoveryProfileResponseModel.md +++ b/citrixorchestration/docs/AppLibPackageDiscoveryProfileResponseModel.md @@ -15,6 +15,7 @@ Name | Type | Description | Notes **DiscoverAppV** | Pointer to **bool** | A value indicating whether or not to search should Discover App-V Packages. | [optional] **DiscoverMsix** | Pointer to **bool** | A value indicating whether or not to search should Discover Msix Packages. | [optional] **DiscoverAppAttach** | Pointer to **bool** | A value indicating whether or not to search should Discover AppAttach Packages. | [optional] +**DiscoverFlexApp** | Pointer to **bool** | A value indicating whether or not to search should Discover FlexApp Packages. | [optional] **AutomateDiscovery** | Pointer to **bool** | A value indicating whether or not the discovery should run automatically. | [optional] **AutoDiscoveryPeriod** | Pointer to **NullableString** | A value indicating what time period should used to trigger the discovery. | [optional] **AutoDiscoveryCadence** | Pointer to **int32** | A value indicating how often to trigger the discovery. | [optional] @@ -373,6 +374,31 @@ SetDiscoverAppAttach sets DiscoverAppAttach field to given value. HasDiscoverAppAttach returns a boolean if a field has been set. +### GetDiscoverFlexApp + +`func (o *AppLibPackageDiscoveryProfileResponseModel) GetDiscoverFlexApp() bool` + +GetDiscoverFlexApp returns the DiscoverFlexApp field if non-nil, zero value otherwise. + +### GetDiscoverFlexAppOk + +`func (o *AppLibPackageDiscoveryProfileResponseModel) GetDiscoverFlexAppOk() (*bool, bool)` + +GetDiscoverFlexAppOk returns a tuple with the DiscoverFlexApp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiscoverFlexApp + +`func (o *AppLibPackageDiscoveryProfileResponseModel) SetDiscoverFlexApp(v bool)` + +SetDiscoverFlexApp sets DiscoverFlexApp field to given value. + +### HasDiscoverFlexApp + +`func (o *AppLibPackageDiscoveryProfileResponseModel) HasDiscoverFlexApp() bool` + +HasDiscoverFlexApp returns a boolean if a field has been set. + ### GetAutomateDiscovery `func (o *AppLibPackageDiscoveryProfileResponseModel) GetAutomateDiscovery() bool` diff --git a/citrixorchestration/docs/AppLibPackageDiscoveryRequestModel.md b/citrixorchestration/docs/AppLibPackageDiscoveryRequestModel.md index 3234c31..9e8d4ca 100644 --- a/citrixorchestration/docs/AppLibPackageDiscoveryRequestModel.md +++ b/citrixorchestration/docs/AppLibPackageDiscoveryRequestModel.md @@ -12,6 +12,7 @@ Name | Type | Description | Notes **DiscoverAppV** | Pointer to **NullableBool** | A value indicating whether or not to discover App-V packages | [optional] [default to false] **DiscoverMsiX** | Pointer to **NullableBool** | A value indicating whether or not to discover MSIX packages | [optional] [default to false] **DiscoverAppAttach** | Pointer to **NullableBool** | A value indicating whether or not to discover AppAttach packages | [optional] [default to false] +**DiscoverFlexApp** | Pointer to **NullableBool** | A value indicating whether or not to discover FlexApp packages | [optional] [default to false] **ManagementServer** | Pointer to **NullableString** | The url of the App-V Management Server that packages will be discovered from. | [optional] **PublishingServer** | Pointer to **NullableString** | A value indicating whether or not to discover AppAttach packages | [optional] **Username** | Pointer to **NullableString** | the username of App-V server admin | [optional] @@ -307,6 +308,41 @@ HasDiscoverAppAttach returns a boolean if a field has been set. `func (o *AppLibPackageDiscoveryRequestModel) UnsetDiscoverAppAttach()` UnsetDiscoverAppAttach ensures that no value is present for DiscoverAppAttach, not even an explicit nil +### GetDiscoverFlexApp + +`func (o *AppLibPackageDiscoveryRequestModel) GetDiscoverFlexApp() bool` + +GetDiscoverFlexApp returns the DiscoverFlexApp field if non-nil, zero value otherwise. + +### GetDiscoverFlexAppOk + +`func (o *AppLibPackageDiscoveryRequestModel) GetDiscoverFlexAppOk() (*bool, bool)` + +GetDiscoverFlexAppOk returns a tuple with the DiscoverFlexApp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiscoverFlexApp + +`func (o *AppLibPackageDiscoveryRequestModel) SetDiscoverFlexApp(v bool)` + +SetDiscoverFlexApp sets DiscoverFlexApp field to given value. + +### HasDiscoverFlexApp + +`func (o *AppLibPackageDiscoveryRequestModel) HasDiscoverFlexApp() bool` + +HasDiscoverFlexApp returns a boolean if a field has been set. + +### SetDiscoverFlexAppNil + +`func (o *AppLibPackageDiscoveryRequestModel) SetDiscoverFlexAppNil(b bool)` + + SetDiscoverFlexAppNil sets the value for DiscoverFlexApp to be an explicit nil + +### UnsetDiscoverFlexApp +`func (o *AppLibPackageDiscoveryRequestModel) UnsetDiscoverFlexApp()` + +UnsetDiscoverFlexApp ensures that no value is present for DiscoverFlexApp, not even an explicit nil ### GetManagementServer `func (o *AppLibPackageDiscoveryRequestModel) GetManagementServer() string` diff --git a/citrixorchestration/docs/AppSearchProperty.md b/citrixorchestration/docs/AppSearchProperty.md index 0a4a3d4..9585476 100644 --- a/citrixorchestration/docs/AppSearchProperty.md +++ b/citrixorchestration/docs/AppSearchProperty.md @@ -3,6 +3,8 @@ ## Enum +* `UID` (value: `"Uid"`) + * `CLIENT_FOLDER` (value: `"ClientFolder"`) * `APPLICATION_GROUP` (value: `"ApplicationGroup"`) diff --git a/citrixorchestration/docs/ApplicationDetailResponseModel.md b/citrixorchestration/docs/ApplicationDetailResponseModel.md index 3256c7e..ed109c5 100644 --- a/citrixorchestration/docs/ApplicationDetailResponseModel.md +++ b/citrixorchestration/docs/ApplicationDetailResponseModel.md @@ -86,7 +86,22 @@ and a boolean to check if the value has been set. SetId sets Id field to given value. +### HasId +`func (o *ApplicationDetailResponseModel) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetIdNil + +`func (o *ApplicationDetailResponseModel) SetIdNil(b bool)` + + SetIdNil sets the value for Id to be an explicit nil + +### UnsetId +`func (o *ApplicationDetailResponseModel) UnsetId()` + +UnsetId ensures that no value is present for Id, not even an explicit nil ### GetUid `func (o *ApplicationDetailResponseModel) GetUid() int32` @@ -141,6 +156,11 @@ and a boolean to check if the value has been set. SetApplicationFolder sets ApplicationFolder field to given value. +### HasApplicationFolder + +`func (o *ApplicationDetailResponseModel) HasApplicationFolder() bool` + +HasApplicationFolder returns a boolean if a field has been set. ### GetApplicationType @@ -161,6 +181,11 @@ and a boolean to check if the value has been set. SetApplicationType sets ApplicationType field to given value. +### HasApplicationType + +`func (o *ApplicationDetailResponseModel) HasApplicationType() bool` + +HasApplicationType returns a boolean if a field has been set. ### GetPackagedApplicationType @@ -181,6 +206,11 @@ and a boolean to check if the value has been set. SetPackagedApplicationType sets PackagedApplicationType field to given value. +### HasPackagedApplicationType + +`func (o *ApplicationDetailResponseModel) HasPackagedApplicationType() bool` + +HasPackagedApplicationType returns a boolean if a field has been set. ### GetClientFolder @@ -236,7 +266,22 @@ and a boolean to check if the value has been set. SetContainerScopes sets ContainerScopes field to given value. +### HasContainerScopes + +`func (o *ApplicationDetailResponseModel) HasContainerScopes() bool` + +HasContainerScopes returns a boolean if a field has been set. + +### SetContainerScopesNil + +`func (o *ApplicationDetailResponseModel) SetContainerScopesNil(b bool)` + SetContainerScopesNil sets the value for ContainerScopes to be an explicit nil + +### UnsetContainerScopes +`func (o *ApplicationDetailResponseModel) UnsetContainerScopes()` + +UnsetContainerScopes ensures that no value is present for ContainerScopes, not even an explicit nil ### GetDescription `func (o *ApplicationDetailResponseModel) GetDescription() string` @@ -316,6 +361,11 @@ and a boolean to check if the value has been set. SetEnabled sets Enabled field to given value. +### HasEnabled + +`func (o *ApplicationDetailResponseModel) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. ### GetIconId @@ -336,7 +386,22 @@ and a boolean to check if the value has been set. SetIconId sets IconId field to given value. +### HasIconId + +`func (o *ApplicationDetailResponseModel) HasIconId() bool` +HasIconId returns a boolean if a field has been set. + +### SetIconIdNil + +`func (o *ApplicationDetailResponseModel) SetIconIdNil(b bool)` + + SetIconIdNil sets the value for IconId to be an explicit nil + +### UnsetIconId +`func (o *ApplicationDetailResponseModel) UnsetIconId()` + +UnsetIconId ensures that no value is present for IconId, not even an explicit nil ### GetInstalledAppProperties `func (o *ApplicationDetailResponseModel) GetInstalledAppProperties() InstalledAppResponseModel` @@ -466,7 +531,22 @@ and a boolean to check if the value has been set. SetName sets Name field to given value. +### HasName + +`func (o *ApplicationDetailResponseModel) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *ApplicationDetailResponseModel) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *ApplicationDetailResponseModel) UnsetName()` +UnsetName ensures that no value is present for Name, not even an explicit nil ### GetPublishedName `func (o *ApplicationDetailResponseModel) GetPublishedName() string` @@ -486,7 +566,22 @@ and a boolean to check if the value has been set. SetPublishedName sets PublishedName field to given value. +### HasPublishedName +`func (o *ApplicationDetailResponseModel) HasPublishedName() bool` + +HasPublishedName returns a boolean if a field has been set. + +### SetPublishedNameNil + +`func (o *ApplicationDetailResponseModel) SetPublishedNameNil(b bool)` + + SetPublishedNameNil sets the value for PublishedName to be an explicit nil + +### UnsetPublishedName +`func (o *ApplicationDetailResponseModel) UnsetPublishedName()` + +UnsetPublishedName ensures that no value is present for PublishedName, not even an explicit nil ### GetMetadata `func (o *ApplicationDetailResponseModel) GetMetadata() []NameValueStringPairModel` @@ -541,6 +636,11 @@ and a boolean to check if the value has been set. SetVisible sets Visible field to given value. +### HasVisible + +`func (o *ApplicationDetailResponseModel) HasVisible() bool` + +HasVisible returns a boolean if a field has been set. ### GetSharingKind @@ -561,6 +661,11 @@ and a boolean to check if the value has been set. SetSharingKind sets SharingKind field to given value. +### HasSharingKind + +`func (o *ApplicationDetailResponseModel) HasSharingKind() bool` + +HasSharingKind returns a boolean if a field has been set. ### GetTags diff --git a/citrixorchestration/docs/ApplicationGroupDetailResponseModel.md b/citrixorchestration/docs/ApplicationGroupDetailResponseModel.md index a73dcfa..5f486d6 100644 --- a/citrixorchestration/docs/ApplicationGroupDetailResponseModel.md +++ b/citrixorchestration/docs/ApplicationGroupDetailResponseModel.md @@ -65,7 +65,22 @@ and a boolean to check if the value has been set. SetId sets Id field to given value. +### HasId +`func (o *ApplicationGroupDetailResponseModel) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetIdNil + +`func (o *ApplicationGroupDetailResponseModel) SetIdNil(b bool)` + + SetIdNil sets the value for Id to be an explicit nil + +### UnsetId +`func (o *ApplicationGroupDetailResponseModel) UnsetId()` + +UnsetId ensures that no value is present for Id, not even an explicit nil ### GetUid `func (o *ApplicationGroupDetailResponseModel) GetUid() int32` @@ -120,7 +135,22 @@ and a boolean to check if the value has been set. SetContainerScopes sets ContainerScopes field to given value. +### HasContainerScopes + +`func (o *ApplicationGroupDetailResponseModel) HasContainerScopes() bool` + +HasContainerScopes returns a boolean if a field has been set. +### SetContainerScopesNil + +`func (o *ApplicationGroupDetailResponseModel) SetContainerScopesNil(b bool)` + + SetContainerScopesNil sets the value for ContainerScopes to be an explicit nil + +### UnsetContainerScopes +`func (o *ApplicationGroupDetailResponseModel) UnsetContainerScopes()` + +UnsetContainerScopes ensures that no value is present for ContainerScopes, not even an explicit nil ### GetDescription `func (o *ApplicationGroupDetailResponseModel) GetDescription() string` @@ -175,6 +205,11 @@ and a boolean to check if the value has been set. SetEnabled sets Enabled field to given value. +### HasEnabled + +`func (o *ApplicationGroupDetailResponseModel) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. ### GetName @@ -265,7 +300,22 @@ and a boolean to check if the value has been set. SetScopes sets Scopes field to given value. +### HasScopes + +`func (o *ApplicationGroupDetailResponseModel) HasScopes() bool` +HasScopes returns a boolean if a field has been set. + +### SetScopesNil + +`func (o *ApplicationGroupDetailResponseModel) SetScopesNil(b bool)` + + SetScopesNil sets the value for Scopes to be an explicit nil + +### UnsetScopes +`func (o *ApplicationGroupDetailResponseModel) UnsetScopes()` + +UnsetScopes ensures that no value is present for Scopes, not even an explicit nil ### GetMetadata `func (o *ApplicationGroupDetailResponseModel) GetMetadata() []NameValueStringPairModel` @@ -390,6 +440,11 @@ and a boolean to check if the value has been set. SetNumApplications sets NumApplications field to given value. +### HasNumApplications + +`func (o *ApplicationGroupDetailResponseModel) HasNumApplications() bool` + +HasNumApplications returns a boolean if a field has been set. ### GetNumMachines @@ -410,6 +465,11 @@ and a boolean to check if the value has been set. SetNumMachines sets NumMachines field to given value. +### HasNumMachines + +`func (o *ApplicationGroupDetailResponseModel) HasNumMachines() bool` + +HasNumMachines returns a boolean if a field has been set. ### GetNumMachinesWithTag @@ -480,7 +540,22 @@ and a boolean to check if the value has been set. SetDeliveryGroups sets DeliveryGroups field to given value. +### HasDeliveryGroups + +`func (o *ApplicationGroupDetailResponseModel) HasDeliveryGroups() bool` + +HasDeliveryGroups returns a boolean if a field has been set. + +### SetDeliveryGroupsNil + +`func (o *ApplicationGroupDetailResponseModel) SetDeliveryGroupsNil(b bool)` + + SetDeliveryGroupsNil sets the value for DeliveryGroups to be an explicit nil + +### UnsetDeliveryGroups +`func (o *ApplicationGroupDetailResponseModel) UnsetDeliveryGroups()` +UnsetDeliveryGroups ensures that no value is present for DeliveryGroups, not even an explicit nil ### GetAdminFolder `func (o *ApplicationGroupDetailResponseModel) GetAdminFolder() RefResponseModel` diff --git a/citrixorchestration/docs/ApplicationGroupResponseModel.md b/citrixorchestration/docs/ApplicationGroupResponseModel.md index 5ae061a..42a1a9c 100644 --- a/citrixorchestration/docs/ApplicationGroupResponseModel.md +++ b/citrixorchestration/docs/ApplicationGroupResponseModel.md @@ -60,7 +60,22 @@ and a boolean to check if the value has been set. SetId sets Id field to given value. +### HasId +`func (o *ApplicationGroupResponseModel) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetIdNil + +`func (o *ApplicationGroupResponseModel) SetIdNil(b bool)` + + SetIdNil sets the value for Id to be an explicit nil + +### UnsetId +`func (o *ApplicationGroupResponseModel) UnsetId()` + +UnsetId ensures that no value is present for Id, not even an explicit nil ### GetUid `func (o *ApplicationGroupResponseModel) GetUid() int32` @@ -115,7 +130,22 @@ and a boolean to check if the value has been set. SetContainerScopes sets ContainerScopes field to given value. +### HasContainerScopes + +`func (o *ApplicationGroupResponseModel) HasContainerScopes() bool` + +HasContainerScopes returns a boolean if a field has been set. +### SetContainerScopesNil + +`func (o *ApplicationGroupResponseModel) SetContainerScopesNil(b bool)` + + SetContainerScopesNil sets the value for ContainerScopes to be an explicit nil + +### UnsetContainerScopes +`func (o *ApplicationGroupResponseModel) UnsetContainerScopes()` + +UnsetContainerScopes ensures that no value is present for ContainerScopes, not even an explicit nil ### GetDescription `func (o *ApplicationGroupResponseModel) GetDescription() string` @@ -170,6 +200,11 @@ and a boolean to check if the value has been set. SetEnabled sets Enabled field to given value. +### HasEnabled + +`func (o *ApplicationGroupResponseModel) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. ### GetName @@ -260,7 +295,22 @@ and a boolean to check if the value has been set. SetScopes sets Scopes field to given value. +### HasScopes + +`func (o *ApplicationGroupResponseModel) HasScopes() bool` +HasScopes returns a boolean if a field has been set. + +### SetScopesNil + +`func (o *ApplicationGroupResponseModel) SetScopesNil(b bool)` + + SetScopesNil sets the value for Scopes to be an explicit nil + +### UnsetScopes +`func (o *ApplicationGroupResponseModel) UnsetScopes()` + +UnsetScopes ensures that no value is present for Scopes, not even an explicit nil ### GetMetadata `func (o *ApplicationGroupResponseModel) GetMetadata() []NameValueStringPairModel` @@ -385,6 +435,11 @@ and a boolean to check if the value has been set. SetNumApplications sets NumApplications field to given value. +### HasNumApplications + +`func (o *ApplicationGroupResponseModel) HasNumApplications() bool` + +HasNumApplications returns a boolean if a field has been set. ### GetNumMachines @@ -405,6 +460,11 @@ and a boolean to check if the value has been set. SetNumMachines sets NumMachines field to given value. +### HasNumMachines + +`func (o *ApplicationGroupResponseModel) HasNumMachines() bool` + +HasNumMachines returns a boolean if a field has been set. ### GetNumMachinesWithTag @@ -475,7 +535,22 @@ and a boolean to check if the value has been set. SetDeliveryGroups sets DeliveryGroups field to given value. +### HasDeliveryGroups + +`func (o *ApplicationGroupResponseModel) HasDeliveryGroups() bool` + +HasDeliveryGroups returns a boolean if a field has been set. + +### SetDeliveryGroupsNil + +`func (o *ApplicationGroupResponseModel) SetDeliveryGroupsNil(b bool)` + + SetDeliveryGroupsNil sets the value for DeliveryGroups to be an explicit nil + +### UnsetDeliveryGroups +`func (o *ApplicationGroupResponseModel) UnsetDeliveryGroups()` +UnsetDeliveryGroups ensures that no value is present for DeliveryGroups, not even an explicit nil ### GetAdminFolder `func (o *ApplicationGroupResponseModel) GetAdminFolder() RefResponseModel` diff --git a/citrixorchestration/docs/ApplicationResponseModel.md b/citrixorchestration/docs/ApplicationResponseModel.md index d4ffb91..1aafb59 100644 --- a/citrixorchestration/docs/ApplicationResponseModel.md +++ b/citrixorchestration/docs/ApplicationResponseModel.md @@ -71,7 +71,22 @@ and a boolean to check if the value has been set. SetId sets Id field to given value. +### HasId +`func (o *ApplicationResponseModel) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetIdNil + +`func (o *ApplicationResponseModel) SetIdNil(b bool)` + + SetIdNil sets the value for Id to be an explicit nil + +### UnsetId +`func (o *ApplicationResponseModel) UnsetId()` + +UnsetId ensures that no value is present for Id, not even an explicit nil ### GetUid `func (o *ApplicationResponseModel) GetUid() int32` @@ -126,6 +141,11 @@ and a boolean to check if the value has been set. SetApplicationFolder sets ApplicationFolder field to given value. +### HasApplicationFolder + +`func (o *ApplicationResponseModel) HasApplicationFolder() bool` + +HasApplicationFolder returns a boolean if a field has been set. ### GetApplicationType @@ -146,6 +166,11 @@ and a boolean to check if the value has been set. SetApplicationType sets ApplicationType field to given value. +### HasApplicationType + +`func (o *ApplicationResponseModel) HasApplicationType() bool` + +HasApplicationType returns a boolean if a field has been set. ### GetPackagedApplicationType @@ -166,6 +191,11 @@ and a boolean to check if the value has been set. SetPackagedApplicationType sets PackagedApplicationType field to given value. +### HasPackagedApplicationType + +`func (o *ApplicationResponseModel) HasPackagedApplicationType() bool` + +HasPackagedApplicationType returns a boolean if a field has been set. ### GetClientFolder @@ -221,7 +251,22 @@ and a boolean to check if the value has been set. SetContainerScopes sets ContainerScopes field to given value. +### HasContainerScopes + +`func (o *ApplicationResponseModel) HasContainerScopes() bool` + +HasContainerScopes returns a boolean if a field has been set. + +### SetContainerScopesNil + +`func (o *ApplicationResponseModel) SetContainerScopesNil(b bool)` + SetContainerScopesNil sets the value for ContainerScopes to be an explicit nil + +### UnsetContainerScopes +`func (o *ApplicationResponseModel) UnsetContainerScopes()` + +UnsetContainerScopes ensures that no value is present for ContainerScopes, not even an explicit nil ### GetDescription `func (o *ApplicationResponseModel) GetDescription() string` @@ -301,6 +346,11 @@ and a boolean to check if the value has been set. SetEnabled sets Enabled field to given value. +### HasEnabled + +`func (o *ApplicationResponseModel) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. ### GetIconId @@ -321,7 +371,22 @@ and a boolean to check if the value has been set. SetIconId sets IconId field to given value. +### HasIconId + +`func (o *ApplicationResponseModel) HasIconId() bool` +HasIconId returns a boolean if a field has been set. + +### SetIconIdNil + +`func (o *ApplicationResponseModel) SetIconIdNil(b bool)` + + SetIconIdNil sets the value for IconId to be an explicit nil + +### UnsetIconId +`func (o *ApplicationResponseModel) UnsetIconId()` + +UnsetIconId ensures that no value is present for IconId, not even an explicit nil ### GetInstalledAppProperties `func (o *ApplicationResponseModel) GetInstalledAppProperties() InstalledAppResponseModel` @@ -451,7 +516,22 @@ and a boolean to check if the value has been set. SetName sets Name field to given value. +### HasName + +`func (o *ApplicationResponseModel) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *ApplicationResponseModel) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *ApplicationResponseModel) UnsetName()` +UnsetName ensures that no value is present for Name, not even an explicit nil ### GetPublishedName `func (o *ApplicationResponseModel) GetPublishedName() string` @@ -471,7 +551,22 @@ and a boolean to check if the value has been set. SetPublishedName sets PublishedName field to given value. +### HasPublishedName +`func (o *ApplicationResponseModel) HasPublishedName() bool` + +HasPublishedName returns a boolean if a field has been set. + +### SetPublishedNameNil + +`func (o *ApplicationResponseModel) SetPublishedNameNil(b bool)` + + SetPublishedNameNil sets the value for PublishedName to be an explicit nil + +### UnsetPublishedName +`func (o *ApplicationResponseModel) UnsetPublishedName()` + +UnsetPublishedName ensures that no value is present for PublishedName, not even an explicit nil ### GetMetadata `func (o *ApplicationResponseModel) GetMetadata() []NameValueStringPairModel` @@ -526,6 +621,11 @@ and a boolean to check if the value has been set. SetVisible sets Visible field to given value. +### HasVisible + +`func (o *ApplicationResponseModel) HasVisible() bool` + +HasVisible returns a boolean if a field has been set. ### GetSharingKind @@ -546,6 +646,11 @@ and a boolean to check if the value has been set. SetSharingKind sets SharingKind field to given value. +### HasSharingKind + +`func (o *ApplicationResponseModel) HasSharingKind() bool` + +HasSharingKind returns a boolean if a field has been set. ### GetTags diff --git a/citrixorchestration/docs/ApplicationType.md b/citrixorchestration/docs/ApplicationType.md index cb270d0..1665eab 100644 --- a/citrixorchestration/docs/ApplicationType.md +++ b/citrixorchestration/docs/ApplicationType.md @@ -21,6 +21,8 @@ * `APP_ATTACH` (value: `"AppAttach"`) +* `FLEX_APP` (value: `"FlexApp"`) + * `PACKAGED_APPLICATION` (value: `"PackagedApplication"`) diff --git a/citrixorchestration/docs/BackupRestoreStatusRequestModel.md b/citrixorchestration/docs/BackupRestoreStatusRequestModel.md index a83508a..a9b81d3 100644 --- a/citrixorchestration/docs/BackupRestoreStatusRequestModel.md +++ b/citrixorchestration/docs/BackupRestoreStatusRequestModel.md @@ -27,6 +27,7 @@ Name | Type | Description | Notes **BackupDetails** | Pointer to **map[string]string** | Backup Status Details | [optional] **RestoreDetails** | Pointer to [**[]BackupRestoreRestoreSingleMemberModel**](BackupRestoreRestoreSingleMemberModel.md) | Restore Status Details | [optional] **SimpleResults** | Pointer to **[]string** | Simple Results (such as Get backed up member names) | [optional] +**Fixups** | Pointer to **NullableString** | Fixups from backups or restores | [optional] **RestoreType** | Pointer to [**BackupRestoreRestoreTypes**](BackupRestoreRestoreTypes.md) | | [optional] ## Methods @@ -673,6 +674,41 @@ HasSimpleResults returns a boolean if a field has been set. `func (o *BackupRestoreStatusRequestModel) UnsetSimpleResults()` UnsetSimpleResults ensures that no value is present for SimpleResults, not even an explicit nil +### GetFixups + +`func (o *BackupRestoreStatusRequestModel) GetFixups() string` + +GetFixups returns the Fixups field if non-nil, zero value otherwise. + +### GetFixupsOk + +`func (o *BackupRestoreStatusRequestModel) GetFixupsOk() (*string, bool)` + +GetFixupsOk returns a tuple with the Fixups field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFixups + +`func (o *BackupRestoreStatusRequestModel) SetFixups(v string)` + +SetFixups sets Fixups field to given value. + +### HasFixups + +`func (o *BackupRestoreStatusRequestModel) HasFixups() bool` + +HasFixups returns a boolean if a field has been set. + +### SetFixupsNil + +`func (o *BackupRestoreStatusRequestModel) SetFixupsNil(b bool)` + + SetFixupsNil sets the value for Fixups to be an explicit nil + +### UnsetFixups +`func (o *BackupRestoreStatusRequestModel) UnsetFixups()` + +UnsetFixups ensures that no value is present for Fixups, not even an explicit nil ### GetRestoreType `func (o *BackupRestoreStatusRequestModel) GetRestoreType() BackupRestoreRestoreTypes` diff --git a/citrixorchestration/docs/CatalogSearchResponseModel.md b/citrixorchestration/docs/CatalogSearchResponseModel.md index ccf72d0..762b051 100644 --- a/citrixorchestration/docs/CatalogSearchResponseModel.md +++ b/citrixorchestration/docs/CatalogSearchResponseModel.md @@ -91,7 +91,22 @@ and a boolean to check if the value has been set. SetName sets Name field to given value. +### HasName +`func (o *CatalogSearchResponseModel) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *CatalogSearchResponseModel) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *CatalogSearchResponseModel) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil ### GetFullName `func (o *CatalogSearchResponseModel) GetFullName() string` @@ -146,7 +161,22 @@ and a boolean to check if the value has been set. SetId sets Id field to given value. +### HasId + +`func (o *CatalogSearchResponseModel) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetIdNil + +`func (o *CatalogSearchResponseModel) SetIdNil(b bool)` + + SetIdNil sets the value for Id to be an explicit nil + +### UnsetId +`func (o *CatalogSearchResponseModel) UnsetId()` +UnsetId ensures that no value is present for Id, not even an explicit nil ### GetUid `func (o *CatalogSearchResponseModel) GetUid() int32` @@ -191,6 +221,11 @@ and a boolean to check if the value has been set. SetAllocationType sets AllocationType field to given value. +### HasAllocationType + +`func (o *CatalogSearchResponseModel) HasAllocationType() bool` + +HasAllocationType returns a boolean if a field has been set. ### GetAssignedCount @@ -281,6 +316,11 @@ and a boolean to check if the value has been set. SetAvailableCount sets AvailableCount field to given value. +### HasAvailableCount + +`func (o *CatalogSearchResponseModel) HasAvailableCount() bool` + +HasAvailableCount returns a boolean if a field has been set. ### GetAvailableUnassignedCount @@ -396,6 +436,11 @@ and a boolean to check if the value has been set. SetIsRemotePC sets IsRemotePC field to given value. +### HasIsRemotePC + +`func (o *CatalogSearchResponseModel) HasIsRemotePC() bool` + +HasIsRemotePC returns a boolean if a field has been set. ### GetJobsInProgress @@ -451,6 +496,11 @@ and a boolean to check if the value has been set. SetMachineType sets MachineType field to given value. +### HasMachineType + +`func (o *CatalogSearchResponseModel) HasMachineType() bool` + +HasMachineType returns a boolean if a field has been set. ### GetMetadata @@ -506,6 +556,11 @@ and a boolean to check if the value has been set. SetMinimumFunctionalLevel sets MinimumFunctionalLevel field to given value. +### HasMinimumFunctionalLevel + +`func (o *CatalogSearchResponseModel) HasMinimumFunctionalLevel() bool` + +HasMinimumFunctionalLevel returns a boolean if a field has been set. ### GetHasBeenPromoted @@ -526,6 +581,11 @@ and a boolean to check if the value has been set. SetHasBeenPromoted sets HasBeenPromoted field to given value. +### HasHasBeenPromoted + +`func (o *CatalogSearchResponseModel) HasHasBeenPromoted() bool` + +HasHasBeenPromoted returns a boolean if a field has been set. ### GetHasBeenPromotedFrom @@ -571,6 +631,11 @@ and a boolean to check if the value has been set. SetCanRollbackVMImage sets CanRollbackVMImage field to given value. +### HasCanRollbackVMImage + +`func (o *CatalogSearchResponseModel) HasCanRollbackVMImage() bool` + +HasCanRollbackVMImage returns a boolean if a field has been set. ### GetCanRecreateCatalog @@ -591,6 +656,11 @@ and a boolean to check if the value has been set. SetCanRecreateCatalog sets CanRecreateCatalog field to given value. +### HasCanRecreateCatalog + +`func (o *CatalogSearchResponseModel) HasCanRecreateCatalog() bool` + +HasCanRecreateCatalog returns a boolean if a field has been set. ### GetPersistChanges @@ -611,6 +681,11 @@ and a boolean to check if the value has been set. SetPersistChanges sets PersistChanges field to given value. +### HasPersistChanges + +`func (o *CatalogSearchResponseModel) HasPersistChanges() bool` + +HasPersistChanges returns a boolean if a field has been set. ### GetProvisioningScheme @@ -656,6 +731,11 @@ and a boolean to check if the value has been set. SetProvisioningType sets ProvisioningType field to given value. +### HasProvisioningType + +`func (o *CatalogSearchResponseModel) HasProvisioningType() bool` + +HasProvisioningType returns a boolean if a field has been set. ### GetProvisioningProgress @@ -876,6 +956,11 @@ and a boolean to check if the value has been set. SetSessionSupport sets SessionSupport field to given value. +### HasSessionSupport + +`func (o *CatalogSearchResponseModel) HasSessionSupport() bool` + +HasSessionSupport returns a boolean if a field has been set. ### GetSharingKind @@ -896,6 +981,11 @@ and a boolean to check if the value has been set. SetSharingKind sets SharingKind field to given value. +### HasSharingKind + +`func (o *CatalogSearchResponseModel) HasSharingKind() bool` + +HasSharingKind returns a boolean if a field has been set. ### GetTotalCount @@ -916,6 +1006,11 @@ and a boolean to check if the value has been set. SetTotalCount sets TotalCount field to given value. +### HasTotalCount + +`func (o *CatalogSearchResponseModel) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. ### GetIsBroken @@ -936,6 +1031,11 @@ and a boolean to check if the value has been set. SetIsBroken sets IsBroken field to given value. +### HasIsBroken + +`func (o *CatalogSearchResponseModel) HasIsBroken() bool` + +HasIsBroken returns a boolean if a field has been set. ### GetIsMasterImageAssociated @@ -1086,6 +1186,11 @@ and a boolean to check if the value has been set. SetUnassignedCount sets UnassignedCount field to given value. +### HasUnassignedCount + +`func (o *CatalogSearchResponseModel) HasUnassignedCount() bool` + +HasUnassignedCount returns a boolean if a field has been set. ### GetUsedCount @@ -1106,6 +1211,11 @@ and a boolean to check if the value has been set. SetUsedCount sets UsedCount field to given value. +### HasUsedCount + +`func (o *CatalogSearchResponseModel) HasUsedCount() bool` + +HasUsedCount returns a boolean if a field has been set. ### GetAvailableCountOfSuspend @@ -1221,6 +1331,11 @@ and a boolean to check if the value has been set. SetZone sets Zone field to given value. +### HasZone + +`func (o *CatalogSearchResponseModel) HasZone() bool` + +HasZone returns a boolean if a field has been set. ### GetAdminFolder diff --git a/citrixorchestration/docs/CollectionModelOfProvisionedVirtualMachineSearchResponseModel.md b/citrixorchestration/docs/CollectionModelOfProvisionedVirtualMachineSearchResponseModel.md new file mode 100644 index 0000000..13e9a8b --- /dev/null +++ b/citrixorchestration/docs/CollectionModelOfProvisionedVirtualMachineSearchResponseModel.md @@ -0,0 +1,123 @@ +# CollectionModelOfProvisionedVirtualMachineSearchResponseModel + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Items** | [**[]ProvisionedVirtualMachineSearchResponseModel**](ProvisionedVirtualMachineSearchResponseModel.md) | List of items. | +**ContinuationToken** | Pointer to **NullableString** | If present, indicates to the caller that the query was not complete, and they should call the API again specifying the continuation token as a query parameter. | [optional] +**TotalItems** | Pointer to **NullableInt32** | Indicates the total number of items in the collection, which may be more than the number of Items returned, if there is a ContinuationToken. Only returned in the response to `$search` APIs. | [optional] + +## Methods + +### NewCollectionModelOfProvisionedVirtualMachineSearchResponseModel + +`func NewCollectionModelOfProvisionedVirtualMachineSearchResponseModel(items []ProvisionedVirtualMachineSearchResponseModel, ) *CollectionModelOfProvisionedVirtualMachineSearchResponseModel` + +NewCollectionModelOfProvisionedVirtualMachineSearchResponseModel instantiates a new CollectionModelOfProvisionedVirtualMachineSearchResponseModel object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCollectionModelOfProvisionedVirtualMachineSearchResponseModelWithDefaults + +`func NewCollectionModelOfProvisionedVirtualMachineSearchResponseModelWithDefaults() *CollectionModelOfProvisionedVirtualMachineSearchResponseModel` + +NewCollectionModelOfProvisionedVirtualMachineSearchResponseModelWithDefaults instantiates a new CollectionModelOfProvisionedVirtualMachineSearchResponseModel object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetItems + +`func (o *CollectionModelOfProvisionedVirtualMachineSearchResponseModel) GetItems() []ProvisionedVirtualMachineSearchResponseModel` + +GetItems returns the Items field if non-nil, zero value otherwise. + +### GetItemsOk + +`func (o *CollectionModelOfProvisionedVirtualMachineSearchResponseModel) GetItemsOk() (*[]ProvisionedVirtualMachineSearchResponseModel, bool)` + +GetItemsOk returns a tuple with the Items field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetItems + +`func (o *CollectionModelOfProvisionedVirtualMachineSearchResponseModel) SetItems(v []ProvisionedVirtualMachineSearchResponseModel)` + +SetItems sets Items field to given value. + + +### GetContinuationToken + +`func (o *CollectionModelOfProvisionedVirtualMachineSearchResponseModel) GetContinuationToken() string` + +GetContinuationToken returns the ContinuationToken field if non-nil, zero value otherwise. + +### GetContinuationTokenOk + +`func (o *CollectionModelOfProvisionedVirtualMachineSearchResponseModel) GetContinuationTokenOk() (*string, bool)` + +GetContinuationTokenOk returns a tuple with the ContinuationToken field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContinuationToken + +`func (o *CollectionModelOfProvisionedVirtualMachineSearchResponseModel) SetContinuationToken(v string)` + +SetContinuationToken sets ContinuationToken field to given value. + +### HasContinuationToken + +`func (o *CollectionModelOfProvisionedVirtualMachineSearchResponseModel) HasContinuationToken() bool` + +HasContinuationToken returns a boolean if a field has been set. + +### SetContinuationTokenNil + +`func (o *CollectionModelOfProvisionedVirtualMachineSearchResponseModel) SetContinuationTokenNil(b bool)` + + SetContinuationTokenNil sets the value for ContinuationToken to be an explicit nil + +### UnsetContinuationToken +`func (o *CollectionModelOfProvisionedVirtualMachineSearchResponseModel) UnsetContinuationToken()` + +UnsetContinuationToken ensures that no value is present for ContinuationToken, not even an explicit nil +### GetTotalItems + +`func (o *CollectionModelOfProvisionedVirtualMachineSearchResponseModel) GetTotalItems() int32` + +GetTotalItems returns the TotalItems field if non-nil, zero value otherwise. + +### GetTotalItemsOk + +`func (o *CollectionModelOfProvisionedVirtualMachineSearchResponseModel) GetTotalItemsOk() (*int32, bool)` + +GetTotalItemsOk returns a tuple with the TotalItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalItems + +`func (o *CollectionModelOfProvisionedVirtualMachineSearchResponseModel) SetTotalItems(v int32)` + +SetTotalItems sets TotalItems field to given value. + +### HasTotalItems + +`func (o *CollectionModelOfProvisionedVirtualMachineSearchResponseModel) HasTotalItems() bool` + +HasTotalItems returns a boolean if a field has been set. + +### SetTotalItemsNil + +`func (o *CollectionModelOfProvisionedVirtualMachineSearchResponseModel) SetTotalItemsNil(b bool)` + + SetTotalItemsNil sets the value for TotalItems to be an explicit nil + +### UnsetTotalItems +`func (o *CollectionModelOfProvisionedVirtualMachineSearchResponseModel) UnsetTotalItems()` + +UnsetTotalItems ensures that no value is present for TotalItems, not even an explicit nil + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/citrixorchestration/docs/ControllerServiceType.md b/citrixorchestration/docs/ControllerServiceType.md index 4592dc4..6fd097d 100644 --- a/citrixorchestration/docs/ControllerServiceType.md +++ b/citrixorchestration/docs/ControllerServiceType.md @@ -29,6 +29,8 @@ * `APP_V` (value: `"AppV"`) +* `VUS` (value: `"Vus"`) + * `CONFIG` (value: `"Config"`) * `LOG` (value: `"Log"`) @@ -39,6 +41,8 @@ * `APP_LIB` (value: `"AppLib"`) +* `IDENTITY` (value: `"Identity"`) + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/citrixorchestration/docs/CreateDeliveryGroupRequestModel.md b/citrixorchestration/docs/CreateDeliveryGroupRequestModel.md index 8b5ddbd..3006361 100644 --- a/citrixorchestration/docs/CreateDeliveryGroupRequestModel.md +++ b/citrixorchestration/docs/CreateDeliveryGroupRequestModel.md @@ -373,7 +373,107 @@ and a boolean to check if the value has been set. SetMachineCatalogs sets MachineCatalogs field to given value. +### HasMachineCatalogs +`func (o *CreateDeliveryGroupRequestModel) HasMachineCatalogs() bool` + +HasMachineCatalogs returns a boolean if a field has been set. + +### SetMachineCatalogsNil + +`func (o *CreateDeliveryGroupRequestModel) SetMachineCatalogsNil(b bool)` + + SetMachineCatalogsNil sets the value for MachineCatalogs to be an explicit nil + +### UnsetMachineCatalogs +`func (o *CreateDeliveryGroupRequestModel) UnsetMachineCatalogs()` + +UnsetMachineCatalogs ensures that no value is present for MachineCatalogs, not even an explicit nil +### GetSessionSupport + +`func (o *CreateDeliveryGroupRequestModel) GetSessionSupport() SessionSupport` + +GetSessionSupport returns the SessionSupport field if non-nil, zero value otherwise. + +### GetSessionSupportOk + +`func (o *CreateDeliveryGroupRequestModel) GetSessionSupportOk() (*SessionSupport, bool)` + +GetSessionSupportOk returns a tuple with the SessionSupport field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSessionSupport + +`func (o *CreateDeliveryGroupRequestModel) SetSessionSupport(v SessionSupport)` + +SetSessionSupport sets SessionSupport field to given value. + +### HasSessionSupport + +`func (o *CreateDeliveryGroupRequestModel) HasSessionSupport() bool` + +HasSessionSupport returns a boolean if a field has been set. + +### GetSharingKind + +`func (o *CreateDeliveryGroupRequestModel) GetSharingKind() SharingKind` + +GetSharingKind returns the SharingKind field if non-nil, zero value otherwise. + +### GetSharingKindOk + +`func (o *CreateDeliveryGroupRequestModel) GetSharingKindOk() (*SharingKind, bool)` + +GetSharingKindOk returns a tuple with the SharingKind field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSharingKind + +`func (o *CreateDeliveryGroupRequestModel) SetSharingKind(v SharingKind)` + +SetSharingKind sets SharingKind field to given value. + +### HasSharingKind + +`func (o *CreateDeliveryGroupRequestModel) HasSharingKind() bool` + +HasSharingKind returns a boolean if a field has been set. + +### GetIsRemotePC + +`func (o *CreateDeliveryGroupRequestModel) GetIsRemotePC() bool` + +GetIsRemotePC returns the IsRemotePC field if non-nil, zero value otherwise. + +### GetIsRemotePCOk + +`func (o *CreateDeliveryGroupRequestModel) GetIsRemotePCOk() (*bool, bool)` + +GetIsRemotePCOk returns a tuple with the IsRemotePC field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsRemotePC + +`func (o *CreateDeliveryGroupRequestModel) SetIsRemotePC(v bool)` + +SetIsRemotePC sets IsRemotePC field to given value. + +### HasIsRemotePC + +`func (o *CreateDeliveryGroupRequestModel) HasIsRemotePC() bool` + +HasIsRemotePC returns a boolean if a field has been set. + +### SetIsRemotePCNil + +`func (o *CreateDeliveryGroupRequestModel) SetIsRemotePCNil(b bool)` + + SetIsRemotePCNil sets the value for IsRemotePC to be an explicit nil + +### UnsetIsRemotePC +`func (o *CreateDeliveryGroupRequestModel) UnsetIsRemotePC()` + +UnsetIsRemotePC ensures that no value is present for IsRemotePC, not even an explicit nil ### GetMinimumFunctionalLevel `func (o *CreateDeliveryGroupRequestModel) GetMinimumFunctionalLevel() FunctionalLevel` diff --git a/citrixorchestration/docs/DeliveryGroupsAPIsDAAS.md b/citrixorchestration/docs/DeliveryGroupsAPIsDAAS.md index 8e130c5..8f9dd62 100644 --- a/citrixorchestration/docs/DeliveryGroupsAPIsDAAS.md +++ b/citrixorchestration/docs/DeliveryGroupsAPIsDAAS.md @@ -418,7 +418,7 @@ import ( func main() { citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises' citrixInstanceId := "citrixInstanceId_example" // string | Citrix Instance (Site) ID. - createDeliveryGroupRequestModel := *openapiclient.NewCreateDeliveryGroupRequestModel([]openapiclient.DeliveryGroupAddMachinesRequestModel{*openapiclient.NewDeliveryGroupAddMachinesRequestModel("f254399c-6b4c-46fd-86e0-c03ade9135a2")}, "Name of the delivery group") // CreateDeliveryGroupRequestModel | The request + createDeliveryGroupRequestModel := *openapiclient.NewCreateDeliveryGroupRequestModel("Name of the delivery group") // CreateDeliveryGroupRequestModel | The request userAgent := "Mozilla/5.0" // string | User Agent type of the request. (optional) authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional) citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional) diff --git a/citrixorchestration/docs/EditAppLibPackageDiscoveryProfileRequestModel.md b/citrixorchestration/docs/EditAppLibPackageDiscoveryProfileRequestModel.md index da51f27..a48d6e0 100644 --- a/citrixorchestration/docs/EditAppLibPackageDiscoveryProfileRequestModel.md +++ b/citrixorchestration/docs/EditAppLibPackageDiscoveryProfileRequestModel.md @@ -16,6 +16,7 @@ Name | Type | Description | Notes **DiscoverAppV** | Pointer to **NullableBool** | A value indicating whether or not to search should Discover App-V Packages. | [optional] **DiscoverMsix** | Pointer to **NullableBool** | A value indicating whether or not to search should Discover MSIX Packages. | [optional] **DiscoverAppAttach** | Pointer to **NullableBool** | A value indicating whether or not to search should discover AppAttach Packages. | [optional] +**DiscoverFlexApp** | Pointer to **NullableBool** | A value indicating whether or not to search should discover FlexApp Packages. | [optional] **AutomateDiscovery** | Pointer to **NullableBool** | A value indicating whether or not the discovery should run automatically. | [optional] **AutoDiscoveryPeriod** | Pointer to [**AutoDiscoveryPeriod**](AutoDiscoveryPeriod.md) | | [optional] **AutoDiscoveryCadence** | Pointer to **NullableInt32** | A value indicating how often to trigger the discovery. | [optional] @@ -449,6 +450,41 @@ HasDiscoverAppAttach returns a boolean if a field has been set. `func (o *EditAppLibPackageDiscoveryProfileRequestModel) UnsetDiscoverAppAttach()` UnsetDiscoverAppAttach ensures that no value is present for DiscoverAppAttach, not even an explicit nil +### GetDiscoverFlexApp + +`func (o *EditAppLibPackageDiscoveryProfileRequestModel) GetDiscoverFlexApp() bool` + +GetDiscoverFlexApp returns the DiscoverFlexApp field if non-nil, zero value otherwise. + +### GetDiscoverFlexAppOk + +`func (o *EditAppLibPackageDiscoveryProfileRequestModel) GetDiscoverFlexAppOk() (*bool, bool)` + +GetDiscoverFlexAppOk returns a tuple with the DiscoverFlexApp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDiscoverFlexApp + +`func (o *EditAppLibPackageDiscoveryProfileRequestModel) SetDiscoverFlexApp(v bool)` + +SetDiscoverFlexApp sets DiscoverFlexApp field to given value. + +### HasDiscoverFlexApp + +`func (o *EditAppLibPackageDiscoveryProfileRequestModel) HasDiscoverFlexApp() bool` + +HasDiscoverFlexApp returns a boolean if a field has been set. + +### SetDiscoverFlexAppNil + +`func (o *EditAppLibPackageDiscoveryProfileRequestModel) SetDiscoverFlexAppNil(b bool)` + + SetDiscoverFlexAppNil sets the value for DiscoverFlexApp to be an explicit nil + +### UnsetDiscoverFlexApp +`func (o *EditAppLibPackageDiscoveryProfileRequestModel) UnsetDiscoverFlexApp()` + +UnsetDiscoverFlexApp ensures that no value is present for DiscoverFlexApp, not even an explicit nil ### GetAutomateDiscovery `func (o *EditAppLibPackageDiscoveryProfileRequestModel) GetAutomateDiscovery() bool` diff --git a/citrixorchestration/docs/GpoDAAS.md b/citrixorchestration/docs/GpoDAAS.md new file mode 100644 index 0000000..dfead39 --- /dev/null +++ b/citrixorchestration/docs/GpoDAAS.md @@ -0,0 +1,3027 @@ +# \GpoDAAS + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**GpoComparePolicies**](GpoDAAS.md#GpoComparePolicies) | **Post** /gpo/comparePolicies | Compare policies. The policies can be from different policy sets. +[**GpoCopyGpoPolicies**](GpoDAAS.md#GpoCopyGpoPolicies) | **Post** /gpo/policies/$copy | Copy some policies of a policy set to other policy sets. +[**GpoCopyGpoPolicySet**](GpoDAAS.md#GpoCopyGpoPolicySet) | **Post** /gpo/policySets/{policySetGuid} | Create a new GPO policy set by copying an existing policy set. The policies and settings in each policy are copied to the new policy set. Optionally, the filters in the policies may be copied. Regardless of the type of the source policy set, the resulting policy set is always of type DeliveryGroupPolicies. +[**GpoCreateGpoFilter**](GpoDAAS.md#GpoCreateGpoFilter) | **Post** /gpo/filters | Create a filter in a policy. Filters cannot be created in a policy in a policy set of type SiteTemplates or CustomTemplates. +[**GpoCreateGpoPolicy**](GpoDAAS.md#GpoCreateGpoPolicy) | **Post** /gpo/policies | Create a new policy. Policies cannot be created in the policy set of type SiteTemplates. +[**GpoCreateGpoPolicySet**](GpoDAAS.md#GpoCreateGpoPolicySet) | **Post** /gpo/policySets | Create a new GPO policy set. Only a policy set of type DeliveryGroupPolicies can be created. +[**GpoCreateGpoSetting**](GpoDAAS.md#GpoCreateGpoSetting) | **Post** /gpo/settings | Create a setting in a policy. Settings cannot be created in the policy set of type SiteTemplates. +[**GpoDeleteGpoFilter**](GpoDAAS.md#GpoDeleteGpoFilter) | **Delete** /gpo/filters/{filterGuid} | Delete an existing filter. +[**GpoDeleteGpoPolicy**](GpoDAAS.md#GpoDeleteGpoPolicy) | **Delete** /gpo/policies/{policyGuid} | Delete an existing GPO policy. A policy in the policy set of type SiteTemplates cannot be deleted. The Unfiltered policy in the policy set of type SitePolicies cannot be deleted. +[**GpoDeleteGpoPolicySet**](GpoDAAS.md#GpoDeleteGpoPolicySet) | **Delete** /gpo/policySets/{policySetGuid} | Delete an existing GPO policy set. Only policy sets of type DeliveryGroupPolicies can be deleted. Policies in the policy set are deleted if a policy set is deleted. +[**GpoDeleteGpoSetting**](GpoDAAS.md#GpoDeleteGpoSetting) | **Delete** /gpo/settings/{settingGuid} | Delete a setting. Settings in the policy set of type SiteTemplates cannot be deleted. +[**GpoDisableGpoPolicies**](GpoDAAS.md#GpoDisableGpoPolicies) | **Post** /gpo/policies/$disable | Disable some policies of a policy set. +[**GpoEnableGpoPolicies**](GpoDAAS.md#GpoEnableGpoPolicies) | **Post** /gpo/policies/$enable | Enable some policies of a policy set. +[**GpoGetFilterDefinitions**](GpoDAAS.md#GpoGetFilterDefinitions) | **Get** /gpo/filterDefinitions | Get all filter definitions. +[**GpoGetSettingDefinitions**](GpoDAAS.md#GpoGetSettingDefinitions) | **Get** /gpo/settingDefinitions | Get setting definitions. If isLean is set to true, only basic session information is returned. EnumType, VdaVersions, VersionDetails, and Explanation are not retrieved. If limit is set to -1 or a number larger than the number of settings available, all entries are retrieved. If limit is set to a positive integer smaller than the number of settings available, the specified number of settings are retrieved. +[**GpoGetSettingFullDetail**](GpoDAAS.md#GpoGetSettingFullDetail) | **Get** /gpo/settingFullDetail | Get full detail of a setting definition. +[**GpoMoveGpoPolicies**](GpoDAAS.md#GpoMoveGpoPolicies) | **Post** /gpo/policies/$move | Move some policies of a policy set to another policy set. +[**GpoRankGpoPolicies**](GpoDAAS.md#GpoRankGpoPolicies) | **Post** /gpo/policyPriorities | Specify new priority order for all existing policies in a policy set. All the policies in the policy set must be specified, even if the priorities of only some of the policies are changed. +[**GpoReadGpoFilter**](GpoDAAS.md#GpoReadGpoFilter) | **Get** /gpo/filters/{filterGuid} | Read a specific filter. +[**GpoReadGpoFilters**](GpoDAAS.md#GpoReadGpoFilters) | **Get** /gpo/filters | Read filters defined in a policy. A policy in a policy set of type SiteTemplates or CustomTemplates does not have filters. +[**GpoReadGpoPolicies**](GpoDAAS.md#GpoReadGpoPolicies) | **Get** /gpo/policies | Read all policies defined in a policy set. Policy templates don't have filters. +[**GpoReadGpoPolicy**](GpoDAAS.md#GpoReadGpoPolicy) | **Get** /gpo/policies/{policyGuid} | Read a policy. A policy template doesn't have filters. +[**GpoReadGpoPolicySet**](GpoDAAS.md#GpoReadGpoPolicySet) | **Get** /gpo/policySets/{policySetGuid} | Read a GPO policy set. +[**GpoReadGpoPolicySets**](GpoDAAS.md#GpoReadGpoPolicySets) | **Get** /gpo/policySets | Get all GPO policy sets in the site. +[**GpoReadGpoSetting**](GpoDAAS.md#GpoReadGpoSetting) | **Get** /gpo/settings/{settingGuid} | Read a specific setting. +[**GpoReadGpoSettings**](GpoDAAS.md#GpoReadGpoSettings) | **Get** /gpo/settings | Read settings defined in a policy. +[**GpoRemoveGpoPolicies**](GpoDAAS.md#GpoRemoveGpoPolicies) | **Post** /gpo/policies/$remove | Remove some policies of a policy set. +[**GpoRunSimulation**](GpoDAAS.md#GpoRunSimulation) | **Post** /gpo/simulation | Simulate policy application. +[**GpoSearchFilters**](GpoDAAS.md#GpoSearchFilters) | **Post** /gpo/filters/$search | Perform an advanced search for GPO filters. +[**GpoSearchPolicies**](GpoDAAS.md#GpoSearchPolicies) | **Post** /gpo/policies/$search | Perform an advanced search for GPO policies. +[**GpoSearchPolicySets**](GpoDAAS.md#GpoSearchPolicySets) | **Post** /gpo/policySets/$search | Perform an advanced search for GPO policy sets. +[**GpoSearchSettings**](GpoDAAS.md#GpoSearchSettings) | **Post** /gpo/settings/$search | Perform an advanced search for GPO settings. +[**GpoUpdateGpoFilter**](GpoDAAS.md#GpoUpdateGpoFilter) | **Patch** /gpo/filters/{filterGuid} | Update an existing filter. +[**GpoUpdateGpoPolicy**](GpoDAAS.md#GpoUpdateGpoPolicy) | **Patch** /gpo/policies/{policyGuid} | Update a policy. Only the policy body is updated. +[**GpoUpdateGpoPolicySet**](GpoDAAS.md#GpoUpdateGpoPolicySet) | **Patch** /gpo/policySets/{policySetGuid} | Update an existing GPO policy set. +[**GpoUpdateGpoSetting**](GpoDAAS.md#GpoUpdateGpoSetting) | **Patch** /gpo/settings/{settingGuid} | Update a setting. Settings in the policy set of type SiteTemplates cannot be updated. +[**GpoUpdatePolicySetBlob**](GpoDAAS.md#GpoUpdatePolicySetBlob) | **Put** /gpo/policySets/{policySetGuid} | Force serialization of policy set. The data of a policy set is serialized into a byte stream before it is sent to VDAs. The serialization is done automatically in the background at 5 minute intervals. A change made to the data in a policy set may not be in the serialized data for up to 5 minutes. This call tells the background thread to serialize the data immediately. No serialization is done if there have been no changes to the policy set data since the last time the data was serialized. + + + +## GpoComparePolicies + +> ComparisonResponseContract GpoComparePolicies(ctx).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).WithDefaults(withDefaults).RequestBody(requestBody).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + +Compare policies. The policies can be from different policy sets. + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration" +) + +func main() { + citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises' + citrixInstanceId := "citrixInstanceId_example" // string | Citrix Instance (Site) ID. + withDefaults := true // bool | Include defaults in comparison + requestBody := []string{"Property_example"} // []string | GUIDs of policies + userAgent := "Mozilla/5.0" // string | User Agent type of the request. (optional) + authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional) + citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional) + accept := "application/json" // string | Must accept application/json. (optional) + citrixLocale := "en-US" // string | Locale of the request. (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.GpoDAAS.GpoComparePolicies(context.Background()).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).WithDefaults(withDefaults).RequestBody(requestBody).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GpoDAAS.GpoComparePolicies``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GpoComparePolicies`: ComparisonResponseContract + fmt.Fprintf(os.Stdout, "Response from `GpoDAAS.GpoComparePolicies`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGpoComparePoliciesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **citrixCustomerId** | **string** | Citrix Customer ID. Default is 'CitrixOnPremises' | + **citrixInstanceId** | **string** | Citrix Instance (Site) ID. | + **withDefaults** | **bool** | Include defaults in comparison | + **requestBody** | **[]string** | GUIDs of policies | + **userAgent** | **string** | User Agent type of the request. | + **authorization** | **string** | Citrix authorization header: CWSAuth Bearer={token} | + **citrixTransactionId** | **string** | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. | + **accept** | **string** | Must accept application/json. | + **citrixLocale** | **string** | Locale of the request. | + +### Return type + +[**ComparisonResponseContract**](ComparisonResponseContract.md) + +### Authorization + +[BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GpoCopyGpoPolicies + +> GpoCopyGpoPolicies(ctx).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).WithFilters(withFilters).CopyPoliciesRequest(copyPoliciesRequest).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + +Copy some policies of a policy set to other policy sets. + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration" +) + +func main() { + citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises' + citrixInstanceId := "citrixInstanceId_example" // string | Citrix Instance (Site) ID. + withFilters := true // bool | Specify if policy filters should be included + copyPoliciesRequest := *openapiclient.NewCopyPoliciesRequest() // CopyPoliciesRequest | + userAgent := "Mozilla/5.0" // string | User Agent type of the request. (optional) + authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional) + citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional) + accept := "application/json" // string | Must accept application/json. (optional) + citrixLocale := "en-US" // string | Locale of the request. (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + r, err := apiClient.GpoDAAS.GpoCopyGpoPolicies(context.Background()).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).WithFilters(withFilters).CopyPoliciesRequest(copyPoliciesRequest).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GpoDAAS.GpoCopyGpoPolicies``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGpoCopyGpoPoliciesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **citrixCustomerId** | **string** | Citrix Customer ID. Default is 'CitrixOnPremises' | + **citrixInstanceId** | **string** | Citrix Instance (Site) ID. | + **withFilters** | **bool** | Specify if policy filters should be included | + **copyPoliciesRequest** | [**CopyPoliciesRequest**](CopyPoliciesRequest.md) | | + **userAgent** | **string** | User Agent type of the request. | + **authorization** | **string** | Citrix authorization header: CWSAuth Bearer={token} | + **citrixTransactionId** | **string** | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. | + **accept** | **string** | Must accept application/json. | + **citrixLocale** | **string** | Locale of the request. | + +### Return type + + (empty response body) + +### Authorization + +[BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GpoCopyGpoPolicySet + +> PolicySetResponse GpoCopyGpoPolicySet(ctx, policySetGuid).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).Name(name).WithFilters(withFilters).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + +Create a new GPO policy set by copying an existing policy set. The policies and settings in each policy are copied to the new policy set. Optionally, the filters in the policies may be copied. Regardless of the type of the source policy set, the resulting policy set is always of type DeliveryGroupPolicies. + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration" +) + +func main() { + citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises' + citrixInstanceId := "citrixInstanceId_example" // string | Citrix Instance (Site) ID. + policySetGuid := "policySetGuid_example" // string | GUID of the existing policy set + name := "name_example" // string | The name of the new policy set + withFilters := true // bool | Indicate if filters in the policies should be copied + userAgent := "Mozilla/5.0" // string | User Agent type of the request. (optional) + authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional) + citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional) + accept := "application/json" // string | Must accept application/json. (optional) + citrixLocale := "en-US" // string | Locale of the request. (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.GpoDAAS.GpoCopyGpoPolicySet(context.Background(), policySetGuid).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).Name(name).WithFilters(withFilters).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GpoDAAS.GpoCopyGpoPolicySet``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GpoCopyGpoPolicySet`: PolicySetResponse + fmt.Fprintf(os.Stdout, "Response from `GpoDAAS.GpoCopyGpoPolicySet`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**policySetGuid** | **string** | GUID of the existing policy set | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGpoCopyGpoPolicySetRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **citrixCustomerId** | **string** | Citrix Customer ID. Default is 'CitrixOnPremises' | + **citrixInstanceId** | **string** | Citrix Instance (Site) ID. | + + **name** | **string** | The name of the new policy set | + **withFilters** | **bool** | Indicate if filters in the policies should be copied | + **userAgent** | **string** | User Agent type of the request. | + **authorization** | **string** | Citrix authorization header: CWSAuth Bearer={token} | + **citrixTransactionId** | **string** | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. | + **accept** | **string** | Must accept application/json. | + **citrixLocale** | **string** | Locale of the request. | + +### Return type + +[**PolicySetResponse**](PolicySetResponse.md) + +### Authorization + +[BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GpoCreateGpoFilter + +> FilterResponse GpoCreateGpoFilter(ctx).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).PolicyGuid(policyGuid).FilterRequest(filterRequest).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + +Create a filter in a policy. Filters cannot be created in a policy in a policy set of type SiteTemplates or CustomTemplates. + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration" +) + +func main() { + citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises' + citrixInstanceId := "citrixInstanceId_example" // string | Citrix Instance (Site) ID. + policyGuid := "policyGuid_example" // string | The GUID of the policy to which the new filter belongs + filterRequest := *openapiclient.NewFilterRequest() // FilterRequest | Filter data + userAgent := "Mozilla/5.0" // string | User Agent type of the request. (optional) + authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional) + citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional) + accept := "application/json" // string | Must accept application/json. (optional) + citrixLocale := "en-US" // string | Locale of the request. (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.GpoDAAS.GpoCreateGpoFilter(context.Background()).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).PolicyGuid(policyGuid).FilterRequest(filterRequest).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GpoDAAS.GpoCreateGpoFilter``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GpoCreateGpoFilter`: FilterResponse + fmt.Fprintf(os.Stdout, "Response from `GpoDAAS.GpoCreateGpoFilter`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGpoCreateGpoFilterRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **citrixCustomerId** | **string** | Citrix Customer ID. Default is 'CitrixOnPremises' | + **citrixInstanceId** | **string** | Citrix Instance (Site) ID. | + **policyGuid** | **string** | The GUID of the policy to which the new filter belongs | + **filterRequest** | [**FilterRequest**](FilterRequest.md) | Filter data | + **userAgent** | **string** | User Agent type of the request. | + **authorization** | **string** | Citrix authorization header: CWSAuth Bearer={token} | + **citrixTransactionId** | **string** | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. | + **accept** | **string** | Must accept application/json. | + **citrixLocale** | **string** | Locale of the request. | + +### Return type + +[**FilterResponse**](FilterResponse.md) + +### Authorization + +[BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GpoCreateGpoPolicy + +> PolicyResponse GpoCreateGpoPolicy(ctx).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).PolicySetGuid(policySetGuid).PolicyRequest(policyRequest).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + +Create a new policy. Policies cannot be created in the policy set of type SiteTemplates. + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration" +) + +func main() { + citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises' + citrixInstanceId := "citrixInstanceId_example" // string | Citrix Instance (Site) ID. + policySetGuid := "policySetGuid_example" // string | GUID of the policy set in which the new policy is created + policyRequest := *openapiclient.NewPolicyRequest() // PolicyRequest | Data for the new policy + userAgent := "Mozilla/5.0" // string | User Agent type of the request. (optional) + authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional) + citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional) + accept := "application/json" // string | Must accept application/json. (optional) + citrixLocale := "en-US" // string | Locale of the request. (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.GpoDAAS.GpoCreateGpoPolicy(context.Background()).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).PolicySetGuid(policySetGuid).PolicyRequest(policyRequest).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GpoDAAS.GpoCreateGpoPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GpoCreateGpoPolicy`: PolicyResponse + fmt.Fprintf(os.Stdout, "Response from `GpoDAAS.GpoCreateGpoPolicy`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGpoCreateGpoPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **citrixCustomerId** | **string** | Citrix Customer ID. Default is 'CitrixOnPremises' | + **citrixInstanceId** | **string** | Citrix Instance (Site) ID. | + **policySetGuid** | **string** | GUID of the policy set in which the new policy is created | + **policyRequest** | [**PolicyRequest**](PolicyRequest.md) | Data for the new policy | + **userAgent** | **string** | User Agent type of the request. | + **authorization** | **string** | Citrix authorization header: CWSAuth Bearer={token} | + **citrixTransactionId** | **string** | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. | + **accept** | **string** | Must accept application/json. | + **citrixLocale** | **string** | Locale of the request. | + +### Return type + +[**PolicyResponse**](PolicyResponse.md) + +### Authorization + +[BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GpoCreateGpoPolicySet + +> PolicySetResponse GpoCreateGpoPolicySet(ctx).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).PolicySetRequest(policySetRequest).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + +Create a new GPO policy set. Only a policy set of type DeliveryGroupPolicies can be created. + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration" +) + +func main() { + citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises' + citrixInstanceId := "citrixInstanceId_example" // string | Citrix Instance (Site) ID. + policySetRequest := *openapiclient.NewPolicySetRequest() // PolicySetRequest | Parameters for the new policy set + userAgent := "Mozilla/5.0" // string | User Agent type of the request. (optional) + authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional) + citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional) + accept := "application/json" // string | Must accept application/json. (optional) + citrixLocale := "en-US" // string | Locale of the request. (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.GpoDAAS.GpoCreateGpoPolicySet(context.Background()).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).PolicySetRequest(policySetRequest).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GpoDAAS.GpoCreateGpoPolicySet``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GpoCreateGpoPolicySet`: PolicySetResponse + fmt.Fprintf(os.Stdout, "Response from `GpoDAAS.GpoCreateGpoPolicySet`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGpoCreateGpoPolicySetRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **citrixCustomerId** | **string** | Citrix Customer ID. Default is 'CitrixOnPremises' | + **citrixInstanceId** | **string** | Citrix Instance (Site) ID. | + **policySetRequest** | [**PolicySetRequest**](PolicySetRequest.md) | Parameters for the new policy set | + **userAgent** | **string** | User Agent type of the request. | + **authorization** | **string** | Citrix authorization header: CWSAuth Bearer={token} | + **citrixTransactionId** | **string** | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. | + **accept** | **string** | Must accept application/json. | + **citrixLocale** | **string** | Locale of the request. | + +### Return type + +[**PolicySetResponse**](PolicySetResponse.md) + +### Authorization + +[BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GpoCreateGpoSetting + +> SettingResponse GpoCreateGpoSetting(ctx).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).PolicyGuid(policyGuid).SettingRequest(settingRequest).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + +Create a setting in a policy. Settings cannot be created in the policy set of type SiteTemplates. + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration" +) + +func main() { + citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises' + citrixInstanceId := "citrixInstanceId_example" // string | Citrix Instance (Site) ID. + policyGuid := "policyGuid_example" // string | GUID of the policy to which the setting belongs + settingRequest := *openapiclient.NewSettingRequest() // SettingRequest | Data for the new setting + userAgent := "Mozilla/5.0" // string | User Agent type of the request. (optional) + authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional) + citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional) + accept := "application/json" // string | Must accept application/json. (optional) + citrixLocale := "en-US" // string | Locale of the request. (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.GpoDAAS.GpoCreateGpoSetting(context.Background()).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).PolicyGuid(policyGuid).SettingRequest(settingRequest).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GpoDAAS.GpoCreateGpoSetting``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GpoCreateGpoSetting`: SettingResponse + fmt.Fprintf(os.Stdout, "Response from `GpoDAAS.GpoCreateGpoSetting`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGpoCreateGpoSettingRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **citrixCustomerId** | **string** | Citrix Customer ID. Default is 'CitrixOnPremises' | + **citrixInstanceId** | **string** | Citrix Instance (Site) ID. | + **policyGuid** | **string** | GUID of the policy to which the setting belongs | + **settingRequest** | [**SettingRequest**](SettingRequest.md) | Data for the new setting | + **userAgent** | **string** | User Agent type of the request. | + **authorization** | **string** | Citrix authorization header: CWSAuth Bearer={token} | + **citrixTransactionId** | **string** | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. | + **accept** | **string** | Must accept application/json. | + **citrixLocale** | **string** | Locale of the request. | + +### Return type + +[**SettingResponse**](SettingResponse.md) + +### Authorization + +[BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GpoDeleteGpoFilter + +> GpoDeleteGpoFilter(ctx, filterGuid).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + +Delete an existing filter. + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration" +) + +func main() { + citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises' + citrixInstanceId := "citrixInstanceId_example" // string | Citrix Instance (Site) ID. + filterGuid := "filterGuid_example" // string | The GUID of the filter to be deleted + userAgent := "Mozilla/5.0" // string | User Agent type of the request. (optional) + authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional) + citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional) + accept := "application/json" // string | Must accept application/json. (optional) + citrixLocale := "en-US" // string | Locale of the request. (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + r, err := apiClient.GpoDAAS.GpoDeleteGpoFilter(context.Background(), filterGuid).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GpoDAAS.GpoDeleteGpoFilter``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**filterGuid** | **string** | The GUID of the filter to be deleted | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGpoDeleteGpoFilterRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **citrixCustomerId** | **string** | Citrix Customer ID. Default is 'CitrixOnPremises' | + **citrixInstanceId** | **string** | Citrix Instance (Site) ID. | + + **userAgent** | **string** | User Agent type of the request. | + **authorization** | **string** | Citrix authorization header: CWSAuth Bearer={token} | + **citrixTransactionId** | **string** | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. | + **accept** | **string** | Must accept application/json. | + **citrixLocale** | **string** | Locale of the request. | + +### Return type + + (empty response body) + +### Authorization + +[BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GpoDeleteGpoPolicy + +> GpoDeleteGpoPolicy(ctx, policyGuid).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + +Delete an existing GPO policy. A policy in the policy set of type SiteTemplates cannot be deleted. The Unfiltered policy in the policy set of type SitePolicies cannot be deleted. + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration" +) + +func main() { + citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises' + citrixInstanceId := "citrixInstanceId_example" // string | Citrix Instance (Site) ID. + policyGuid := "policyGuid_example" // string | GUID of the policy to be deleted + userAgent := "Mozilla/5.0" // string | User Agent type of the request. (optional) + authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional) + citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional) + accept := "application/json" // string | Must accept application/json. (optional) + citrixLocale := "en-US" // string | Locale of the request. (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + r, err := apiClient.GpoDAAS.GpoDeleteGpoPolicy(context.Background(), policyGuid).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GpoDAAS.GpoDeleteGpoPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**policyGuid** | **string** | GUID of the policy to be deleted | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGpoDeleteGpoPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **citrixCustomerId** | **string** | Citrix Customer ID. Default is 'CitrixOnPremises' | + **citrixInstanceId** | **string** | Citrix Instance (Site) ID. | + + **userAgent** | **string** | User Agent type of the request. | + **authorization** | **string** | Citrix authorization header: CWSAuth Bearer={token} | + **citrixTransactionId** | **string** | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. | + **accept** | **string** | Must accept application/json. | + **citrixLocale** | **string** | Locale of the request. | + +### Return type + + (empty response body) + +### Authorization + +[BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GpoDeleteGpoPolicySet + +> GpoDeleteGpoPolicySet(ctx, policySetGuid).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + +Delete an existing GPO policy set. Only policy sets of type DeliveryGroupPolicies can be deleted. Policies in the policy set are deleted if a policy set is deleted. + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration" +) + +func main() { + citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises' + citrixInstanceId := "citrixInstanceId_example" // string | Citrix Instance (Site) ID. + policySetGuid := "policySetGuid_example" // string | The GUID of the policy set to be deleted + userAgent := "Mozilla/5.0" // string | User Agent type of the request. (optional) + authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional) + citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional) + accept := "application/json" // string | Must accept application/json. (optional) + citrixLocale := "en-US" // string | Locale of the request. (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + r, err := apiClient.GpoDAAS.GpoDeleteGpoPolicySet(context.Background(), policySetGuid).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GpoDAAS.GpoDeleteGpoPolicySet``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**policySetGuid** | **string** | The GUID of the policy set to be deleted | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGpoDeleteGpoPolicySetRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **citrixCustomerId** | **string** | Citrix Customer ID. Default is 'CitrixOnPremises' | + **citrixInstanceId** | **string** | Citrix Instance (Site) ID. | + + **userAgent** | **string** | User Agent type of the request. | + **authorization** | **string** | Citrix authorization header: CWSAuth Bearer={token} | + **citrixTransactionId** | **string** | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. | + **accept** | **string** | Must accept application/json. | + **citrixLocale** | **string** | Locale of the request. | + +### Return type + + (empty response body) + +### Authorization + +[BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GpoDeleteGpoSetting + +> GpoDeleteGpoSetting(ctx, settingGuid).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + +Delete a setting. Settings in the policy set of type SiteTemplates cannot be deleted. + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration" +) + +func main() { + citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises' + citrixInstanceId := "citrixInstanceId_example" // string | Citrix Instance (Site) ID. + settingGuid := "settingGuid_example" // string | GUID of the setting to be deleted + userAgent := "Mozilla/5.0" // string | User Agent type of the request. (optional) + authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional) + citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional) + accept := "application/json" // string | Must accept application/json. (optional) + citrixLocale := "en-US" // string | Locale of the request. (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + r, err := apiClient.GpoDAAS.GpoDeleteGpoSetting(context.Background(), settingGuid).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GpoDAAS.GpoDeleteGpoSetting``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**settingGuid** | **string** | GUID of the setting to be deleted | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGpoDeleteGpoSettingRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **citrixCustomerId** | **string** | Citrix Customer ID. Default is 'CitrixOnPremises' | + **citrixInstanceId** | **string** | Citrix Instance (Site) ID. | + + **userAgent** | **string** | User Agent type of the request. | + **authorization** | **string** | Citrix authorization header: CWSAuth Bearer={token} | + **citrixTransactionId** | **string** | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. | + **accept** | **string** | Must accept application/json. | + **citrixLocale** | **string** | Locale of the request. | + +### Return type + + (empty response body) + +### Authorization + +[BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GpoDisableGpoPolicies + +> GpoDisableGpoPolicies(ctx).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).RequestBody(requestBody).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + +Disable some policies of a policy set. + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration" +) + +func main() { + citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises' + citrixInstanceId := "citrixInstanceId_example" // string | Citrix Instance (Site) ID. + requestBody := []string{"Property_example"} // []string | GUIDs of the policies to be disabled + userAgent := "Mozilla/5.0" // string | User Agent type of the request. (optional) + authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional) + citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional) + accept := "application/json" // string | Must accept application/json. (optional) + citrixLocale := "en-US" // string | Locale of the request. (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + r, err := apiClient.GpoDAAS.GpoDisableGpoPolicies(context.Background()).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).RequestBody(requestBody).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GpoDAAS.GpoDisableGpoPolicies``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGpoDisableGpoPoliciesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **citrixCustomerId** | **string** | Citrix Customer ID. Default is 'CitrixOnPremises' | + **citrixInstanceId** | **string** | Citrix Instance (Site) ID. | + **requestBody** | **[]string** | GUIDs of the policies to be disabled | + **userAgent** | **string** | User Agent type of the request. | + **authorization** | **string** | Citrix authorization header: CWSAuth Bearer={token} | + **citrixTransactionId** | **string** | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. | + **accept** | **string** | Must accept application/json. | + **citrixLocale** | **string** | Locale of the request. | + +### Return type + + (empty response body) + +### Authorization + +[BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GpoEnableGpoPolicies + +> GpoEnableGpoPolicies(ctx).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).RequestBody(requestBody).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + +Enable some policies of a policy set. + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration" +) + +func main() { + citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises' + citrixInstanceId := "citrixInstanceId_example" // string | Citrix Instance (Site) ID. + requestBody := []string{"Property_example"} // []string | GUIDs of the policies to be enabled + userAgent := "Mozilla/5.0" // string | User Agent type of the request. (optional) + authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional) + citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional) + accept := "application/json" // string | Must accept application/json. (optional) + citrixLocale := "en-US" // string | Locale of the request. (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + r, err := apiClient.GpoDAAS.GpoEnableGpoPolicies(context.Background()).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).RequestBody(requestBody).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GpoDAAS.GpoEnableGpoPolicies``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGpoEnableGpoPoliciesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **citrixCustomerId** | **string** | Citrix Customer ID. Default is 'CitrixOnPremises' | + **citrixInstanceId** | **string** | Citrix Instance (Site) ID. | + **requestBody** | **[]string** | GUIDs of the policies to be enabled | + **userAgent** | **string** | User Agent type of the request. | + **authorization** | **string** | Citrix authorization header: CWSAuth Bearer={token} | + **citrixTransactionId** | **string** | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. | + **accept** | **string** | Must accept application/json. | + **citrixLocale** | **string** | Locale of the request. | + +### Return type + + (empty response body) + +### Authorization + +[BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GpoGetFilterDefinitions + +> CollectionEnvelopeOfFilterDefinition GpoGetFilterDefinitions(ctx).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + +Get all filter definitions. + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration" +) + +func main() { + citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises' + citrixInstanceId := "citrixInstanceId_example" // string | Citrix Instance (Site) ID. + userAgent := "Mozilla/5.0" // string | User Agent type of the request. (optional) + authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional) + citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional) + accept := "application/json" // string | Must accept application/json. (optional) + citrixLocale := "en-US" // string | Locale of the request. (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.GpoDAAS.GpoGetFilterDefinitions(context.Background()).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GpoDAAS.GpoGetFilterDefinitions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GpoGetFilterDefinitions`: CollectionEnvelopeOfFilterDefinition + fmt.Fprintf(os.Stdout, "Response from `GpoDAAS.GpoGetFilterDefinitions`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGpoGetFilterDefinitionsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **citrixCustomerId** | **string** | Citrix Customer ID. Default is 'CitrixOnPremises' | + **citrixInstanceId** | **string** | Citrix Instance (Site) ID. | + **userAgent** | **string** | User Agent type of the request. | + **authorization** | **string** | Citrix authorization header: CWSAuth Bearer={token} | + **citrixTransactionId** | **string** | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. | + **accept** | **string** | Must accept application/json. | + **citrixLocale** | **string** | Locale of the request. | + +### Return type + +[**CollectionEnvelopeOfFilterDefinition**](CollectionEnvelopeOfFilterDefinition.md) + +### Authorization + +[BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GpoGetSettingDefinitions + +> SettingDefinitionEnvelope GpoGetSettingDefinitions(ctx).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).IsLean(isLean).Limit(limit).IsAscending(isAscending).NamePattern(namePattern).IsUserSetting(isUserSetting).ContinuationToken(continuationToken).Execute() + +Get setting definitions. If isLean is set to true, only basic session information is returned. EnumType, VdaVersions, VersionDetails, and Explanation are not retrieved. If limit is set to -1 or a number larger than the number of settings available, all entries are retrieved. If limit is set to a positive integer smaller than the number of settings available, the specified number of settings are retrieved. + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration" +) + +func main() { + citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises' + citrixInstanceId := "citrixInstanceId_example" // string | Citrix Instance (Site) ID. + userAgent := "Mozilla/5.0" // string | User Agent type of the request. (optional) + authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional) + citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional) + accept := "application/json" // string | Must accept application/json. (optional) + citrixLocale := "en-US" // string | Locale of the request. (optional) + isLean := true // bool | Get lean parts of setting definitions, the default is set to true (optional) (default to true) + limit := int32(56) // int32 | Specify the number of entries to retrieve, the default is all entries (optional) (default to -1) + isAscending := true // bool | Specify sort order, default is true (optional) (default to true) + namePattern := "namePattern_example" // string | Specify a regular expression to match the internal setting name. The default is match all names. (optional) + isUserSetting := true // bool | Specify the target of applying the settings. If it's set to true, only user settings are retrieved. If it's set to false, only computer settings are retrieved. If not specified, both kinds of settings are retrieved. The default is to retrieve both kinds of settings. (optional) + continuationToken := "continuationToken_example" // string | Continuation token from a previous retrieval (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.GpoDAAS.GpoGetSettingDefinitions(context.Background()).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).IsLean(isLean).Limit(limit).IsAscending(isAscending).NamePattern(namePattern).IsUserSetting(isUserSetting).ContinuationToken(continuationToken).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GpoDAAS.GpoGetSettingDefinitions``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GpoGetSettingDefinitions`: SettingDefinitionEnvelope + fmt.Fprintf(os.Stdout, "Response from `GpoDAAS.GpoGetSettingDefinitions`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGpoGetSettingDefinitionsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **citrixCustomerId** | **string** | Citrix Customer ID. Default is 'CitrixOnPremises' | + **citrixInstanceId** | **string** | Citrix Instance (Site) ID. | + **userAgent** | **string** | User Agent type of the request. | + **authorization** | **string** | Citrix authorization header: CWSAuth Bearer={token} | + **citrixTransactionId** | **string** | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. | + **accept** | **string** | Must accept application/json. | + **citrixLocale** | **string** | Locale of the request. | + **isLean** | **bool** | Get lean parts of setting definitions, the default is set to true | [default to true] + **limit** | **int32** | Specify the number of entries to retrieve, the default is all entries | [default to -1] + **isAscending** | **bool** | Specify sort order, default is true | [default to true] + **namePattern** | **string** | Specify a regular expression to match the internal setting name. The default is match all names. | + **isUserSetting** | **bool** | Specify the target of applying the settings. If it's set to true, only user settings are retrieved. If it's set to false, only computer settings are retrieved. If not specified, both kinds of settings are retrieved. The default is to retrieve both kinds of settings. | + **continuationToken** | **string** | Continuation token from a previous retrieval | + +### Return type + +[**SettingDefinitionEnvelope**](SettingDefinitionEnvelope.md) + +### Authorization + +[BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GpoGetSettingFullDetail + +> SettingDefinition GpoGetSettingFullDetail(ctx).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).SettingName(settingName).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + +Get full detail of a setting definition. + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration" +) + +func main() { + citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises' + citrixInstanceId := "citrixInstanceId_example" // string | Citrix Instance (Site) ID. + settingName := "settingName_example" // string | The internal name of the setting + userAgent := "Mozilla/5.0" // string | User Agent type of the request. (optional) + authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional) + citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional) + accept := "application/json" // string | Must accept application/json. (optional) + citrixLocale := "en-US" // string | Locale of the request. (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.GpoDAAS.GpoGetSettingFullDetail(context.Background()).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).SettingName(settingName).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GpoDAAS.GpoGetSettingFullDetail``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GpoGetSettingFullDetail`: SettingDefinition + fmt.Fprintf(os.Stdout, "Response from `GpoDAAS.GpoGetSettingFullDetail`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGpoGetSettingFullDetailRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **citrixCustomerId** | **string** | Citrix Customer ID. Default is 'CitrixOnPremises' | + **citrixInstanceId** | **string** | Citrix Instance (Site) ID. | + **settingName** | **string** | The internal name of the setting | + **userAgent** | **string** | User Agent type of the request. | + **authorization** | **string** | Citrix authorization header: CWSAuth Bearer={token} | + **citrixTransactionId** | **string** | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. | + **accept** | **string** | Must accept application/json. | + **citrixLocale** | **string** | Locale of the request. | + +### Return type + +[**SettingDefinition**](SettingDefinition.md) + +### Authorization + +[BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GpoMoveGpoPolicies + +> GpoMoveGpoPolicies(ctx).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).ToPolicySet(toPolicySet).RequestBody(requestBody).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + +Move some policies of a policy set to another policy set. + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration" +) + +func main() { + citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises' + citrixInstanceId := "citrixInstanceId_example" // string | Citrix Instance (Site) ID. + toPolicySet := "toPolicySet_example" // string | GUID of the destination policy set + requestBody := []string{"Property_example"} // []string | GUIDs of the policies to be removed + userAgent := "Mozilla/5.0" // string | User Agent type of the request. (optional) + authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional) + citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional) + accept := "application/json" // string | Must accept application/json. (optional) + citrixLocale := "en-US" // string | Locale of the request. (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + r, err := apiClient.GpoDAAS.GpoMoveGpoPolicies(context.Background()).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).ToPolicySet(toPolicySet).RequestBody(requestBody).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GpoDAAS.GpoMoveGpoPolicies``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGpoMoveGpoPoliciesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **citrixCustomerId** | **string** | Citrix Customer ID. Default is 'CitrixOnPremises' | + **citrixInstanceId** | **string** | Citrix Instance (Site) ID. | + **toPolicySet** | **string** | GUID of the destination policy set | + **requestBody** | **[]string** | GUIDs of the policies to be removed | + **userAgent** | **string** | User Agent type of the request. | + **authorization** | **string** | Citrix authorization header: CWSAuth Bearer={token} | + **citrixTransactionId** | **string** | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. | + **accept** | **string** | Must accept application/json. | + **citrixLocale** | **string** | Locale of the request. | + +### Return type + + (empty response body) + +### Authorization + +[BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GpoRankGpoPolicies + +> bool GpoRankGpoPolicies(ctx).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).PolicySetGuid(policySetGuid).RequestBody(requestBody).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + +Specify new priority order for all existing policies in a policy set. All the policies in the policy set must be specified, even if the priorities of only some of the policies are changed. + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration" +) + +func main() { + citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises' + citrixInstanceId := "citrixInstanceId_example" // string | Citrix Instance (Site) ID. + policySetGuid := "policySetGuid_example" // string | Guid of the policy set that contains the policies + requestBody := []string{"Property_example"} // []string | GUIDs of the policies to be re-prioritized + userAgent := "Mozilla/5.0" // string | User Agent type of the request. (optional) + authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional) + citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional) + accept := "application/json" // string | Must accept application/json. (optional) + citrixLocale := "en-US" // string | Locale of the request. (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.GpoDAAS.GpoRankGpoPolicies(context.Background()).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).PolicySetGuid(policySetGuid).RequestBody(requestBody).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GpoDAAS.GpoRankGpoPolicies``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GpoRankGpoPolicies`: bool + fmt.Fprintf(os.Stdout, "Response from `GpoDAAS.GpoRankGpoPolicies`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGpoRankGpoPoliciesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **citrixCustomerId** | **string** | Citrix Customer ID. Default is 'CitrixOnPremises' | + **citrixInstanceId** | **string** | Citrix Instance (Site) ID. | + **policySetGuid** | **string** | Guid of the policy set that contains the policies | + **requestBody** | **[]string** | GUIDs of the policies to be re-prioritized | + **userAgent** | **string** | User Agent type of the request. | + **authorization** | **string** | Citrix authorization header: CWSAuth Bearer={token} | + **citrixTransactionId** | **string** | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. | + **accept** | **string** | Must accept application/json. | + **citrixLocale** | **string** | Locale of the request. | + +### Return type + +**bool** + +### Authorization + +[BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GpoReadGpoFilter + +> FilterResponse GpoReadGpoFilter(ctx, filterGuid).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + +Read a specific filter. + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration" +) + +func main() { + citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises' + citrixInstanceId := "citrixInstanceId_example" // string | Citrix Instance (Site) ID. + filterGuid := "filterGuid_example" // string | The GUID of the filter to be read + userAgent := "Mozilla/5.0" // string | User Agent type of the request. (optional) + authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional) + citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional) + accept := "application/json" // string | Must accept application/json. (optional) + citrixLocale := "en-US" // string | Locale of the request. (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.GpoDAAS.GpoReadGpoFilter(context.Background(), filterGuid).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GpoDAAS.GpoReadGpoFilter``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GpoReadGpoFilter`: FilterResponse + fmt.Fprintf(os.Stdout, "Response from `GpoDAAS.GpoReadGpoFilter`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**filterGuid** | **string** | The GUID of the filter to be read | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGpoReadGpoFilterRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **citrixCustomerId** | **string** | Citrix Customer ID. Default is 'CitrixOnPremises' | + **citrixInstanceId** | **string** | Citrix Instance (Site) ID. | + + **userAgent** | **string** | User Agent type of the request. | + **authorization** | **string** | Citrix authorization header: CWSAuth Bearer={token} | + **citrixTransactionId** | **string** | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. | + **accept** | **string** | Must accept application/json. | + **citrixLocale** | **string** | Locale of the request. | + +### Return type + +[**FilterResponse**](FilterResponse.md) + +### Authorization + +[BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GpoReadGpoFilters + +> CollectionEnvelopeOfFilterResponse GpoReadGpoFilters(ctx).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).PolicyGuid(policyGuid).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + +Read filters defined in a policy. A policy in a policy set of type SiteTemplates or CustomTemplates does not have filters. + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration" +) + +func main() { + citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises' + citrixInstanceId := "citrixInstanceId_example" // string | Citrix Instance (Site) ID. + policyGuid := "policyGuid_example" // string | The GUID of the policy from which filters are read + userAgent := "Mozilla/5.0" // string | User Agent type of the request. (optional) + authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional) + citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional) + accept := "application/json" // string | Must accept application/json. (optional) + citrixLocale := "en-US" // string | Locale of the request. (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.GpoDAAS.GpoReadGpoFilters(context.Background()).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).PolicyGuid(policyGuid).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GpoDAAS.GpoReadGpoFilters``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GpoReadGpoFilters`: CollectionEnvelopeOfFilterResponse + fmt.Fprintf(os.Stdout, "Response from `GpoDAAS.GpoReadGpoFilters`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGpoReadGpoFiltersRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **citrixCustomerId** | **string** | Citrix Customer ID. Default is 'CitrixOnPremises' | + **citrixInstanceId** | **string** | Citrix Instance (Site) ID. | + **policyGuid** | **string** | The GUID of the policy from which filters are read | + **userAgent** | **string** | User Agent type of the request. | + **authorization** | **string** | Citrix authorization header: CWSAuth Bearer={token} | + **citrixTransactionId** | **string** | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. | + **accept** | **string** | Must accept application/json. | + **citrixLocale** | **string** | Locale of the request. | + +### Return type + +[**CollectionEnvelopeOfFilterResponse**](CollectionEnvelopeOfFilterResponse.md) + +### Authorization + +[BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GpoReadGpoPolicies + +> CollectionEnvelopeOfPolicyResponse GpoReadGpoPolicies(ctx).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).PolicySetGuid(policySetGuid).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).WithSettings(withSettings).WithFilters(withFilters).Execute() + +Read all policies defined in a policy set. Policy templates don't have filters. + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration" +) + +func main() { + citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises' + citrixInstanceId := "citrixInstanceId_example" // string | Citrix Instance (Site) ID. + policySetGuid := "policySetGuid_example" // string | The GUID of the policy set from which policies are read + userAgent := "Mozilla/5.0" // string | User Agent type of the request. (optional) + authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional) + citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional) + accept := "application/json" // string | Must accept application/json. (optional) + citrixLocale := "en-US" // string | Locale of the request. (optional) + withSettings := true // bool | If set to true, settings in the policy are read (optional) + withFilters := true // bool | If set to true, filters in the policy are read (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.GpoDAAS.GpoReadGpoPolicies(context.Background()).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).PolicySetGuid(policySetGuid).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).WithSettings(withSettings).WithFilters(withFilters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GpoDAAS.GpoReadGpoPolicies``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GpoReadGpoPolicies`: CollectionEnvelopeOfPolicyResponse + fmt.Fprintf(os.Stdout, "Response from `GpoDAAS.GpoReadGpoPolicies`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGpoReadGpoPoliciesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **citrixCustomerId** | **string** | Citrix Customer ID. Default is 'CitrixOnPremises' | + **citrixInstanceId** | **string** | Citrix Instance (Site) ID. | + **policySetGuid** | **string** | The GUID of the policy set from which policies are read | + **userAgent** | **string** | User Agent type of the request. | + **authorization** | **string** | Citrix authorization header: CWSAuth Bearer={token} | + **citrixTransactionId** | **string** | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. | + **accept** | **string** | Must accept application/json. | + **citrixLocale** | **string** | Locale of the request. | + **withSettings** | **bool** | If set to true, settings in the policy are read | + **withFilters** | **bool** | If set to true, filters in the policy are read | + +### Return type + +[**CollectionEnvelopeOfPolicyResponse**](CollectionEnvelopeOfPolicyResponse.md) + +### Authorization + +[BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GpoReadGpoPolicy + +> PolicyResponse GpoReadGpoPolicy(ctx, policyGuid).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).WithSettings(withSettings).WithFilters(withFilters).Execute() + +Read a policy. A policy template doesn't have filters. + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration" +) + +func main() { + citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises' + citrixInstanceId := "citrixInstanceId_example" // string | Citrix Instance (Site) ID. + policyGuid := "policyGuid_example" // string | GUID of the policy to be read + userAgent := "Mozilla/5.0" // string | User Agent type of the request. (optional) + authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional) + citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional) + accept := "application/json" // string | Must accept application/json. (optional) + citrixLocale := "en-US" // string | Locale of the request. (optional) + withSettings := true // bool | If set to true, read policy settings (optional) + withFilters := true // bool | If set to true, read policy filters (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.GpoDAAS.GpoReadGpoPolicy(context.Background(), policyGuid).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).WithSettings(withSettings).WithFilters(withFilters).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GpoDAAS.GpoReadGpoPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GpoReadGpoPolicy`: PolicyResponse + fmt.Fprintf(os.Stdout, "Response from `GpoDAAS.GpoReadGpoPolicy`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**policyGuid** | **string** | GUID of the policy to be read | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGpoReadGpoPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **citrixCustomerId** | **string** | Citrix Customer ID. Default is 'CitrixOnPremises' | + **citrixInstanceId** | **string** | Citrix Instance (Site) ID. | + + **userAgent** | **string** | User Agent type of the request. | + **authorization** | **string** | Citrix authorization header: CWSAuth Bearer={token} | + **citrixTransactionId** | **string** | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. | + **accept** | **string** | Must accept application/json. | + **citrixLocale** | **string** | Locale of the request. | + **withSettings** | **bool** | If set to true, read policy settings | + **withFilters** | **bool** | If set to true, read policy filters | + +### Return type + +[**PolicyResponse**](PolicyResponse.md) + +### Authorization + +[BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GpoReadGpoPolicySet + +> PolicySetResponse GpoReadGpoPolicySet(ctx, policySetGuid).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).WithPolicies(withPolicies).Execute() + +Read a GPO policy set. + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration" +) + +func main() { + citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises' + citrixInstanceId := "citrixInstanceId_example" // string | Citrix Instance (Site) ID. + policySetGuid := "policySetGuid_example" // string | GUID of the policy set to read + userAgent := "Mozilla/5.0" // string | User Agent type of the request. (optional) + authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional) + citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional) + accept := "application/json" // string | Must accept application/json. (optional) + citrixLocale := "en-US" // string | Locale of the request. (optional) + withPolicies := true // bool | If set to true, read the policies in the policy set (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.GpoDAAS.GpoReadGpoPolicySet(context.Background(), policySetGuid).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).WithPolicies(withPolicies).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GpoDAAS.GpoReadGpoPolicySet``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GpoReadGpoPolicySet`: PolicySetResponse + fmt.Fprintf(os.Stdout, "Response from `GpoDAAS.GpoReadGpoPolicySet`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**policySetGuid** | **string** | GUID of the policy set to read | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGpoReadGpoPolicySetRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **citrixCustomerId** | **string** | Citrix Customer ID. Default is 'CitrixOnPremises' | + **citrixInstanceId** | **string** | Citrix Instance (Site) ID. | + + **userAgent** | **string** | User Agent type of the request. | + **authorization** | **string** | Citrix authorization header: CWSAuth Bearer={token} | + **citrixTransactionId** | **string** | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. | + **accept** | **string** | Must accept application/json. | + **citrixLocale** | **string** | Locale of the request. | + **withPolicies** | **bool** | If set to true, read the policies in the policy set | + +### Return type + +[**PolicySetResponse**](PolicySetResponse.md) + +### Authorization + +[BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GpoReadGpoPolicySets + +> CollectionEnvelopeOfPolicySetResponse GpoReadGpoPolicySets(ctx).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + +Get all GPO policy sets in the site. + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration" +) + +func main() { + citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises' + citrixInstanceId := "citrixInstanceId_example" // string | Citrix Instance (Site) ID. + userAgent := "Mozilla/5.0" // string | User Agent type of the request. (optional) + authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional) + citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional) + accept := "application/json" // string | Must accept application/json. (optional) + citrixLocale := "en-US" // string | Locale of the request. (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.GpoDAAS.GpoReadGpoPolicySets(context.Background()).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GpoDAAS.GpoReadGpoPolicySets``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GpoReadGpoPolicySets`: CollectionEnvelopeOfPolicySetResponse + fmt.Fprintf(os.Stdout, "Response from `GpoDAAS.GpoReadGpoPolicySets`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGpoReadGpoPolicySetsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **citrixCustomerId** | **string** | Citrix Customer ID. Default is 'CitrixOnPremises' | + **citrixInstanceId** | **string** | Citrix Instance (Site) ID. | + **userAgent** | **string** | User Agent type of the request. | + **authorization** | **string** | Citrix authorization header: CWSAuth Bearer={token} | + **citrixTransactionId** | **string** | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. | + **accept** | **string** | Must accept application/json. | + **citrixLocale** | **string** | Locale of the request. | + +### Return type + +[**CollectionEnvelopeOfPolicySetResponse**](CollectionEnvelopeOfPolicySetResponse.md) + +### Authorization + +[BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GpoReadGpoSetting + +> SettingResponse GpoReadGpoSetting(ctx, settingGuid).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + +Read a specific setting. + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration" +) + +func main() { + citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises' + citrixInstanceId := "citrixInstanceId_example" // string | Citrix Instance (Site) ID. + settingGuid := "settingGuid_example" // string | GUID of the setting to be read + userAgent := "Mozilla/5.0" // string | User Agent type of the request. (optional) + authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional) + citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional) + accept := "application/json" // string | Must accept application/json. (optional) + citrixLocale := "en-US" // string | Locale of the request. (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.GpoDAAS.GpoReadGpoSetting(context.Background(), settingGuid).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GpoDAAS.GpoReadGpoSetting``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GpoReadGpoSetting`: SettingResponse + fmt.Fprintf(os.Stdout, "Response from `GpoDAAS.GpoReadGpoSetting`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**settingGuid** | **string** | GUID of the setting to be read | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGpoReadGpoSettingRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **citrixCustomerId** | **string** | Citrix Customer ID. Default is 'CitrixOnPremises' | + **citrixInstanceId** | **string** | Citrix Instance (Site) ID. | + + **userAgent** | **string** | User Agent type of the request. | + **authorization** | **string** | Citrix authorization header: CWSAuth Bearer={token} | + **citrixTransactionId** | **string** | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. | + **accept** | **string** | Must accept application/json. | + **citrixLocale** | **string** | Locale of the request. | + +### Return type + +[**SettingResponse**](SettingResponse.md) + +### Authorization + +[BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GpoReadGpoSettings + +> CollectionEnvelopeOfSettingResponse GpoReadGpoSettings(ctx).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).PolicyGuid(policyGuid).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + +Read settings defined in a policy. + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration" +) + +func main() { + citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises' + citrixInstanceId := "citrixInstanceId_example" // string | Citrix Instance (Site) ID. + policyGuid := "policyGuid_example" // string | GUID of the policy from which settings are read + userAgent := "Mozilla/5.0" // string | User Agent type of the request. (optional) + authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional) + citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional) + accept := "application/json" // string | Must accept application/json. (optional) + citrixLocale := "en-US" // string | Locale of the request. (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.GpoDAAS.GpoReadGpoSettings(context.Background()).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).PolicyGuid(policyGuid).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GpoDAAS.GpoReadGpoSettings``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GpoReadGpoSettings`: CollectionEnvelopeOfSettingResponse + fmt.Fprintf(os.Stdout, "Response from `GpoDAAS.GpoReadGpoSettings`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGpoReadGpoSettingsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **citrixCustomerId** | **string** | Citrix Customer ID. Default is 'CitrixOnPremises' | + **citrixInstanceId** | **string** | Citrix Instance (Site) ID. | + **policyGuid** | **string** | GUID of the policy from which settings are read | + **userAgent** | **string** | User Agent type of the request. | + **authorization** | **string** | Citrix authorization header: CWSAuth Bearer={token} | + **citrixTransactionId** | **string** | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. | + **accept** | **string** | Must accept application/json. | + **citrixLocale** | **string** | Locale of the request. | + +### Return type + +[**CollectionEnvelopeOfSettingResponse**](CollectionEnvelopeOfSettingResponse.md) + +### Authorization + +[BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GpoRemoveGpoPolicies + +> GpoRemoveGpoPolicies(ctx).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).RequestBody(requestBody).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + +Remove some policies of a policy set. + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration" +) + +func main() { + citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises' + citrixInstanceId := "citrixInstanceId_example" // string | Citrix Instance (Site) ID. + requestBody := []string{"Property_example"} // []string | GUIDs of the policies to be removed + userAgent := "Mozilla/5.0" // string | User Agent type of the request. (optional) + authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional) + citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional) + accept := "application/json" // string | Must accept application/json. (optional) + citrixLocale := "en-US" // string | Locale of the request. (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + r, err := apiClient.GpoDAAS.GpoRemoveGpoPolicies(context.Background()).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).RequestBody(requestBody).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GpoDAAS.GpoRemoveGpoPolicies``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGpoRemoveGpoPoliciesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **citrixCustomerId** | **string** | Citrix Customer ID. Default is 'CitrixOnPremises' | + **citrixInstanceId** | **string** | Citrix Instance (Site) ID. | + **requestBody** | **[]string** | GUIDs of the policies to be removed | + **userAgent** | **string** | User Agent type of the request. | + **authorization** | **string** | Citrix authorization header: CWSAuth Bearer={token} | + **citrixTransactionId** | **string** | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. | + **accept** | **string** | Must accept application/json. | + **citrixLocale** | **string** | Locale of the request. | + +### Return type + + (empty response body) + +### Authorization + +[BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GpoRunSimulation + +> []SimulationResponseContract GpoRunSimulation(ctx).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).PolicySetGuid(policySetGuid).SimulationRequestContract(simulationRequestContract).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + +Simulate policy application. + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration" +) + +func main() { + citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises' + citrixInstanceId := "citrixInstanceId_example" // string | Citrix Instance (Site) ID. + policySetGuid := "policySetGuid_example" // string | The GUID of the policy set, on which this simulation is run + simulationRequestContract := *openapiclient.NewSimulationRequestContract() // SimulationRequestContract | Modeling request + userAgent := "Mozilla/5.0" // string | User Agent type of the request. (optional) + authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional) + citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional) + accept := "application/json" // string | Must accept application/json. (optional) + citrixLocale := "en-US" // string | Locale of the request. (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.GpoDAAS.GpoRunSimulation(context.Background()).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).PolicySetGuid(policySetGuid).SimulationRequestContract(simulationRequestContract).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GpoDAAS.GpoRunSimulation``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GpoRunSimulation`: []SimulationResponseContract + fmt.Fprintf(os.Stdout, "Response from `GpoDAAS.GpoRunSimulation`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGpoRunSimulationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **citrixCustomerId** | **string** | Citrix Customer ID. Default is 'CitrixOnPremises' | + **citrixInstanceId** | **string** | Citrix Instance (Site) ID. | + **policySetGuid** | **string** | The GUID of the policy set, on which this simulation is run | + **simulationRequestContract** | [**SimulationRequestContract**](SimulationRequestContract.md) | Modeling request | + **userAgent** | **string** | User Agent type of the request. | + **authorization** | **string** | Citrix authorization header: CWSAuth Bearer={token} | + **citrixTransactionId** | **string** | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. | + **accept** | **string** | Must accept application/json. | + **citrixLocale** | **string** | Locale of the request. | + +### Return type + +[**[]SimulationResponseContract**](SimulationResponseContract.md) + +### Authorization + +[BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GpoSearchFilters + +> CollectionEnvelopeOfFilterResponse GpoSearchFilters(ctx).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).FilterSearch(filterSearch).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Limit(limit).ContinuationToken(continuationToken).Async(async).Execute() + +Perform an advanced search for GPO filters. + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration" +) + +func main() { + citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises' + citrixInstanceId := "citrixInstanceId_example" // string | Citrix Instance (Site) ID. + filterSearch := *openapiclient.NewFilterSearch() // FilterSearch | Specifies the advanced search parameters. + userAgent := "Mozilla/5.0" // string | User Agent type of the request. (optional) + authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional) + citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional) + accept := "application/json" // string | Must accept application/json. (optional) + citrixLocale := "en-US" // string | Locale of the request. (optional) + limit := int32(56) // int32 | Maximum number of objects, which must not exceed 1000, to return. If not specified, the default value is 250. (optional) + continuationToken := "continuationToken_example" // string | If a previous call didn't return all the records expected, pass the continuation token returned from the previous response to this current query to continue retrieving the remaining objects. (optional) + async := true // bool | If `true`, the search operations will be executed as a background task. (optional) (default to false) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.GpoDAAS.GpoSearchFilters(context.Background()).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).FilterSearch(filterSearch).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Limit(limit).ContinuationToken(continuationToken).Async(async).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GpoDAAS.GpoSearchFilters``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GpoSearchFilters`: CollectionEnvelopeOfFilterResponse + fmt.Fprintf(os.Stdout, "Response from `GpoDAAS.GpoSearchFilters`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGpoSearchFiltersRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **citrixCustomerId** | **string** | Citrix Customer ID. Default is 'CitrixOnPremises' | + **citrixInstanceId** | **string** | Citrix Instance (Site) ID. | + **filterSearch** | [**FilterSearch**](FilterSearch.md) | Specifies the advanced search parameters. | + **userAgent** | **string** | User Agent type of the request. | + **authorization** | **string** | Citrix authorization header: CWSAuth Bearer={token} | + **citrixTransactionId** | **string** | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. | + **accept** | **string** | Must accept application/json. | + **citrixLocale** | **string** | Locale of the request. | + **limit** | **int32** | Maximum number of objects, which must not exceed 1000, to return. If not specified, the default value is 250. | + **continuationToken** | **string** | If a previous call didn't return all the records expected, pass the continuation token returned from the previous response to this current query to continue retrieving the remaining objects. | + **async** | **bool** | If `true`, the search operations will be executed as a background task. | [default to false] + +### Return type + +[**CollectionEnvelopeOfFilterResponse**](CollectionEnvelopeOfFilterResponse.md) + +### Authorization + +[BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GpoSearchPolicies + +> CollectionEnvelopeOfPolicyResponse GpoSearchPolicies(ctx).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).PolicySearch(policySearch).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Limit(limit).ContinuationToken(continuationToken).Async(async).Execute() + +Perform an advanced search for GPO policies. + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration" +) + +func main() { + citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises' + citrixInstanceId := "citrixInstanceId_example" // string | Citrix Instance (Site) ID. + policySearch := *openapiclient.NewPolicySearch() // PolicySearch | Specifies the advanced search parameters. + userAgent := "Mozilla/5.0" // string | User Agent type of the request. (optional) + authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional) + citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional) + accept := "application/json" // string | Must accept application/json. (optional) + citrixLocale := "en-US" // string | Locale of the request. (optional) + limit := int32(56) // int32 | Maximum number of objects, which must not exceed 1000, to return. If not specified, the default value is 250. (optional) + continuationToken := "continuationToken_example" // string | If a previous call didn't return all the records expected, pass the continuation token returned from the previous response to this current query to continue retrieving the remaining objects. (optional) + async := true // bool | If `true`, the search operations will be executed as a background task. (optional) (default to false) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.GpoDAAS.GpoSearchPolicies(context.Background()).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).PolicySearch(policySearch).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Limit(limit).ContinuationToken(continuationToken).Async(async).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GpoDAAS.GpoSearchPolicies``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GpoSearchPolicies`: CollectionEnvelopeOfPolicyResponse + fmt.Fprintf(os.Stdout, "Response from `GpoDAAS.GpoSearchPolicies`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGpoSearchPoliciesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **citrixCustomerId** | **string** | Citrix Customer ID. Default is 'CitrixOnPremises' | + **citrixInstanceId** | **string** | Citrix Instance (Site) ID. | + **policySearch** | [**PolicySearch**](PolicySearch.md) | Specifies the advanced search parameters. | + **userAgent** | **string** | User Agent type of the request. | + **authorization** | **string** | Citrix authorization header: CWSAuth Bearer={token} | + **citrixTransactionId** | **string** | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. | + **accept** | **string** | Must accept application/json. | + **citrixLocale** | **string** | Locale of the request. | + **limit** | **int32** | Maximum number of objects, which must not exceed 1000, to return. If not specified, the default value is 250. | + **continuationToken** | **string** | If a previous call didn't return all the records expected, pass the continuation token returned from the previous response to this current query to continue retrieving the remaining objects. | + **async** | **bool** | If `true`, the search operations will be executed as a background task. | [default to false] + +### Return type + +[**CollectionEnvelopeOfPolicyResponse**](CollectionEnvelopeOfPolicyResponse.md) + +### Authorization + +[BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GpoSearchPolicySets + +> CollectionEnvelopeOfPolicySetResponse GpoSearchPolicySets(ctx).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).PolicySetSearch(policySetSearch).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Limit(limit).ContinuationToken(continuationToken).Async(async).Execute() + +Perform an advanced search for GPO policy sets. + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration" +) + +func main() { + citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises' + citrixInstanceId := "citrixInstanceId_example" // string | Citrix Instance (Site) ID. + policySetSearch := *openapiclient.NewPolicySetSearch() // PolicySetSearch | Specifies the advanced search parameters. + userAgent := "Mozilla/5.0" // string | User Agent type of the request. (optional) + authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional) + citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional) + accept := "application/json" // string | Must accept application/json. (optional) + citrixLocale := "en-US" // string | Locale of the request. (optional) + limit := int32(56) // int32 | Maximum number of objects, which must not exceed 1000, to return. If not specified, the default value is 250. (optional) + continuationToken := "continuationToken_example" // string | If a previous call didn't return all the records expected, pass the continuation token returned from the previous response to this current query to continue retrieving the remaining objects. (optional) + async := true // bool | If `true`, the search operations will be executed as a background task. (optional) (default to false) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.GpoDAAS.GpoSearchPolicySets(context.Background()).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).PolicySetSearch(policySetSearch).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Limit(limit).ContinuationToken(continuationToken).Async(async).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GpoDAAS.GpoSearchPolicySets``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GpoSearchPolicySets`: CollectionEnvelopeOfPolicySetResponse + fmt.Fprintf(os.Stdout, "Response from `GpoDAAS.GpoSearchPolicySets`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGpoSearchPolicySetsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **citrixCustomerId** | **string** | Citrix Customer ID. Default is 'CitrixOnPremises' | + **citrixInstanceId** | **string** | Citrix Instance (Site) ID. | + **policySetSearch** | [**PolicySetSearch**](PolicySetSearch.md) | Specifies the advanced search parameters. | + **userAgent** | **string** | User Agent type of the request. | + **authorization** | **string** | Citrix authorization header: CWSAuth Bearer={token} | + **citrixTransactionId** | **string** | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. | + **accept** | **string** | Must accept application/json. | + **citrixLocale** | **string** | Locale of the request. | + **limit** | **int32** | Maximum number of objects, which must not exceed 1000, to return. If not specified, the default value is 250. | + **continuationToken** | **string** | If a previous call didn't return all the records expected, pass the continuation token returned from the previous response to this current query to continue retrieving the remaining objects. | + **async** | **bool** | If `true`, the search operations will be executed as a background task. | [default to false] + +### Return type + +[**CollectionEnvelopeOfPolicySetResponse**](CollectionEnvelopeOfPolicySetResponse.md) + +### Authorization + +[BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GpoSearchSettings + +> CollectionEnvelopeOfSettingResponse GpoSearchSettings(ctx).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).SettingSearch(settingSearch).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Limit(limit).ContinuationToken(continuationToken).Async(async).Execute() + +Perform an advanced search for GPO settings. + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration" +) + +func main() { + citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises' + citrixInstanceId := "citrixInstanceId_example" // string | Citrix Instance (Site) ID. + settingSearch := *openapiclient.NewSettingSearch() // SettingSearch | Specifies the advanced search parameters. + userAgent := "Mozilla/5.0" // string | User Agent type of the request. (optional) + authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional) + citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional) + accept := "application/json" // string | Must accept application/json. (optional) + citrixLocale := "en-US" // string | Locale of the request. (optional) + limit := int32(56) // int32 | Maximum number of objects, which must not exceed 1000, to return. If not specified, the default value is 250. (optional) + continuationToken := "continuationToken_example" // string | If a previous call didn't return all the records expected, pass the continuation token returned from the previous response to this current query to continue retrieving the remaining objects. (optional) + async := true // bool | If `true`, the search operations will be executed as a background task. (optional) (default to false) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.GpoDAAS.GpoSearchSettings(context.Background()).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).SettingSearch(settingSearch).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Limit(limit).ContinuationToken(continuationToken).Async(async).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GpoDAAS.GpoSearchSettings``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GpoSearchSettings`: CollectionEnvelopeOfSettingResponse + fmt.Fprintf(os.Stdout, "Response from `GpoDAAS.GpoSearchSettings`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGpoSearchSettingsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **citrixCustomerId** | **string** | Citrix Customer ID. Default is 'CitrixOnPremises' | + **citrixInstanceId** | **string** | Citrix Instance (Site) ID. | + **settingSearch** | [**SettingSearch**](SettingSearch.md) | Specifies the advanced search parameters. | + **userAgent** | **string** | User Agent type of the request. | + **authorization** | **string** | Citrix authorization header: CWSAuth Bearer={token} | + **citrixTransactionId** | **string** | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. | + **accept** | **string** | Must accept application/json. | + **citrixLocale** | **string** | Locale of the request. | + **limit** | **int32** | Maximum number of objects, which must not exceed 1000, to return. If not specified, the default value is 250. | + **continuationToken** | **string** | If a previous call didn't return all the records expected, pass the continuation token returned from the previous response to this current query to continue retrieving the remaining objects. | + **async** | **bool** | If `true`, the search operations will be executed as a background task. | [default to false] + +### Return type + +[**CollectionEnvelopeOfSettingResponse**](CollectionEnvelopeOfSettingResponse.md) + +### Authorization + +[BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GpoUpdateGpoFilter + +> GpoUpdateGpoFilter(ctx, filterGuid).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).FilterRequest(filterRequest).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + +Update an existing filter. + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration" +) + +func main() { + citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises' + citrixInstanceId := "citrixInstanceId_example" // string | Citrix Instance (Site) ID. + filterGuid := "filterGuid_example" // string | The GUID of the filter to be updated + filterRequest := *openapiclient.NewFilterRequest() // FilterRequest | Filter data. The filter type is ignored + userAgent := "Mozilla/5.0" // string | User Agent type of the request. (optional) + authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional) + citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional) + accept := "application/json" // string | Must accept application/json. (optional) + citrixLocale := "en-US" // string | Locale of the request. (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + r, err := apiClient.GpoDAAS.GpoUpdateGpoFilter(context.Background(), filterGuid).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).FilterRequest(filterRequest).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GpoDAAS.GpoUpdateGpoFilter``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**filterGuid** | **string** | The GUID of the filter to be updated | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGpoUpdateGpoFilterRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **citrixCustomerId** | **string** | Citrix Customer ID. Default is 'CitrixOnPremises' | + **citrixInstanceId** | **string** | Citrix Instance (Site) ID. | + + **filterRequest** | [**FilterRequest**](FilterRequest.md) | Filter data. The filter type is ignored | + **userAgent** | **string** | User Agent type of the request. | + **authorization** | **string** | Citrix authorization header: CWSAuth Bearer={token} | + **citrixTransactionId** | **string** | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. | + **accept** | **string** | Must accept application/json. | + **citrixLocale** | **string** | Locale of the request. | + +### Return type + + (empty response body) + +### Authorization + +[BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GpoUpdateGpoPolicy + +> GpoUpdateGpoPolicy(ctx, policyGuid).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).PolicyBodyRequest(policyBodyRequest).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + +Update a policy. Only the policy body is updated. + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration" +) + +func main() { + citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises' + citrixInstanceId := "citrixInstanceId_example" // string | Citrix Instance (Site) ID. + policyGuid := "policyGuid_example" // string | GUID of the policy to be updated + policyBodyRequest := *openapiclient.NewPolicyBodyRequest() // PolicyBodyRequest | New policy data + userAgent := "Mozilla/5.0" // string | User Agent type of the request. (optional) + authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional) + citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional) + accept := "application/json" // string | Must accept application/json. (optional) + citrixLocale := "en-US" // string | Locale of the request. (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + r, err := apiClient.GpoDAAS.GpoUpdateGpoPolicy(context.Background(), policyGuid).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).PolicyBodyRequest(policyBodyRequest).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GpoDAAS.GpoUpdateGpoPolicy``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**policyGuid** | **string** | GUID of the policy to be updated | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGpoUpdateGpoPolicyRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **citrixCustomerId** | **string** | Citrix Customer ID. Default is 'CitrixOnPremises' | + **citrixInstanceId** | **string** | Citrix Instance (Site) ID. | + + **policyBodyRequest** | [**PolicyBodyRequest**](PolicyBodyRequest.md) | New policy data | + **userAgent** | **string** | User Agent type of the request. | + **authorization** | **string** | Citrix authorization header: CWSAuth Bearer={token} | + **citrixTransactionId** | **string** | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. | + **accept** | **string** | Must accept application/json. | + **citrixLocale** | **string** | Locale of the request. | + +### Return type + + (empty response body) + +### Authorization + +[BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GpoUpdateGpoPolicySet + +> GpoUpdateGpoPolicySet(ctx, policySetGuid).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).PolicySetRequest(policySetRequest).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + +Update an existing GPO policy set. + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration" +) + +func main() { + citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises' + citrixInstanceId := "citrixInstanceId_example" // string | Citrix Instance (Site) ID. + policySetGuid := "policySetGuid_example" // string | The GUID of the policy set to update + policySetRequest := *openapiclient.NewPolicySetRequest() // PolicySetRequest | New description of the policy set + userAgent := "Mozilla/5.0" // string | User Agent type of the request. (optional) + authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional) + citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional) + accept := "application/json" // string | Must accept application/json. (optional) + citrixLocale := "en-US" // string | Locale of the request. (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + r, err := apiClient.GpoDAAS.GpoUpdateGpoPolicySet(context.Background(), policySetGuid).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).PolicySetRequest(policySetRequest).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GpoDAAS.GpoUpdateGpoPolicySet``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**policySetGuid** | **string** | The GUID of the policy set to update | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGpoUpdateGpoPolicySetRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **citrixCustomerId** | **string** | Citrix Customer ID. Default is 'CitrixOnPremises' | + **citrixInstanceId** | **string** | Citrix Instance (Site) ID. | + + **policySetRequest** | [**PolicySetRequest**](PolicySetRequest.md) | New description of the policy set | + **userAgent** | **string** | User Agent type of the request. | + **authorization** | **string** | Citrix authorization header: CWSAuth Bearer={token} | + **citrixTransactionId** | **string** | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. | + **accept** | **string** | Must accept application/json. | + **citrixLocale** | **string** | Locale of the request. | + +### Return type + + (empty response body) + +### Authorization + +[BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GpoUpdateGpoSetting + +> GpoUpdateGpoSetting(ctx, settingGuid).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).SettingRequest(settingRequest).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + +Update a setting. Settings in the policy set of type SiteTemplates cannot be updated. + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration" +) + +func main() { + citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises' + citrixInstanceId := "citrixInstanceId_example" // string | Citrix Instance (Site) ID. + settingGuid := "settingGuid_example" // string | GUID of the setting to be updated + settingRequest := *openapiclient.NewSettingRequest() // SettingRequest | New setting value + userAgent := "Mozilla/5.0" // string | User Agent type of the request. (optional) + authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional) + citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional) + accept := "application/json" // string | Must accept application/json. (optional) + citrixLocale := "en-US" // string | Locale of the request. (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + r, err := apiClient.GpoDAAS.GpoUpdateGpoSetting(context.Background(), settingGuid).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).SettingRequest(settingRequest).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GpoDAAS.GpoUpdateGpoSetting``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**settingGuid** | **string** | GUID of the setting to be updated | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGpoUpdateGpoSettingRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **citrixCustomerId** | **string** | Citrix Customer ID. Default is 'CitrixOnPremises' | + **citrixInstanceId** | **string** | Citrix Instance (Site) ID. | + + **settingRequest** | [**SettingRequest**](SettingRequest.md) | New setting value | + **userAgent** | **string** | User Agent type of the request. | + **authorization** | **string** | Citrix authorization header: CWSAuth Bearer={token} | + **citrixTransactionId** | **string** | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. | + **accept** | **string** | Must accept application/json. | + **citrixLocale** | **string** | Locale of the request. | + +### Return type + + (empty response body) + +### Authorization + +[BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GpoUpdatePolicySetBlob + +> GpoUpdatePolicySetBlob(ctx, policySetGuid).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + +Force serialization of policy set. The data of a policy set is serialized into a byte stream before it is sent to VDAs. The serialization is done automatically in the background at 5 minute intervals. A change made to the data in a policy set may not be in the serialized data for up to 5 minutes. This call tells the background thread to serialize the data immediately. No serialization is done if there have been no changes to the policy set data since the last time the data was serialized. + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration" +) + +func main() { + citrixCustomerId := "CitrixOnPremises" // string | Citrix Customer ID. Default is 'CitrixOnPremises' + citrixInstanceId := "citrixInstanceId_example" // string | Citrix Instance (Site) ID. + policySetGuid := "policySetGuid_example" // string | The GUID of the policy set whose data is to be serialized + userAgent := "Mozilla/5.0" // string | User Agent type of the request. (optional) + authorization := "authorization_example" // string | Citrix authorization header: CWSAuth Bearer={token} (optional) + citrixTransactionId := "citrixTransactionId_example" // string | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. (optional) + accept := "application/json" // string | Must accept application/json. (optional) + citrixLocale := "en-US" // string | Locale of the request. (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + r, err := apiClient.GpoDAAS.GpoUpdatePolicySetBlob(context.Background(), policySetGuid).CitrixCustomerId(citrixCustomerId).CitrixInstanceId(citrixInstanceId).UserAgent(userAgent).Authorization(authorization).CitrixTransactionId(citrixTransactionId).Accept(accept).CitrixLocale(citrixLocale).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `GpoDAAS.GpoUpdatePolicySetBlob``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**policySetGuid** | **string** | The GUID of the policy set whose data is to be serialized | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGpoUpdatePolicySetBlobRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **citrixCustomerId** | **string** | Citrix Customer ID. Default is 'CitrixOnPremises' | + **citrixInstanceId** | **string** | Citrix Instance (Site) ID. | + + **userAgent** | **string** | User Agent type of the request. | + **authorization** | **string** | Citrix authorization header: CWSAuth Bearer={token} | + **citrixTransactionId** | **string** | Transaction ID that will be used to track this request. If not provided, a new GUID will be generated and returned. | + **accept** | **string** | Must accept application/json. | + **citrixLocale** | **string** | Locale of the request. | + +### Return type + + (empty response body) + +### Authorization + +[BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/citrixorchestration/docs/HypervisorMachineCatalogResponseModel.md b/citrixorchestration/docs/HypervisorMachineCatalogResponseModel.md index 17de929..7ed7cca 100644 --- a/citrixorchestration/docs/HypervisorMachineCatalogResponseModel.md +++ b/citrixorchestration/docs/HypervisorMachineCatalogResponseModel.md @@ -88,7 +88,22 @@ and a boolean to check if the value has been set. SetName sets Name field to given value. +### HasName +`func (o *HypervisorMachineCatalogResponseModel) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *HypervisorMachineCatalogResponseModel) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *HypervisorMachineCatalogResponseModel) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil ### GetFullName `func (o *HypervisorMachineCatalogResponseModel) GetFullName() string` @@ -143,7 +158,22 @@ and a boolean to check if the value has been set. SetId sets Id field to given value. +### HasId + +`func (o *HypervisorMachineCatalogResponseModel) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetIdNil + +`func (o *HypervisorMachineCatalogResponseModel) SetIdNil(b bool)` + + SetIdNil sets the value for Id to be an explicit nil + +### UnsetId +`func (o *HypervisorMachineCatalogResponseModel) UnsetId()` +UnsetId ensures that no value is present for Id, not even an explicit nil ### GetUid `func (o *HypervisorMachineCatalogResponseModel) GetUid() int32` @@ -188,6 +218,11 @@ and a boolean to check if the value has been set. SetAllocationType sets AllocationType field to given value. +### HasAllocationType + +`func (o *HypervisorMachineCatalogResponseModel) HasAllocationType() bool` + +HasAllocationType returns a boolean if a field has been set. ### GetAssignedCount @@ -278,6 +313,11 @@ and a boolean to check if the value has been set. SetAvailableCount sets AvailableCount field to given value. +### HasAvailableCount + +`func (o *HypervisorMachineCatalogResponseModel) HasAvailableCount() bool` + +HasAvailableCount returns a boolean if a field has been set. ### GetAvailableUnassignedCount @@ -393,6 +433,11 @@ and a boolean to check if the value has been set. SetIsRemotePC sets IsRemotePC field to given value. +### HasIsRemotePC + +`func (o *HypervisorMachineCatalogResponseModel) HasIsRemotePC() bool` + +HasIsRemotePC returns a boolean if a field has been set. ### GetJobsInProgress @@ -448,6 +493,11 @@ and a boolean to check if the value has been set. SetMachineType sets MachineType field to given value. +### HasMachineType + +`func (o *HypervisorMachineCatalogResponseModel) HasMachineType() bool` + +HasMachineType returns a boolean if a field has been set. ### GetMetadata @@ -503,6 +553,11 @@ and a boolean to check if the value has been set. SetMinimumFunctionalLevel sets MinimumFunctionalLevel field to given value. +### HasMinimumFunctionalLevel + +`func (o *HypervisorMachineCatalogResponseModel) HasMinimumFunctionalLevel() bool` + +HasMinimumFunctionalLevel returns a boolean if a field has been set. ### GetHasBeenPromoted @@ -523,6 +578,11 @@ and a boolean to check if the value has been set. SetHasBeenPromoted sets HasBeenPromoted field to given value. +### HasHasBeenPromoted + +`func (o *HypervisorMachineCatalogResponseModel) HasHasBeenPromoted() bool` + +HasHasBeenPromoted returns a boolean if a field has been set. ### GetHasBeenPromotedFrom @@ -568,6 +628,11 @@ and a boolean to check if the value has been set. SetCanRollbackVMImage sets CanRollbackVMImage field to given value. +### HasCanRollbackVMImage + +`func (o *HypervisorMachineCatalogResponseModel) HasCanRollbackVMImage() bool` + +HasCanRollbackVMImage returns a boolean if a field has been set. ### GetCanRecreateCatalog @@ -588,6 +653,11 @@ and a boolean to check if the value has been set. SetCanRecreateCatalog sets CanRecreateCatalog field to given value. +### HasCanRecreateCatalog + +`func (o *HypervisorMachineCatalogResponseModel) HasCanRecreateCatalog() bool` + +HasCanRecreateCatalog returns a boolean if a field has been set. ### GetPersistChanges @@ -608,6 +678,11 @@ and a boolean to check if the value has been set. SetPersistChanges sets PersistChanges field to given value. +### HasPersistChanges + +`func (o *HypervisorMachineCatalogResponseModel) HasPersistChanges() bool` + +HasPersistChanges returns a boolean if a field has been set. ### GetProvisioningScheme @@ -653,6 +728,11 @@ and a boolean to check if the value has been set. SetProvisioningType sets ProvisioningType field to given value. +### HasProvisioningType + +`func (o *HypervisorMachineCatalogResponseModel) HasProvisioningType() bool` + +HasProvisioningType returns a boolean if a field has been set. ### GetProvisioningProgress @@ -873,6 +953,11 @@ and a boolean to check if the value has been set. SetSessionSupport sets SessionSupport field to given value. +### HasSessionSupport + +`func (o *HypervisorMachineCatalogResponseModel) HasSessionSupport() bool` + +HasSessionSupport returns a boolean if a field has been set. ### GetSharingKind @@ -893,6 +978,11 @@ and a boolean to check if the value has been set. SetSharingKind sets SharingKind field to given value. +### HasSharingKind + +`func (o *HypervisorMachineCatalogResponseModel) HasSharingKind() bool` + +HasSharingKind returns a boolean if a field has been set. ### GetTotalCount @@ -913,6 +1003,11 @@ and a boolean to check if the value has been set. SetTotalCount sets TotalCount field to given value. +### HasTotalCount + +`func (o *HypervisorMachineCatalogResponseModel) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. ### GetIsBroken @@ -933,6 +1028,11 @@ and a boolean to check if the value has been set. SetIsBroken sets IsBroken field to given value. +### HasIsBroken + +`func (o *HypervisorMachineCatalogResponseModel) HasIsBroken() bool` + +HasIsBroken returns a boolean if a field has been set. ### GetIsMasterImageAssociated @@ -1083,6 +1183,11 @@ and a boolean to check if the value has been set. SetUnassignedCount sets UnassignedCount field to given value. +### HasUnassignedCount + +`func (o *HypervisorMachineCatalogResponseModel) HasUnassignedCount() bool` + +HasUnassignedCount returns a boolean if a field has been set. ### GetUsedCount @@ -1103,6 +1208,11 @@ and a boolean to check if the value has been set. SetUsedCount sets UsedCount field to given value. +### HasUsedCount + +`func (o *HypervisorMachineCatalogResponseModel) HasUsedCount() bool` + +HasUsedCount returns a boolean if a field has been set. ### GetAvailableCountOfSuspend @@ -1218,6 +1328,11 @@ and a boolean to check if the value has been set. SetZone sets Zone field to given value. +### HasZone + +`func (o *HypervisorMachineCatalogResponseModel) HasZone() bool` + +HasZone returns a boolean if a field has been set. ### GetAdminFolder diff --git a/citrixorchestration/docs/HypervisorResourceSearchResourceType.md b/citrixorchestration/docs/HypervisorResourceSearchResourceType.md index a10e6ea..66eea5d 100644 --- a/citrixorchestration/docs/HypervisorResourceSearchResourceType.md +++ b/citrixorchestration/docs/HypervisorResourceSearchResourceType.md @@ -9,6 +9,8 @@ * `LAUNCH_TEMPLATE_VERSION` (value: `"LaunchTemplateVersion"`) +* `FOLDER` (value: `"Folder"`) + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/citrixorchestration/docs/JobType.md b/citrixorchestration/docs/JobType.md index e56414d..d7584c1 100644 --- a/citrixorchestration/docs/JobType.md +++ b/citrixorchestration/docs/JobType.md @@ -489,6 +489,10 @@ * `VALIDATE_MACHINE_CATALOG_CREATION` (value: `"ValidateMachineCatalogCreation"`) +* `SEARCH_PROVISIONED_VIRTUAL_MACHINES` (value: `"SearchProvisionedVirtualMachines"`) + +* `GET_PROVISIONED_VIRTUAL_MACHINE_DETAILS` (value: `"GetProvisionedVirtualMachineDetails"`) + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/citrixorchestration/docs/MachineApplicationResponseModel.md b/citrixorchestration/docs/MachineApplicationResponseModel.md index 6109f3a..19b12e0 100644 --- a/citrixorchestration/docs/MachineApplicationResponseModel.md +++ b/citrixorchestration/docs/MachineApplicationResponseModel.md @@ -73,7 +73,22 @@ and a boolean to check if the value has been set. SetId sets Id field to given value. +### HasId +`func (o *MachineApplicationResponseModel) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetIdNil + +`func (o *MachineApplicationResponseModel) SetIdNil(b bool)` + + SetIdNil sets the value for Id to be an explicit nil + +### UnsetId +`func (o *MachineApplicationResponseModel) UnsetId()` + +UnsetId ensures that no value is present for Id, not even an explicit nil ### GetUid `func (o *MachineApplicationResponseModel) GetUid() int32` @@ -128,6 +143,11 @@ and a boolean to check if the value has been set. SetApplicationFolder sets ApplicationFolder field to given value. +### HasApplicationFolder + +`func (o *MachineApplicationResponseModel) HasApplicationFolder() bool` + +HasApplicationFolder returns a boolean if a field has been set. ### GetApplicationType @@ -148,6 +168,11 @@ and a boolean to check if the value has been set. SetApplicationType sets ApplicationType field to given value. +### HasApplicationType + +`func (o *MachineApplicationResponseModel) HasApplicationType() bool` + +HasApplicationType returns a boolean if a field has been set. ### GetPackagedApplicationType @@ -168,6 +193,11 @@ and a boolean to check if the value has been set. SetPackagedApplicationType sets PackagedApplicationType field to given value. +### HasPackagedApplicationType + +`func (o *MachineApplicationResponseModel) HasPackagedApplicationType() bool` + +HasPackagedApplicationType returns a boolean if a field has been set. ### GetClientFolder @@ -223,7 +253,22 @@ and a boolean to check if the value has been set. SetContainerScopes sets ContainerScopes field to given value. +### HasContainerScopes + +`func (o *MachineApplicationResponseModel) HasContainerScopes() bool` + +HasContainerScopes returns a boolean if a field has been set. + +### SetContainerScopesNil + +`func (o *MachineApplicationResponseModel) SetContainerScopesNil(b bool)` + SetContainerScopesNil sets the value for ContainerScopes to be an explicit nil + +### UnsetContainerScopes +`func (o *MachineApplicationResponseModel) UnsetContainerScopes()` + +UnsetContainerScopes ensures that no value is present for ContainerScopes, not even an explicit nil ### GetDescription `func (o *MachineApplicationResponseModel) GetDescription() string` @@ -303,6 +348,11 @@ and a boolean to check if the value has been set. SetEnabled sets Enabled field to given value. +### HasEnabled + +`func (o *MachineApplicationResponseModel) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. ### GetIconId @@ -323,7 +373,22 @@ and a boolean to check if the value has been set. SetIconId sets IconId field to given value. +### HasIconId + +`func (o *MachineApplicationResponseModel) HasIconId() bool` +HasIconId returns a boolean if a field has been set. + +### SetIconIdNil + +`func (o *MachineApplicationResponseModel) SetIconIdNil(b bool)` + + SetIconIdNil sets the value for IconId to be an explicit nil + +### UnsetIconId +`func (o *MachineApplicationResponseModel) UnsetIconId()` + +UnsetIconId ensures that no value is present for IconId, not even an explicit nil ### GetInstalledAppProperties `func (o *MachineApplicationResponseModel) GetInstalledAppProperties() InstalledAppResponseModel` @@ -453,7 +518,22 @@ and a boolean to check if the value has been set. SetName sets Name field to given value. +### HasName + +`func (o *MachineApplicationResponseModel) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *MachineApplicationResponseModel) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *MachineApplicationResponseModel) UnsetName()` +UnsetName ensures that no value is present for Name, not even an explicit nil ### GetPublishedName `func (o *MachineApplicationResponseModel) GetPublishedName() string` @@ -473,7 +553,22 @@ and a boolean to check if the value has been set. SetPublishedName sets PublishedName field to given value. +### HasPublishedName +`func (o *MachineApplicationResponseModel) HasPublishedName() bool` + +HasPublishedName returns a boolean if a field has been set. + +### SetPublishedNameNil + +`func (o *MachineApplicationResponseModel) SetPublishedNameNil(b bool)` + + SetPublishedNameNil sets the value for PublishedName to be an explicit nil + +### UnsetPublishedName +`func (o *MachineApplicationResponseModel) UnsetPublishedName()` + +UnsetPublishedName ensures that no value is present for PublishedName, not even an explicit nil ### GetMetadata `func (o *MachineApplicationResponseModel) GetMetadata() []NameValueStringPairModel` @@ -528,6 +623,11 @@ and a boolean to check if the value has been set. SetVisible sets Visible field to given value. +### HasVisible + +`func (o *MachineApplicationResponseModel) HasVisible() bool` + +HasVisible returns a boolean if a field has been set. ### GetSharingKind @@ -548,6 +648,11 @@ and a boolean to check if the value has been set. SetSharingKind sets SharingKind field to given value. +### HasSharingKind + +`func (o *MachineApplicationResponseModel) HasSharingKind() bool` + +HasSharingKind returns a boolean if a field has been set. ### GetTags diff --git a/citrixorchestration/docs/MachineCatalogDetailResponseModel.md b/citrixorchestration/docs/MachineCatalogDetailResponseModel.md index 82a3973..316b8d3 100644 --- a/citrixorchestration/docs/MachineCatalogDetailResponseModel.md +++ b/citrixorchestration/docs/MachineCatalogDetailResponseModel.md @@ -93,7 +93,22 @@ and a boolean to check if the value has been set. SetName sets Name field to given value. +### HasName +`func (o *MachineCatalogDetailResponseModel) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *MachineCatalogDetailResponseModel) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *MachineCatalogDetailResponseModel) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil ### GetFullName `func (o *MachineCatalogDetailResponseModel) GetFullName() string` @@ -148,7 +163,22 @@ and a boolean to check if the value has been set. SetId sets Id field to given value. +### HasId + +`func (o *MachineCatalogDetailResponseModel) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetIdNil + +`func (o *MachineCatalogDetailResponseModel) SetIdNil(b bool)` + + SetIdNil sets the value for Id to be an explicit nil + +### UnsetId +`func (o *MachineCatalogDetailResponseModel) UnsetId()` +UnsetId ensures that no value is present for Id, not even an explicit nil ### GetUid `func (o *MachineCatalogDetailResponseModel) GetUid() int32` @@ -193,6 +223,11 @@ and a boolean to check if the value has been set. SetAllocationType sets AllocationType field to given value. +### HasAllocationType + +`func (o *MachineCatalogDetailResponseModel) HasAllocationType() bool` + +HasAllocationType returns a boolean if a field has been set. ### GetAssignedCount @@ -283,6 +318,11 @@ and a boolean to check if the value has been set. SetAvailableCount sets AvailableCount field to given value. +### HasAvailableCount + +`func (o *MachineCatalogDetailResponseModel) HasAvailableCount() bool` + +HasAvailableCount returns a boolean if a field has been set. ### GetAvailableUnassignedCount @@ -398,6 +438,11 @@ and a boolean to check if the value has been set. SetIsRemotePC sets IsRemotePC field to given value. +### HasIsRemotePC + +`func (o *MachineCatalogDetailResponseModel) HasIsRemotePC() bool` + +HasIsRemotePC returns a boolean if a field has been set. ### GetJobsInProgress @@ -453,6 +498,11 @@ and a boolean to check if the value has been set. SetMachineType sets MachineType field to given value. +### HasMachineType + +`func (o *MachineCatalogDetailResponseModel) HasMachineType() bool` + +HasMachineType returns a boolean if a field has been set. ### GetMetadata @@ -508,6 +558,11 @@ and a boolean to check if the value has been set. SetMinimumFunctionalLevel sets MinimumFunctionalLevel field to given value. +### HasMinimumFunctionalLevel + +`func (o *MachineCatalogDetailResponseModel) HasMinimumFunctionalLevel() bool` + +HasMinimumFunctionalLevel returns a boolean if a field has been set. ### GetHasBeenPromoted @@ -528,6 +583,11 @@ and a boolean to check if the value has been set. SetHasBeenPromoted sets HasBeenPromoted field to given value. +### HasHasBeenPromoted + +`func (o *MachineCatalogDetailResponseModel) HasHasBeenPromoted() bool` + +HasHasBeenPromoted returns a boolean if a field has been set. ### GetHasBeenPromotedFrom @@ -573,6 +633,11 @@ and a boolean to check if the value has been set. SetCanRollbackVMImage sets CanRollbackVMImage field to given value. +### HasCanRollbackVMImage + +`func (o *MachineCatalogDetailResponseModel) HasCanRollbackVMImage() bool` + +HasCanRollbackVMImage returns a boolean if a field has been set. ### GetCanRecreateCatalog @@ -593,6 +658,11 @@ and a boolean to check if the value has been set. SetCanRecreateCatalog sets CanRecreateCatalog field to given value. +### HasCanRecreateCatalog + +`func (o *MachineCatalogDetailResponseModel) HasCanRecreateCatalog() bool` + +HasCanRecreateCatalog returns a boolean if a field has been set. ### GetPersistChanges @@ -613,6 +683,11 @@ and a boolean to check if the value has been set. SetPersistChanges sets PersistChanges field to given value. +### HasPersistChanges + +`func (o *MachineCatalogDetailResponseModel) HasPersistChanges() bool` + +HasPersistChanges returns a boolean if a field has been set. ### GetProvisioningScheme @@ -658,6 +733,11 @@ and a boolean to check if the value has been set. SetProvisioningType sets ProvisioningType field to given value. +### HasProvisioningType + +`func (o *MachineCatalogDetailResponseModel) HasProvisioningType() bool` + +HasProvisioningType returns a boolean if a field has been set. ### GetProvisioningProgress @@ -878,6 +958,11 @@ and a boolean to check if the value has been set. SetSessionSupport sets SessionSupport field to given value. +### HasSessionSupport + +`func (o *MachineCatalogDetailResponseModel) HasSessionSupport() bool` + +HasSessionSupport returns a boolean if a field has been set. ### GetSharingKind @@ -898,6 +983,11 @@ and a boolean to check if the value has been set. SetSharingKind sets SharingKind field to given value. +### HasSharingKind + +`func (o *MachineCatalogDetailResponseModel) HasSharingKind() bool` + +HasSharingKind returns a boolean if a field has been set. ### GetTotalCount @@ -918,6 +1008,11 @@ and a boolean to check if the value has been set. SetTotalCount sets TotalCount field to given value. +### HasTotalCount + +`func (o *MachineCatalogDetailResponseModel) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. ### GetIsBroken @@ -938,6 +1033,11 @@ and a boolean to check if the value has been set. SetIsBroken sets IsBroken field to given value. +### HasIsBroken + +`func (o *MachineCatalogDetailResponseModel) HasIsBroken() bool` + +HasIsBroken returns a boolean if a field has been set. ### GetIsMasterImageAssociated @@ -1088,6 +1188,11 @@ and a boolean to check if the value has been set. SetUnassignedCount sets UnassignedCount field to given value. +### HasUnassignedCount + +`func (o *MachineCatalogDetailResponseModel) HasUnassignedCount() bool` + +HasUnassignedCount returns a boolean if a field has been set. ### GetUsedCount @@ -1108,6 +1213,11 @@ and a boolean to check if the value has been set. SetUsedCount sets UsedCount field to given value. +### HasUsedCount + +`func (o *MachineCatalogDetailResponseModel) HasUsedCount() bool` + +HasUsedCount returns a boolean if a field has been set. ### GetAvailableCountOfSuspend @@ -1223,6 +1333,11 @@ and a boolean to check if the value has been set. SetZone sets Zone field to given value. +### HasZone + +`func (o *MachineCatalogDetailResponseModel) HasZone() bool` + +HasZone returns a boolean if a field has been set. ### GetAdminFolder diff --git a/citrixorchestration/docs/MachineCatalogResponseModel.md b/citrixorchestration/docs/MachineCatalogResponseModel.md index 40dc337..9470aa9 100644 --- a/citrixorchestration/docs/MachineCatalogResponseModel.md +++ b/citrixorchestration/docs/MachineCatalogResponseModel.md @@ -87,7 +87,22 @@ and a boolean to check if the value has been set. SetName sets Name field to given value. +### HasName +`func (o *MachineCatalogResponseModel) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *MachineCatalogResponseModel) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *MachineCatalogResponseModel) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil ### GetFullName `func (o *MachineCatalogResponseModel) GetFullName() string` @@ -142,7 +157,22 @@ and a boolean to check if the value has been set. SetId sets Id field to given value. +### HasId + +`func (o *MachineCatalogResponseModel) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetIdNil + +`func (o *MachineCatalogResponseModel) SetIdNil(b bool)` + + SetIdNil sets the value for Id to be an explicit nil + +### UnsetId +`func (o *MachineCatalogResponseModel) UnsetId()` +UnsetId ensures that no value is present for Id, not even an explicit nil ### GetUid `func (o *MachineCatalogResponseModel) GetUid() int32` @@ -187,6 +217,11 @@ and a boolean to check if the value has been set. SetAllocationType sets AllocationType field to given value. +### HasAllocationType + +`func (o *MachineCatalogResponseModel) HasAllocationType() bool` + +HasAllocationType returns a boolean if a field has been set. ### GetAssignedCount @@ -277,6 +312,11 @@ and a boolean to check if the value has been set. SetAvailableCount sets AvailableCount field to given value. +### HasAvailableCount + +`func (o *MachineCatalogResponseModel) HasAvailableCount() bool` + +HasAvailableCount returns a boolean if a field has been set. ### GetAvailableUnassignedCount @@ -392,6 +432,11 @@ and a boolean to check if the value has been set. SetIsRemotePC sets IsRemotePC field to given value. +### HasIsRemotePC + +`func (o *MachineCatalogResponseModel) HasIsRemotePC() bool` + +HasIsRemotePC returns a boolean if a field has been set. ### GetJobsInProgress @@ -447,6 +492,11 @@ and a boolean to check if the value has been set. SetMachineType sets MachineType field to given value. +### HasMachineType + +`func (o *MachineCatalogResponseModel) HasMachineType() bool` + +HasMachineType returns a boolean if a field has been set. ### GetMetadata @@ -502,6 +552,11 @@ and a boolean to check if the value has been set. SetMinimumFunctionalLevel sets MinimumFunctionalLevel field to given value. +### HasMinimumFunctionalLevel + +`func (o *MachineCatalogResponseModel) HasMinimumFunctionalLevel() bool` + +HasMinimumFunctionalLevel returns a boolean if a field has been set. ### GetHasBeenPromoted @@ -522,6 +577,11 @@ and a boolean to check if the value has been set. SetHasBeenPromoted sets HasBeenPromoted field to given value. +### HasHasBeenPromoted + +`func (o *MachineCatalogResponseModel) HasHasBeenPromoted() bool` + +HasHasBeenPromoted returns a boolean if a field has been set. ### GetHasBeenPromotedFrom @@ -567,6 +627,11 @@ and a boolean to check if the value has been set. SetCanRollbackVMImage sets CanRollbackVMImage field to given value. +### HasCanRollbackVMImage + +`func (o *MachineCatalogResponseModel) HasCanRollbackVMImage() bool` + +HasCanRollbackVMImage returns a boolean if a field has been set. ### GetCanRecreateCatalog @@ -587,6 +652,11 @@ and a boolean to check if the value has been set. SetCanRecreateCatalog sets CanRecreateCatalog field to given value. +### HasCanRecreateCatalog + +`func (o *MachineCatalogResponseModel) HasCanRecreateCatalog() bool` + +HasCanRecreateCatalog returns a boolean if a field has been set. ### GetPersistChanges @@ -607,6 +677,11 @@ and a boolean to check if the value has been set. SetPersistChanges sets PersistChanges field to given value. +### HasPersistChanges + +`func (o *MachineCatalogResponseModel) HasPersistChanges() bool` + +HasPersistChanges returns a boolean if a field has been set. ### GetProvisioningScheme @@ -652,6 +727,11 @@ and a boolean to check if the value has been set. SetProvisioningType sets ProvisioningType field to given value. +### HasProvisioningType + +`func (o *MachineCatalogResponseModel) HasProvisioningType() bool` + +HasProvisioningType returns a boolean if a field has been set. ### GetProvisioningProgress @@ -872,6 +952,11 @@ and a boolean to check if the value has been set. SetSessionSupport sets SessionSupport field to given value. +### HasSessionSupport + +`func (o *MachineCatalogResponseModel) HasSessionSupport() bool` + +HasSessionSupport returns a boolean if a field has been set. ### GetSharingKind @@ -892,6 +977,11 @@ and a boolean to check if the value has been set. SetSharingKind sets SharingKind field to given value. +### HasSharingKind + +`func (o *MachineCatalogResponseModel) HasSharingKind() bool` + +HasSharingKind returns a boolean if a field has been set. ### GetTotalCount @@ -912,6 +1002,11 @@ and a boolean to check if the value has been set. SetTotalCount sets TotalCount field to given value. +### HasTotalCount + +`func (o *MachineCatalogResponseModel) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. ### GetIsBroken @@ -932,6 +1027,11 @@ and a boolean to check if the value has been set. SetIsBroken sets IsBroken field to given value. +### HasIsBroken + +`func (o *MachineCatalogResponseModel) HasIsBroken() bool` + +HasIsBroken returns a boolean if a field has been set. ### GetIsMasterImageAssociated @@ -1082,6 +1182,11 @@ and a boolean to check if the value has been set. SetUnassignedCount sets UnassignedCount field to given value. +### HasUnassignedCount + +`func (o *MachineCatalogResponseModel) HasUnassignedCount() bool` + +HasUnassignedCount returns a boolean if a field has been set. ### GetUsedCount @@ -1102,6 +1207,11 @@ and a boolean to check if the value has been set. SetUsedCount sets UsedCount field to given value. +### HasUsedCount + +`func (o *MachineCatalogResponseModel) HasUsedCount() bool` + +HasUsedCount returns a boolean if a field has been set. ### GetAvailableCountOfSuspend @@ -1217,6 +1327,11 @@ and a boolean to check if the value has been set. SetZone sets Zone field to given value. +### HasZone + +`func (o *MachineCatalogResponseModel) HasZone() bool` + +HasZone returns a boolean if a field has been set. ### GetAdminFolder diff --git a/citrixorchestration/docs/MachineDetailResponseModel.md b/citrixorchestration/docs/MachineDetailResponseModel.md index 861ad19..87a9b0b 100644 --- a/citrixorchestration/docs/MachineDetailResponseModel.md +++ b/citrixorchestration/docs/MachineDetailResponseModel.md @@ -86,6 +86,7 @@ Name | Type | Description | Notes **UpgradeState** | Pointer to [**VdaUpgradeState**](VdaUpgradeState.md) | | [optional] **MachineConfigurationOutOfSync** | Pointer to **NullableBool** | Flag indicating whether the machine's configuration is out of sync with the catalog's latest configuration | [optional] **UpgradeDetail** | Pointer to [**MachineUpgradeDetail**](MachineUpgradeDetail.md) | | [optional] +**Metadata** | Pointer to [**[]NameValueStringPairModel**](NameValueStringPairModel.md) | The meta data of this machine. | [optional] **AssignedClientName** | Pointer to **NullableString** | The name of the endpoint client device that the machine has been assigned to. | [optional] **AssignedIPAddress** | Pointer to **NullableString** | The IP address of the endpoint client device that the machine has been assigned to. | [optional] **BrowserName** | Pointer to **NullableString** | Site-wide unique name identifying associated desktop to other components (for example StoreFront). This is typically non-null only for machines backing assigned private desktops. | [optional] @@ -2664,6 +2665,41 @@ SetUpgradeDetail sets UpgradeDetail field to given value. HasUpgradeDetail returns a boolean if a field has been set. +### GetMetadata + +`func (o *MachineDetailResponseModel) GetMetadata() []NameValueStringPairModel` + +GetMetadata returns the Metadata field if non-nil, zero value otherwise. + +### GetMetadataOk + +`func (o *MachineDetailResponseModel) GetMetadataOk() (*[]NameValueStringPairModel, bool)` + +GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetadata + +`func (o *MachineDetailResponseModel) SetMetadata(v []NameValueStringPairModel)` + +SetMetadata sets Metadata field to given value. + +### HasMetadata + +`func (o *MachineDetailResponseModel) HasMetadata() bool` + +HasMetadata returns a boolean if a field has been set. + +### SetMetadataNil + +`func (o *MachineDetailResponseModel) SetMetadataNil(b bool)` + + SetMetadataNil sets the value for Metadata to be an explicit nil + +### UnsetMetadata +`func (o *MachineDetailResponseModel) UnsetMetadata()` + +UnsetMetadata ensures that no value is present for Metadata, not even an explicit nil ### GetAssignedClientName `func (o *MachineDetailResponseModel) GetAssignedClientName() string` diff --git a/citrixorchestration/docs/MachineResponseModel.md b/citrixorchestration/docs/MachineResponseModel.md index 6a601d5..403777a 100644 --- a/citrixorchestration/docs/MachineResponseModel.md +++ b/citrixorchestration/docs/MachineResponseModel.md @@ -86,6 +86,7 @@ Name | Type | Description | Notes **UpgradeState** | Pointer to [**VdaUpgradeState**](VdaUpgradeState.md) | | [optional] **MachineConfigurationOutOfSync** | Pointer to **NullableBool** | Flag indicating whether the machine's configuration is out of sync with the catalog's latest configuration | [optional] **UpgradeDetail** | Pointer to [**MachineUpgradeDetail**](MachineUpgradeDetail.md) | | [optional] +**Metadata** | Pointer to [**[]NameValueStringPairModel**](NameValueStringPairModel.md) | The meta data of this machine. | [optional] ## Methods @@ -2651,6 +2652,41 @@ SetUpgradeDetail sets UpgradeDetail field to given value. HasUpgradeDetail returns a boolean if a field has been set. +### GetMetadata + +`func (o *MachineResponseModel) GetMetadata() []NameValueStringPairModel` + +GetMetadata returns the Metadata field if non-nil, zero value otherwise. + +### GetMetadataOk + +`func (o *MachineResponseModel) GetMetadataOk() (*[]NameValueStringPairModel, bool)` + +GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetadata + +`func (o *MachineResponseModel) SetMetadata(v []NameValueStringPairModel)` + +SetMetadata sets Metadata field to given value. + +### HasMetadata + +`func (o *MachineResponseModel) HasMetadata() bool` + +HasMetadata returns a boolean if a field has been set. + +### SetMetadataNil + +`func (o *MachineResponseModel) SetMetadataNil(b bool)` + + SetMetadataNil sets the value for Metadata to be an explicit nil + +### UnsetMetadata +`func (o *MachineResponseModel) UnsetMetadata()` + +UnsetMetadata ensures that no value is present for Metadata, not even an explicit nil [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/citrixorchestration/docs/PackagedApplicationType.md b/citrixorchestration/docs/PackagedApplicationType.md index 43df905..edf96e6 100644 --- a/citrixorchestration/docs/PackagedApplicationType.md +++ b/citrixorchestration/docs/PackagedApplicationType.md @@ -13,6 +13,8 @@ * `APP_ATTACH` (value: `"AppAttach"`) +* `FLEX_APP` (value: `"FlexApp"`) + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/citrixorchestration/docs/ProvisionedVirtualMachineCustomVmDataResponseModel.md b/citrixorchestration/docs/ProvisionedVirtualMachineCustomVmDataResponseModel.md new file mode 100644 index 0000000..70bcca8 --- /dev/null +++ b/citrixorchestration/docs/ProvisionedVirtualMachineCustomVmDataResponseModel.md @@ -0,0 +1,972 @@ +# ProvisionedVirtualMachineCustomVmDataResponseModel + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AvailabilityZone** | Pointer to **NullableString** | Availability Zones | [optional] +**DataDiskId** | Pointer to **NullableString** | WBCDiskId | [optional] +**DataDiskStorageType** | Pointer to **NullableString** | Data Disk Storage Type | [optional] +**EphemeralOsDiskMode** | Pointer to **NullableString** | Ephemeral OS Disk Mode | [optional] +**EncryptionSettingDESI** | Pointer to **NullableString** | Disk Encryption Set Id | [optional] +**FailSafeStorageType** | Pointer to **bool** | Storage Type - Fail Safe | [optional] +**HostGroupId** | Pointer to **NullableString** | Host Group | [optional] +**IdentityDiskId** | Pointer to **NullableString** | Identity Disk full path | [optional] +**IdentityDiskStorageType** | Pointer to **NullableString** | Identity Disk Storage Type | [optional] +**IsOSDiskAzureTempDisk** | Pointer to **bool** | OS Disk Use Temp Disk | [optional] +**IsSharedImageGalleryUsed** | Pointer to **NullableBool** | Use Shared Image Gallery | [optional] +**IsUsingEphemeralOsDisk** | Pointer to **bool** | Ephemeral OS Disk | [optional] +**LicenseType** | Pointer to **NullableString** | License Type | [optional] +**MachineSizeId** | Pointer to **NullableString** | Machine Size | [optional] +**NetworkInterfaceIds** | Pointer to **[]string** | Network Maps | [optional] +**OSDiskId** | Pointer to **NullableString** | OS Disk full path | [optional] +**OsDiskStorageType** | Pointer to **NullableString** | OS Disk Storage Type | [optional] +**OsType** | Pointer to **NullableString** | Operation System | [optional] +**PersistOsDisk** | Pointer to **NullableBool** | Retaining System Disk | [optional] +**PersistWbc** | Pointer to **NullableBool** | Retaining Write-back Cache Disk | [optional] +**RegionId** | Pointer to **NullableString** | Region Id | [optional] +**ResourceGroupName** | Pointer to **NullableString** | Resource Group | [optional] +**SecurityType** | Pointer to **NullableString** | Security Type | [optional] +**SIGMachineToReplicaRatio** | Pointer to **NullableInt32** | Azure Shared Image Gallery Machine To Replica Ratio | [optional] +**SIGReplicaMaximum** | Pointer to **NullableInt32** | Azure Shared Image Replica Maximum | [optional] +**StorageTypeAtShutdown** | Pointer to **NullableString** | Storage Type At Shutdown | [optional] +**SupportsHibernation** | Pointer to **NullableBool** | VmMetadata hibernation configuration. | [optional] + +## Methods + +### NewProvisionedVirtualMachineCustomVmDataResponseModel + +`func NewProvisionedVirtualMachineCustomVmDataResponseModel() *ProvisionedVirtualMachineCustomVmDataResponseModel` + +NewProvisionedVirtualMachineCustomVmDataResponseModel instantiates a new ProvisionedVirtualMachineCustomVmDataResponseModel object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewProvisionedVirtualMachineCustomVmDataResponseModelWithDefaults + +`func NewProvisionedVirtualMachineCustomVmDataResponseModelWithDefaults() *ProvisionedVirtualMachineCustomVmDataResponseModel` + +NewProvisionedVirtualMachineCustomVmDataResponseModelWithDefaults instantiates a new ProvisionedVirtualMachineCustomVmDataResponseModel object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAvailabilityZone + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetAvailabilityZone() string` + +GetAvailabilityZone returns the AvailabilityZone field if non-nil, zero value otherwise. + +### GetAvailabilityZoneOk + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetAvailabilityZoneOk() (*string, bool)` + +GetAvailabilityZoneOk returns a tuple with the AvailabilityZone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAvailabilityZone + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetAvailabilityZone(v string)` + +SetAvailabilityZone sets AvailabilityZone field to given value. + +### HasAvailabilityZone + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasAvailabilityZone() bool` + +HasAvailabilityZone returns a boolean if a field has been set. + +### SetAvailabilityZoneNil + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetAvailabilityZoneNil(b bool)` + + SetAvailabilityZoneNil sets the value for AvailabilityZone to be an explicit nil + +### UnsetAvailabilityZone +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) UnsetAvailabilityZone()` + +UnsetAvailabilityZone ensures that no value is present for AvailabilityZone, not even an explicit nil +### GetDataDiskId + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetDataDiskId() string` + +GetDataDiskId returns the DataDiskId field if non-nil, zero value otherwise. + +### GetDataDiskIdOk + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetDataDiskIdOk() (*string, bool)` + +GetDataDiskIdOk returns a tuple with the DataDiskId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDataDiskId + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetDataDiskId(v string)` + +SetDataDiskId sets DataDiskId field to given value. + +### HasDataDiskId + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasDataDiskId() bool` + +HasDataDiskId returns a boolean if a field has been set. + +### SetDataDiskIdNil + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetDataDiskIdNil(b bool)` + + SetDataDiskIdNil sets the value for DataDiskId to be an explicit nil + +### UnsetDataDiskId +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) UnsetDataDiskId()` + +UnsetDataDiskId ensures that no value is present for DataDiskId, not even an explicit nil +### GetDataDiskStorageType + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetDataDiskStorageType() string` + +GetDataDiskStorageType returns the DataDiskStorageType field if non-nil, zero value otherwise. + +### GetDataDiskStorageTypeOk + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetDataDiskStorageTypeOk() (*string, bool)` + +GetDataDiskStorageTypeOk returns a tuple with the DataDiskStorageType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDataDiskStorageType + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetDataDiskStorageType(v string)` + +SetDataDiskStorageType sets DataDiskStorageType field to given value. + +### HasDataDiskStorageType + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasDataDiskStorageType() bool` + +HasDataDiskStorageType returns a boolean if a field has been set. + +### SetDataDiskStorageTypeNil + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetDataDiskStorageTypeNil(b bool)` + + SetDataDiskStorageTypeNil sets the value for DataDiskStorageType to be an explicit nil + +### UnsetDataDiskStorageType +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) UnsetDataDiskStorageType()` + +UnsetDataDiskStorageType ensures that no value is present for DataDiskStorageType, not even an explicit nil +### GetEphemeralOsDiskMode + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetEphemeralOsDiskMode() string` + +GetEphemeralOsDiskMode returns the EphemeralOsDiskMode field if non-nil, zero value otherwise. + +### GetEphemeralOsDiskModeOk + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetEphemeralOsDiskModeOk() (*string, bool)` + +GetEphemeralOsDiskModeOk returns a tuple with the EphemeralOsDiskMode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEphemeralOsDiskMode + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetEphemeralOsDiskMode(v string)` + +SetEphemeralOsDiskMode sets EphemeralOsDiskMode field to given value. + +### HasEphemeralOsDiskMode + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasEphemeralOsDiskMode() bool` + +HasEphemeralOsDiskMode returns a boolean if a field has been set. + +### SetEphemeralOsDiskModeNil + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetEphemeralOsDiskModeNil(b bool)` + + SetEphemeralOsDiskModeNil sets the value for EphemeralOsDiskMode to be an explicit nil + +### UnsetEphemeralOsDiskMode +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) UnsetEphemeralOsDiskMode()` + +UnsetEphemeralOsDiskMode ensures that no value is present for EphemeralOsDiskMode, not even an explicit nil +### GetEncryptionSettingDESI + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetEncryptionSettingDESI() string` + +GetEncryptionSettingDESI returns the EncryptionSettingDESI field if non-nil, zero value otherwise. + +### GetEncryptionSettingDESIOk + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetEncryptionSettingDESIOk() (*string, bool)` + +GetEncryptionSettingDESIOk returns a tuple with the EncryptionSettingDESI field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEncryptionSettingDESI + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetEncryptionSettingDESI(v string)` + +SetEncryptionSettingDESI sets EncryptionSettingDESI field to given value. + +### HasEncryptionSettingDESI + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasEncryptionSettingDESI() bool` + +HasEncryptionSettingDESI returns a boolean if a field has been set. + +### SetEncryptionSettingDESINil + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetEncryptionSettingDESINil(b bool)` + + SetEncryptionSettingDESINil sets the value for EncryptionSettingDESI to be an explicit nil + +### UnsetEncryptionSettingDESI +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) UnsetEncryptionSettingDESI()` + +UnsetEncryptionSettingDESI ensures that no value is present for EncryptionSettingDESI, not even an explicit nil +### GetFailSafeStorageType + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetFailSafeStorageType() bool` + +GetFailSafeStorageType returns the FailSafeStorageType field if non-nil, zero value otherwise. + +### GetFailSafeStorageTypeOk + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetFailSafeStorageTypeOk() (*bool, bool)` + +GetFailSafeStorageTypeOk returns a tuple with the FailSafeStorageType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFailSafeStorageType + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetFailSafeStorageType(v bool)` + +SetFailSafeStorageType sets FailSafeStorageType field to given value. + +### HasFailSafeStorageType + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasFailSafeStorageType() bool` + +HasFailSafeStorageType returns a boolean if a field has been set. + +### GetHostGroupId + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetHostGroupId() string` + +GetHostGroupId returns the HostGroupId field if non-nil, zero value otherwise. + +### GetHostGroupIdOk + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetHostGroupIdOk() (*string, bool)` + +GetHostGroupIdOk returns a tuple with the HostGroupId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHostGroupId + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetHostGroupId(v string)` + +SetHostGroupId sets HostGroupId field to given value. + +### HasHostGroupId + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasHostGroupId() bool` + +HasHostGroupId returns a boolean if a field has been set. + +### SetHostGroupIdNil + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetHostGroupIdNil(b bool)` + + SetHostGroupIdNil sets the value for HostGroupId to be an explicit nil + +### UnsetHostGroupId +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) UnsetHostGroupId()` + +UnsetHostGroupId ensures that no value is present for HostGroupId, not even an explicit nil +### GetIdentityDiskId + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetIdentityDiskId() string` + +GetIdentityDiskId returns the IdentityDiskId field if non-nil, zero value otherwise. + +### GetIdentityDiskIdOk + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetIdentityDiskIdOk() (*string, bool)` + +GetIdentityDiskIdOk returns a tuple with the IdentityDiskId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityDiskId + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetIdentityDiskId(v string)` + +SetIdentityDiskId sets IdentityDiskId field to given value. + +### HasIdentityDiskId + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasIdentityDiskId() bool` + +HasIdentityDiskId returns a boolean if a field has been set. + +### SetIdentityDiskIdNil + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetIdentityDiskIdNil(b bool)` + + SetIdentityDiskIdNil sets the value for IdentityDiskId to be an explicit nil + +### UnsetIdentityDiskId +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) UnsetIdentityDiskId()` + +UnsetIdentityDiskId ensures that no value is present for IdentityDiskId, not even an explicit nil +### GetIdentityDiskStorageType + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetIdentityDiskStorageType() string` + +GetIdentityDiskStorageType returns the IdentityDiskStorageType field if non-nil, zero value otherwise. + +### GetIdentityDiskStorageTypeOk + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetIdentityDiskStorageTypeOk() (*string, bool)` + +GetIdentityDiskStorageTypeOk returns a tuple with the IdentityDiskStorageType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityDiskStorageType + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetIdentityDiskStorageType(v string)` + +SetIdentityDiskStorageType sets IdentityDiskStorageType field to given value. + +### HasIdentityDiskStorageType + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasIdentityDiskStorageType() bool` + +HasIdentityDiskStorageType returns a boolean if a field has been set. + +### SetIdentityDiskStorageTypeNil + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetIdentityDiskStorageTypeNil(b bool)` + + SetIdentityDiskStorageTypeNil sets the value for IdentityDiskStorageType to be an explicit nil + +### UnsetIdentityDiskStorageType +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) UnsetIdentityDiskStorageType()` + +UnsetIdentityDiskStorageType ensures that no value is present for IdentityDiskStorageType, not even an explicit nil +### GetIsOSDiskAzureTempDisk + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetIsOSDiskAzureTempDisk() bool` + +GetIsOSDiskAzureTempDisk returns the IsOSDiskAzureTempDisk field if non-nil, zero value otherwise. + +### GetIsOSDiskAzureTempDiskOk + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetIsOSDiskAzureTempDiskOk() (*bool, bool)` + +GetIsOSDiskAzureTempDiskOk returns a tuple with the IsOSDiskAzureTempDisk field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsOSDiskAzureTempDisk + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetIsOSDiskAzureTempDisk(v bool)` + +SetIsOSDiskAzureTempDisk sets IsOSDiskAzureTempDisk field to given value. + +### HasIsOSDiskAzureTempDisk + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasIsOSDiskAzureTempDisk() bool` + +HasIsOSDiskAzureTempDisk returns a boolean if a field has been set. + +### GetIsSharedImageGalleryUsed + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetIsSharedImageGalleryUsed() bool` + +GetIsSharedImageGalleryUsed returns the IsSharedImageGalleryUsed field if non-nil, zero value otherwise. + +### GetIsSharedImageGalleryUsedOk + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetIsSharedImageGalleryUsedOk() (*bool, bool)` + +GetIsSharedImageGalleryUsedOk returns a tuple with the IsSharedImageGalleryUsed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsSharedImageGalleryUsed + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetIsSharedImageGalleryUsed(v bool)` + +SetIsSharedImageGalleryUsed sets IsSharedImageGalleryUsed field to given value. + +### HasIsSharedImageGalleryUsed + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasIsSharedImageGalleryUsed() bool` + +HasIsSharedImageGalleryUsed returns a boolean if a field has been set. + +### SetIsSharedImageGalleryUsedNil + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetIsSharedImageGalleryUsedNil(b bool)` + + SetIsSharedImageGalleryUsedNil sets the value for IsSharedImageGalleryUsed to be an explicit nil + +### UnsetIsSharedImageGalleryUsed +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) UnsetIsSharedImageGalleryUsed()` + +UnsetIsSharedImageGalleryUsed ensures that no value is present for IsSharedImageGalleryUsed, not even an explicit nil +### GetIsUsingEphemeralOsDisk + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetIsUsingEphemeralOsDisk() bool` + +GetIsUsingEphemeralOsDisk returns the IsUsingEphemeralOsDisk field if non-nil, zero value otherwise. + +### GetIsUsingEphemeralOsDiskOk + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetIsUsingEphemeralOsDiskOk() (*bool, bool)` + +GetIsUsingEphemeralOsDiskOk returns a tuple with the IsUsingEphemeralOsDisk field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsUsingEphemeralOsDisk + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetIsUsingEphemeralOsDisk(v bool)` + +SetIsUsingEphemeralOsDisk sets IsUsingEphemeralOsDisk field to given value. + +### HasIsUsingEphemeralOsDisk + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasIsUsingEphemeralOsDisk() bool` + +HasIsUsingEphemeralOsDisk returns a boolean if a field has been set. + +### GetLicenseType + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetLicenseType() string` + +GetLicenseType returns the LicenseType field if non-nil, zero value otherwise. + +### GetLicenseTypeOk + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetLicenseTypeOk() (*string, bool)` + +GetLicenseTypeOk returns a tuple with the LicenseType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLicenseType + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetLicenseType(v string)` + +SetLicenseType sets LicenseType field to given value. + +### HasLicenseType + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasLicenseType() bool` + +HasLicenseType returns a boolean if a field has been set. + +### SetLicenseTypeNil + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetLicenseTypeNil(b bool)` + + SetLicenseTypeNil sets the value for LicenseType to be an explicit nil + +### UnsetLicenseType +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) UnsetLicenseType()` + +UnsetLicenseType ensures that no value is present for LicenseType, not even an explicit nil +### GetMachineSizeId + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetMachineSizeId() string` + +GetMachineSizeId returns the MachineSizeId field if non-nil, zero value otherwise. + +### GetMachineSizeIdOk + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetMachineSizeIdOk() (*string, bool)` + +GetMachineSizeIdOk returns a tuple with the MachineSizeId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMachineSizeId + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetMachineSizeId(v string)` + +SetMachineSizeId sets MachineSizeId field to given value. + +### HasMachineSizeId + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasMachineSizeId() bool` + +HasMachineSizeId returns a boolean if a field has been set. + +### SetMachineSizeIdNil + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetMachineSizeIdNil(b bool)` + + SetMachineSizeIdNil sets the value for MachineSizeId to be an explicit nil + +### UnsetMachineSizeId +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) UnsetMachineSizeId()` + +UnsetMachineSizeId ensures that no value is present for MachineSizeId, not even an explicit nil +### GetNetworkInterfaceIds + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetNetworkInterfaceIds() []string` + +GetNetworkInterfaceIds returns the NetworkInterfaceIds field if non-nil, zero value otherwise. + +### GetNetworkInterfaceIdsOk + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetNetworkInterfaceIdsOk() (*[]string, bool)` + +GetNetworkInterfaceIdsOk returns a tuple with the NetworkInterfaceIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNetworkInterfaceIds + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetNetworkInterfaceIds(v []string)` + +SetNetworkInterfaceIds sets NetworkInterfaceIds field to given value. + +### HasNetworkInterfaceIds + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasNetworkInterfaceIds() bool` + +HasNetworkInterfaceIds returns a boolean if a field has been set. + +### SetNetworkInterfaceIdsNil + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetNetworkInterfaceIdsNil(b bool)` + + SetNetworkInterfaceIdsNil sets the value for NetworkInterfaceIds to be an explicit nil + +### UnsetNetworkInterfaceIds +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) UnsetNetworkInterfaceIds()` + +UnsetNetworkInterfaceIds ensures that no value is present for NetworkInterfaceIds, not even an explicit nil +### GetOSDiskId + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetOSDiskId() string` + +GetOSDiskId returns the OSDiskId field if non-nil, zero value otherwise. + +### GetOSDiskIdOk + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetOSDiskIdOk() (*string, bool)` + +GetOSDiskIdOk returns a tuple with the OSDiskId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOSDiskId + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetOSDiskId(v string)` + +SetOSDiskId sets OSDiskId field to given value. + +### HasOSDiskId + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasOSDiskId() bool` + +HasOSDiskId returns a boolean if a field has been set. + +### SetOSDiskIdNil + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetOSDiskIdNil(b bool)` + + SetOSDiskIdNil sets the value for OSDiskId to be an explicit nil + +### UnsetOSDiskId +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) UnsetOSDiskId()` + +UnsetOSDiskId ensures that no value is present for OSDiskId, not even an explicit nil +### GetOsDiskStorageType + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetOsDiskStorageType() string` + +GetOsDiskStorageType returns the OsDiskStorageType field if non-nil, zero value otherwise. + +### GetOsDiskStorageTypeOk + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetOsDiskStorageTypeOk() (*string, bool)` + +GetOsDiskStorageTypeOk returns a tuple with the OsDiskStorageType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOsDiskStorageType + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetOsDiskStorageType(v string)` + +SetOsDiskStorageType sets OsDiskStorageType field to given value. + +### HasOsDiskStorageType + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasOsDiskStorageType() bool` + +HasOsDiskStorageType returns a boolean if a field has been set. + +### SetOsDiskStorageTypeNil + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetOsDiskStorageTypeNil(b bool)` + + SetOsDiskStorageTypeNil sets the value for OsDiskStorageType to be an explicit nil + +### UnsetOsDiskStorageType +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) UnsetOsDiskStorageType()` + +UnsetOsDiskStorageType ensures that no value is present for OsDiskStorageType, not even an explicit nil +### GetOsType + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetOsType() string` + +GetOsType returns the OsType field if non-nil, zero value otherwise. + +### GetOsTypeOk + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetOsTypeOk() (*string, bool)` + +GetOsTypeOk returns a tuple with the OsType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOsType + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetOsType(v string)` + +SetOsType sets OsType field to given value. + +### HasOsType + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasOsType() bool` + +HasOsType returns a boolean if a field has been set. + +### SetOsTypeNil + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetOsTypeNil(b bool)` + + SetOsTypeNil sets the value for OsType to be an explicit nil + +### UnsetOsType +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) UnsetOsType()` + +UnsetOsType ensures that no value is present for OsType, not even an explicit nil +### GetPersistOsDisk + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetPersistOsDisk() bool` + +GetPersistOsDisk returns the PersistOsDisk field if non-nil, zero value otherwise. + +### GetPersistOsDiskOk + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetPersistOsDiskOk() (*bool, bool)` + +GetPersistOsDiskOk returns a tuple with the PersistOsDisk field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPersistOsDisk + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetPersistOsDisk(v bool)` + +SetPersistOsDisk sets PersistOsDisk field to given value. + +### HasPersistOsDisk + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasPersistOsDisk() bool` + +HasPersistOsDisk returns a boolean if a field has been set. + +### SetPersistOsDiskNil + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetPersistOsDiskNil(b bool)` + + SetPersistOsDiskNil sets the value for PersistOsDisk to be an explicit nil + +### UnsetPersistOsDisk +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) UnsetPersistOsDisk()` + +UnsetPersistOsDisk ensures that no value is present for PersistOsDisk, not even an explicit nil +### GetPersistWbc + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetPersistWbc() bool` + +GetPersistWbc returns the PersistWbc field if non-nil, zero value otherwise. + +### GetPersistWbcOk + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetPersistWbcOk() (*bool, bool)` + +GetPersistWbcOk returns a tuple with the PersistWbc field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPersistWbc + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetPersistWbc(v bool)` + +SetPersistWbc sets PersistWbc field to given value. + +### HasPersistWbc + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasPersistWbc() bool` + +HasPersistWbc returns a boolean if a field has been set. + +### SetPersistWbcNil + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetPersistWbcNil(b bool)` + + SetPersistWbcNil sets the value for PersistWbc to be an explicit nil + +### UnsetPersistWbc +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) UnsetPersistWbc()` + +UnsetPersistWbc ensures that no value is present for PersistWbc, not even an explicit nil +### GetRegionId + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetRegionId() string` + +GetRegionId returns the RegionId field if non-nil, zero value otherwise. + +### GetRegionIdOk + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetRegionIdOk() (*string, bool)` + +GetRegionIdOk returns a tuple with the RegionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegionId + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetRegionId(v string)` + +SetRegionId sets RegionId field to given value. + +### HasRegionId + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasRegionId() bool` + +HasRegionId returns a boolean if a field has been set. + +### SetRegionIdNil + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetRegionIdNil(b bool)` + + SetRegionIdNil sets the value for RegionId to be an explicit nil + +### UnsetRegionId +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) UnsetRegionId()` + +UnsetRegionId ensures that no value is present for RegionId, not even an explicit nil +### GetResourceGroupName + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetResourceGroupName() string` + +GetResourceGroupName returns the ResourceGroupName field if non-nil, zero value otherwise. + +### GetResourceGroupNameOk + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetResourceGroupNameOk() (*string, bool)` + +GetResourceGroupNameOk returns a tuple with the ResourceGroupName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResourceGroupName + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetResourceGroupName(v string)` + +SetResourceGroupName sets ResourceGroupName field to given value. + +### HasResourceGroupName + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasResourceGroupName() bool` + +HasResourceGroupName returns a boolean if a field has been set. + +### SetResourceGroupNameNil + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetResourceGroupNameNil(b bool)` + + SetResourceGroupNameNil sets the value for ResourceGroupName to be an explicit nil + +### UnsetResourceGroupName +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) UnsetResourceGroupName()` + +UnsetResourceGroupName ensures that no value is present for ResourceGroupName, not even an explicit nil +### GetSecurityType + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetSecurityType() string` + +GetSecurityType returns the SecurityType field if non-nil, zero value otherwise. + +### GetSecurityTypeOk + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetSecurityTypeOk() (*string, bool)` + +GetSecurityTypeOk returns a tuple with the SecurityType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSecurityType + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetSecurityType(v string)` + +SetSecurityType sets SecurityType field to given value. + +### HasSecurityType + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasSecurityType() bool` + +HasSecurityType returns a boolean if a field has been set. + +### SetSecurityTypeNil + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetSecurityTypeNil(b bool)` + + SetSecurityTypeNil sets the value for SecurityType to be an explicit nil + +### UnsetSecurityType +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) UnsetSecurityType()` + +UnsetSecurityType ensures that no value is present for SecurityType, not even an explicit nil +### GetSIGMachineToReplicaRatio + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetSIGMachineToReplicaRatio() int32` + +GetSIGMachineToReplicaRatio returns the SIGMachineToReplicaRatio field if non-nil, zero value otherwise. + +### GetSIGMachineToReplicaRatioOk + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetSIGMachineToReplicaRatioOk() (*int32, bool)` + +GetSIGMachineToReplicaRatioOk returns a tuple with the SIGMachineToReplicaRatio field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSIGMachineToReplicaRatio + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetSIGMachineToReplicaRatio(v int32)` + +SetSIGMachineToReplicaRatio sets SIGMachineToReplicaRatio field to given value. + +### HasSIGMachineToReplicaRatio + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasSIGMachineToReplicaRatio() bool` + +HasSIGMachineToReplicaRatio returns a boolean if a field has been set. + +### SetSIGMachineToReplicaRatioNil + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetSIGMachineToReplicaRatioNil(b bool)` + + SetSIGMachineToReplicaRatioNil sets the value for SIGMachineToReplicaRatio to be an explicit nil + +### UnsetSIGMachineToReplicaRatio +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) UnsetSIGMachineToReplicaRatio()` + +UnsetSIGMachineToReplicaRatio ensures that no value is present for SIGMachineToReplicaRatio, not even an explicit nil +### GetSIGReplicaMaximum + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetSIGReplicaMaximum() int32` + +GetSIGReplicaMaximum returns the SIGReplicaMaximum field if non-nil, zero value otherwise. + +### GetSIGReplicaMaximumOk + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetSIGReplicaMaximumOk() (*int32, bool)` + +GetSIGReplicaMaximumOk returns a tuple with the SIGReplicaMaximum field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSIGReplicaMaximum + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetSIGReplicaMaximum(v int32)` + +SetSIGReplicaMaximum sets SIGReplicaMaximum field to given value. + +### HasSIGReplicaMaximum + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasSIGReplicaMaximum() bool` + +HasSIGReplicaMaximum returns a boolean if a field has been set. + +### SetSIGReplicaMaximumNil + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetSIGReplicaMaximumNil(b bool)` + + SetSIGReplicaMaximumNil sets the value for SIGReplicaMaximum to be an explicit nil + +### UnsetSIGReplicaMaximum +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) UnsetSIGReplicaMaximum()` + +UnsetSIGReplicaMaximum ensures that no value is present for SIGReplicaMaximum, not even an explicit nil +### GetStorageTypeAtShutdown + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetStorageTypeAtShutdown() string` + +GetStorageTypeAtShutdown returns the StorageTypeAtShutdown field if non-nil, zero value otherwise. + +### GetStorageTypeAtShutdownOk + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetStorageTypeAtShutdownOk() (*string, bool)` + +GetStorageTypeAtShutdownOk returns a tuple with the StorageTypeAtShutdown field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStorageTypeAtShutdown + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetStorageTypeAtShutdown(v string)` + +SetStorageTypeAtShutdown sets StorageTypeAtShutdown field to given value. + +### HasStorageTypeAtShutdown + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasStorageTypeAtShutdown() bool` + +HasStorageTypeAtShutdown returns a boolean if a field has been set. + +### SetStorageTypeAtShutdownNil + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetStorageTypeAtShutdownNil(b bool)` + + SetStorageTypeAtShutdownNil sets the value for StorageTypeAtShutdown to be an explicit nil + +### UnsetStorageTypeAtShutdown +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) UnsetStorageTypeAtShutdown()` + +UnsetStorageTypeAtShutdown ensures that no value is present for StorageTypeAtShutdown, not even an explicit nil +### GetSupportsHibernation + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetSupportsHibernation() bool` + +GetSupportsHibernation returns the SupportsHibernation field if non-nil, zero value otherwise. + +### GetSupportsHibernationOk + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetSupportsHibernationOk() (*bool, bool)` + +GetSupportsHibernationOk returns a tuple with the SupportsHibernation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSupportsHibernation + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetSupportsHibernation(v bool)` + +SetSupportsHibernation sets SupportsHibernation field to given value. + +### HasSupportsHibernation + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasSupportsHibernation() bool` + +HasSupportsHibernation returns a boolean if a field has been set. + +### SetSupportsHibernationNil + +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetSupportsHibernationNil(b bool)` + + SetSupportsHibernationNil sets the value for SupportsHibernation to be an explicit nil + +### UnsetSupportsHibernation +`func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) UnsetSupportsHibernation()` + +UnsetSupportsHibernation ensures that no value is present for SupportsHibernation, not even an explicit nil + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/citrixorchestration/docs/ProvisionedVirtualMachineDetailsResponseModel.md b/citrixorchestration/docs/ProvisionedVirtualMachineDetailsResponseModel.md new file mode 100644 index 0000000..f952093 --- /dev/null +++ b/citrixorchestration/docs/ProvisionedVirtualMachineDetailsResponseModel.md @@ -0,0 +1,1154 @@ +# ProvisionedVirtualMachineDetailsResponseModel + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AcceleratedNetwork** | Pointer to **NullableBool** | Accelerated Network | [optional] +**ADAccountName** | Pointer to **NullableString** | Active Directory Account Name | [optional] +**VMSid** | Pointer to **NullableString** | Virtual Machine Sid | [optional] +**AssignedImage** | Pointer to **NullableString** | Assigned Image | [optional] +**BootedImage** | Pointer to **NullableString** | Booted Image | [optional] +**CustomVmData** | Pointer to [**ProvisionedVirtualMachineCustomVmDataResponseModel**](ProvisionedVirtualMachineCustomVmDataResponseModel.md) | | [optional] +**CpuCount** | Pointer to **int32** | Cpu Count | [optional] +**CreationDate** | Pointer to **NullableString** | Creation Date | [optional] +**Domain** | Pointer to **NullableString** | Domain | [optional] +**EnableIntegrityMonitoring** | Pointer to **NullableBool** | IntegrityMonitoring | [optional] +**EnableSecureBoot** | Pointer to **NullableBool** | From ProvScheme VMMetaData | [optional] +**EnableVTPM** | Pointer to **NullableBool** | From ProvScheme VMMetaData | [optional] +**EncryptionAtHost** | Pointer to **NullableBool** | From ProvScheme VMMetaData | [optional] +**Errors** | Pointer to **[]string** | The Errors of provisioned virtual machine | [optional] +**PluginId** | Pointer to **NullableString** | Broker Hypervisor Connection Type - Plugin Factory Name | [optional] +**ImageOutOfDate** | Pointer to **bool** | Image Out Of Date, booted image name doesn't equal assigned image name | [optional] +**MemoryMB** | Pointer to **int32** | MemoryMB | [optional] +**HostingUnitUid** | Pointer to **string** | Hosting Unit Uid | [optional] +**HypervisorConnectionUid** | Pointer to **string** | Hypervisor Connection Uid | [optional] +**IdentityDiskId** | Pointer to **NullableString** | Identity Disk Id | [optional] +**LastBootTime** | Pointer to **NullableString** | Last Boot Time | [optional] +**ProvisioningSchemeType** | Pointer to **NullableString** | Provisioning Scheme Type: MCS, PVS | [optional] +**ProvisioningSchemeUpdateRequested** | Pointer to **NullableString** | Provisioning Scheme Update Requested | [optional] +**ProvisioningSchemeVersion** | Pointer to **int32** | Provisioning SchemeVersion | [optional] +**UseFullDiskCloneProvisioning** | Pointer to **bool** | Use Full Disk Clone Provisioning | [optional] +**VMId** | Pointer to **NullableString** | VMId, Azure - resourcegroup/VMName | [optional] +**VMName** | Pointer to **NullableString** | VM Name on the hypervisor | [optional] +**Warnings** | Pointer to [**[]ProvisionedVirtualMachineDetailsWarningReponseModel**](ProvisionedVirtualMachineDetailsWarningReponseModel.md) | Warnings, decode CustomVMData failed reason | [optional] +**WindowsActivationStatus** | Pointer to **NullableString** | Windows Activation Status | [optional] +**WindowsActivationStatusErrorCode** | Pointer to **NullableString** | Windows Activation Status Error Code | [optional] +**WindowsActivationStatusVirtualMachineError** | Pointer to **NullableString** | Windows Activation Status Virtual Machine Error | [optional] +**WindowsActivationTypeProvisionedVirtualMachine** | Pointer to **NullableString** | Windows Activation Type Provisioned Virtual Machine | [optional] +**WriteBackCacheDiskSize** | Pointer to **int32** | Write Back Cache(WBC) Disk Size | [optional] +**WriteBackCacheMemorySize** | Pointer to **int32** | Write Back Cache(WBC) Memory Size | [optional] + +## Methods + +### NewProvisionedVirtualMachineDetailsResponseModel + +`func NewProvisionedVirtualMachineDetailsResponseModel() *ProvisionedVirtualMachineDetailsResponseModel` + +NewProvisionedVirtualMachineDetailsResponseModel instantiates a new ProvisionedVirtualMachineDetailsResponseModel object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewProvisionedVirtualMachineDetailsResponseModelWithDefaults + +`func NewProvisionedVirtualMachineDetailsResponseModelWithDefaults() *ProvisionedVirtualMachineDetailsResponseModel` + +NewProvisionedVirtualMachineDetailsResponseModelWithDefaults instantiates a new ProvisionedVirtualMachineDetailsResponseModel object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAcceleratedNetwork + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetAcceleratedNetwork() bool` + +GetAcceleratedNetwork returns the AcceleratedNetwork field if non-nil, zero value otherwise. + +### GetAcceleratedNetworkOk + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetAcceleratedNetworkOk() (*bool, bool)` + +GetAcceleratedNetworkOk returns a tuple with the AcceleratedNetwork field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAcceleratedNetwork + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetAcceleratedNetwork(v bool)` + +SetAcceleratedNetwork sets AcceleratedNetwork field to given value. + +### HasAcceleratedNetwork + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) HasAcceleratedNetwork() bool` + +HasAcceleratedNetwork returns a boolean if a field has been set. + +### SetAcceleratedNetworkNil + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetAcceleratedNetworkNil(b bool)` + + SetAcceleratedNetworkNil sets the value for AcceleratedNetwork to be an explicit nil + +### UnsetAcceleratedNetwork +`func (o *ProvisionedVirtualMachineDetailsResponseModel) UnsetAcceleratedNetwork()` + +UnsetAcceleratedNetwork ensures that no value is present for AcceleratedNetwork, not even an explicit nil +### GetADAccountName + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetADAccountName() string` + +GetADAccountName returns the ADAccountName field if non-nil, zero value otherwise. + +### GetADAccountNameOk + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetADAccountNameOk() (*string, bool)` + +GetADAccountNameOk returns a tuple with the ADAccountName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetADAccountName + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetADAccountName(v string)` + +SetADAccountName sets ADAccountName field to given value. + +### HasADAccountName + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) HasADAccountName() bool` + +HasADAccountName returns a boolean if a field has been set. + +### SetADAccountNameNil + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetADAccountNameNil(b bool)` + + SetADAccountNameNil sets the value for ADAccountName to be an explicit nil + +### UnsetADAccountName +`func (o *ProvisionedVirtualMachineDetailsResponseModel) UnsetADAccountName()` + +UnsetADAccountName ensures that no value is present for ADAccountName, not even an explicit nil +### GetVMSid + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetVMSid() string` + +GetVMSid returns the VMSid field if non-nil, zero value otherwise. + +### GetVMSidOk + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetVMSidOk() (*string, bool)` + +GetVMSidOk returns a tuple with the VMSid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVMSid + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetVMSid(v string)` + +SetVMSid sets VMSid field to given value. + +### HasVMSid + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) HasVMSid() bool` + +HasVMSid returns a boolean if a field has been set. + +### SetVMSidNil + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetVMSidNil(b bool)` + + SetVMSidNil sets the value for VMSid to be an explicit nil + +### UnsetVMSid +`func (o *ProvisionedVirtualMachineDetailsResponseModel) UnsetVMSid()` + +UnsetVMSid ensures that no value is present for VMSid, not even an explicit nil +### GetAssignedImage + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetAssignedImage() string` + +GetAssignedImage returns the AssignedImage field if non-nil, zero value otherwise. + +### GetAssignedImageOk + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetAssignedImageOk() (*string, bool)` + +GetAssignedImageOk returns a tuple with the AssignedImage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssignedImage + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetAssignedImage(v string)` + +SetAssignedImage sets AssignedImage field to given value. + +### HasAssignedImage + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) HasAssignedImage() bool` + +HasAssignedImage returns a boolean if a field has been set. + +### SetAssignedImageNil + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetAssignedImageNil(b bool)` + + SetAssignedImageNil sets the value for AssignedImage to be an explicit nil + +### UnsetAssignedImage +`func (o *ProvisionedVirtualMachineDetailsResponseModel) UnsetAssignedImage()` + +UnsetAssignedImage ensures that no value is present for AssignedImage, not even an explicit nil +### GetBootedImage + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetBootedImage() string` + +GetBootedImage returns the BootedImage field if non-nil, zero value otherwise. + +### GetBootedImageOk + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetBootedImageOk() (*string, bool)` + +GetBootedImageOk returns a tuple with the BootedImage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBootedImage + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetBootedImage(v string)` + +SetBootedImage sets BootedImage field to given value. + +### HasBootedImage + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) HasBootedImage() bool` + +HasBootedImage returns a boolean if a field has been set. + +### SetBootedImageNil + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetBootedImageNil(b bool)` + + SetBootedImageNil sets the value for BootedImage to be an explicit nil + +### UnsetBootedImage +`func (o *ProvisionedVirtualMachineDetailsResponseModel) UnsetBootedImage()` + +UnsetBootedImage ensures that no value is present for BootedImage, not even an explicit nil +### GetCustomVmData + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetCustomVmData() ProvisionedVirtualMachineCustomVmDataResponseModel` + +GetCustomVmData returns the CustomVmData field if non-nil, zero value otherwise. + +### GetCustomVmDataOk + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetCustomVmDataOk() (*ProvisionedVirtualMachineCustomVmDataResponseModel, bool)` + +GetCustomVmDataOk returns a tuple with the CustomVmData field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCustomVmData + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetCustomVmData(v ProvisionedVirtualMachineCustomVmDataResponseModel)` + +SetCustomVmData sets CustomVmData field to given value. + +### HasCustomVmData + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) HasCustomVmData() bool` + +HasCustomVmData returns a boolean if a field has been set. + +### GetCpuCount + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetCpuCount() int32` + +GetCpuCount returns the CpuCount field if non-nil, zero value otherwise. + +### GetCpuCountOk + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetCpuCountOk() (*int32, bool)` + +GetCpuCountOk returns a tuple with the CpuCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCpuCount + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetCpuCount(v int32)` + +SetCpuCount sets CpuCount field to given value. + +### HasCpuCount + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) HasCpuCount() bool` + +HasCpuCount returns a boolean if a field has been set. + +### GetCreationDate + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetCreationDate() string` + +GetCreationDate returns the CreationDate field if non-nil, zero value otherwise. + +### GetCreationDateOk + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetCreationDateOk() (*string, bool)` + +GetCreationDateOk returns a tuple with the CreationDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreationDate + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetCreationDate(v string)` + +SetCreationDate sets CreationDate field to given value. + +### HasCreationDate + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) HasCreationDate() bool` + +HasCreationDate returns a boolean if a field has been set. + +### SetCreationDateNil + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetCreationDateNil(b bool)` + + SetCreationDateNil sets the value for CreationDate to be an explicit nil + +### UnsetCreationDate +`func (o *ProvisionedVirtualMachineDetailsResponseModel) UnsetCreationDate()` + +UnsetCreationDate ensures that no value is present for CreationDate, not even an explicit nil +### GetDomain + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetDomain() string` + +GetDomain returns the Domain field if non-nil, zero value otherwise. + +### GetDomainOk + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetDomainOk() (*string, bool)` + +GetDomainOk returns a tuple with the Domain field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDomain + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetDomain(v string)` + +SetDomain sets Domain field to given value. + +### HasDomain + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) HasDomain() bool` + +HasDomain returns a boolean if a field has been set. + +### SetDomainNil + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetDomainNil(b bool)` + + SetDomainNil sets the value for Domain to be an explicit nil + +### UnsetDomain +`func (o *ProvisionedVirtualMachineDetailsResponseModel) UnsetDomain()` + +UnsetDomain ensures that no value is present for Domain, not even an explicit nil +### GetEnableIntegrityMonitoring + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetEnableIntegrityMonitoring() bool` + +GetEnableIntegrityMonitoring returns the EnableIntegrityMonitoring field if non-nil, zero value otherwise. + +### GetEnableIntegrityMonitoringOk + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetEnableIntegrityMonitoringOk() (*bool, bool)` + +GetEnableIntegrityMonitoringOk returns a tuple with the EnableIntegrityMonitoring field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnableIntegrityMonitoring + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetEnableIntegrityMonitoring(v bool)` + +SetEnableIntegrityMonitoring sets EnableIntegrityMonitoring field to given value. + +### HasEnableIntegrityMonitoring + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) HasEnableIntegrityMonitoring() bool` + +HasEnableIntegrityMonitoring returns a boolean if a field has been set. + +### SetEnableIntegrityMonitoringNil + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetEnableIntegrityMonitoringNil(b bool)` + + SetEnableIntegrityMonitoringNil sets the value for EnableIntegrityMonitoring to be an explicit nil + +### UnsetEnableIntegrityMonitoring +`func (o *ProvisionedVirtualMachineDetailsResponseModel) UnsetEnableIntegrityMonitoring()` + +UnsetEnableIntegrityMonitoring ensures that no value is present for EnableIntegrityMonitoring, not even an explicit nil +### GetEnableSecureBoot + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetEnableSecureBoot() bool` + +GetEnableSecureBoot returns the EnableSecureBoot field if non-nil, zero value otherwise. + +### GetEnableSecureBootOk + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetEnableSecureBootOk() (*bool, bool)` + +GetEnableSecureBootOk returns a tuple with the EnableSecureBoot field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnableSecureBoot + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetEnableSecureBoot(v bool)` + +SetEnableSecureBoot sets EnableSecureBoot field to given value. + +### HasEnableSecureBoot + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) HasEnableSecureBoot() bool` + +HasEnableSecureBoot returns a boolean if a field has been set. + +### SetEnableSecureBootNil + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetEnableSecureBootNil(b bool)` + + SetEnableSecureBootNil sets the value for EnableSecureBoot to be an explicit nil + +### UnsetEnableSecureBoot +`func (o *ProvisionedVirtualMachineDetailsResponseModel) UnsetEnableSecureBoot()` + +UnsetEnableSecureBoot ensures that no value is present for EnableSecureBoot, not even an explicit nil +### GetEnableVTPM + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetEnableVTPM() bool` + +GetEnableVTPM returns the EnableVTPM field if non-nil, zero value otherwise. + +### GetEnableVTPMOk + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetEnableVTPMOk() (*bool, bool)` + +GetEnableVTPMOk returns a tuple with the EnableVTPM field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnableVTPM + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetEnableVTPM(v bool)` + +SetEnableVTPM sets EnableVTPM field to given value. + +### HasEnableVTPM + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) HasEnableVTPM() bool` + +HasEnableVTPM returns a boolean if a field has been set. + +### SetEnableVTPMNil + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetEnableVTPMNil(b bool)` + + SetEnableVTPMNil sets the value for EnableVTPM to be an explicit nil + +### UnsetEnableVTPM +`func (o *ProvisionedVirtualMachineDetailsResponseModel) UnsetEnableVTPM()` + +UnsetEnableVTPM ensures that no value is present for EnableVTPM, not even an explicit nil +### GetEncryptionAtHost + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetEncryptionAtHost() bool` + +GetEncryptionAtHost returns the EncryptionAtHost field if non-nil, zero value otherwise. + +### GetEncryptionAtHostOk + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetEncryptionAtHostOk() (*bool, bool)` + +GetEncryptionAtHostOk returns a tuple with the EncryptionAtHost field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEncryptionAtHost + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetEncryptionAtHost(v bool)` + +SetEncryptionAtHost sets EncryptionAtHost field to given value. + +### HasEncryptionAtHost + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) HasEncryptionAtHost() bool` + +HasEncryptionAtHost returns a boolean if a field has been set. + +### SetEncryptionAtHostNil + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetEncryptionAtHostNil(b bool)` + + SetEncryptionAtHostNil sets the value for EncryptionAtHost to be an explicit nil + +### UnsetEncryptionAtHost +`func (o *ProvisionedVirtualMachineDetailsResponseModel) UnsetEncryptionAtHost()` + +UnsetEncryptionAtHost ensures that no value is present for EncryptionAtHost, not even an explicit nil +### GetErrors + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetErrors() []string` + +GetErrors returns the Errors field if non-nil, zero value otherwise. + +### GetErrorsOk + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetErrorsOk() (*[]string, bool)` + +GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrors + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetErrors(v []string)` + +SetErrors sets Errors field to given value. + +### HasErrors + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) HasErrors() bool` + +HasErrors returns a boolean if a field has been set. + +### SetErrorsNil + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetErrorsNil(b bool)` + + SetErrorsNil sets the value for Errors to be an explicit nil + +### UnsetErrors +`func (o *ProvisionedVirtualMachineDetailsResponseModel) UnsetErrors()` + +UnsetErrors ensures that no value is present for Errors, not even an explicit nil +### GetPluginId + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetPluginId() string` + +GetPluginId returns the PluginId field if non-nil, zero value otherwise. + +### GetPluginIdOk + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetPluginIdOk() (*string, bool)` + +GetPluginIdOk returns a tuple with the PluginId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPluginId + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetPluginId(v string)` + +SetPluginId sets PluginId field to given value. + +### HasPluginId + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) HasPluginId() bool` + +HasPluginId returns a boolean if a field has been set. + +### SetPluginIdNil + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetPluginIdNil(b bool)` + + SetPluginIdNil sets the value for PluginId to be an explicit nil + +### UnsetPluginId +`func (o *ProvisionedVirtualMachineDetailsResponseModel) UnsetPluginId()` + +UnsetPluginId ensures that no value is present for PluginId, not even an explicit nil +### GetImageOutOfDate + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetImageOutOfDate() bool` + +GetImageOutOfDate returns the ImageOutOfDate field if non-nil, zero value otherwise. + +### GetImageOutOfDateOk + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetImageOutOfDateOk() (*bool, bool)` + +GetImageOutOfDateOk returns a tuple with the ImageOutOfDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetImageOutOfDate + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetImageOutOfDate(v bool)` + +SetImageOutOfDate sets ImageOutOfDate field to given value. + +### HasImageOutOfDate + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) HasImageOutOfDate() bool` + +HasImageOutOfDate returns a boolean if a field has been set. + +### GetMemoryMB + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetMemoryMB() int32` + +GetMemoryMB returns the MemoryMB field if non-nil, zero value otherwise. + +### GetMemoryMBOk + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetMemoryMBOk() (*int32, bool)` + +GetMemoryMBOk returns a tuple with the MemoryMB field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMemoryMB + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetMemoryMB(v int32)` + +SetMemoryMB sets MemoryMB field to given value. + +### HasMemoryMB + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) HasMemoryMB() bool` + +HasMemoryMB returns a boolean if a field has been set. + +### GetHostingUnitUid + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetHostingUnitUid() string` + +GetHostingUnitUid returns the HostingUnitUid field if non-nil, zero value otherwise. + +### GetHostingUnitUidOk + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetHostingUnitUidOk() (*string, bool)` + +GetHostingUnitUidOk returns a tuple with the HostingUnitUid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHostingUnitUid + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetHostingUnitUid(v string)` + +SetHostingUnitUid sets HostingUnitUid field to given value. + +### HasHostingUnitUid + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) HasHostingUnitUid() bool` + +HasHostingUnitUid returns a boolean if a field has been set. + +### GetHypervisorConnectionUid + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetHypervisorConnectionUid() string` + +GetHypervisorConnectionUid returns the HypervisorConnectionUid field if non-nil, zero value otherwise. + +### GetHypervisorConnectionUidOk + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetHypervisorConnectionUidOk() (*string, bool)` + +GetHypervisorConnectionUidOk returns a tuple with the HypervisorConnectionUid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHypervisorConnectionUid + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetHypervisorConnectionUid(v string)` + +SetHypervisorConnectionUid sets HypervisorConnectionUid field to given value. + +### HasHypervisorConnectionUid + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) HasHypervisorConnectionUid() bool` + +HasHypervisorConnectionUid returns a boolean if a field has been set. + +### GetIdentityDiskId + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetIdentityDiskId() string` + +GetIdentityDiskId returns the IdentityDiskId field if non-nil, zero value otherwise. + +### GetIdentityDiskIdOk + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetIdentityDiskIdOk() (*string, bool)` + +GetIdentityDiskIdOk returns a tuple with the IdentityDiskId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityDiskId + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetIdentityDiskId(v string)` + +SetIdentityDiskId sets IdentityDiskId field to given value. + +### HasIdentityDiskId + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) HasIdentityDiskId() bool` + +HasIdentityDiskId returns a boolean if a field has been set. + +### SetIdentityDiskIdNil + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetIdentityDiskIdNil(b bool)` + + SetIdentityDiskIdNil sets the value for IdentityDiskId to be an explicit nil + +### UnsetIdentityDiskId +`func (o *ProvisionedVirtualMachineDetailsResponseModel) UnsetIdentityDiskId()` + +UnsetIdentityDiskId ensures that no value is present for IdentityDiskId, not even an explicit nil +### GetLastBootTime + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetLastBootTime() string` + +GetLastBootTime returns the LastBootTime field if non-nil, zero value otherwise. + +### GetLastBootTimeOk + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetLastBootTimeOk() (*string, bool)` + +GetLastBootTimeOk returns a tuple with the LastBootTime field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastBootTime + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetLastBootTime(v string)` + +SetLastBootTime sets LastBootTime field to given value. + +### HasLastBootTime + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) HasLastBootTime() bool` + +HasLastBootTime returns a boolean if a field has been set. + +### SetLastBootTimeNil + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetLastBootTimeNil(b bool)` + + SetLastBootTimeNil sets the value for LastBootTime to be an explicit nil + +### UnsetLastBootTime +`func (o *ProvisionedVirtualMachineDetailsResponseModel) UnsetLastBootTime()` + +UnsetLastBootTime ensures that no value is present for LastBootTime, not even an explicit nil +### GetProvisioningSchemeType + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetProvisioningSchemeType() string` + +GetProvisioningSchemeType returns the ProvisioningSchemeType field if non-nil, zero value otherwise. + +### GetProvisioningSchemeTypeOk + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetProvisioningSchemeTypeOk() (*string, bool)` + +GetProvisioningSchemeTypeOk returns a tuple with the ProvisioningSchemeType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioningSchemeType + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetProvisioningSchemeType(v string)` + +SetProvisioningSchemeType sets ProvisioningSchemeType field to given value. + +### HasProvisioningSchemeType + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) HasProvisioningSchemeType() bool` + +HasProvisioningSchemeType returns a boolean if a field has been set. + +### SetProvisioningSchemeTypeNil + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetProvisioningSchemeTypeNil(b bool)` + + SetProvisioningSchemeTypeNil sets the value for ProvisioningSchemeType to be an explicit nil + +### UnsetProvisioningSchemeType +`func (o *ProvisionedVirtualMachineDetailsResponseModel) UnsetProvisioningSchemeType()` + +UnsetProvisioningSchemeType ensures that no value is present for ProvisioningSchemeType, not even an explicit nil +### GetProvisioningSchemeUpdateRequested + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetProvisioningSchemeUpdateRequested() string` + +GetProvisioningSchemeUpdateRequested returns the ProvisioningSchemeUpdateRequested field if non-nil, zero value otherwise. + +### GetProvisioningSchemeUpdateRequestedOk + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetProvisioningSchemeUpdateRequestedOk() (*string, bool)` + +GetProvisioningSchemeUpdateRequestedOk returns a tuple with the ProvisioningSchemeUpdateRequested field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioningSchemeUpdateRequested + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetProvisioningSchemeUpdateRequested(v string)` + +SetProvisioningSchemeUpdateRequested sets ProvisioningSchemeUpdateRequested field to given value. + +### HasProvisioningSchemeUpdateRequested + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) HasProvisioningSchemeUpdateRequested() bool` + +HasProvisioningSchemeUpdateRequested returns a boolean if a field has been set. + +### SetProvisioningSchemeUpdateRequestedNil + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetProvisioningSchemeUpdateRequestedNil(b bool)` + + SetProvisioningSchemeUpdateRequestedNil sets the value for ProvisioningSchemeUpdateRequested to be an explicit nil + +### UnsetProvisioningSchemeUpdateRequested +`func (o *ProvisionedVirtualMachineDetailsResponseModel) UnsetProvisioningSchemeUpdateRequested()` + +UnsetProvisioningSchemeUpdateRequested ensures that no value is present for ProvisioningSchemeUpdateRequested, not even an explicit nil +### GetProvisioningSchemeVersion + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetProvisioningSchemeVersion() int32` + +GetProvisioningSchemeVersion returns the ProvisioningSchemeVersion field if non-nil, zero value otherwise. + +### GetProvisioningSchemeVersionOk + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetProvisioningSchemeVersionOk() (*int32, bool)` + +GetProvisioningSchemeVersionOk returns a tuple with the ProvisioningSchemeVersion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioningSchemeVersion + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetProvisioningSchemeVersion(v int32)` + +SetProvisioningSchemeVersion sets ProvisioningSchemeVersion field to given value. + +### HasProvisioningSchemeVersion + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) HasProvisioningSchemeVersion() bool` + +HasProvisioningSchemeVersion returns a boolean if a field has been set. + +### GetUseFullDiskCloneProvisioning + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetUseFullDiskCloneProvisioning() bool` + +GetUseFullDiskCloneProvisioning returns the UseFullDiskCloneProvisioning field if non-nil, zero value otherwise. + +### GetUseFullDiskCloneProvisioningOk + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetUseFullDiskCloneProvisioningOk() (*bool, bool)` + +GetUseFullDiskCloneProvisioningOk returns a tuple with the UseFullDiskCloneProvisioning field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUseFullDiskCloneProvisioning + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetUseFullDiskCloneProvisioning(v bool)` + +SetUseFullDiskCloneProvisioning sets UseFullDiskCloneProvisioning field to given value. + +### HasUseFullDiskCloneProvisioning + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) HasUseFullDiskCloneProvisioning() bool` + +HasUseFullDiskCloneProvisioning returns a boolean if a field has been set. + +### GetVMId + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetVMId() string` + +GetVMId returns the VMId field if non-nil, zero value otherwise. + +### GetVMIdOk + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetVMIdOk() (*string, bool)` + +GetVMIdOk returns a tuple with the VMId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVMId + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetVMId(v string)` + +SetVMId sets VMId field to given value. + +### HasVMId + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) HasVMId() bool` + +HasVMId returns a boolean if a field has been set. + +### SetVMIdNil + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetVMIdNil(b bool)` + + SetVMIdNil sets the value for VMId to be an explicit nil + +### UnsetVMId +`func (o *ProvisionedVirtualMachineDetailsResponseModel) UnsetVMId()` + +UnsetVMId ensures that no value is present for VMId, not even an explicit nil +### GetVMName + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetVMName() string` + +GetVMName returns the VMName field if non-nil, zero value otherwise. + +### GetVMNameOk + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetVMNameOk() (*string, bool)` + +GetVMNameOk returns a tuple with the VMName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVMName + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetVMName(v string)` + +SetVMName sets VMName field to given value. + +### HasVMName + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) HasVMName() bool` + +HasVMName returns a boolean if a field has been set. + +### SetVMNameNil + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetVMNameNil(b bool)` + + SetVMNameNil sets the value for VMName to be an explicit nil + +### UnsetVMName +`func (o *ProvisionedVirtualMachineDetailsResponseModel) UnsetVMName()` + +UnsetVMName ensures that no value is present for VMName, not even an explicit nil +### GetWarnings + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetWarnings() []ProvisionedVirtualMachineDetailsWarningReponseModel` + +GetWarnings returns the Warnings field if non-nil, zero value otherwise. + +### GetWarningsOk + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetWarningsOk() (*[]ProvisionedVirtualMachineDetailsWarningReponseModel, bool)` + +GetWarningsOk returns a tuple with the Warnings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWarnings + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetWarnings(v []ProvisionedVirtualMachineDetailsWarningReponseModel)` + +SetWarnings sets Warnings field to given value. + +### HasWarnings + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) HasWarnings() bool` + +HasWarnings returns a boolean if a field has been set. + +### SetWarningsNil + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetWarningsNil(b bool)` + + SetWarningsNil sets the value for Warnings to be an explicit nil + +### UnsetWarnings +`func (o *ProvisionedVirtualMachineDetailsResponseModel) UnsetWarnings()` + +UnsetWarnings ensures that no value is present for Warnings, not even an explicit nil +### GetWindowsActivationStatus + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetWindowsActivationStatus() string` + +GetWindowsActivationStatus returns the WindowsActivationStatus field if non-nil, zero value otherwise. + +### GetWindowsActivationStatusOk + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetWindowsActivationStatusOk() (*string, bool)` + +GetWindowsActivationStatusOk returns a tuple with the WindowsActivationStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWindowsActivationStatus + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetWindowsActivationStatus(v string)` + +SetWindowsActivationStatus sets WindowsActivationStatus field to given value. + +### HasWindowsActivationStatus + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) HasWindowsActivationStatus() bool` + +HasWindowsActivationStatus returns a boolean if a field has been set. + +### SetWindowsActivationStatusNil + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetWindowsActivationStatusNil(b bool)` + + SetWindowsActivationStatusNil sets the value for WindowsActivationStatus to be an explicit nil + +### UnsetWindowsActivationStatus +`func (o *ProvisionedVirtualMachineDetailsResponseModel) UnsetWindowsActivationStatus()` + +UnsetWindowsActivationStatus ensures that no value is present for WindowsActivationStatus, not even an explicit nil +### GetWindowsActivationStatusErrorCode + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetWindowsActivationStatusErrorCode() string` + +GetWindowsActivationStatusErrorCode returns the WindowsActivationStatusErrorCode field if non-nil, zero value otherwise. + +### GetWindowsActivationStatusErrorCodeOk + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetWindowsActivationStatusErrorCodeOk() (*string, bool)` + +GetWindowsActivationStatusErrorCodeOk returns a tuple with the WindowsActivationStatusErrorCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWindowsActivationStatusErrorCode + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetWindowsActivationStatusErrorCode(v string)` + +SetWindowsActivationStatusErrorCode sets WindowsActivationStatusErrorCode field to given value. + +### HasWindowsActivationStatusErrorCode + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) HasWindowsActivationStatusErrorCode() bool` + +HasWindowsActivationStatusErrorCode returns a boolean if a field has been set. + +### SetWindowsActivationStatusErrorCodeNil + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetWindowsActivationStatusErrorCodeNil(b bool)` + + SetWindowsActivationStatusErrorCodeNil sets the value for WindowsActivationStatusErrorCode to be an explicit nil + +### UnsetWindowsActivationStatusErrorCode +`func (o *ProvisionedVirtualMachineDetailsResponseModel) UnsetWindowsActivationStatusErrorCode()` + +UnsetWindowsActivationStatusErrorCode ensures that no value is present for WindowsActivationStatusErrorCode, not even an explicit nil +### GetWindowsActivationStatusVirtualMachineError + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetWindowsActivationStatusVirtualMachineError() string` + +GetWindowsActivationStatusVirtualMachineError returns the WindowsActivationStatusVirtualMachineError field if non-nil, zero value otherwise. + +### GetWindowsActivationStatusVirtualMachineErrorOk + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetWindowsActivationStatusVirtualMachineErrorOk() (*string, bool)` + +GetWindowsActivationStatusVirtualMachineErrorOk returns a tuple with the WindowsActivationStatusVirtualMachineError field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWindowsActivationStatusVirtualMachineError + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetWindowsActivationStatusVirtualMachineError(v string)` + +SetWindowsActivationStatusVirtualMachineError sets WindowsActivationStatusVirtualMachineError field to given value. + +### HasWindowsActivationStatusVirtualMachineError + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) HasWindowsActivationStatusVirtualMachineError() bool` + +HasWindowsActivationStatusVirtualMachineError returns a boolean if a field has been set. + +### SetWindowsActivationStatusVirtualMachineErrorNil + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetWindowsActivationStatusVirtualMachineErrorNil(b bool)` + + SetWindowsActivationStatusVirtualMachineErrorNil sets the value for WindowsActivationStatusVirtualMachineError to be an explicit nil + +### UnsetWindowsActivationStatusVirtualMachineError +`func (o *ProvisionedVirtualMachineDetailsResponseModel) UnsetWindowsActivationStatusVirtualMachineError()` + +UnsetWindowsActivationStatusVirtualMachineError ensures that no value is present for WindowsActivationStatusVirtualMachineError, not even an explicit nil +### GetWindowsActivationTypeProvisionedVirtualMachine + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetWindowsActivationTypeProvisionedVirtualMachine() string` + +GetWindowsActivationTypeProvisionedVirtualMachine returns the WindowsActivationTypeProvisionedVirtualMachine field if non-nil, zero value otherwise. + +### GetWindowsActivationTypeProvisionedVirtualMachineOk + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetWindowsActivationTypeProvisionedVirtualMachineOk() (*string, bool)` + +GetWindowsActivationTypeProvisionedVirtualMachineOk returns a tuple with the WindowsActivationTypeProvisionedVirtualMachine field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWindowsActivationTypeProvisionedVirtualMachine + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetWindowsActivationTypeProvisionedVirtualMachine(v string)` + +SetWindowsActivationTypeProvisionedVirtualMachine sets WindowsActivationTypeProvisionedVirtualMachine field to given value. + +### HasWindowsActivationTypeProvisionedVirtualMachine + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) HasWindowsActivationTypeProvisionedVirtualMachine() bool` + +HasWindowsActivationTypeProvisionedVirtualMachine returns a boolean if a field has been set. + +### SetWindowsActivationTypeProvisionedVirtualMachineNil + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetWindowsActivationTypeProvisionedVirtualMachineNil(b bool)` + + SetWindowsActivationTypeProvisionedVirtualMachineNil sets the value for WindowsActivationTypeProvisionedVirtualMachine to be an explicit nil + +### UnsetWindowsActivationTypeProvisionedVirtualMachine +`func (o *ProvisionedVirtualMachineDetailsResponseModel) UnsetWindowsActivationTypeProvisionedVirtualMachine()` + +UnsetWindowsActivationTypeProvisionedVirtualMachine ensures that no value is present for WindowsActivationTypeProvisionedVirtualMachine, not even an explicit nil +### GetWriteBackCacheDiskSize + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetWriteBackCacheDiskSize() int32` + +GetWriteBackCacheDiskSize returns the WriteBackCacheDiskSize field if non-nil, zero value otherwise. + +### GetWriteBackCacheDiskSizeOk + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetWriteBackCacheDiskSizeOk() (*int32, bool)` + +GetWriteBackCacheDiskSizeOk returns a tuple with the WriteBackCacheDiskSize field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWriteBackCacheDiskSize + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetWriteBackCacheDiskSize(v int32)` + +SetWriteBackCacheDiskSize sets WriteBackCacheDiskSize field to given value. + +### HasWriteBackCacheDiskSize + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) HasWriteBackCacheDiskSize() bool` + +HasWriteBackCacheDiskSize returns a boolean if a field has been set. + +### GetWriteBackCacheMemorySize + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetWriteBackCacheMemorySize() int32` + +GetWriteBackCacheMemorySize returns the WriteBackCacheMemorySize field if non-nil, zero value otherwise. + +### GetWriteBackCacheMemorySizeOk + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) GetWriteBackCacheMemorySizeOk() (*int32, bool)` + +GetWriteBackCacheMemorySizeOk returns a tuple with the WriteBackCacheMemorySize field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWriteBackCacheMemorySize + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) SetWriteBackCacheMemorySize(v int32)` + +SetWriteBackCacheMemorySize sets WriteBackCacheMemorySize field to given value. + +### HasWriteBackCacheMemorySize + +`func (o *ProvisionedVirtualMachineDetailsResponseModel) HasWriteBackCacheMemorySize() bool` + +HasWriteBackCacheMemorySize returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/citrixorchestration/docs/ProvisionedVirtualMachineDetailsWarningReponseModel.md b/citrixorchestration/docs/ProvisionedVirtualMachineDetailsWarningReponseModel.md new file mode 100644 index 0000000..81f5028 --- /dev/null +++ b/citrixorchestration/docs/ProvisionedVirtualMachineDetailsWarningReponseModel.md @@ -0,0 +1,92 @@ +# ProvisionedVirtualMachineDetailsWarningReponseModel + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**ProvisionedVirtualMachineDetailsWarningType**](ProvisionedVirtualMachineDetailsWarningType.md) | | [optional] +**Message** | Pointer to **NullableString** | Message associated with warning | [optional] + +## Methods + +### NewProvisionedVirtualMachineDetailsWarningReponseModel + +`func NewProvisionedVirtualMachineDetailsWarningReponseModel() *ProvisionedVirtualMachineDetailsWarningReponseModel` + +NewProvisionedVirtualMachineDetailsWarningReponseModel instantiates a new ProvisionedVirtualMachineDetailsWarningReponseModel object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewProvisionedVirtualMachineDetailsWarningReponseModelWithDefaults + +`func NewProvisionedVirtualMachineDetailsWarningReponseModelWithDefaults() *ProvisionedVirtualMachineDetailsWarningReponseModel` + +NewProvisionedVirtualMachineDetailsWarningReponseModelWithDefaults instantiates a new ProvisionedVirtualMachineDetailsWarningReponseModel object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetType + +`func (o *ProvisionedVirtualMachineDetailsWarningReponseModel) GetType() ProvisionedVirtualMachineDetailsWarningType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ProvisionedVirtualMachineDetailsWarningReponseModel) GetTypeOk() (*ProvisionedVirtualMachineDetailsWarningType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ProvisionedVirtualMachineDetailsWarningReponseModel) SetType(v ProvisionedVirtualMachineDetailsWarningType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ProvisionedVirtualMachineDetailsWarningReponseModel) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetMessage + +`func (o *ProvisionedVirtualMachineDetailsWarningReponseModel) GetMessage() string` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *ProvisionedVirtualMachineDetailsWarningReponseModel) GetMessageOk() (*string, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *ProvisionedVirtualMachineDetailsWarningReponseModel) SetMessage(v string)` + +SetMessage sets Message field to given value. + +### HasMessage + +`func (o *ProvisionedVirtualMachineDetailsWarningReponseModel) HasMessage() bool` + +HasMessage returns a boolean if a field has been set. + +### SetMessageNil + +`func (o *ProvisionedVirtualMachineDetailsWarningReponseModel) SetMessageNil(b bool)` + + SetMessageNil sets the value for Message to be an explicit nil + +### UnsetMessage +`func (o *ProvisionedVirtualMachineDetailsWarningReponseModel) UnsetMessage()` + +UnsetMessage ensures that no value is present for Message, not even an explicit nil + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/citrixorchestration/docs/ProvisionedVirtualMachineDetailsWarningType.md b/citrixorchestration/docs/ProvisionedVirtualMachineDetailsWarningType.md new file mode 100644 index 0000000..d8fb72c --- /dev/null +++ b/citrixorchestration/docs/ProvisionedVirtualMachineDetailsWarningType.md @@ -0,0 +1,15 @@ +# ProvisionedVirtualMachineDetailsWarningType + +## Enum + + +* `UNKNOWN` (value: `"Unknown"`) + +* `GET_PROVISIONED_VIRTUAL_MACHINE_CUSTOM_VM_DATA_FAILED` (value: `"GetProvisionedVirtualMachineCustomVMDataFailed"`) + +* `GET_PROVISIONING_SCHEME_VM_METADATA_FAILED` (value: `"GetProvisioningSchemeVMMetadataFailed"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/citrixorchestration/docs/ProvisionedVirtualMachineSearchFilterGroupRequestModel.md b/citrixorchestration/docs/ProvisionedVirtualMachineSearchFilterGroupRequestModel.md new file mode 100644 index 0000000..90705d9 --- /dev/null +++ b/citrixorchestration/docs/ProvisionedVirtualMachineSearchFilterGroupRequestModel.md @@ -0,0 +1,154 @@ +# ProvisionedVirtualMachineSearchFilterGroupRequestModel + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SearchFilterGroupType** | Pointer to [**ProvisionedVirtualMachineSearchFilterGroupType**](ProvisionedVirtualMachineSearchFilterGroupType.md) | | [optional] +**SearchFilters** | Pointer to [**[]ProvisionedVirtualMachineSearchFilterRequestModel**](ProvisionedVirtualMachineSearchFilterRequestModel.md) | The search filters in search filter group | [optional] +**SearchFilterGroupsType** | Pointer to [**ProvisionedVirtualMachineSearchFilterGroupsType**](ProvisionedVirtualMachineSearchFilterGroupsType.md) | | [optional] +**SearchFilterGroups** | Pointer to [**[]ProvisionedVirtualMachineSearchFilterGroupRequestModel**](ProvisionedVirtualMachineSearchFilterGroupRequestModel.md) | The search filter group in search filter groups | [optional] + +## Methods + +### NewProvisionedVirtualMachineSearchFilterGroupRequestModel + +`func NewProvisionedVirtualMachineSearchFilterGroupRequestModel() *ProvisionedVirtualMachineSearchFilterGroupRequestModel` + +NewProvisionedVirtualMachineSearchFilterGroupRequestModel instantiates a new ProvisionedVirtualMachineSearchFilterGroupRequestModel object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewProvisionedVirtualMachineSearchFilterGroupRequestModelWithDefaults + +`func NewProvisionedVirtualMachineSearchFilterGroupRequestModelWithDefaults() *ProvisionedVirtualMachineSearchFilterGroupRequestModel` + +NewProvisionedVirtualMachineSearchFilterGroupRequestModelWithDefaults instantiates a new ProvisionedVirtualMachineSearchFilterGroupRequestModel object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetSearchFilterGroupType + +`func (o *ProvisionedVirtualMachineSearchFilterGroupRequestModel) GetSearchFilterGroupType() ProvisionedVirtualMachineSearchFilterGroupType` + +GetSearchFilterGroupType returns the SearchFilterGroupType field if non-nil, zero value otherwise. + +### GetSearchFilterGroupTypeOk + +`func (o *ProvisionedVirtualMachineSearchFilterGroupRequestModel) GetSearchFilterGroupTypeOk() (*ProvisionedVirtualMachineSearchFilterGroupType, bool)` + +GetSearchFilterGroupTypeOk returns a tuple with the SearchFilterGroupType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSearchFilterGroupType + +`func (o *ProvisionedVirtualMachineSearchFilterGroupRequestModel) SetSearchFilterGroupType(v ProvisionedVirtualMachineSearchFilterGroupType)` + +SetSearchFilterGroupType sets SearchFilterGroupType field to given value. + +### HasSearchFilterGroupType + +`func (o *ProvisionedVirtualMachineSearchFilterGroupRequestModel) HasSearchFilterGroupType() bool` + +HasSearchFilterGroupType returns a boolean if a field has been set. + +### GetSearchFilters + +`func (o *ProvisionedVirtualMachineSearchFilterGroupRequestModel) GetSearchFilters() []ProvisionedVirtualMachineSearchFilterRequestModel` + +GetSearchFilters returns the SearchFilters field if non-nil, zero value otherwise. + +### GetSearchFiltersOk + +`func (o *ProvisionedVirtualMachineSearchFilterGroupRequestModel) GetSearchFiltersOk() (*[]ProvisionedVirtualMachineSearchFilterRequestModel, bool)` + +GetSearchFiltersOk returns a tuple with the SearchFilters field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSearchFilters + +`func (o *ProvisionedVirtualMachineSearchFilterGroupRequestModel) SetSearchFilters(v []ProvisionedVirtualMachineSearchFilterRequestModel)` + +SetSearchFilters sets SearchFilters field to given value. + +### HasSearchFilters + +`func (o *ProvisionedVirtualMachineSearchFilterGroupRequestModel) HasSearchFilters() bool` + +HasSearchFilters returns a boolean if a field has been set. + +### SetSearchFiltersNil + +`func (o *ProvisionedVirtualMachineSearchFilterGroupRequestModel) SetSearchFiltersNil(b bool)` + + SetSearchFiltersNil sets the value for SearchFilters to be an explicit nil + +### UnsetSearchFilters +`func (o *ProvisionedVirtualMachineSearchFilterGroupRequestModel) UnsetSearchFilters()` + +UnsetSearchFilters ensures that no value is present for SearchFilters, not even an explicit nil +### GetSearchFilterGroupsType + +`func (o *ProvisionedVirtualMachineSearchFilterGroupRequestModel) GetSearchFilterGroupsType() ProvisionedVirtualMachineSearchFilterGroupsType` + +GetSearchFilterGroupsType returns the SearchFilterGroupsType field if non-nil, zero value otherwise. + +### GetSearchFilterGroupsTypeOk + +`func (o *ProvisionedVirtualMachineSearchFilterGroupRequestModel) GetSearchFilterGroupsTypeOk() (*ProvisionedVirtualMachineSearchFilterGroupsType, bool)` + +GetSearchFilterGroupsTypeOk returns a tuple with the SearchFilterGroupsType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSearchFilterGroupsType + +`func (o *ProvisionedVirtualMachineSearchFilterGroupRequestModel) SetSearchFilterGroupsType(v ProvisionedVirtualMachineSearchFilterGroupsType)` + +SetSearchFilterGroupsType sets SearchFilterGroupsType field to given value. + +### HasSearchFilterGroupsType + +`func (o *ProvisionedVirtualMachineSearchFilterGroupRequestModel) HasSearchFilterGroupsType() bool` + +HasSearchFilterGroupsType returns a boolean if a field has been set. + +### GetSearchFilterGroups + +`func (o *ProvisionedVirtualMachineSearchFilterGroupRequestModel) GetSearchFilterGroups() []ProvisionedVirtualMachineSearchFilterGroupRequestModel` + +GetSearchFilterGroups returns the SearchFilterGroups field if non-nil, zero value otherwise. + +### GetSearchFilterGroupsOk + +`func (o *ProvisionedVirtualMachineSearchFilterGroupRequestModel) GetSearchFilterGroupsOk() (*[]ProvisionedVirtualMachineSearchFilterGroupRequestModel, bool)` + +GetSearchFilterGroupsOk returns a tuple with the SearchFilterGroups field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSearchFilterGroups + +`func (o *ProvisionedVirtualMachineSearchFilterGroupRequestModel) SetSearchFilterGroups(v []ProvisionedVirtualMachineSearchFilterGroupRequestModel)` + +SetSearchFilterGroups sets SearchFilterGroups field to given value. + +### HasSearchFilterGroups + +`func (o *ProvisionedVirtualMachineSearchFilterGroupRequestModel) HasSearchFilterGroups() bool` + +HasSearchFilterGroups returns a boolean if a field has been set. + +### SetSearchFilterGroupsNil + +`func (o *ProvisionedVirtualMachineSearchFilterGroupRequestModel) SetSearchFilterGroupsNil(b bool)` + + SetSearchFilterGroupsNil sets the value for SearchFilterGroups to be an explicit nil + +### UnsetSearchFilterGroups +`func (o *ProvisionedVirtualMachineSearchFilterGroupRequestModel) UnsetSearchFilterGroups()` + +UnsetSearchFilterGroups ensures that no value is present for SearchFilterGroups, not even an explicit nil + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/citrixorchestration/docs/ProvisionedVirtualMachineSearchFilterGroupType.md b/citrixorchestration/docs/ProvisionedVirtualMachineSearchFilterGroupType.md new file mode 100644 index 0000000..489c251 --- /dev/null +++ b/citrixorchestration/docs/ProvisionedVirtualMachineSearchFilterGroupType.md @@ -0,0 +1,13 @@ +# ProvisionedVirtualMachineSearchFilterGroupType + +## Enum + + +* `OR` (value: `"Or"`) + +* `AND` (value: `"And"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/citrixorchestration/docs/ProvisionedVirtualMachineSearchFilterGroupsType.md b/citrixorchestration/docs/ProvisionedVirtualMachineSearchFilterGroupsType.md new file mode 100644 index 0000000..193ce45 --- /dev/null +++ b/citrixorchestration/docs/ProvisionedVirtualMachineSearchFilterGroupsType.md @@ -0,0 +1,13 @@ +# ProvisionedVirtualMachineSearchFilterGroupsType + +## Enum + + +* `OR` (value: `"Or"`) + +* `AND` (value: `"And"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/citrixorchestration/docs/ProvisionedVirtualMachineSearchFilterRequestModel.md b/citrixorchestration/docs/ProvisionedVirtualMachineSearchFilterRequestModel.md new file mode 100644 index 0000000..25744e1 --- /dev/null +++ b/citrixorchestration/docs/ProvisionedVirtualMachineSearchFilterRequestModel.md @@ -0,0 +1,108 @@ +# ProvisionedVirtualMachineSearchFilterRequestModel + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Property** | [**ProvisionedVirtualMachineSearchProperty**](ProvisionedVirtualMachineSearchProperty.md) | | +**Value** | Pointer to **NullableString** | Value to match. | [optional] +**Operator** | [**SearchOperator**](SearchOperator.md) | | + +## Methods + +### NewProvisionedVirtualMachineSearchFilterRequestModel + +`func NewProvisionedVirtualMachineSearchFilterRequestModel(property ProvisionedVirtualMachineSearchProperty, operator SearchOperator, ) *ProvisionedVirtualMachineSearchFilterRequestModel` + +NewProvisionedVirtualMachineSearchFilterRequestModel instantiates a new ProvisionedVirtualMachineSearchFilterRequestModel object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewProvisionedVirtualMachineSearchFilterRequestModelWithDefaults + +`func NewProvisionedVirtualMachineSearchFilterRequestModelWithDefaults() *ProvisionedVirtualMachineSearchFilterRequestModel` + +NewProvisionedVirtualMachineSearchFilterRequestModelWithDefaults instantiates a new ProvisionedVirtualMachineSearchFilterRequestModel object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetProperty + +`func (o *ProvisionedVirtualMachineSearchFilterRequestModel) GetProperty() ProvisionedVirtualMachineSearchProperty` + +GetProperty returns the Property field if non-nil, zero value otherwise. + +### GetPropertyOk + +`func (o *ProvisionedVirtualMachineSearchFilterRequestModel) GetPropertyOk() (*ProvisionedVirtualMachineSearchProperty, bool)` + +GetPropertyOk returns a tuple with the Property field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProperty + +`func (o *ProvisionedVirtualMachineSearchFilterRequestModel) SetProperty(v ProvisionedVirtualMachineSearchProperty)` + +SetProperty sets Property field to given value. + + +### GetValue + +`func (o *ProvisionedVirtualMachineSearchFilterRequestModel) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *ProvisionedVirtualMachineSearchFilterRequestModel) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *ProvisionedVirtualMachineSearchFilterRequestModel) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *ProvisionedVirtualMachineSearchFilterRequestModel) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### SetValueNil + +`func (o *ProvisionedVirtualMachineSearchFilterRequestModel) SetValueNil(b bool)` + + SetValueNil sets the value for Value to be an explicit nil + +### UnsetValue +`func (o *ProvisionedVirtualMachineSearchFilterRequestModel) UnsetValue()` + +UnsetValue ensures that no value is present for Value, not even an explicit nil +### GetOperator + +`func (o *ProvisionedVirtualMachineSearchFilterRequestModel) GetOperator() SearchOperator` + +GetOperator returns the Operator field if non-nil, zero value otherwise. + +### GetOperatorOk + +`func (o *ProvisionedVirtualMachineSearchFilterRequestModel) GetOperatorOk() (*SearchOperator, bool)` + +GetOperatorOk returns a tuple with the Operator field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperator + +`func (o *ProvisionedVirtualMachineSearchFilterRequestModel) SetOperator(v SearchOperator)` + +SetOperator sets Operator field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/citrixorchestration/docs/ProvisionedVirtualMachineSearchProperty.md b/citrixorchestration/docs/ProvisionedVirtualMachineSearchProperty.md new file mode 100644 index 0000000..11c1493 --- /dev/null +++ b/citrixorchestration/docs/ProvisionedVirtualMachineSearchProperty.md @@ -0,0 +1,45 @@ +# ProvisionedVirtualMachineSearchProperty + +## Enum + + +* `ACTIVE_OPERATION` (value: `"ActiveOperation"`) + +* `VM_SID` (value: `"VMSid"`) + +* `CPU_COUNT` (value: `"CpuCount"`) + +* `IDENTITY_TYPE` (value: `"IdentityType"`) + +* `IDENTITIES` (value: `"Identities"`) + +* `IMAGE_OUT_OF_DATE` (value: `"ImageOutOfDate"`) + +* `LAST_BOOT_TIME` (value: `"LastBootTime"`) + +* `MEMORY_MB` (value: `"MemoryMB"`) + +* `PERSISTENCY` (value: `"Persistency"`) + +* `PROVISIONING_SCHEME_NAME` (value: `"ProvisioningSchemeName"`) + +* `PROVISIONING_SCHEME_VERSION` (value: `"ProvisioningSchemeVersion"`) + +* `PROV_VM_CONFIGURATION_VERSION` (value: `"ProvVMConfigurationVersion"`) + +* `VM_NAME` (value: `"VMName"`) + +* `WINDOWS_ACTIVATION_TYPE_PROVISIONED_VIRTUAL_MACHINE` (value: `"WindowsActivationTypeProvisionedVirtualMachine"`) + +* `USE_WRITE_BACK_CACHE` (value: `"UseWriteBackCache"`) + +* `WRITE_BACK_CACHE_DISK_SIZE` (value: `"WriteBackCacheDiskSize"`) + +* `WRITE_BACK_CACHE_DISK_DRIVE_LETTER` (value: `"WriteBackCacheDiskDriveLetter"`) + +* `WRITE_BACK_CACHE_MEMORY_SIZE` (value: `"WriteBackCacheMemorySize"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/citrixorchestration/docs/ProvisionedVirtualMachineSearchRequestModel.md b/citrixorchestration/docs/ProvisionedVirtualMachineSearchRequestModel.md new file mode 100644 index 0000000..7e10eb4 --- /dev/null +++ b/citrixorchestration/docs/ProvisionedVirtualMachineSearchRequestModel.md @@ -0,0 +1,200 @@ +# ProvisionedVirtualMachineSearchRequestModel + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BasicSearchString** | Pointer to **NullableString** | Basic search string. Specify a string which will match if contained within some string property of the machine. | [optional] +**SearchFilters** | Pointer to [**[]ProvisionedVirtualMachineSearchFilterRequestModel**](ProvisionedVirtualMachineSearchFilterRequestModel.md) | List of advanced search filters. | [optional] +**SearchFilterGroups** | Pointer to [**[]ProvisionedVirtualMachineSearchFilterGroupRequestModel**](ProvisionedVirtualMachineSearchFilterGroupRequestModel.md) | List of advanced search filter groups. | [optional] +**SearchFilterGroupsType** | Pointer to [**ProvisionedVirtualMachineSearchFilterGroupsType**](ProvisionedVirtualMachineSearchFilterGroupsType.md) | | [optional] +**SortCriteriaItems** | Pointer to [**[]ProvisionedVirtualMachineSortCriteriaRequestModel**](ProvisionedVirtualMachineSortCriteriaRequestModel.md) | Sort criteria for the results, multiple sorting criteria can be specified here. | [optional] + +## Methods + +### NewProvisionedVirtualMachineSearchRequestModel + +`func NewProvisionedVirtualMachineSearchRequestModel() *ProvisionedVirtualMachineSearchRequestModel` + +NewProvisionedVirtualMachineSearchRequestModel instantiates a new ProvisionedVirtualMachineSearchRequestModel object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewProvisionedVirtualMachineSearchRequestModelWithDefaults + +`func NewProvisionedVirtualMachineSearchRequestModelWithDefaults() *ProvisionedVirtualMachineSearchRequestModel` + +NewProvisionedVirtualMachineSearchRequestModelWithDefaults instantiates a new ProvisionedVirtualMachineSearchRequestModel object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetBasicSearchString + +`func (o *ProvisionedVirtualMachineSearchRequestModel) GetBasicSearchString() string` + +GetBasicSearchString returns the BasicSearchString field if non-nil, zero value otherwise. + +### GetBasicSearchStringOk + +`func (o *ProvisionedVirtualMachineSearchRequestModel) GetBasicSearchStringOk() (*string, bool)` + +GetBasicSearchStringOk returns a tuple with the BasicSearchString field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBasicSearchString + +`func (o *ProvisionedVirtualMachineSearchRequestModel) SetBasicSearchString(v string)` + +SetBasicSearchString sets BasicSearchString field to given value. + +### HasBasicSearchString + +`func (o *ProvisionedVirtualMachineSearchRequestModel) HasBasicSearchString() bool` + +HasBasicSearchString returns a boolean if a field has been set. + +### SetBasicSearchStringNil + +`func (o *ProvisionedVirtualMachineSearchRequestModel) SetBasicSearchStringNil(b bool)` + + SetBasicSearchStringNil sets the value for BasicSearchString to be an explicit nil + +### UnsetBasicSearchString +`func (o *ProvisionedVirtualMachineSearchRequestModel) UnsetBasicSearchString()` + +UnsetBasicSearchString ensures that no value is present for BasicSearchString, not even an explicit nil +### GetSearchFilters + +`func (o *ProvisionedVirtualMachineSearchRequestModel) GetSearchFilters() []ProvisionedVirtualMachineSearchFilterRequestModel` + +GetSearchFilters returns the SearchFilters field if non-nil, zero value otherwise. + +### GetSearchFiltersOk + +`func (o *ProvisionedVirtualMachineSearchRequestModel) GetSearchFiltersOk() (*[]ProvisionedVirtualMachineSearchFilterRequestModel, bool)` + +GetSearchFiltersOk returns a tuple with the SearchFilters field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSearchFilters + +`func (o *ProvisionedVirtualMachineSearchRequestModel) SetSearchFilters(v []ProvisionedVirtualMachineSearchFilterRequestModel)` + +SetSearchFilters sets SearchFilters field to given value. + +### HasSearchFilters + +`func (o *ProvisionedVirtualMachineSearchRequestModel) HasSearchFilters() bool` + +HasSearchFilters returns a boolean if a field has been set. + +### SetSearchFiltersNil + +`func (o *ProvisionedVirtualMachineSearchRequestModel) SetSearchFiltersNil(b bool)` + + SetSearchFiltersNil sets the value for SearchFilters to be an explicit nil + +### UnsetSearchFilters +`func (o *ProvisionedVirtualMachineSearchRequestModel) UnsetSearchFilters()` + +UnsetSearchFilters ensures that no value is present for SearchFilters, not even an explicit nil +### GetSearchFilterGroups + +`func (o *ProvisionedVirtualMachineSearchRequestModel) GetSearchFilterGroups() []ProvisionedVirtualMachineSearchFilterGroupRequestModel` + +GetSearchFilterGroups returns the SearchFilterGroups field if non-nil, zero value otherwise. + +### GetSearchFilterGroupsOk + +`func (o *ProvisionedVirtualMachineSearchRequestModel) GetSearchFilterGroupsOk() (*[]ProvisionedVirtualMachineSearchFilterGroupRequestModel, bool)` + +GetSearchFilterGroupsOk returns a tuple with the SearchFilterGroups field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSearchFilterGroups + +`func (o *ProvisionedVirtualMachineSearchRequestModel) SetSearchFilterGroups(v []ProvisionedVirtualMachineSearchFilterGroupRequestModel)` + +SetSearchFilterGroups sets SearchFilterGroups field to given value. + +### HasSearchFilterGroups + +`func (o *ProvisionedVirtualMachineSearchRequestModel) HasSearchFilterGroups() bool` + +HasSearchFilterGroups returns a boolean if a field has been set. + +### SetSearchFilterGroupsNil + +`func (o *ProvisionedVirtualMachineSearchRequestModel) SetSearchFilterGroupsNil(b bool)` + + SetSearchFilterGroupsNil sets the value for SearchFilterGroups to be an explicit nil + +### UnsetSearchFilterGroups +`func (o *ProvisionedVirtualMachineSearchRequestModel) UnsetSearchFilterGroups()` + +UnsetSearchFilterGroups ensures that no value is present for SearchFilterGroups, not even an explicit nil +### GetSearchFilterGroupsType + +`func (o *ProvisionedVirtualMachineSearchRequestModel) GetSearchFilterGroupsType() ProvisionedVirtualMachineSearchFilterGroupsType` + +GetSearchFilterGroupsType returns the SearchFilterGroupsType field if non-nil, zero value otherwise. + +### GetSearchFilterGroupsTypeOk + +`func (o *ProvisionedVirtualMachineSearchRequestModel) GetSearchFilterGroupsTypeOk() (*ProvisionedVirtualMachineSearchFilterGroupsType, bool)` + +GetSearchFilterGroupsTypeOk returns a tuple with the SearchFilterGroupsType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSearchFilterGroupsType + +`func (o *ProvisionedVirtualMachineSearchRequestModel) SetSearchFilterGroupsType(v ProvisionedVirtualMachineSearchFilterGroupsType)` + +SetSearchFilterGroupsType sets SearchFilterGroupsType field to given value. + +### HasSearchFilterGroupsType + +`func (o *ProvisionedVirtualMachineSearchRequestModel) HasSearchFilterGroupsType() bool` + +HasSearchFilterGroupsType returns a boolean if a field has been set. + +### GetSortCriteriaItems + +`func (o *ProvisionedVirtualMachineSearchRequestModel) GetSortCriteriaItems() []ProvisionedVirtualMachineSortCriteriaRequestModel` + +GetSortCriteriaItems returns the SortCriteriaItems field if non-nil, zero value otherwise. + +### GetSortCriteriaItemsOk + +`func (o *ProvisionedVirtualMachineSearchRequestModel) GetSortCriteriaItemsOk() (*[]ProvisionedVirtualMachineSortCriteriaRequestModel, bool)` + +GetSortCriteriaItemsOk returns a tuple with the SortCriteriaItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSortCriteriaItems + +`func (o *ProvisionedVirtualMachineSearchRequestModel) SetSortCriteriaItems(v []ProvisionedVirtualMachineSortCriteriaRequestModel)` + +SetSortCriteriaItems sets SortCriteriaItems field to given value. + +### HasSortCriteriaItems + +`func (o *ProvisionedVirtualMachineSearchRequestModel) HasSortCriteriaItems() bool` + +HasSortCriteriaItems returns a boolean if a field has been set. + +### SetSortCriteriaItemsNil + +`func (o *ProvisionedVirtualMachineSearchRequestModel) SetSortCriteriaItemsNil(b bool)` + + SetSortCriteriaItemsNil sets the value for SortCriteriaItems to be an explicit nil + +### UnsetSortCriteriaItems +`func (o *ProvisionedVirtualMachineSearchRequestModel) UnsetSortCriteriaItems()` + +UnsetSortCriteriaItems ensures that no value is present for SortCriteriaItems, not even an explicit nil + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/citrixorchestration/docs/ProvisionedVirtualMachineSearchResponseModel.md b/citrixorchestration/docs/ProvisionedVirtualMachineSearchResponseModel.md new file mode 100644 index 0000000..2d76693 --- /dev/null +++ b/citrixorchestration/docs/ProvisionedVirtualMachineSearchResponseModel.md @@ -0,0 +1,578 @@ +# ProvisionedVirtualMachineSearchResponseModel + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ActiveOperation** | Pointer to **NullableString** | Active Operation. | [optional] +**VMSid** | Pointer to **NullableString** | Provisioned Virtual Machine Sid. | [optional] +**CpuCount** | Pointer to **int32** | Cpu Count. | [optional] +**IdentityType** | Pointer to **NullableString** | Identity Type:ActiveDirectory, AzureAD, HybridAzureAD, Workgroup. | [optional] +**Identities** | Pointer to **NullableString** | ActiveDirectory, HybridAzureAD - Domain. AzureAD - TenantId. Workgroup - null. | [optional] +**ImageOutOfDate** | Pointer to **bool** | Booted image isn't same as assigned image. | [optional] +**LastBootTime** | Pointer to **NullableString** | Last boot time. | [optional] +**MemoryMB** | Pointer to **int32** | Memory(MB). | [optional] +**Persistency** | Pointer to **bool** | Persistency. | [optional] +**ProvisioningSchemeName** | Pointer to **NullableString** | Provision Scheme Name. | [optional] +**ProvisioningSchemeVersion** | Pointer to **int32** | Provision Scheme Version. | [optional] +**ProvVMConfigurationVersion** | Pointer to **int32** | Provisioned Virtual Machine Configuration Version. | [optional] +**VMName** | Pointer to **NullableString** | Provisioned virtual machine name on hypervisor. | [optional] +**WindowsActivationTypeProvisionedVirtualMachine** | Pointer to **NullableString** | Windows Activation Type. | [optional] +**UseWriteBackCache** | Pointer to **bool** | Whether use write back cache. | [optional] +**WriteBackCacheDiskSize** | Pointer to **int32** | Write back cache disk size. | [optional] +**WriteBackCacheDiskDriveLetter** | Pointer to **int32** | Write back cache disk drive letter. | [optional] +**WriteBackCacheMemorySize** | Pointer to **int32** | Write back cache memory size. | [optional] + +## Methods + +### NewProvisionedVirtualMachineSearchResponseModel + +`func NewProvisionedVirtualMachineSearchResponseModel() *ProvisionedVirtualMachineSearchResponseModel` + +NewProvisionedVirtualMachineSearchResponseModel instantiates a new ProvisionedVirtualMachineSearchResponseModel object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewProvisionedVirtualMachineSearchResponseModelWithDefaults + +`func NewProvisionedVirtualMachineSearchResponseModelWithDefaults() *ProvisionedVirtualMachineSearchResponseModel` + +NewProvisionedVirtualMachineSearchResponseModelWithDefaults instantiates a new ProvisionedVirtualMachineSearchResponseModel object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetActiveOperation + +`func (o *ProvisionedVirtualMachineSearchResponseModel) GetActiveOperation() string` + +GetActiveOperation returns the ActiveOperation field if non-nil, zero value otherwise. + +### GetActiveOperationOk + +`func (o *ProvisionedVirtualMachineSearchResponseModel) GetActiveOperationOk() (*string, bool)` + +GetActiveOperationOk returns a tuple with the ActiveOperation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActiveOperation + +`func (o *ProvisionedVirtualMachineSearchResponseModel) SetActiveOperation(v string)` + +SetActiveOperation sets ActiveOperation field to given value. + +### HasActiveOperation + +`func (o *ProvisionedVirtualMachineSearchResponseModel) HasActiveOperation() bool` + +HasActiveOperation returns a boolean if a field has been set. + +### SetActiveOperationNil + +`func (o *ProvisionedVirtualMachineSearchResponseModel) SetActiveOperationNil(b bool)` + + SetActiveOperationNil sets the value for ActiveOperation to be an explicit nil + +### UnsetActiveOperation +`func (o *ProvisionedVirtualMachineSearchResponseModel) UnsetActiveOperation()` + +UnsetActiveOperation ensures that no value is present for ActiveOperation, not even an explicit nil +### GetVMSid + +`func (o *ProvisionedVirtualMachineSearchResponseModel) GetVMSid() string` + +GetVMSid returns the VMSid field if non-nil, zero value otherwise. + +### GetVMSidOk + +`func (o *ProvisionedVirtualMachineSearchResponseModel) GetVMSidOk() (*string, bool)` + +GetVMSidOk returns a tuple with the VMSid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVMSid + +`func (o *ProvisionedVirtualMachineSearchResponseModel) SetVMSid(v string)` + +SetVMSid sets VMSid field to given value. + +### HasVMSid + +`func (o *ProvisionedVirtualMachineSearchResponseModel) HasVMSid() bool` + +HasVMSid returns a boolean if a field has been set. + +### SetVMSidNil + +`func (o *ProvisionedVirtualMachineSearchResponseModel) SetVMSidNil(b bool)` + + SetVMSidNil sets the value for VMSid to be an explicit nil + +### UnsetVMSid +`func (o *ProvisionedVirtualMachineSearchResponseModel) UnsetVMSid()` + +UnsetVMSid ensures that no value is present for VMSid, not even an explicit nil +### GetCpuCount + +`func (o *ProvisionedVirtualMachineSearchResponseModel) GetCpuCount() int32` + +GetCpuCount returns the CpuCount field if non-nil, zero value otherwise. + +### GetCpuCountOk + +`func (o *ProvisionedVirtualMachineSearchResponseModel) GetCpuCountOk() (*int32, bool)` + +GetCpuCountOk returns a tuple with the CpuCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCpuCount + +`func (o *ProvisionedVirtualMachineSearchResponseModel) SetCpuCount(v int32)` + +SetCpuCount sets CpuCount field to given value. + +### HasCpuCount + +`func (o *ProvisionedVirtualMachineSearchResponseModel) HasCpuCount() bool` + +HasCpuCount returns a boolean if a field has been set. + +### GetIdentityType + +`func (o *ProvisionedVirtualMachineSearchResponseModel) GetIdentityType() string` + +GetIdentityType returns the IdentityType field if non-nil, zero value otherwise. + +### GetIdentityTypeOk + +`func (o *ProvisionedVirtualMachineSearchResponseModel) GetIdentityTypeOk() (*string, bool)` + +GetIdentityTypeOk returns a tuple with the IdentityType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentityType + +`func (o *ProvisionedVirtualMachineSearchResponseModel) SetIdentityType(v string)` + +SetIdentityType sets IdentityType field to given value. + +### HasIdentityType + +`func (o *ProvisionedVirtualMachineSearchResponseModel) HasIdentityType() bool` + +HasIdentityType returns a boolean if a field has been set. + +### SetIdentityTypeNil + +`func (o *ProvisionedVirtualMachineSearchResponseModel) SetIdentityTypeNil(b bool)` + + SetIdentityTypeNil sets the value for IdentityType to be an explicit nil + +### UnsetIdentityType +`func (o *ProvisionedVirtualMachineSearchResponseModel) UnsetIdentityType()` + +UnsetIdentityType ensures that no value is present for IdentityType, not even an explicit nil +### GetIdentities + +`func (o *ProvisionedVirtualMachineSearchResponseModel) GetIdentities() string` + +GetIdentities returns the Identities field if non-nil, zero value otherwise. + +### GetIdentitiesOk + +`func (o *ProvisionedVirtualMachineSearchResponseModel) GetIdentitiesOk() (*string, bool)` + +GetIdentitiesOk returns a tuple with the Identities field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIdentities + +`func (o *ProvisionedVirtualMachineSearchResponseModel) SetIdentities(v string)` + +SetIdentities sets Identities field to given value. + +### HasIdentities + +`func (o *ProvisionedVirtualMachineSearchResponseModel) HasIdentities() bool` + +HasIdentities returns a boolean if a field has been set. + +### SetIdentitiesNil + +`func (o *ProvisionedVirtualMachineSearchResponseModel) SetIdentitiesNil(b bool)` + + SetIdentitiesNil sets the value for Identities to be an explicit nil + +### UnsetIdentities +`func (o *ProvisionedVirtualMachineSearchResponseModel) UnsetIdentities()` + +UnsetIdentities ensures that no value is present for Identities, not even an explicit nil +### GetImageOutOfDate + +`func (o *ProvisionedVirtualMachineSearchResponseModel) GetImageOutOfDate() bool` + +GetImageOutOfDate returns the ImageOutOfDate field if non-nil, zero value otherwise. + +### GetImageOutOfDateOk + +`func (o *ProvisionedVirtualMachineSearchResponseModel) GetImageOutOfDateOk() (*bool, bool)` + +GetImageOutOfDateOk returns a tuple with the ImageOutOfDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetImageOutOfDate + +`func (o *ProvisionedVirtualMachineSearchResponseModel) SetImageOutOfDate(v bool)` + +SetImageOutOfDate sets ImageOutOfDate field to given value. + +### HasImageOutOfDate + +`func (o *ProvisionedVirtualMachineSearchResponseModel) HasImageOutOfDate() bool` + +HasImageOutOfDate returns a boolean if a field has been set. + +### GetLastBootTime + +`func (o *ProvisionedVirtualMachineSearchResponseModel) GetLastBootTime() string` + +GetLastBootTime returns the LastBootTime field if non-nil, zero value otherwise. + +### GetLastBootTimeOk + +`func (o *ProvisionedVirtualMachineSearchResponseModel) GetLastBootTimeOk() (*string, bool)` + +GetLastBootTimeOk returns a tuple with the LastBootTime field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastBootTime + +`func (o *ProvisionedVirtualMachineSearchResponseModel) SetLastBootTime(v string)` + +SetLastBootTime sets LastBootTime field to given value. + +### HasLastBootTime + +`func (o *ProvisionedVirtualMachineSearchResponseModel) HasLastBootTime() bool` + +HasLastBootTime returns a boolean if a field has been set. + +### SetLastBootTimeNil + +`func (o *ProvisionedVirtualMachineSearchResponseModel) SetLastBootTimeNil(b bool)` + + SetLastBootTimeNil sets the value for LastBootTime to be an explicit nil + +### UnsetLastBootTime +`func (o *ProvisionedVirtualMachineSearchResponseModel) UnsetLastBootTime()` + +UnsetLastBootTime ensures that no value is present for LastBootTime, not even an explicit nil +### GetMemoryMB + +`func (o *ProvisionedVirtualMachineSearchResponseModel) GetMemoryMB() int32` + +GetMemoryMB returns the MemoryMB field if non-nil, zero value otherwise. + +### GetMemoryMBOk + +`func (o *ProvisionedVirtualMachineSearchResponseModel) GetMemoryMBOk() (*int32, bool)` + +GetMemoryMBOk returns a tuple with the MemoryMB field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMemoryMB + +`func (o *ProvisionedVirtualMachineSearchResponseModel) SetMemoryMB(v int32)` + +SetMemoryMB sets MemoryMB field to given value. + +### HasMemoryMB + +`func (o *ProvisionedVirtualMachineSearchResponseModel) HasMemoryMB() bool` + +HasMemoryMB returns a boolean if a field has been set. + +### GetPersistency + +`func (o *ProvisionedVirtualMachineSearchResponseModel) GetPersistency() bool` + +GetPersistency returns the Persistency field if non-nil, zero value otherwise. + +### GetPersistencyOk + +`func (o *ProvisionedVirtualMachineSearchResponseModel) GetPersistencyOk() (*bool, bool)` + +GetPersistencyOk returns a tuple with the Persistency field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPersistency + +`func (o *ProvisionedVirtualMachineSearchResponseModel) SetPersistency(v bool)` + +SetPersistency sets Persistency field to given value. + +### HasPersistency + +`func (o *ProvisionedVirtualMachineSearchResponseModel) HasPersistency() bool` + +HasPersistency returns a boolean if a field has been set. + +### GetProvisioningSchemeName + +`func (o *ProvisionedVirtualMachineSearchResponseModel) GetProvisioningSchemeName() string` + +GetProvisioningSchemeName returns the ProvisioningSchemeName field if non-nil, zero value otherwise. + +### GetProvisioningSchemeNameOk + +`func (o *ProvisionedVirtualMachineSearchResponseModel) GetProvisioningSchemeNameOk() (*string, bool)` + +GetProvisioningSchemeNameOk returns a tuple with the ProvisioningSchemeName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioningSchemeName + +`func (o *ProvisionedVirtualMachineSearchResponseModel) SetProvisioningSchemeName(v string)` + +SetProvisioningSchemeName sets ProvisioningSchemeName field to given value. + +### HasProvisioningSchemeName + +`func (o *ProvisionedVirtualMachineSearchResponseModel) HasProvisioningSchemeName() bool` + +HasProvisioningSchemeName returns a boolean if a field has been set. + +### SetProvisioningSchemeNameNil + +`func (o *ProvisionedVirtualMachineSearchResponseModel) SetProvisioningSchemeNameNil(b bool)` + + SetProvisioningSchemeNameNil sets the value for ProvisioningSchemeName to be an explicit nil + +### UnsetProvisioningSchemeName +`func (o *ProvisionedVirtualMachineSearchResponseModel) UnsetProvisioningSchemeName()` + +UnsetProvisioningSchemeName ensures that no value is present for ProvisioningSchemeName, not even an explicit nil +### GetProvisioningSchemeVersion + +`func (o *ProvisionedVirtualMachineSearchResponseModel) GetProvisioningSchemeVersion() int32` + +GetProvisioningSchemeVersion returns the ProvisioningSchemeVersion field if non-nil, zero value otherwise. + +### GetProvisioningSchemeVersionOk + +`func (o *ProvisionedVirtualMachineSearchResponseModel) GetProvisioningSchemeVersionOk() (*int32, bool)` + +GetProvisioningSchemeVersionOk returns a tuple with the ProvisioningSchemeVersion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvisioningSchemeVersion + +`func (o *ProvisionedVirtualMachineSearchResponseModel) SetProvisioningSchemeVersion(v int32)` + +SetProvisioningSchemeVersion sets ProvisioningSchemeVersion field to given value. + +### HasProvisioningSchemeVersion + +`func (o *ProvisionedVirtualMachineSearchResponseModel) HasProvisioningSchemeVersion() bool` + +HasProvisioningSchemeVersion returns a boolean if a field has been set. + +### GetProvVMConfigurationVersion + +`func (o *ProvisionedVirtualMachineSearchResponseModel) GetProvVMConfigurationVersion() int32` + +GetProvVMConfigurationVersion returns the ProvVMConfigurationVersion field if non-nil, zero value otherwise. + +### GetProvVMConfigurationVersionOk + +`func (o *ProvisionedVirtualMachineSearchResponseModel) GetProvVMConfigurationVersionOk() (*int32, bool)` + +GetProvVMConfigurationVersionOk returns a tuple with the ProvVMConfigurationVersion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProvVMConfigurationVersion + +`func (o *ProvisionedVirtualMachineSearchResponseModel) SetProvVMConfigurationVersion(v int32)` + +SetProvVMConfigurationVersion sets ProvVMConfigurationVersion field to given value. + +### HasProvVMConfigurationVersion + +`func (o *ProvisionedVirtualMachineSearchResponseModel) HasProvVMConfigurationVersion() bool` + +HasProvVMConfigurationVersion returns a boolean if a field has been set. + +### GetVMName + +`func (o *ProvisionedVirtualMachineSearchResponseModel) GetVMName() string` + +GetVMName returns the VMName field if non-nil, zero value otherwise. + +### GetVMNameOk + +`func (o *ProvisionedVirtualMachineSearchResponseModel) GetVMNameOk() (*string, bool)` + +GetVMNameOk returns a tuple with the VMName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVMName + +`func (o *ProvisionedVirtualMachineSearchResponseModel) SetVMName(v string)` + +SetVMName sets VMName field to given value. + +### HasVMName + +`func (o *ProvisionedVirtualMachineSearchResponseModel) HasVMName() bool` + +HasVMName returns a boolean if a field has been set. + +### SetVMNameNil + +`func (o *ProvisionedVirtualMachineSearchResponseModel) SetVMNameNil(b bool)` + + SetVMNameNil sets the value for VMName to be an explicit nil + +### UnsetVMName +`func (o *ProvisionedVirtualMachineSearchResponseModel) UnsetVMName()` + +UnsetVMName ensures that no value is present for VMName, not even an explicit nil +### GetWindowsActivationTypeProvisionedVirtualMachine + +`func (o *ProvisionedVirtualMachineSearchResponseModel) GetWindowsActivationTypeProvisionedVirtualMachine() string` + +GetWindowsActivationTypeProvisionedVirtualMachine returns the WindowsActivationTypeProvisionedVirtualMachine field if non-nil, zero value otherwise. + +### GetWindowsActivationTypeProvisionedVirtualMachineOk + +`func (o *ProvisionedVirtualMachineSearchResponseModel) GetWindowsActivationTypeProvisionedVirtualMachineOk() (*string, bool)` + +GetWindowsActivationTypeProvisionedVirtualMachineOk returns a tuple with the WindowsActivationTypeProvisionedVirtualMachine field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWindowsActivationTypeProvisionedVirtualMachine + +`func (o *ProvisionedVirtualMachineSearchResponseModel) SetWindowsActivationTypeProvisionedVirtualMachine(v string)` + +SetWindowsActivationTypeProvisionedVirtualMachine sets WindowsActivationTypeProvisionedVirtualMachine field to given value. + +### HasWindowsActivationTypeProvisionedVirtualMachine + +`func (o *ProvisionedVirtualMachineSearchResponseModel) HasWindowsActivationTypeProvisionedVirtualMachine() bool` + +HasWindowsActivationTypeProvisionedVirtualMachine returns a boolean if a field has been set. + +### SetWindowsActivationTypeProvisionedVirtualMachineNil + +`func (o *ProvisionedVirtualMachineSearchResponseModel) SetWindowsActivationTypeProvisionedVirtualMachineNil(b bool)` + + SetWindowsActivationTypeProvisionedVirtualMachineNil sets the value for WindowsActivationTypeProvisionedVirtualMachine to be an explicit nil + +### UnsetWindowsActivationTypeProvisionedVirtualMachine +`func (o *ProvisionedVirtualMachineSearchResponseModel) UnsetWindowsActivationTypeProvisionedVirtualMachine()` + +UnsetWindowsActivationTypeProvisionedVirtualMachine ensures that no value is present for WindowsActivationTypeProvisionedVirtualMachine, not even an explicit nil +### GetUseWriteBackCache + +`func (o *ProvisionedVirtualMachineSearchResponseModel) GetUseWriteBackCache() bool` + +GetUseWriteBackCache returns the UseWriteBackCache field if non-nil, zero value otherwise. + +### GetUseWriteBackCacheOk + +`func (o *ProvisionedVirtualMachineSearchResponseModel) GetUseWriteBackCacheOk() (*bool, bool)` + +GetUseWriteBackCacheOk returns a tuple with the UseWriteBackCache field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUseWriteBackCache + +`func (o *ProvisionedVirtualMachineSearchResponseModel) SetUseWriteBackCache(v bool)` + +SetUseWriteBackCache sets UseWriteBackCache field to given value. + +### HasUseWriteBackCache + +`func (o *ProvisionedVirtualMachineSearchResponseModel) HasUseWriteBackCache() bool` + +HasUseWriteBackCache returns a boolean if a field has been set. + +### GetWriteBackCacheDiskSize + +`func (o *ProvisionedVirtualMachineSearchResponseModel) GetWriteBackCacheDiskSize() int32` + +GetWriteBackCacheDiskSize returns the WriteBackCacheDiskSize field if non-nil, zero value otherwise. + +### GetWriteBackCacheDiskSizeOk + +`func (o *ProvisionedVirtualMachineSearchResponseModel) GetWriteBackCacheDiskSizeOk() (*int32, bool)` + +GetWriteBackCacheDiskSizeOk returns a tuple with the WriteBackCacheDiskSize field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWriteBackCacheDiskSize + +`func (o *ProvisionedVirtualMachineSearchResponseModel) SetWriteBackCacheDiskSize(v int32)` + +SetWriteBackCacheDiskSize sets WriteBackCacheDiskSize field to given value. + +### HasWriteBackCacheDiskSize + +`func (o *ProvisionedVirtualMachineSearchResponseModel) HasWriteBackCacheDiskSize() bool` + +HasWriteBackCacheDiskSize returns a boolean if a field has been set. + +### GetWriteBackCacheDiskDriveLetter + +`func (o *ProvisionedVirtualMachineSearchResponseModel) GetWriteBackCacheDiskDriveLetter() int32` + +GetWriteBackCacheDiskDriveLetter returns the WriteBackCacheDiskDriveLetter field if non-nil, zero value otherwise. + +### GetWriteBackCacheDiskDriveLetterOk + +`func (o *ProvisionedVirtualMachineSearchResponseModel) GetWriteBackCacheDiskDriveLetterOk() (*int32, bool)` + +GetWriteBackCacheDiskDriveLetterOk returns a tuple with the WriteBackCacheDiskDriveLetter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWriteBackCacheDiskDriveLetter + +`func (o *ProvisionedVirtualMachineSearchResponseModel) SetWriteBackCacheDiskDriveLetter(v int32)` + +SetWriteBackCacheDiskDriveLetter sets WriteBackCacheDiskDriveLetter field to given value. + +### HasWriteBackCacheDiskDriveLetter + +`func (o *ProvisionedVirtualMachineSearchResponseModel) HasWriteBackCacheDiskDriveLetter() bool` + +HasWriteBackCacheDiskDriveLetter returns a boolean if a field has been set. + +### GetWriteBackCacheMemorySize + +`func (o *ProvisionedVirtualMachineSearchResponseModel) GetWriteBackCacheMemorySize() int32` + +GetWriteBackCacheMemorySize returns the WriteBackCacheMemorySize field if non-nil, zero value otherwise. + +### GetWriteBackCacheMemorySizeOk + +`func (o *ProvisionedVirtualMachineSearchResponseModel) GetWriteBackCacheMemorySizeOk() (*int32, bool)` + +GetWriteBackCacheMemorySizeOk returns a tuple with the WriteBackCacheMemorySize field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetWriteBackCacheMemorySize + +`func (o *ProvisionedVirtualMachineSearchResponseModel) SetWriteBackCacheMemorySize(v int32)` + +SetWriteBackCacheMemorySize sets WriteBackCacheMemorySize field to given value. + +### HasWriteBackCacheMemorySize + +`func (o *ProvisionedVirtualMachineSearchResponseModel) HasWriteBackCacheMemorySize() bool` + +HasWriteBackCacheMemorySize returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/citrixorchestration/docs/ProvisionedVirtualMachineSearchResponseModelCollection.md b/citrixorchestration/docs/ProvisionedVirtualMachineSearchResponseModelCollection.md new file mode 100644 index 0000000..0d4a054 --- /dev/null +++ b/citrixorchestration/docs/ProvisionedVirtualMachineSearchResponseModelCollection.md @@ -0,0 +1,123 @@ +# ProvisionedVirtualMachineSearchResponseModelCollection + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Items** | [**[]ProvisionedVirtualMachineSearchResponseModel**](ProvisionedVirtualMachineSearchResponseModel.md) | List of items. | +**ContinuationToken** | Pointer to **NullableString** | If present, indicates to the caller that the query was not complete, and they should call the API again specifying the continuation token as a query parameter. | [optional] +**TotalItems** | Pointer to **NullableInt32** | Indicates the total number of items in the collection, which may be more than the number of Items returned, if there is a ContinuationToken. Only returned in the response to `$search` APIs. | [optional] + +## Methods + +### NewProvisionedVirtualMachineSearchResponseModelCollection + +`func NewProvisionedVirtualMachineSearchResponseModelCollection(items []ProvisionedVirtualMachineSearchResponseModel, ) *ProvisionedVirtualMachineSearchResponseModelCollection` + +NewProvisionedVirtualMachineSearchResponseModelCollection instantiates a new ProvisionedVirtualMachineSearchResponseModelCollection object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewProvisionedVirtualMachineSearchResponseModelCollectionWithDefaults + +`func NewProvisionedVirtualMachineSearchResponseModelCollectionWithDefaults() *ProvisionedVirtualMachineSearchResponseModelCollection` + +NewProvisionedVirtualMachineSearchResponseModelCollectionWithDefaults instantiates a new ProvisionedVirtualMachineSearchResponseModelCollection object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetItems + +`func (o *ProvisionedVirtualMachineSearchResponseModelCollection) GetItems() []ProvisionedVirtualMachineSearchResponseModel` + +GetItems returns the Items field if non-nil, zero value otherwise. + +### GetItemsOk + +`func (o *ProvisionedVirtualMachineSearchResponseModelCollection) GetItemsOk() (*[]ProvisionedVirtualMachineSearchResponseModel, bool)` + +GetItemsOk returns a tuple with the Items field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetItems + +`func (o *ProvisionedVirtualMachineSearchResponseModelCollection) SetItems(v []ProvisionedVirtualMachineSearchResponseModel)` + +SetItems sets Items field to given value. + + +### GetContinuationToken + +`func (o *ProvisionedVirtualMachineSearchResponseModelCollection) GetContinuationToken() string` + +GetContinuationToken returns the ContinuationToken field if non-nil, zero value otherwise. + +### GetContinuationTokenOk + +`func (o *ProvisionedVirtualMachineSearchResponseModelCollection) GetContinuationTokenOk() (*string, bool)` + +GetContinuationTokenOk returns a tuple with the ContinuationToken field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContinuationToken + +`func (o *ProvisionedVirtualMachineSearchResponseModelCollection) SetContinuationToken(v string)` + +SetContinuationToken sets ContinuationToken field to given value. + +### HasContinuationToken + +`func (o *ProvisionedVirtualMachineSearchResponseModelCollection) HasContinuationToken() bool` + +HasContinuationToken returns a boolean if a field has been set. + +### SetContinuationTokenNil + +`func (o *ProvisionedVirtualMachineSearchResponseModelCollection) SetContinuationTokenNil(b bool)` + + SetContinuationTokenNil sets the value for ContinuationToken to be an explicit nil + +### UnsetContinuationToken +`func (o *ProvisionedVirtualMachineSearchResponseModelCollection) UnsetContinuationToken()` + +UnsetContinuationToken ensures that no value is present for ContinuationToken, not even an explicit nil +### GetTotalItems + +`func (o *ProvisionedVirtualMachineSearchResponseModelCollection) GetTotalItems() int32` + +GetTotalItems returns the TotalItems field if non-nil, zero value otherwise. + +### GetTotalItemsOk + +`func (o *ProvisionedVirtualMachineSearchResponseModelCollection) GetTotalItemsOk() (*int32, bool)` + +GetTotalItemsOk returns a tuple with the TotalItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalItems + +`func (o *ProvisionedVirtualMachineSearchResponseModelCollection) SetTotalItems(v int32)` + +SetTotalItems sets TotalItems field to given value. + +### HasTotalItems + +`func (o *ProvisionedVirtualMachineSearchResponseModelCollection) HasTotalItems() bool` + +HasTotalItems returns a boolean if a field has been set. + +### SetTotalItemsNil + +`func (o *ProvisionedVirtualMachineSearchResponseModelCollection) SetTotalItemsNil(b bool)` + + SetTotalItemsNil sets the value for TotalItems to be an explicit nil + +### UnsetTotalItems +`func (o *ProvisionedVirtualMachineSearchResponseModelCollection) UnsetTotalItems()` + +UnsetTotalItems ensures that no value is present for TotalItems, not even an explicit nil + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/citrixorchestration/docs/ProvisionedVirtualMachineSortCriteriaRequestModel.md b/citrixorchestration/docs/ProvisionedVirtualMachineSortCriteriaRequestModel.md new file mode 100644 index 0000000..c1d7eed --- /dev/null +++ b/citrixorchestration/docs/ProvisionedVirtualMachineSortCriteriaRequestModel.md @@ -0,0 +1,72 @@ +# ProvisionedVirtualMachineSortCriteriaRequestModel + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Property** | [**ProvisionedVirtualMachineSearchProperty**](ProvisionedVirtualMachineSearchProperty.md) | | +**SortDirection** | [**ListSortDirection**](ListSortDirection.md) | | + +## Methods + +### NewProvisionedVirtualMachineSortCriteriaRequestModel + +`func NewProvisionedVirtualMachineSortCriteriaRequestModel(property ProvisionedVirtualMachineSearchProperty, sortDirection ListSortDirection, ) *ProvisionedVirtualMachineSortCriteriaRequestModel` + +NewProvisionedVirtualMachineSortCriteriaRequestModel instantiates a new ProvisionedVirtualMachineSortCriteriaRequestModel object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewProvisionedVirtualMachineSortCriteriaRequestModelWithDefaults + +`func NewProvisionedVirtualMachineSortCriteriaRequestModelWithDefaults() *ProvisionedVirtualMachineSortCriteriaRequestModel` + +NewProvisionedVirtualMachineSortCriteriaRequestModelWithDefaults instantiates a new ProvisionedVirtualMachineSortCriteriaRequestModel object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetProperty + +`func (o *ProvisionedVirtualMachineSortCriteriaRequestModel) GetProperty() ProvisionedVirtualMachineSearchProperty` + +GetProperty returns the Property field if non-nil, zero value otherwise. + +### GetPropertyOk + +`func (o *ProvisionedVirtualMachineSortCriteriaRequestModel) GetPropertyOk() (*ProvisionedVirtualMachineSearchProperty, bool)` + +GetPropertyOk returns a tuple with the Property field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProperty + +`func (o *ProvisionedVirtualMachineSortCriteriaRequestModel) SetProperty(v ProvisionedVirtualMachineSearchProperty)` + +SetProperty sets Property field to given value. + + +### GetSortDirection + +`func (o *ProvisionedVirtualMachineSortCriteriaRequestModel) GetSortDirection() ListSortDirection` + +GetSortDirection returns the SortDirection field if non-nil, zero value otherwise. + +### GetSortDirectionOk + +`func (o *ProvisionedVirtualMachineSortCriteriaRequestModel) GetSortDirectionOk() (*ListSortDirection, bool)` + +GetSortDirectionOk returns a tuple with the SortDirection field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSortDirection + +`func (o *ProvisionedVirtualMachineSortCriteriaRequestModel) SetSortDirection(v ListSortDirection)` + +SetSortDirection sets SortDirection field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/citrixorchestration/docs/ProvisioningSchemeVmMetadataResponseModel.md b/citrixorchestration/docs/ProvisioningSchemeVmMetadataResponseModel.md index 6577938..582cfbc 100644 --- a/citrixorchestration/docs/ProvisioningSchemeVmMetadataResponseModel.md +++ b/citrixorchestration/docs/ProvisioningSchemeVmMetadataResponseModel.md @@ -13,8 +13,13 @@ Name | Type | Description | Notes **SecurityType** | Pointer to **NullableString** | VmMetadata security type configuration | [optional] **DiskSecurityType** | Pointer to **NullableString** | VmMetadata disk security type configuration | [optional] **ConfidentialVmDiskEncryptionSetId** | Pointer to **NullableString** | VmMetadata confidential VM disk encryption set id configuration | [optional] +**EnableSecureBoot** | Pointer to **NullableBool** | VmMetadata VirtualMachine.Resources.Properties.SecurityProfile.UefiSettings.secureBootEnabled | [optional] +**EnableVTPM** | Pointer to **NullableBool** | VmMetadata VirtualMachine.Resources.Properties.SecurityProfile.UefiSettings.vTpmEnabled | [optional] +**EncryptionAtHost** | Pointer to **NullableBool** | VmMetadata VirtualMachine.Resources.Properties.SecurityProfile.EncryptionAtHost | [optional] **Labels** | Pointer to **NullableString** | VmMetadata Labels | [optional] **ZoneName** | Pointer to **NullableString** | VmMetadata zone name | [optional] +**StorageType** | Pointer to **NullableString** | VmMetadata storage type | [optional] +**EncryptionKeyId** | Pointer to **NullableString** | VmMetadata encryption key | [optional] ## Methods @@ -350,6 +355,111 @@ HasConfidentialVmDiskEncryptionSetId returns a boolean if a field has been set. `func (o *ProvisioningSchemeVmMetadataResponseModel) UnsetConfidentialVmDiskEncryptionSetId()` UnsetConfidentialVmDiskEncryptionSetId ensures that no value is present for ConfidentialVmDiskEncryptionSetId, not even an explicit nil +### GetEnableSecureBoot + +`func (o *ProvisioningSchemeVmMetadataResponseModel) GetEnableSecureBoot() bool` + +GetEnableSecureBoot returns the EnableSecureBoot field if non-nil, zero value otherwise. + +### GetEnableSecureBootOk + +`func (o *ProvisioningSchemeVmMetadataResponseModel) GetEnableSecureBootOk() (*bool, bool)` + +GetEnableSecureBootOk returns a tuple with the EnableSecureBoot field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnableSecureBoot + +`func (o *ProvisioningSchemeVmMetadataResponseModel) SetEnableSecureBoot(v bool)` + +SetEnableSecureBoot sets EnableSecureBoot field to given value. + +### HasEnableSecureBoot + +`func (o *ProvisioningSchemeVmMetadataResponseModel) HasEnableSecureBoot() bool` + +HasEnableSecureBoot returns a boolean if a field has been set. + +### SetEnableSecureBootNil + +`func (o *ProvisioningSchemeVmMetadataResponseModel) SetEnableSecureBootNil(b bool)` + + SetEnableSecureBootNil sets the value for EnableSecureBoot to be an explicit nil + +### UnsetEnableSecureBoot +`func (o *ProvisioningSchemeVmMetadataResponseModel) UnsetEnableSecureBoot()` + +UnsetEnableSecureBoot ensures that no value is present for EnableSecureBoot, not even an explicit nil +### GetEnableVTPM + +`func (o *ProvisioningSchemeVmMetadataResponseModel) GetEnableVTPM() bool` + +GetEnableVTPM returns the EnableVTPM field if non-nil, zero value otherwise. + +### GetEnableVTPMOk + +`func (o *ProvisioningSchemeVmMetadataResponseModel) GetEnableVTPMOk() (*bool, bool)` + +GetEnableVTPMOk returns a tuple with the EnableVTPM field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEnableVTPM + +`func (o *ProvisioningSchemeVmMetadataResponseModel) SetEnableVTPM(v bool)` + +SetEnableVTPM sets EnableVTPM field to given value. + +### HasEnableVTPM + +`func (o *ProvisioningSchemeVmMetadataResponseModel) HasEnableVTPM() bool` + +HasEnableVTPM returns a boolean if a field has been set. + +### SetEnableVTPMNil + +`func (o *ProvisioningSchemeVmMetadataResponseModel) SetEnableVTPMNil(b bool)` + + SetEnableVTPMNil sets the value for EnableVTPM to be an explicit nil + +### UnsetEnableVTPM +`func (o *ProvisioningSchemeVmMetadataResponseModel) UnsetEnableVTPM()` + +UnsetEnableVTPM ensures that no value is present for EnableVTPM, not even an explicit nil +### GetEncryptionAtHost + +`func (o *ProvisioningSchemeVmMetadataResponseModel) GetEncryptionAtHost() bool` + +GetEncryptionAtHost returns the EncryptionAtHost field if non-nil, zero value otherwise. + +### GetEncryptionAtHostOk + +`func (o *ProvisioningSchemeVmMetadataResponseModel) GetEncryptionAtHostOk() (*bool, bool)` + +GetEncryptionAtHostOk returns a tuple with the EncryptionAtHost field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEncryptionAtHost + +`func (o *ProvisioningSchemeVmMetadataResponseModel) SetEncryptionAtHost(v bool)` + +SetEncryptionAtHost sets EncryptionAtHost field to given value. + +### HasEncryptionAtHost + +`func (o *ProvisioningSchemeVmMetadataResponseModel) HasEncryptionAtHost() bool` + +HasEncryptionAtHost returns a boolean if a field has been set. + +### SetEncryptionAtHostNil + +`func (o *ProvisioningSchemeVmMetadataResponseModel) SetEncryptionAtHostNil(b bool)` + + SetEncryptionAtHostNil sets the value for EncryptionAtHost to be an explicit nil + +### UnsetEncryptionAtHost +`func (o *ProvisioningSchemeVmMetadataResponseModel) UnsetEncryptionAtHost()` + +UnsetEncryptionAtHost ensures that no value is present for EncryptionAtHost, not even an explicit nil ### GetLabels `func (o *ProvisioningSchemeVmMetadataResponseModel) GetLabels() string` @@ -420,6 +530,76 @@ HasZoneName returns a boolean if a field has been set. `func (o *ProvisioningSchemeVmMetadataResponseModel) UnsetZoneName()` UnsetZoneName ensures that no value is present for ZoneName, not even an explicit nil +### GetStorageType + +`func (o *ProvisioningSchemeVmMetadataResponseModel) GetStorageType() string` + +GetStorageType returns the StorageType field if non-nil, zero value otherwise. + +### GetStorageTypeOk + +`func (o *ProvisioningSchemeVmMetadataResponseModel) GetStorageTypeOk() (*string, bool)` + +GetStorageTypeOk returns a tuple with the StorageType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStorageType + +`func (o *ProvisioningSchemeVmMetadataResponseModel) SetStorageType(v string)` + +SetStorageType sets StorageType field to given value. + +### HasStorageType + +`func (o *ProvisioningSchemeVmMetadataResponseModel) HasStorageType() bool` + +HasStorageType returns a boolean if a field has been set. + +### SetStorageTypeNil + +`func (o *ProvisioningSchemeVmMetadataResponseModel) SetStorageTypeNil(b bool)` + + SetStorageTypeNil sets the value for StorageType to be an explicit nil + +### UnsetStorageType +`func (o *ProvisioningSchemeVmMetadataResponseModel) UnsetStorageType()` + +UnsetStorageType ensures that no value is present for StorageType, not even an explicit nil +### GetEncryptionKeyId + +`func (o *ProvisioningSchemeVmMetadataResponseModel) GetEncryptionKeyId() string` + +GetEncryptionKeyId returns the EncryptionKeyId field if non-nil, zero value otherwise. + +### GetEncryptionKeyIdOk + +`func (o *ProvisioningSchemeVmMetadataResponseModel) GetEncryptionKeyIdOk() (*string, bool)` + +GetEncryptionKeyIdOk returns a tuple with the EncryptionKeyId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEncryptionKeyId + +`func (o *ProvisioningSchemeVmMetadataResponseModel) SetEncryptionKeyId(v string)` + +SetEncryptionKeyId sets EncryptionKeyId field to given value. + +### HasEncryptionKeyId + +`func (o *ProvisioningSchemeVmMetadataResponseModel) HasEncryptionKeyId() bool` + +HasEncryptionKeyId returns a boolean if a field has been set. + +### SetEncryptionKeyIdNil + +`func (o *ProvisioningSchemeVmMetadataResponseModel) SetEncryptionKeyIdNil(b bool)` + + SetEncryptionKeyIdNil sets the value for EncryptionKeyId to be an explicit nil + +### UnsetEncryptionKeyId +`func (o *ProvisioningSchemeVmMetadataResponseModel) UnsetEncryptionKeyId()` + +UnsetEncryptionKeyId ensures that no value is present for EncryptionKeyId, not even an explicit nil [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/citrixorchestration/docs/UpdateMachineRequestModel.md b/citrixorchestration/docs/UpdateMachineRequestModel.md index dde094f..9cef67b 100644 --- a/citrixorchestration/docs/UpdateMachineRequestModel.md +++ b/citrixorchestration/docs/UpdateMachineRequestModel.md @@ -11,6 +11,7 @@ Name | Type | Description | Notes **HypervisorConnection** | Pointer to **NullableString** | Hypervisor connection to use for power management of the machine. | [optional] **InMaintenanceMode** | Pointer to **NullableBool** | Specifies whether the machine is initially in maintenance mode. A machine in maintenance mode is not available for new sessions, and for managed machines all automatic power management is disabled. If `null`, will not be changed. | [optional] **PublishedName** | Pointer to **NullableString** | Customized name of the machine that is displayed in StoreFront, if the machine has been published. It can be set only for private desktops. If `null`, will not be changed. If empty string (`\"\"`), the machine will be unassigned from any published name. | [optional] +**Metadata** | Pointer to [**[]NameValueStringPairModel**](NameValueStringPairModel.md) | The metadata of machine. Set the value of the NameValueStringPairModel is null or empty will be remove this metadata. Not existing Name and Value NameValueStringPairModel object will be added. The same Name but different value object will be updated. | [optional] ## Methods @@ -276,6 +277,41 @@ HasPublishedName returns a boolean if a field has been set. `func (o *UpdateMachineRequestModel) UnsetPublishedName()` UnsetPublishedName ensures that no value is present for PublishedName, not even an explicit nil +### GetMetadata + +`func (o *UpdateMachineRequestModel) GetMetadata() []NameValueStringPairModel` + +GetMetadata returns the Metadata field if non-nil, zero value otherwise. + +### GetMetadataOk + +`func (o *UpdateMachineRequestModel) GetMetadataOk() (*[]NameValueStringPairModel, bool)` + +GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetadata + +`func (o *UpdateMachineRequestModel) SetMetadata(v []NameValueStringPairModel)` + +SetMetadata sets Metadata field to given value. + +### HasMetadata + +`func (o *UpdateMachineRequestModel) HasMetadata() bool` + +HasMetadata returns a boolean if a field has been set. + +### SetMetadataNil + +`func (o *UpdateMachineRequestModel) SetMetadataNil(b bool)` + + SetMetadataNil sets the value for Metadata to be an explicit nil + +### UnsetMetadata +`func (o *UpdateMachineRequestModel) UnsetMetadata()` + +UnsetMetadata ensures that no value is present for Metadata, not even an explicit nil [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/citrixorchestration/model_add_machine_to_machine_catalog_detail_request_model.go b/citrixorchestration/model_add_machine_to_machine_catalog_detail_request_model.go index 36e2a27..411f820 100644 --- a/citrixorchestration/model_add_machine_to_machine_catalog_detail_request_model.go +++ b/citrixorchestration/model_add_machine_to_machine_catalog_detail_request_model.go @@ -33,6 +33,8 @@ type AddMachineToMachineCatalogDetailRequestModel struct { HypervisorConnection NullableString `json:"HypervisorConnection,omitempty"` // Specifies whether the machine is initially in maintenance mode. A machine in maintenance mode is not available for new sessions, and for managed machines all automatic power management is disabled. Optional; default is `false`. InMaintenanceMode NullableBool `json:"InMaintenanceMode,omitempty"` + // The metadata of machine. + Metadata []NameValueStringPairModel `json:"Metadata,omitempty"` // IP address of the PVS server to be used. This only applies if the ProvisioningType is PVS. PvsAddress NullableString `json:"PvsAddress,omitempty"` // The domain of the PVS server to be used. This only applies if the ProvisioningType is PVS. @@ -349,6 +351,39 @@ func (o *AddMachineToMachineCatalogDetailRequestModel) UnsetInMaintenanceMode() o.InMaintenanceMode.Unset() } +// GetMetadata returns the Metadata field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *AddMachineToMachineCatalogDetailRequestModel) GetMetadata() []NameValueStringPairModel { + if o == nil { + var ret []NameValueStringPairModel + return ret + } + return o.Metadata +} + +// GetMetadataOk returns a tuple with the Metadata field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *AddMachineToMachineCatalogDetailRequestModel) GetMetadataOk() ([]NameValueStringPairModel, bool) { + if o == nil || IsNil(o.Metadata) { + return nil, false + } + return o.Metadata, true +} + +// HasMetadata returns a boolean if a field has been set. +func (o *AddMachineToMachineCatalogDetailRequestModel) HasMetadata() bool { + if o != nil && IsNil(o.Metadata) { + return true + } + + return false +} + +// SetMetadata gets a reference to the given []NameValueStringPairModel and assigns it to the Metadata field. +func (o *AddMachineToMachineCatalogDetailRequestModel) SetMetadata(v []NameValueStringPairModel) { + o.Metadata = v +} + // GetPvsAddress returns the PvsAddress field value if set, zero value otherwise (both if not set or set to explicit null). func (o *AddMachineToMachineCatalogDetailRequestModel) GetPvsAddress() string { if o == nil || IsNil(o.PvsAddress.Get()) { @@ -561,6 +596,9 @@ func (o AddMachineToMachineCatalogDetailRequestModel) ToMap() (map[string]interf if o.InMaintenanceMode.IsSet() { toSerialize["InMaintenanceMode"] = o.InMaintenanceMode.Get() } + if o.Metadata != nil { + toSerialize["Metadata"] = o.Metadata + } if o.PvsAddress.IsSet() { toSerialize["PvsAddress"] = o.PvsAddress.Get() } diff --git a/citrixorchestration/model_add_machine_to_machine_catalog_request_model.go b/citrixorchestration/model_add_machine_to_machine_catalog_request_model.go index 3140adc..ac26c9d 100644 --- a/citrixorchestration/model_add_machine_to_machine_catalog_request_model.go +++ b/citrixorchestration/model_add_machine_to_machine_catalog_request_model.go @@ -33,6 +33,8 @@ type AddMachineToMachineCatalogRequestModel struct { HypervisorConnection NullableString `json:"HypervisorConnection,omitempty"` // Specifies whether the machine is initially in maintenance mode. A machine in maintenance mode is not available for new sessions, and for managed machines all automatic power management is disabled. Optional; default is `false`. InMaintenanceMode NullableBool `json:"InMaintenanceMode,omitempty"` + // The metadata of machine. + Metadata []NameValueStringPairModel `json:"Metadata,omitempty"` } // NewAddMachineToMachineCatalogRequestModel instantiates a new AddMachineToMachineCatalogRequestModel object @@ -341,6 +343,39 @@ func (o *AddMachineToMachineCatalogRequestModel) UnsetInMaintenanceMode() { o.InMaintenanceMode.Unset() } +// GetMetadata returns the Metadata field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *AddMachineToMachineCatalogRequestModel) GetMetadata() []NameValueStringPairModel { + if o == nil { + var ret []NameValueStringPairModel + return ret + } + return o.Metadata +} + +// GetMetadataOk returns a tuple with the Metadata field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *AddMachineToMachineCatalogRequestModel) GetMetadataOk() ([]NameValueStringPairModel, bool) { + if o == nil || IsNil(o.Metadata) { + return nil, false + } + return o.Metadata, true +} + +// HasMetadata returns a boolean if a field has been set. +func (o *AddMachineToMachineCatalogRequestModel) HasMetadata() bool { + if o != nil && IsNil(o.Metadata) { + return true + } + + return false +} + +// SetMetadata gets a reference to the given []NameValueStringPairModel and assigns it to the Metadata field. +func (o *AddMachineToMachineCatalogRequestModel) SetMetadata(v []NameValueStringPairModel) { + o.Metadata = v +} + func (o AddMachineToMachineCatalogRequestModel) MarshalJSON() ([]byte, error) { toSerialize,err := o.ToMap() if err != nil { @@ -372,6 +407,9 @@ func (o AddMachineToMachineCatalogRequestModel) ToMap() (map[string]interface{}, if o.InMaintenanceMode.IsSet() { toSerialize["InMaintenanceMode"] = o.InMaintenanceMode.Get() } + if o.Metadata != nil { + toSerialize["Metadata"] = o.Metadata + } return toSerialize, nil } diff --git a/citrixorchestration/model_app_lib_package_discovery_profile_request_model.go b/citrixorchestration/model_app_lib_package_discovery_profile_request_model.go index 7d783b2..9434153 100644 --- a/citrixorchestration/model_app_lib_package_discovery_profile_request_model.go +++ b/citrixorchestration/model_app_lib_package_discovery_profile_request_model.go @@ -43,6 +43,8 @@ type AppLibPackageDiscoveryProfileRequestModel struct { DiscoverMsix NullableBool `json:"DiscoverMsix,omitempty"` // A value indicating whether or not to search should discover AppAttach Packages. DiscoverAppAttach NullableBool `json:"DiscoverAppAttach,omitempty"` + // A value indicating whether or not to search should discover FlexApp Packages. + DiscoverFlexApp NullableBool `json:"DiscoverFlexApp,omitempty"` // A value indicating whether or not the discovery should run automatically. AutomateDiscovery NullableBool `json:"AutomateDiscovery,omitempty"` AutoDiscoveryPeriod *AutoDiscoveryPeriod `json:"AutoDiscoveryPeriod,omitempty"` @@ -67,6 +69,8 @@ func NewAppLibPackageDiscoveryProfileRequestModel(discoveryType AppLibPackageDis this.DiscoverMsix = *NewNullableBool(&discoverMsix) var discoverAppAttach bool = false this.DiscoverAppAttach = *NewNullableBool(&discoverAppAttach) + var discoverFlexApp bool = false + this.DiscoverFlexApp = *NewNullableBool(&discoverFlexApp) var automateDiscovery bool = false this.AutomateDiscovery = *NewNullableBool(&automateDiscovery) return &this @@ -85,6 +89,8 @@ func NewAppLibPackageDiscoveryProfileRequestModelWithDefaults() *AppLibPackageDi this.DiscoverMsix = *NewNullableBool(&discoverMsix) var discoverAppAttach bool = false this.DiscoverAppAttach = *NewNullableBool(&discoverAppAttach) + var discoverFlexApp bool = false + this.DiscoverFlexApp = *NewNullableBool(&discoverFlexApp) var automateDiscovery bool = false this.AutomateDiscovery = *NewNullableBool(&automateDiscovery) return &this @@ -572,6 +578,48 @@ func (o *AppLibPackageDiscoveryProfileRequestModel) UnsetDiscoverAppAttach() { o.DiscoverAppAttach.Unset() } +// GetDiscoverFlexApp returns the DiscoverFlexApp field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *AppLibPackageDiscoveryProfileRequestModel) GetDiscoverFlexApp() bool { + if o == nil || IsNil(o.DiscoverFlexApp.Get()) { + var ret bool + return ret + } + return *o.DiscoverFlexApp.Get() +} + +// GetDiscoverFlexAppOk returns a tuple with the DiscoverFlexApp field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *AppLibPackageDiscoveryProfileRequestModel) GetDiscoverFlexAppOk() (*bool, bool) { + if o == nil { + return nil, false + } + return o.DiscoverFlexApp.Get(), o.DiscoverFlexApp.IsSet() +} + +// HasDiscoverFlexApp returns a boolean if a field has been set. +func (o *AppLibPackageDiscoveryProfileRequestModel) HasDiscoverFlexApp() bool { + if o != nil && o.DiscoverFlexApp.IsSet() { + return true + } + + return false +} + +// SetDiscoverFlexApp gets a reference to the given NullableBool and assigns it to the DiscoverFlexApp field. +func (o *AppLibPackageDiscoveryProfileRequestModel) SetDiscoverFlexApp(v bool) { + o.DiscoverFlexApp.Set(&v) +} +// SetDiscoverFlexAppNil sets the value for DiscoverFlexApp to be an explicit nil +func (o *AppLibPackageDiscoveryProfileRequestModel) SetDiscoverFlexAppNil() { + o.DiscoverFlexApp.Set(nil) +} + +// UnsetDiscoverFlexApp ensures that no value is present for DiscoverFlexApp, not even an explicit nil +func (o *AppLibPackageDiscoveryProfileRequestModel) UnsetDiscoverFlexApp() { + o.DiscoverFlexApp.Unset() +} + // GetAutomateDiscovery returns the AutomateDiscovery field value if set, zero value otherwise (both if not set or set to explicit null). func (o *AppLibPackageDiscoveryProfileRequestModel) GetAutomateDiscovery() bool { if o == nil || IsNil(o.AutomateDiscovery.Get()) { @@ -721,6 +769,9 @@ func (o AppLibPackageDiscoveryProfileRequestModel) ToMap() (map[string]interface if o.DiscoverAppAttach.IsSet() { toSerialize["DiscoverAppAttach"] = o.DiscoverAppAttach.Get() } + if o.DiscoverFlexApp.IsSet() { + toSerialize["DiscoverFlexApp"] = o.DiscoverFlexApp.Get() + } if o.AutomateDiscovery.IsSet() { toSerialize["AutomateDiscovery"] = o.AutomateDiscovery.Get() } diff --git a/citrixorchestration/model_app_lib_package_discovery_profile_response_model.go b/citrixorchestration/model_app_lib_package_discovery_profile_response_model.go index 4e83a3c..8ec6a68 100644 --- a/citrixorchestration/model_app_lib_package_discovery_profile_response_model.go +++ b/citrixorchestration/model_app_lib_package_discovery_profile_response_model.go @@ -41,6 +41,8 @@ type AppLibPackageDiscoveryProfileResponseModel struct { DiscoverMsix *bool `json:"DiscoverMsix,omitempty"` // A value indicating whether or not to search should Discover AppAttach Packages. DiscoverAppAttach *bool `json:"DiscoverAppAttach,omitempty"` + // A value indicating whether or not to search should Discover FlexApp Packages. + DiscoverFlexApp *bool `json:"DiscoverFlexApp,omitempty"` // A value indicating whether or not the discovery should run automatically. AutomateDiscovery *bool `json:"AutomateDiscovery,omitempty"` // A value indicating what time period should used to trigger the discovery. @@ -478,6 +480,38 @@ func (o *AppLibPackageDiscoveryProfileResponseModel) SetDiscoverAppAttach(v bool o.DiscoverAppAttach = &v } +// GetDiscoverFlexApp returns the DiscoverFlexApp field value if set, zero value otherwise. +func (o *AppLibPackageDiscoveryProfileResponseModel) GetDiscoverFlexApp() bool { + if o == nil || IsNil(o.DiscoverFlexApp) { + var ret bool + return ret + } + return *o.DiscoverFlexApp +} + +// GetDiscoverFlexAppOk returns a tuple with the DiscoverFlexApp field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *AppLibPackageDiscoveryProfileResponseModel) GetDiscoverFlexAppOk() (*bool, bool) { + if o == nil || IsNil(o.DiscoverFlexApp) { + return nil, false + } + return o.DiscoverFlexApp, true +} + +// HasDiscoverFlexApp returns a boolean if a field has been set. +func (o *AppLibPackageDiscoveryProfileResponseModel) HasDiscoverFlexApp() bool { + if o != nil && !IsNil(o.DiscoverFlexApp) { + return true + } + + return false +} + +// SetDiscoverFlexApp gets a reference to the given bool and assigns it to the DiscoverFlexApp field. +func (o *AppLibPackageDiscoveryProfileResponseModel) SetDiscoverFlexApp(v bool) { + o.DiscoverFlexApp = &v +} + // GetAutomateDiscovery returns the AutomateDiscovery field value if set, zero value otherwise. func (o *AppLibPackageDiscoveryProfileResponseModel) GetAutomateDiscovery() bool { if o == nil || IsNil(o.AutomateDiscovery) { @@ -627,6 +661,9 @@ func (o AppLibPackageDiscoveryProfileResponseModel) ToMap() (map[string]interfac if !IsNil(o.DiscoverAppAttach) { toSerialize["DiscoverAppAttach"] = o.DiscoverAppAttach } + if !IsNil(o.DiscoverFlexApp) { + toSerialize["DiscoverFlexApp"] = o.DiscoverFlexApp + } if !IsNil(o.AutomateDiscovery) { toSerialize["AutomateDiscovery"] = o.AutomateDiscovery } diff --git a/citrixorchestration/model_app_lib_package_discovery_request_model.go b/citrixorchestration/model_app_lib_package_discovery_request_model.go index 8b18aae..5d55e18 100644 --- a/citrixorchestration/model_app_lib_package_discovery_request_model.go +++ b/citrixorchestration/model_app_lib_package_discovery_request_model.go @@ -34,6 +34,8 @@ type AppLibPackageDiscoveryRequestModel struct { DiscoverMsiX NullableBool `json:"DiscoverMsiX,omitempty"` // A value indicating whether or not to discover AppAttach packages DiscoverAppAttach NullableBool `json:"DiscoverAppAttach,omitempty"` + // A value indicating whether or not to discover FlexApp packages + DiscoverFlexApp NullableBool `json:"DiscoverFlexApp,omitempty"` // The url of the App-V Management Server that packages will be discovered from. ManagementServer NullableString `json:"ManagementServer,omitempty"` // A value indicating whether or not to discover AppAttach packages @@ -59,6 +61,8 @@ func NewAppLibPackageDiscoveryRequestModel() *AppLibPackageDiscoveryRequestModel this.DiscoverMsiX = *NewNullableBool(&discoverMsiX) var discoverAppAttach bool = false this.DiscoverAppAttach = *NewNullableBool(&discoverAppAttach) + var discoverFlexApp bool = false + this.DiscoverFlexApp = *NewNullableBool(&discoverFlexApp) return &this } @@ -75,6 +79,8 @@ func NewAppLibPackageDiscoveryRequestModelWithDefaults() *AppLibPackageDiscovery this.DiscoverMsiX = *NewNullableBool(&discoverMsiX) var discoverAppAttach bool = false this.DiscoverAppAttach = *NewNullableBool(&discoverAppAttach) + var discoverFlexApp bool = false + this.DiscoverFlexApp = *NewNullableBool(&discoverFlexApp) return &this } @@ -404,6 +410,48 @@ func (o *AppLibPackageDiscoveryRequestModel) UnsetDiscoverAppAttach() { o.DiscoverAppAttach.Unset() } +// GetDiscoverFlexApp returns the DiscoverFlexApp field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *AppLibPackageDiscoveryRequestModel) GetDiscoverFlexApp() bool { + if o == nil || IsNil(o.DiscoverFlexApp.Get()) { + var ret bool + return ret + } + return *o.DiscoverFlexApp.Get() +} + +// GetDiscoverFlexAppOk returns a tuple with the DiscoverFlexApp field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *AppLibPackageDiscoveryRequestModel) GetDiscoverFlexAppOk() (*bool, bool) { + if o == nil { + return nil, false + } + return o.DiscoverFlexApp.Get(), o.DiscoverFlexApp.IsSet() +} + +// HasDiscoverFlexApp returns a boolean if a field has been set. +func (o *AppLibPackageDiscoveryRequestModel) HasDiscoverFlexApp() bool { + if o != nil && o.DiscoverFlexApp.IsSet() { + return true + } + + return false +} + +// SetDiscoverFlexApp gets a reference to the given NullableBool and assigns it to the DiscoverFlexApp field. +func (o *AppLibPackageDiscoveryRequestModel) SetDiscoverFlexApp(v bool) { + o.DiscoverFlexApp.Set(&v) +} +// SetDiscoverFlexAppNil sets the value for DiscoverFlexApp to be an explicit nil +func (o *AppLibPackageDiscoveryRequestModel) SetDiscoverFlexAppNil() { + o.DiscoverFlexApp.Set(nil) +} + +// UnsetDiscoverFlexApp ensures that no value is present for DiscoverFlexApp, not even an explicit nil +func (o *AppLibPackageDiscoveryRequestModel) UnsetDiscoverFlexApp() { + o.DiscoverFlexApp.Unset() +} + // GetManagementServer returns the ManagementServer field value if set, zero value otherwise (both if not set or set to explicit null). func (o *AppLibPackageDiscoveryRequestModel) GetManagementServer() string { if o == nil || IsNil(o.ManagementServer.Get()) { @@ -638,6 +686,9 @@ func (o AppLibPackageDiscoveryRequestModel) ToMap() (map[string]interface{}, err if o.DiscoverAppAttach.IsSet() { toSerialize["DiscoverAppAttach"] = o.DiscoverAppAttach.Get() } + if o.DiscoverFlexApp.IsSet() { + toSerialize["DiscoverFlexApp"] = o.DiscoverFlexApp.Get() + } if o.ManagementServer.IsSet() { toSerialize["ManagementServer"] = o.ManagementServer.Get() } diff --git a/citrixorchestration/model_app_search_property.go b/citrixorchestration/model_app_search_property.go index d18003d..96b8df5 100644 --- a/citrixorchestration/model_app_search_property.go +++ b/citrixorchestration/model_app_search_property.go @@ -20,6 +20,7 @@ type AppSearchProperty string // List of AppSearchProperty const ( + APPSEARCHPROPERTY_UID AppSearchProperty = "Uid" APPSEARCHPROPERTY_CLIENT_FOLDER AppSearchProperty = "ClientFolder" APPSEARCHPROPERTY_APPLICATION_GROUP AppSearchProperty = "ApplicationGroup" APPSEARCHPROPERTY_NAME AppSearchProperty = "Name" @@ -44,6 +45,7 @@ const ( // All allowed values of AppSearchProperty enum var AllowedAppSearchPropertyEnumValues = []AppSearchProperty{ + "Uid", "ClientFolder", "ApplicationGroup", "Name", diff --git a/citrixorchestration/model_application_detail_response_model.go b/citrixorchestration/model_application_detail_response_model.go index 10b00e0..45b3b2a 100644 --- a/citrixorchestration/model_application_detail_response_model.go +++ b/citrixorchestration/model_application_detail_response_model.go @@ -20,39 +20,39 @@ var _ MappedNullable = &ApplicationDetailResponseModel{} // ApplicationDetailResponseModel struct for ApplicationDetailResponseModel type ApplicationDetailResponseModel struct { // Id of the application. Used to be: Uuid Needs to be globally unique This is likely to contain a guid but the property type should be string for future flexibility - Id string `json:"Id"` + Id NullableString `json:"Id,omitempty"` // `DEPRECATED. Use .` DEPRECATED. Use Id. // Deprecated Uid NullableInt32 `json:"Uid,omitempty"` - ApplicationFolder RefResponseModel `json:"ApplicationFolder"` - ApplicationType ApplicationType `json:"ApplicationType"` - PackagedApplicationType PackagedApplicationType `json:"PackagedApplicationType"` + ApplicationFolder *RefResponseModel `json:"ApplicationFolder,omitempty"` + ApplicationType *ApplicationType `json:"ApplicationType,omitempty"` + PackagedApplicationType *PackagedApplicationType `json:"PackagedApplicationType,omitempty"` // The folder that the application belongs to as the user sees it. ClientFolder NullableString `json:"ClientFolder,omitempty"` // Delegated admin scopes in which the containers of the application reside. - ContainerScopes []ContainerScopeResponseModel `json:"ContainerScopes"` + ContainerScopes []ContainerScopeResponseModel `json:"ContainerScopes,omitempty"` // The description of the application. Description NullableString `json:"Description,omitempty"` // Indicates whether or not this application is enumerable DoNotEnumerate *bool `json:"DoNotEnumerate,omitempty"` // Indicates whether or not this application can be launched. - Enabled bool `json:"Enabled"` + Enabled *bool `json:"Enabled,omitempty"` // Id of the icon used for the application. Used to be: IconUid (and it was not globally unique) Needs to be globally unique Might be constructed from site ID + internal Uid - IconId string `json:"IconId"` + IconId NullableString `json:"IconId,omitempty"` InstalledAppProperties *InstalledAppResponseModel `json:"InstalledAppProperties,omitempty"` PackagedAppProperties *AppVAppResponseModel `json:"PackagedAppProperties,omitempty"` AppVAppProperties *AppVAppResponseModel `json:"AppVAppProperties,omitempty"` // Location of published content. ContentLocation NullableString `json:"ContentLocation,omitempty"` // Name of the application. Only seen by administrators. - Name string `json:"Name"` + Name NullableString `json:"Name,omitempty"` // The name seen by end users who have access to the application. - PublishedName string `json:"PublishedName"` + PublishedName NullableString `json:"PublishedName,omitempty"` // The metadata of application. Metadata []NameValueStringPairModel `json:"Metadata,omitempty"` // Indicates whether or not this application is visible to users. - Visible bool `json:"Visible"` - SharingKind SharingKind `json:"SharingKind"` + Visible *bool `json:"Visible,omitempty"` + SharingKind *SharingKind `json:"SharingKind,omitempty"` // Tags associated with this application. Tags []string `json:"Tags,omitempty"` // The tenant(s) that the application is assigned to. If `null`, the application is not assigned to any tenants, and may be used by any tenant. @@ -102,19 +102,8 @@ type ApplicationDetailResponseModel struct { // This constructor will assign default values to properties that have it defined, // and makes sure properties required by API are set, but the set of arguments // will change when the set of required properties is changed -func NewApplicationDetailResponseModel(id string, applicationFolder RefResponseModel, applicationType ApplicationType, packagedApplicationType PackagedApplicationType, containerScopes []ContainerScopeResponseModel, enabled bool, iconId string, name string, publishedName string, visible bool, sharingKind SharingKind, browserName string, cpuPriorityLevel CpuPriorityLevel, homeZone RefResponseModel, homeZoneMode HomeZoneMode, includedUserFilterEnabled bool) *ApplicationDetailResponseModel { +func NewApplicationDetailResponseModel(browserName string, cpuPriorityLevel CpuPriorityLevel, homeZone RefResponseModel, homeZoneMode HomeZoneMode, includedUserFilterEnabled bool) *ApplicationDetailResponseModel { this := ApplicationDetailResponseModel{} - this.Id = id - this.ApplicationFolder = applicationFolder - this.ApplicationType = applicationType - this.PackagedApplicationType = packagedApplicationType - this.ContainerScopes = containerScopes - this.Enabled = enabled - this.IconId = iconId - this.Name = name - this.PublishedName = publishedName - this.Visible = visible - this.SharingKind = sharingKind this.BrowserName = browserName this.CpuPriorityLevel = cpuPriorityLevel this.HomeZone = homeZone @@ -131,28 +120,46 @@ func NewApplicationDetailResponseModelWithDefaults() *ApplicationDetailResponseM return &this } -// GetId returns the Id field value +// GetId returns the Id field value if set, zero value otherwise (both if not set or set to explicit null). func (o *ApplicationDetailResponseModel) GetId() string { - if o == nil { + if o == nil || IsNil(o.Id.Get()) { var ret string return ret } - - return o.Id + return *o.Id.Get() } -// GetIdOk returns a tuple with the Id field value +// GetIdOk returns a tuple with the Id field value if set, nil otherwise // and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned func (o *ApplicationDetailResponseModel) GetIdOk() (*string, bool) { if o == nil { return nil, false } - return &o.Id, true + return o.Id.Get(), o.Id.IsSet() +} + +// HasId returns a boolean if a field has been set. +func (o *ApplicationDetailResponseModel) HasId() bool { + if o != nil && o.Id.IsSet() { + return true + } + + return false } -// SetId sets field value +// SetId gets a reference to the given NullableString and assigns it to the Id field. func (o *ApplicationDetailResponseModel) SetId(v string) { - o.Id = v + o.Id.Set(&v) +} +// SetIdNil sets the value for Id to be an explicit nil +func (o *ApplicationDetailResponseModel) SetIdNil() { + o.Id.Set(nil) +} + +// UnsetId ensures that no value is present for Id, not even an explicit nil +func (o *ApplicationDetailResponseModel) UnsetId() { + o.Id.Unset() } // GetUid returns the Uid field value if set, zero value otherwise (both if not set or set to explicit null). @@ -200,76 +207,100 @@ func (o *ApplicationDetailResponseModel) UnsetUid() { o.Uid.Unset() } -// GetApplicationFolder returns the ApplicationFolder field value +// GetApplicationFolder returns the ApplicationFolder field value if set, zero value otherwise. func (o *ApplicationDetailResponseModel) GetApplicationFolder() RefResponseModel { - if o == nil { + if o == nil || IsNil(o.ApplicationFolder) { var ret RefResponseModel return ret } - - return o.ApplicationFolder + return *o.ApplicationFolder } -// GetApplicationFolderOk returns a tuple with the ApplicationFolder field value +// GetApplicationFolderOk returns a tuple with the ApplicationFolder field value if set, nil otherwise // and a boolean to check if the value has been set. func (o *ApplicationDetailResponseModel) GetApplicationFolderOk() (*RefResponseModel, bool) { - if o == nil { + if o == nil || IsNil(o.ApplicationFolder) { return nil, false } - return &o.ApplicationFolder, true + return o.ApplicationFolder, true } -// SetApplicationFolder sets field value +// HasApplicationFolder returns a boolean if a field has been set. +func (o *ApplicationDetailResponseModel) HasApplicationFolder() bool { + if o != nil && !IsNil(o.ApplicationFolder) { + return true + } + + return false +} + +// SetApplicationFolder gets a reference to the given RefResponseModel and assigns it to the ApplicationFolder field. func (o *ApplicationDetailResponseModel) SetApplicationFolder(v RefResponseModel) { - o.ApplicationFolder = v + o.ApplicationFolder = &v } -// GetApplicationType returns the ApplicationType field value +// GetApplicationType returns the ApplicationType field value if set, zero value otherwise. func (o *ApplicationDetailResponseModel) GetApplicationType() ApplicationType { - if o == nil { + if o == nil || IsNil(o.ApplicationType) { var ret ApplicationType return ret } - - return o.ApplicationType + return *o.ApplicationType } -// GetApplicationTypeOk returns a tuple with the ApplicationType field value +// GetApplicationTypeOk returns a tuple with the ApplicationType field value if set, nil otherwise // and a boolean to check if the value has been set. func (o *ApplicationDetailResponseModel) GetApplicationTypeOk() (*ApplicationType, bool) { - if o == nil { + if o == nil || IsNil(o.ApplicationType) { return nil, false } - return &o.ApplicationType, true + return o.ApplicationType, true } -// SetApplicationType sets field value +// HasApplicationType returns a boolean if a field has been set. +func (o *ApplicationDetailResponseModel) HasApplicationType() bool { + if o != nil && !IsNil(o.ApplicationType) { + return true + } + + return false +} + +// SetApplicationType gets a reference to the given ApplicationType and assigns it to the ApplicationType field. func (o *ApplicationDetailResponseModel) SetApplicationType(v ApplicationType) { - o.ApplicationType = v + o.ApplicationType = &v } -// GetPackagedApplicationType returns the PackagedApplicationType field value +// GetPackagedApplicationType returns the PackagedApplicationType field value if set, zero value otherwise. func (o *ApplicationDetailResponseModel) GetPackagedApplicationType() PackagedApplicationType { - if o == nil { + if o == nil || IsNil(o.PackagedApplicationType) { var ret PackagedApplicationType return ret } - - return o.PackagedApplicationType + return *o.PackagedApplicationType } -// GetPackagedApplicationTypeOk returns a tuple with the PackagedApplicationType field value +// GetPackagedApplicationTypeOk returns a tuple with the PackagedApplicationType field value if set, nil otherwise // and a boolean to check if the value has been set. func (o *ApplicationDetailResponseModel) GetPackagedApplicationTypeOk() (*PackagedApplicationType, bool) { - if o == nil { + if o == nil || IsNil(o.PackagedApplicationType) { return nil, false } - return &o.PackagedApplicationType, true + return o.PackagedApplicationType, true +} + +// HasPackagedApplicationType returns a boolean if a field has been set. +func (o *ApplicationDetailResponseModel) HasPackagedApplicationType() bool { + if o != nil && !IsNil(o.PackagedApplicationType) { + return true + } + + return false } -// SetPackagedApplicationType sets field value +// SetPackagedApplicationType gets a reference to the given PackagedApplicationType and assigns it to the PackagedApplicationType field. func (o *ApplicationDetailResponseModel) SetPackagedApplicationType(v PackagedApplicationType) { - o.PackagedApplicationType = v + o.PackagedApplicationType = &v } // GetClientFolder returns the ClientFolder field value if set, zero value otherwise (both if not set or set to explicit null). @@ -314,26 +345,35 @@ func (o *ApplicationDetailResponseModel) UnsetClientFolder() { o.ClientFolder.Unset() } -// GetContainerScopes returns the ContainerScopes field value +// GetContainerScopes returns the ContainerScopes field value if set, zero value otherwise (both if not set or set to explicit null). func (o *ApplicationDetailResponseModel) GetContainerScopes() []ContainerScopeResponseModel { if o == nil { var ret []ContainerScopeResponseModel return ret } - return o.ContainerScopes } -// GetContainerScopesOk returns a tuple with the ContainerScopes field value +// GetContainerScopesOk returns a tuple with the ContainerScopes field value if set, nil otherwise // and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned func (o *ApplicationDetailResponseModel) GetContainerScopesOk() ([]ContainerScopeResponseModel, bool) { - if o == nil { + if o == nil || IsNil(o.ContainerScopes) { return nil, false } return o.ContainerScopes, true } -// SetContainerScopes sets field value +// HasContainerScopes returns a boolean if a field has been set. +func (o *ApplicationDetailResponseModel) HasContainerScopes() bool { + if o != nil && IsNil(o.ContainerScopes) { + return true + } + + return false +} + +// SetContainerScopes gets a reference to the given []ContainerScopeResponseModel and assigns it to the ContainerScopes field. func (o *ApplicationDetailResponseModel) SetContainerScopes(v []ContainerScopeResponseModel) { o.ContainerScopes = v } @@ -412,52 +452,78 @@ func (o *ApplicationDetailResponseModel) SetDoNotEnumerate(v bool) { o.DoNotEnumerate = &v } -// GetEnabled returns the Enabled field value +// GetEnabled returns the Enabled field value if set, zero value otherwise. func (o *ApplicationDetailResponseModel) GetEnabled() bool { - if o == nil { + if o == nil || IsNil(o.Enabled) { var ret bool return ret } - - return o.Enabled + return *o.Enabled } -// GetEnabledOk returns a tuple with the Enabled field value +// GetEnabledOk returns a tuple with the Enabled field value if set, nil otherwise // and a boolean to check if the value has been set. func (o *ApplicationDetailResponseModel) GetEnabledOk() (*bool, bool) { - if o == nil { + if o == nil || IsNil(o.Enabled) { return nil, false } - return &o.Enabled, true + return o.Enabled, true } -// SetEnabled sets field value +// HasEnabled returns a boolean if a field has been set. +func (o *ApplicationDetailResponseModel) HasEnabled() bool { + if o != nil && !IsNil(o.Enabled) { + return true + } + + return false +} + +// SetEnabled gets a reference to the given bool and assigns it to the Enabled field. func (o *ApplicationDetailResponseModel) SetEnabled(v bool) { - o.Enabled = v + o.Enabled = &v } -// GetIconId returns the IconId field value +// GetIconId returns the IconId field value if set, zero value otherwise (both if not set or set to explicit null). func (o *ApplicationDetailResponseModel) GetIconId() string { - if o == nil { + if o == nil || IsNil(o.IconId.Get()) { var ret string return ret } - - return o.IconId + return *o.IconId.Get() } -// GetIconIdOk returns a tuple with the IconId field value +// GetIconIdOk returns a tuple with the IconId field value if set, nil otherwise // and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned func (o *ApplicationDetailResponseModel) GetIconIdOk() (*string, bool) { if o == nil { return nil, false } - return &o.IconId, true + return o.IconId.Get(), o.IconId.IsSet() +} + +// HasIconId returns a boolean if a field has been set. +func (o *ApplicationDetailResponseModel) HasIconId() bool { + if o != nil && o.IconId.IsSet() { + return true + } + + return false } -// SetIconId sets field value +// SetIconId gets a reference to the given NullableString and assigns it to the IconId field. func (o *ApplicationDetailResponseModel) SetIconId(v string) { - o.IconId = v + o.IconId.Set(&v) +} +// SetIconIdNil sets the value for IconId to be an explicit nil +func (o *ApplicationDetailResponseModel) SetIconIdNil() { + o.IconId.Set(nil) +} + +// UnsetIconId ensures that no value is present for IconId, not even an explicit nil +func (o *ApplicationDetailResponseModel) UnsetIconId() { + o.IconId.Unset() } // GetInstalledAppProperties returns the InstalledAppProperties field value if set, zero value otherwise. @@ -598,52 +664,88 @@ func (o *ApplicationDetailResponseModel) UnsetContentLocation() { o.ContentLocation.Unset() } -// GetName returns the Name field value +// GetName returns the Name field value if set, zero value otherwise (both if not set or set to explicit null). func (o *ApplicationDetailResponseModel) GetName() string { - if o == nil { + if o == nil || IsNil(o.Name.Get()) { var ret string return ret } - - return o.Name + return *o.Name.Get() } -// GetNameOk returns a tuple with the Name field value +// GetNameOk returns a tuple with the Name field value if set, nil otherwise // and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned func (o *ApplicationDetailResponseModel) GetNameOk() (*string, bool) { if o == nil { return nil, false } - return &o.Name, true + return o.Name.Get(), o.Name.IsSet() } -// SetName sets field value +// HasName returns a boolean if a field has been set. +func (o *ApplicationDetailResponseModel) HasName() bool { + if o != nil && o.Name.IsSet() { + return true + } + + return false +} + +// SetName gets a reference to the given NullableString and assigns it to the Name field. func (o *ApplicationDetailResponseModel) SetName(v string) { - o.Name = v + o.Name.Set(&v) +} +// SetNameNil sets the value for Name to be an explicit nil +func (o *ApplicationDetailResponseModel) SetNameNil() { + o.Name.Set(nil) +} + +// UnsetName ensures that no value is present for Name, not even an explicit nil +func (o *ApplicationDetailResponseModel) UnsetName() { + o.Name.Unset() } -// GetPublishedName returns the PublishedName field value +// GetPublishedName returns the PublishedName field value if set, zero value otherwise (both if not set or set to explicit null). func (o *ApplicationDetailResponseModel) GetPublishedName() string { - if o == nil { + if o == nil || IsNil(o.PublishedName.Get()) { var ret string return ret } - - return o.PublishedName + return *o.PublishedName.Get() } -// GetPublishedNameOk returns a tuple with the PublishedName field value +// GetPublishedNameOk returns a tuple with the PublishedName field value if set, nil otherwise // and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned func (o *ApplicationDetailResponseModel) GetPublishedNameOk() (*string, bool) { if o == nil { return nil, false } - return &o.PublishedName, true + return o.PublishedName.Get(), o.PublishedName.IsSet() } -// SetPublishedName sets field value +// HasPublishedName returns a boolean if a field has been set. +func (o *ApplicationDetailResponseModel) HasPublishedName() bool { + if o != nil && o.PublishedName.IsSet() { + return true + } + + return false +} + +// SetPublishedName gets a reference to the given NullableString and assigns it to the PublishedName field. func (o *ApplicationDetailResponseModel) SetPublishedName(v string) { - o.PublishedName = v + o.PublishedName.Set(&v) +} +// SetPublishedNameNil sets the value for PublishedName to be an explicit nil +func (o *ApplicationDetailResponseModel) SetPublishedNameNil() { + o.PublishedName.Set(nil) +} + +// UnsetPublishedName ensures that no value is present for PublishedName, not even an explicit nil +func (o *ApplicationDetailResponseModel) UnsetPublishedName() { + o.PublishedName.Unset() } // GetMetadata returns the Metadata field value if set, zero value otherwise (both if not set or set to explicit null). @@ -679,52 +781,68 @@ func (o *ApplicationDetailResponseModel) SetMetadata(v []NameValueStringPairMode o.Metadata = v } -// GetVisible returns the Visible field value +// GetVisible returns the Visible field value if set, zero value otherwise. func (o *ApplicationDetailResponseModel) GetVisible() bool { - if o == nil { + if o == nil || IsNil(o.Visible) { var ret bool return ret } - - return o.Visible + return *o.Visible } -// GetVisibleOk returns a tuple with the Visible field value +// GetVisibleOk returns a tuple with the Visible field value if set, nil otherwise // and a boolean to check if the value has been set. func (o *ApplicationDetailResponseModel) GetVisibleOk() (*bool, bool) { - if o == nil { + if o == nil || IsNil(o.Visible) { return nil, false } - return &o.Visible, true + return o.Visible, true } -// SetVisible sets field value +// HasVisible returns a boolean if a field has been set. +func (o *ApplicationDetailResponseModel) HasVisible() bool { + if o != nil && !IsNil(o.Visible) { + return true + } + + return false +} + +// SetVisible gets a reference to the given bool and assigns it to the Visible field. func (o *ApplicationDetailResponseModel) SetVisible(v bool) { - o.Visible = v + o.Visible = &v } -// GetSharingKind returns the SharingKind field value +// GetSharingKind returns the SharingKind field value if set, zero value otherwise. func (o *ApplicationDetailResponseModel) GetSharingKind() SharingKind { - if o == nil { + if o == nil || IsNil(o.SharingKind) { var ret SharingKind return ret } - - return o.SharingKind + return *o.SharingKind } -// GetSharingKindOk returns a tuple with the SharingKind field value +// GetSharingKindOk returns a tuple with the SharingKind field value if set, nil otherwise // and a boolean to check if the value has been set. func (o *ApplicationDetailResponseModel) GetSharingKindOk() (*SharingKind, bool) { - if o == nil { + if o == nil || IsNil(o.SharingKind) { return nil, false } - return &o.SharingKind, true + return o.SharingKind, true +} + +// HasSharingKind returns a boolean if a field has been set. +func (o *ApplicationDetailResponseModel) HasSharingKind() bool { + if o != nil && !IsNil(o.SharingKind) { + return true + } + + return false } -// SetSharingKind sets field value +// SetSharingKind gets a reference to the given SharingKind and assigns it to the SharingKind field. func (o *ApplicationDetailResponseModel) SetSharingKind(v SharingKind) { - o.SharingKind = v + o.SharingKind = &v } // GetTags returns the Tags field value if set, zero value otherwise (both if not set or set to explicit null). @@ -1520,25 +1638,39 @@ func (o ApplicationDetailResponseModel) MarshalJSON() ([]byte, error) { func (o ApplicationDetailResponseModel) ToMap() (map[string]interface{}, error) { toSerialize := map[string]interface{}{} - toSerialize["Id"] = o.Id + if o.Id.IsSet() { + toSerialize["Id"] = o.Id.Get() + } if o.Uid.IsSet() { toSerialize["Uid"] = o.Uid.Get() } - toSerialize["ApplicationFolder"] = o.ApplicationFolder - toSerialize["ApplicationType"] = o.ApplicationType - toSerialize["PackagedApplicationType"] = o.PackagedApplicationType + if !IsNil(o.ApplicationFolder) { + toSerialize["ApplicationFolder"] = o.ApplicationFolder + } + if !IsNil(o.ApplicationType) { + toSerialize["ApplicationType"] = o.ApplicationType + } + if !IsNil(o.PackagedApplicationType) { + toSerialize["PackagedApplicationType"] = o.PackagedApplicationType + } if o.ClientFolder.IsSet() { toSerialize["ClientFolder"] = o.ClientFolder.Get() } - toSerialize["ContainerScopes"] = o.ContainerScopes + if o.ContainerScopes != nil { + toSerialize["ContainerScopes"] = o.ContainerScopes + } if o.Description.IsSet() { toSerialize["Description"] = o.Description.Get() } if !IsNil(o.DoNotEnumerate) { toSerialize["DoNotEnumerate"] = o.DoNotEnumerate } - toSerialize["Enabled"] = o.Enabled - toSerialize["IconId"] = o.IconId + if !IsNil(o.Enabled) { + toSerialize["Enabled"] = o.Enabled + } + if o.IconId.IsSet() { + toSerialize["IconId"] = o.IconId.Get() + } if !IsNil(o.InstalledAppProperties) { toSerialize["InstalledAppProperties"] = o.InstalledAppProperties } @@ -1551,13 +1683,21 @@ func (o ApplicationDetailResponseModel) ToMap() (map[string]interface{}, error) if o.ContentLocation.IsSet() { toSerialize["ContentLocation"] = o.ContentLocation.Get() } - toSerialize["Name"] = o.Name - toSerialize["PublishedName"] = o.PublishedName + if o.Name.IsSet() { + toSerialize["Name"] = o.Name.Get() + } + if o.PublishedName.IsSet() { + toSerialize["PublishedName"] = o.PublishedName.Get() + } if o.Metadata != nil { toSerialize["Metadata"] = o.Metadata } - toSerialize["Visible"] = o.Visible - toSerialize["SharingKind"] = o.SharingKind + if !IsNil(o.Visible) { + toSerialize["Visible"] = o.Visible + } + if !IsNil(o.SharingKind) { + toSerialize["SharingKind"] = o.SharingKind + } if o.Tags != nil { toSerialize["Tags"] = o.Tags } diff --git a/citrixorchestration/model_application_group_detail_response_model.go b/citrixorchestration/model_application_group_detail_response_model.go index 262a193..e72c764 100644 --- a/citrixorchestration/model_application_group_detail_response_model.go +++ b/citrixorchestration/model_application_group_detail_response_model.go @@ -20,22 +20,22 @@ var _ MappedNullable = &ApplicationGroupDetailResponseModel{} // ApplicationGroupDetailResponseModel struct for ApplicationGroupDetailResponseModel type ApplicationGroupDetailResponseModel struct { // Id of the application group. Used to be: Uuid Needs to be globally unique This is likely to contain a guid but the property type should be string for future flexibility - Id string `json:"Id"` + Id NullableString `json:"Id,omitempty"` // `DEPRECATED. Use .` DEPRECATED. Use Id. // Deprecated Uid NullableInt32 `json:"Uid,omitempty"` // Delegated admin scopes in which the containers of the application group reside. - ContainerScopes []ContainerScopeResponseModel `json:"ContainerScopes"` + ContainerScopes []ContainerScopeResponseModel `json:"ContainerScopes,omitempty"` // Description of the application group. As with other facets of application groups, the description is not visible to end users. Description NullableString `json:"Description,omitempty"` // Indicates whether or not the applications in this application group can be launched. - Enabled bool `json:"Enabled"` + Enabled *bool `json:"Enabled,omitempty"` // Simple administrative name of application group within parent admin folder (if any). This property is not guaranteed unique across all application groups. Name NullableString `json:"Name,omitempty"` // Name of this application group. The name uniquely identifies the application group within the site. As with other facets of application groups, the name is not visible to end users. FullName NullableString `json:"FullName,omitempty"` // The list of the delegated admin scopes to which the application group belongs. - Scopes []ScopeResponseModel `json:"Scopes"` + Scopes []ScopeResponseModel `json:"Scopes,omitempty"` // The metadata of application group. Metadata []NameValueStringPairModel `json:"Metadata,omitempty"` // Tags associated with this application group. @@ -43,14 +43,14 @@ type ApplicationGroupDetailResponseModel struct { // The tenant(s) that the application group is assigned to. If `null`, the application group is not assigned to tenants, and may be used by any tenant, including future added tenants. Tenants []RefResponseModel `json:"Tenants,omitempty"` // Number of applications present in the application group. - NumApplications int32 `json:"NumApplications"` + NumApplications *int32 `json:"NumApplications,omitempty"` // Number of machines capable of hosting the applications in the application group. - NumMachines int32 `json:"NumMachines"` + NumMachines *int32 `json:"NumMachines,omitempty"` // Total number of machines across all desktop groups on which the application group is published, and which are tagged with the tag given by the RestrictToTag property. NumMachinesWithTag *int32 `json:"NumMachinesWithTag,omitempty"` RestrictToTag *RefResponseModel `json:"RestrictToTag,omitempty"` // Delivery groups associated with the application group. - DeliveryGroups []ApplicationGroupDeliveryGroupRefResponseModel `json:"DeliveryGroups"` + DeliveryGroups []ApplicationGroupDeliveryGroupRefResponseModel `json:"DeliveryGroups,omitempty"` AdminFolder *RefResponseModel `json:"AdminFolder,omitempty"` // Number of applications in the group. ApplicationCount int32 `json:"ApplicationCount"` @@ -68,15 +68,8 @@ type ApplicationGroupDetailResponseModel struct { // This constructor will assign default values to properties that have it defined, // and makes sure properties required by API are set, but the set of arguments // will change when the set of required properties is changed -func NewApplicationGroupDetailResponseModel(id string, containerScopes []ContainerScopeResponseModel, enabled bool, scopes []ScopeResponseModel, numApplications int32, numMachines int32, deliveryGroups []ApplicationGroupDeliveryGroupRefResponseModel, applicationCount int32, includedUsersFilterEnabled bool, sessionSharingEnabled bool, totalMachines int32) *ApplicationGroupDetailResponseModel { +func NewApplicationGroupDetailResponseModel(applicationCount int32, includedUsersFilterEnabled bool, sessionSharingEnabled bool, totalMachines int32) *ApplicationGroupDetailResponseModel { this := ApplicationGroupDetailResponseModel{} - this.Id = id - this.ContainerScopes = containerScopes - this.Enabled = enabled - this.Scopes = scopes - this.NumApplications = numApplications - this.NumMachines = numMachines - this.DeliveryGroups = deliveryGroups this.ApplicationCount = applicationCount this.IncludedUsersFilterEnabled = includedUsersFilterEnabled this.SessionSharingEnabled = sessionSharingEnabled @@ -92,28 +85,46 @@ func NewApplicationGroupDetailResponseModelWithDefaults() *ApplicationGroupDetai return &this } -// GetId returns the Id field value +// GetId returns the Id field value if set, zero value otherwise (both if not set or set to explicit null). func (o *ApplicationGroupDetailResponseModel) GetId() string { - if o == nil { + if o == nil || IsNil(o.Id.Get()) { var ret string return ret } - - return o.Id + return *o.Id.Get() } -// GetIdOk returns a tuple with the Id field value +// GetIdOk returns a tuple with the Id field value if set, nil otherwise // and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned func (o *ApplicationGroupDetailResponseModel) GetIdOk() (*string, bool) { if o == nil { return nil, false } - return &o.Id, true + return o.Id.Get(), o.Id.IsSet() +} + +// HasId returns a boolean if a field has been set. +func (o *ApplicationGroupDetailResponseModel) HasId() bool { + if o != nil && o.Id.IsSet() { + return true + } + + return false } -// SetId sets field value +// SetId gets a reference to the given NullableString and assigns it to the Id field. func (o *ApplicationGroupDetailResponseModel) SetId(v string) { - o.Id = v + o.Id.Set(&v) +} +// SetIdNil sets the value for Id to be an explicit nil +func (o *ApplicationGroupDetailResponseModel) SetIdNil() { + o.Id.Set(nil) +} + +// UnsetId ensures that no value is present for Id, not even an explicit nil +func (o *ApplicationGroupDetailResponseModel) UnsetId() { + o.Id.Unset() } // GetUid returns the Uid field value if set, zero value otherwise (both if not set or set to explicit null). @@ -161,26 +172,35 @@ func (o *ApplicationGroupDetailResponseModel) UnsetUid() { o.Uid.Unset() } -// GetContainerScopes returns the ContainerScopes field value +// GetContainerScopes returns the ContainerScopes field value if set, zero value otherwise (both if not set or set to explicit null). func (o *ApplicationGroupDetailResponseModel) GetContainerScopes() []ContainerScopeResponseModel { if o == nil { var ret []ContainerScopeResponseModel return ret } - return o.ContainerScopes } -// GetContainerScopesOk returns a tuple with the ContainerScopes field value +// GetContainerScopesOk returns a tuple with the ContainerScopes field value if set, nil otherwise // and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned func (o *ApplicationGroupDetailResponseModel) GetContainerScopesOk() ([]ContainerScopeResponseModel, bool) { - if o == nil { + if o == nil || IsNil(o.ContainerScopes) { return nil, false } return o.ContainerScopes, true } -// SetContainerScopes sets field value +// HasContainerScopes returns a boolean if a field has been set. +func (o *ApplicationGroupDetailResponseModel) HasContainerScopes() bool { + if o != nil && IsNil(o.ContainerScopes) { + return true + } + + return false +} + +// SetContainerScopes gets a reference to the given []ContainerScopeResponseModel and assigns it to the ContainerScopes field. func (o *ApplicationGroupDetailResponseModel) SetContainerScopes(v []ContainerScopeResponseModel) { o.ContainerScopes = v } @@ -227,28 +247,36 @@ func (o *ApplicationGroupDetailResponseModel) UnsetDescription() { o.Description.Unset() } -// GetEnabled returns the Enabled field value +// GetEnabled returns the Enabled field value if set, zero value otherwise. func (o *ApplicationGroupDetailResponseModel) GetEnabled() bool { - if o == nil { + if o == nil || IsNil(o.Enabled) { var ret bool return ret } - - return o.Enabled + return *o.Enabled } -// GetEnabledOk returns a tuple with the Enabled field value +// GetEnabledOk returns a tuple with the Enabled field value if set, nil otherwise // and a boolean to check if the value has been set. func (o *ApplicationGroupDetailResponseModel) GetEnabledOk() (*bool, bool) { - if o == nil { + if o == nil || IsNil(o.Enabled) { return nil, false } - return &o.Enabled, true + return o.Enabled, true +} + +// HasEnabled returns a boolean if a field has been set. +func (o *ApplicationGroupDetailResponseModel) HasEnabled() bool { + if o != nil && !IsNil(o.Enabled) { + return true + } + + return false } -// SetEnabled sets field value +// SetEnabled gets a reference to the given bool and assigns it to the Enabled field. func (o *ApplicationGroupDetailResponseModel) SetEnabled(v bool) { - o.Enabled = v + o.Enabled = &v } // GetName returns the Name field value if set, zero value otherwise (both if not set or set to explicit null). @@ -335,26 +363,35 @@ func (o *ApplicationGroupDetailResponseModel) UnsetFullName() { o.FullName.Unset() } -// GetScopes returns the Scopes field value +// GetScopes returns the Scopes field value if set, zero value otherwise (both if not set or set to explicit null). func (o *ApplicationGroupDetailResponseModel) GetScopes() []ScopeResponseModel { if o == nil { var ret []ScopeResponseModel return ret } - return o.Scopes } -// GetScopesOk returns a tuple with the Scopes field value +// GetScopesOk returns a tuple with the Scopes field value if set, nil otherwise // and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned func (o *ApplicationGroupDetailResponseModel) GetScopesOk() ([]ScopeResponseModel, bool) { - if o == nil { + if o == nil || IsNil(o.Scopes) { return nil, false } return o.Scopes, true } -// SetScopes sets field value +// HasScopes returns a boolean if a field has been set. +func (o *ApplicationGroupDetailResponseModel) HasScopes() bool { + if o != nil && IsNil(o.Scopes) { + return true + } + + return false +} + +// SetScopes gets a reference to the given []ScopeResponseModel and assigns it to the Scopes field. func (o *ApplicationGroupDetailResponseModel) SetScopes(v []ScopeResponseModel) { o.Scopes = v } @@ -458,52 +495,68 @@ func (o *ApplicationGroupDetailResponseModel) SetTenants(v []RefResponseModel) { o.Tenants = v } -// GetNumApplications returns the NumApplications field value +// GetNumApplications returns the NumApplications field value if set, zero value otherwise. func (o *ApplicationGroupDetailResponseModel) GetNumApplications() int32 { - if o == nil { + if o == nil || IsNil(o.NumApplications) { var ret int32 return ret } - - return o.NumApplications + return *o.NumApplications } -// GetNumApplicationsOk returns a tuple with the NumApplications field value +// GetNumApplicationsOk returns a tuple with the NumApplications field value if set, nil otherwise // and a boolean to check if the value has been set. func (o *ApplicationGroupDetailResponseModel) GetNumApplicationsOk() (*int32, bool) { - if o == nil { + if o == nil || IsNil(o.NumApplications) { return nil, false } - return &o.NumApplications, true + return o.NumApplications, true +} + +// HasNumApplications returns a boolean if a field has been set. +func (o *ApplicationGroupDetailResponseModel) HasNumApplications() bool { + if o != nil && !IsNil(o.NumApplications) { + return true + } + + return false } -// SetNumApplications sets field value +// SetNumApplications gets a reference to the given int32 and assigns it to the NumApplications field. func (o *ApplicationGroupDetailResponseModel) SetNumApplications(v int32) { - o.NumApplications = v + o.NumApplications = &v } -// GetNumMachines returns the NumMachines field value +// GetNumMachines returns the NumMachines field value if set, zero value otherwise. func (o *ApplicationGroupDetailResponseModel) GetNumMachines() int32 { - if o == nil { + if o == nil || IsNil(o.NumMachines) { var ret int32 return ret } - - return o.NumMachines + return *o.NumMachines } -// GetNumMachinesOk returns a tuple with the NumMachines field value +// GetNumMachinesOk returns a tuple with the NumMachines field value if set, nil otherwise // and a boolean to check if the value has been set. func (o *ApplicationGroupDetailResponseModel) GetNumMachinesOk() (*int32, bool) { - if o == nil { + if o == nil || IsNil(o.NumMachines) { return nil, false } - return &o.NumMachines, true + return o.NumMachines, true +} + +// HasNumMachines returns a boolean if a field has been set. +func (o *ApplicationGroupDetailResponseModel) HasNumMachines() bool { + if o != nil && !IsNil(o.NumMachines) { + return true + } + + return false } -// SetNumMachines sets field value +// SetNumMachines gets a reference to the given int32 and assigns it to the NumMachines field. func (o *ApplicationGroupDetailResponseModel) SetNumMachines(v int32) { - o.NumMachines = v + o.NumMachines = &v } // GetNumMachinesWithTag returns the NumMachinesWithTag field value if set, zero value otherwise. @@ -570,26 +623,35 @@ func (o *ApplicationGroupDetailResponseModel) SetRestrictToTag(v RefResponseMode o.RestrictToTag = &v } -// GetDeliveryGroups returns the DeliveryGroups field value +// GetDeliveryGroups returns the DeliveryGroups field value if set, zero value otherwise (both if not set or set to explicit null). func (o *ApplicationGroupDetailResponseModel) GetDeliveryGroups() []ApplicationGroupDeliveryGroupRefResponseModel { if o == nil { var ret []ApplicationGroupDeliveryGroupRefResponseModel return ret } - return o.DeliveryGroups } -// GetDeliveryGroupsOk returns a tuple with the DeliveryGroups field value +// GetDeliveryGroupsOk returns a tuple with the DeliveryGroups field value if set, nil otherwise // and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned func (o *ApplicationGroupDetailResponseModel) GetDeliveryGroupsOk() ([]ApplicationGroupDeliveryGroupRefResponseModel, bool) { - if o == nil { + if o == nil || IsNil(o.DeliveryGroups) { return nil, false } return o.DeliveryGroups, true } -// SetDeliveryGroups sets field value +// HasDeliveryGroups returns a boolean if a field has been set. +func (o *ApplicationGroupDetailResponseModel) HasDeliveryGroups() bool { + if o != nil && IsNil(o.DeliveryGroups) { + return true + } + + return false +} + +// SetDeliveryGroups gets a reference to the given []ApplicationGroupDeliveryGroupRefResponseModel and assigns it to the DeliveryGroups field. func (o *ApplicationGroupDetailResponseModel) SetDeliveryGroups(v []ApplicationGroupDeliveryGroupRefResponseModel) { o.DeliveryGroups = v } @@ -765,22 +827,30 @@ func (o ApplicationGroupDetailResponseModel) MarshalJSON() ([]byte, error) { func (o ApplicationGroupDetailResponseModel) ToMap() (map[string]interface{}, error) { toSerialize := map[string]interface{}{} - toSerialize["Id"] = o.Id + if o.Id.IsSet() { + toSerialize["Id"] = o.Id.Get() + } if o.Uid.IsSet() { toSerialize["Uid"] = o.Uid.Get() } - toSerialize["ContainerScopes"] = o.ContainerScopes + if o.ContainerScopes != nil { + toSerialize["ContainerScopes"] = o.ContainerScopes + } if o.Description.IsSet() { toSerialize["Description"] = o.Description.Get() } - toSerialize["Enabled"] = o.Enabled + if !IsNil(o.Enabled) { + toSerialize["Enabled"] = o.Enabled + } if o.Name.IsSet() { toSerialize["Name"] = o.Name.Get() } if o.FullName.IsSet() { toSerialize["FullName"] = o.FullName.Get() } - toSerialize["Scopes"] = o.Scopes + if o.Scopes != nil { + toSerialize["Scopes"] = o.Scopes + } if o.Metadata != nil { toSerialize["Metadata"] = o.Metadata } @@ -790,15 +860,21 @@ func (o ApplicationGroupDetailResponseModel) ToMap() (map[string]interface{}, er if o.Tenants != nil { toSerialize["Tenants"] = o.Tenants } - toSerialize["NumApplications"] = o.NumApplications - toSerialize["NumMachines"] = o.NumMachines + if !IsNil(o.NumApplications) { + toSerialize["NumApplications"] = o.NumApplications + } + if !IsNil(o.NumMachines) { + toSerialize["NumMachines"] = o.NumMachines + } if !IsNil(o.NumMachinesWithTag) { toSerialize["NumMachinesWithTag"] = o.NumMachinesWithTag } if !IsNil(o.RestrictToTag) { toSerialize["RestrictToTag"] = o.RestrictToTag } - toSerialize["DeliveryGroups"] = o.DeliveryGroups + if o.DeliveryGroups != nil { + toSerialize["DeliveryGroups"] = o.DeliveryGroups + } if !IsNil(o.AdminFolder) { toSerialize["AdminFolder"] = o.AdminFolder } diff --git a/citrixorchestration/model_application_group_response_model.go b/citrixorchestration/model_application_group_response_model.go index 62fac89..6279a33 100644 --- a/citrixorchestration/model_application_group_response_model.go +++ b/citrixorchestration/model_application_group_response_model.go @@ -20,22 +20,22 @@ var _ MappedNullable = &ApplicationGroupResponseModel{} // ApplicationGroupResponseModel Response object for an application group. type ApplicationGroupResponseModel struct { // Id of the application group. Used to be: Uuid Needs to be globally unique This is likely to contain a guid but the property type should be string for future flexibility - Id string `json:"Id"` + Id NullableString `json:"Id,omitempty"` // `DEPRECATED. Use .` DEPRECATED. Use Id. // Deprecated Uid NullableInt32 `json:"Uid,omitempty"` // Delegated admin scopes in which the containers of the application group reside. - ContainerScopes []ContainerScopeResponseModel `json:"ContainerScopes"` + ContainerScopes []ContainerScopeResponseModel `json:"ContainerScopes,omitempty"` // Description of the application group. As with other facets of application groups, the description is not visible to end users. Description NullableString `json:"Description,omitempty"` // Indicates whether or not the applications in this application group can be launched. - Enabled bool `json:"Enabled"` + Enabled *bool `json:"Enabled,omitempty"` // Simple administrative name of application group within parent admin folder (if any). This property is not guaranteed unique across all application groups. Name NullableString `json:"Name,omitempty"` // Name of this application group. The name uniquely identifies the application group within the site. As with other facets of application groups, the name is not visible to end users. FullName NullableString `json:"FullName,omitempty"` // The list of the delegated admin scopes to which the application group belongs. - Scopes []ScopeResponseModel `json:"Scopes"` + Scopes []ScopeResponseModel `json:"Scopes,omitempty"` // The metadata of application group. Metadata []NameValueStringPairModel `json:"Metadata,omitempty"` // Tags associated with this application group. @@ -43,14 +43,14 @@ type ApplicationGroupResponseModel struct { // The tenant(s) that the application group is assigned to. If `null`, the application group is not assigned to tenants, and may be used by any tenant, including future added tenants. Tenants []RefResponseModel `json:"Tenants,omitempty"` // Number of applications present in the application group. - NumApplications int32 `json:"NumApplications"` + NumApplications *int32 `json:"NumApplications,omitempty"` // Number of machines capable of hosting the applications in the application group. - NumMachines int32 `json:"NumMachines"` + NumMachines *int32 `json:"NumMachines,omitempty"` // Total number of machines across all desktop groups on which the application group is published, and which are tagged with the tag given by the RestrictToTag property. NumMachinesWithTag *int32 `json:"NumMachinesWithTag,omitempty"` RestrictToTag *RefResponseModel `json:"RestrictToTag,omitempty"` // Delivery groups associated with the application group. - DeliveryGroups []ApplicationGroupDeliveryGroupRefResponseModel `json:"DeliveryGroups"` + DeliveryGroups []ApplicationGroupDeliveryGroupRefResponseModel `json:"DeliveryGroups,omitempty"` AdminFolder *RefResponseModel `json:"AdminFolder,omitempty"` } @@ -58,15 +58,8 @@ type ApplicationGroupResponseModel struct { // This constructor will assign default values to properties that have it defined, // and makes sure properties required by API are set, but the set of arguments // will change when the set of required properties is changed -func NewApplicationGroupResponseModel(id string, containerScopes []ContainerScopeResponseModel, enabled bool, scopes []ScopeResponseModel, numApplications int32, numMachines int32, deliveryGroups []ApplicationGroupDeliveryGroupRefResponseModel) *ApplicationGroupResponseModel { +func NewApplicationGroupResponseModel() *ApplicationGroupResponseModel { this := ApplicationGroupResponseModel{} - this.Id = id - this.ContainerScopes = containerScopes - this.Enabled = enabled - this.Scopes = scopes - this.NumApplications = numApplications - this.NumMachines = numMachines - this.DeliveryGroups = deliveryGroups return &this } @@ -78,28 +71,46 @@ func NewApplicationGroupResponseModelWithDefaults() *ApplicationGroupResponseMod return &this } -// GetId returns the Id field value +// GetId returns the Id field value if set, zero value otherwise (both if not set or set to explicit null). func (o *ApplicationGroupResponseModel) GetId() string { - if o == nil { + if o == nil || IsNil(o.Id.Get()) { var ret string return ret } - - return o.Id + return *o.Id.Get() } -// GetIdOk returns a tuple with the Id field value +// GetIdOk returns a tuple with the Id field value if set, nil otherwise // and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned func (o *ApplicationGroupResponseModel) GetIdOk() (*string, bool) { if o == nil { return nil, false } - return &o.Id, true + return o.Id.Get(), o.Id.IsSet() +} + +// HasId returns a boolean if a field has been set. +func (o *ApplicationGroupResponseModel) HasId() bool { + if o != nil && o.Id.IsSet() { + return true + } + + return false } -// SetId sets field value +// SetId gets a reference to the given NullableString and assigns it to the Id field. func (o *ApplicationGroupResponseModel) SetId(v string) { - o.Id = v + o.Id.Set(&v) +} +// SetIdNil sets the value for Id to be an explicit nil +func (o *ApplicationGroupResponseModel) SetIdNil() { + o.Id.Set(nil) +} + +// UnsetId ensures that no value is present for Id, not even an explicit nil +func (o *ApplicationGroupResponseModel) UnsetId() { + o.Id.Unset() } // GetUid returns the Uid field value if set, zero value otherwise (both if not set or set to explicit null). @@ -147,26 +158,35 @@ func (o *ApplicationGroupResponseModel) UnsetUid() { o.Uid.Unset() } -// GetContainerScopes returns the ContainerScopes field value +// GetContainerScopes returns the ContainerScopes field value if set, zero value otherwise (both if not set or set to explicit null). func (o *ApplicationGroupResponseModel) GetContainerScopes() []ContainerScopeResponseModel { if o == nil { var ret []ContainerScopeResponseModel return ret } - return o.ContainerScopes } -// GetContainerScopesOk returns a tuple with the ContainerScopes field value +// GetContainerScopesOk returns a tuple with the ContainerScopes field value if set, nil otherwise // and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned func (o *ApplicationGroupResponseModel) GetContainerScopesOk() ([]ContainerScopeResponseModel, bool) { - if o == nil { + if o == nil || IsNil(o.ContainerScopes) { return nil, false } return o.ContainerScopes, true } -// SetContainerScopes sets field value +// HasContainerScopes returns a boolean if a field has been set. +func (o *ApplicationGroupResponseModel) HasContainerScopes() bool { + if o != nil && IsNil(o.ContainerScopes) { + return true + } + + return false +} + +// SetContainerScopes gets a reference to the given []ContainerScopeResponseModel and assigns it to the ContainerScopes field. func (o *ApplicationGroupResponseModel) SetContainerScopes(v []ContainerScopeResponseModel) { o.ContainerScopes = v } @@ -213,28 +233,36 @@ func (o *ApplicationGroupResponseModel) UnsetDescription() { o.Description.Unset() } -// GetEnabled returns the Enabled field value +// GetEnabled returns the Enabled field value if set, zero value otherwise. func (o *ApplicationGroupResponseModel) GetEnabled() bool { - if o == nil { + if o == nil || IsNil(o.Enabled) { var ret bool return ret } - - return o.Enabled + return *o.Enabled } -// GetEnabledOk returns a tuple with the Enabled field value +// GetEnabledOk returns a tuple with the Enabled field value if set, nil otherwise // and a boolean to check if the value has been set. func (o *ApplicationGroupResponseModel) GetEnabledOk() (*bool, bool) { - if o == nil { + if o == nil || IsNil(o.Enabled) { return nil, false } - return &o.Enabled, true + return o.Enabled, true +} + +// HasEnabled returns a boolean if a field has been set. +func (o *ApplicationGroupResponseModel) HasEnabled() bool { + if o != nil && !IsNil(o.Enabled) { + return true + } + + return false } -// SetEnabled sets field value +// SetEnabled gets a reference to the given bool and assigns it to the Enabled field. func (o *ApplicationGroupResponseModel) SetEnabled(v bool) { - o.Enabled = v + o.Enabled = &v } // GetName returns the Name field value if set, zero value otherwise (both if not set or set to explicit null). @@ -321,26 +349,35 @@ func (o *ApplicationGroupResponseModel) UnsetFullName() { o.FullName.Unset() } -// GetScopes returns the Scopes field value +// GetScopes returns the Scopes field value if set, zero value otherwise (both if not set or set to explicit null). func (o *ApplicationGroupResponseModel) GetScopes() []ScopeResponseModel { if o == nil { var ret []ScopeResponseModel return ret } - return o.Scopes } -// GetScopesOk returns a tuple with the Scopes field value +// GetScopesOk returns a tuple with the Scopes field value if set, nil otherwise // and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned func (o *ApplicationGroupResponseModel) GetScopesOk() ([]ScopeResponseModel, bool) { - if o == nil { + if o == nil || IsNil(o.Scopes) { return nil, false } return o.Scopes, true } -// SetScopes sets field value +// HasScopes returns a boolean if a field has been set. +func (o *ApplicationGroupResponseModel) HasScopes() bool { + if o != nil && IsNil(o.Scopes) { + return true + } + + return false +} + +// SetScopes gets a reference to the given []ScopeResponseModel and assigns it to the Scopes field. func (o *ApplicationGroupResponseModel) SetScopes(v []ScopeResponseModel) { o.Scopes = v } @@ -444,52 +481,68 @@ func (o *ApplicationGroupResponseModel) SetTenants(v []RefResponseModel) { o.Tenants = v } -// GetNumApplications returns the NumApplications field value +// GetNumApplications returns the NumApplications field value if set, zero value otherwise. func (o *ApplicationGroupResponseModel) GetNumApplications() int32 { - if o == nil { + if o == nil || IsNil(o.NumApplications) { var ret int32 return ret } - - return o.NumApplications + return *o.NumApplications } -// GetNumApplicationsOk returns a tuple with the NumApplications field value +// GetNumApplicationsOk returns a tuple with the NumApplications field value if set, nil otherwise // and a boolean to check if the value has been set. func (o *ApplicationGroupResponseModel) GetNumApplicationsOk() (*int32, bool) { - if o == nil { + if o == nil || IsNil(o.NumApplications) { return nil, false } - return &o.NumApplications, true + return o.NumApplications, true +} + +// HasNumApplications returns a boolean if a field has been set. +func (o *ApplicationGroupResponseModel) HasNumApplications() bool { + if o != nil && !IsNil(o.NumApplications) { + return true + } + + return false } -// SetNumApplications sets field value +// SetNumApplications gets a reference to the given int32 and assigns it to the NumApplications field. func (o *ApplicationGroupResponseModel) SetNumApplications(v int32) { - o.NumApplications = v + o.NumApplications = &v } -// GetNumMachines returns the NumMachines field value +// GetNumMachines returns the NumMachines field value if set, zero value otherwise. func (o *ApplicationGroupResponseModel) GetNumMachines() int32 { - if o == nil { + if o == nil || IsNil(o.NumMachines) { var ret int32 return ret } - - return o.NumMachines + return *o.NumMachines } -// GetNumMachinesOk returns a tuple with the NumMachines field value +// GetNumMachinesOk returns a tuple with the NumMachines field value if set, nil otherwise // and a boolean to check if the value has been set. func (o *ApplicationGroupResponseModel) GetNumMachinesOk() (*int32, bool) { - if o == nil { + if o == nil || IsNil(o.NumMachines) { return nil, false } - return &o.NumMachines, true + return o.NumMachines, true +} + +// HasNumMachines returns a boolean if a field has been set. +func (o *ApplicationGroupResponseModel) HasNumMachines() bool { + if o != nil && !IsNil(o.NumMachines) { + return true + } + + return false } -// SetNumMachines sets field value +// SetNumMachines gets a reference to the given int32 and assigns it to the NumMachines field. func (o *ApplicationGroupResponseModel) SetNumMachines(v int32) { - o.NumMachines = v + o.NumMachines = &v } // GetNumMachinesWithTag returns the NumMachinesWithTag field value if set, zero value otherwise. @@ -556,26 +609,35 @@ func (o *ApplicationGroupResponseModel) SetRestrictToTag(v RefResponseModel) { o.RestrictToTag = &v } -// GetDeliveryGroups returns the DeliveryGroups field value +// GetDeliveryGroups returns the DeliveryGroups field value if set, zero value otherwise (both if not set or set to explicit null). func (o *ApplicationGroupResponseModel) GetDeliveryGroups() []ApplicationGroupDeliveryGroupRefResponseModel { if o == nil { var ret []ApplicationGroupDeliveryGroupRefResponseModel return ret } - return o.DeliveryGroups } -// GetDeliveryGroupsOk returns a tuple with the DeliveryGroups field value +// GetDeliveryGroupsOk returns a tuple with the DeliveryGroups field value if set, nil otherwise // and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned func (o *ApplicationGroupResponseModel) GetDeliveryGroupsOk() ([]ApplicationGroupDeliveryGroupRefResponseModel, bool) { - if o == nil { + if o == nil || IsNil(o.DeliveryGroups) { return nil, false } return o.DeliveryGroups, true } -// SetDeliveryGroups sets field value +// HasDeliveryGroups returns a boolean if a field has been set. +func (o *ApplicationGroupResponseModel) HasDeliveryGroups() bool { + if o != nil && IsNil(o.DeliveryGroups) { + return true + } + + return false +} + +// SetDeliveryGroups gets a reference to the given []ApplicationGroupDeliveryGroupRefResponseModel and assigns it to the DeliveryGroups field. func (o *ApplicationGroupResponseModel) SetDeliveryGroups(v []ApplicationGroupDeliveryGroupRefResponseModel) { o.DeliveryGroups = v } @@ -622,22 +684,30 @@ func (o ApplicationGroupResponseModel) MarshalJSON() ([]byte, error) { func (o ApplicationGroupResponseModel) ToMap() (map[string]interface{}, error) { toSerialize := map[string]interface{}{} - toSerialize["Id"] = o.Id + if o.Id.IsSet() { + toSerialize["Id"] = o.Id.Get() + } if o.Uid.IsSet() { toSerialize["Uid"] = o.Uid.Get() } - toSerialize["ContainerScopes"] = o.ContainerScopes + if o.ContainerScopes != nil { + toSerialize["ContainerScopes"] = o.ContainerScopes + } if o.Description.IsSet() { toSerialize["Description"] = o.Description.Get() } - toSerialize["Enabled"] = o.Enabled + if !IsNil(o.Enabled) { + toSerialize["Enabled"] = o.Enabled + } if o.Name.IsSet() { toSerialize["Name"] = o.Name.Get() } if o.FullName.IsSet() { toSerialize["FullName"] = o.FullName.Get() } - toSerialize["Scopes"] = o.Scopes + if o.Scopes != nil { + toSerialize["Scopes"] = o.Scopes + } if o.Metadata != nil { toSerialize["Metadata"] = o.Metadata } @@ -647,15 +717,21 @@ func (o ApplicationGroupResponseModel) ToMap() (map[string]interface{}, error) { if o.Tenants != nil { toSerialize["Tenants"] = o.Tenants } - toSerialize["NumApplications"] = o.NumApplications - toSerialize["NumMachines"] = o.NumMachines + if !IsNil(o.NumApplications) { + toSerialize["NumApplications"] = o.NumApplications + } + if !IsNil(o.NumMachines) { + toSerialize["NumMachines"] = o.NumMachines + } if !IsNil(o.NumMachinesWithTag) { toSerialize["NumMachinesWithTag"] = o.NumMachinesWithTag } if !IsNil(o.RestrictToTag) { toSerialize["RestrictToTag"] = o.RestrictToTag } - toSerialize["DeliveryGroups"] = o.DeliveryGroups + if o.DeliveryGroups != nil { + toSerialize["DeliveryGroups"] = o.DeliveryGroups + } if !IsNil(o.AdminFolder) { toSerialize["AdminFolder"] = o.AdminFolder } diff --git a/citrixorchestration/model_application_response_model.go b/citrixorchestration/model_application_response_model.go index 15bf315..c3406dc 100644 --- a/citrixorchestration/model_application_response_model.go +++ b/citrixorchestration/model_application_response_model.go @@ -20,39 +20,39 @@ var _ MappedNullable = &ApplicationResponseModel{} // ApplicationResponseModel Response object for application. type ApplicationResponseModel struct { // Id of the application. Used to be: Uuid Needs to be globally unique This is likely to contain a guid but the property type should be string for future flexibility - Id string `json:"Id"` + Id NullableString `json:"Id,omitempty"` // `DEPRECATED. Use .` DEPRECATED. Use Id. // Deprecated Uid NullableInt32 `json:"Uid,omitempty"` - ApplicationFolder RefResponseModel `json:"ApplicationFolder"` - ApplicationType ApplicationType `json:"ApplicationType"` - PackagedApplicationType PackagedApplicationType `json:"PackagedApplicationType"` + ApplicationFolder *RefResponseModel `json:"ApplicationFolder,omitempty"` + ApplicationType *ApplicationType `json:"ApplicationType,omitempty"` + PackagedApplicationType *PackagedApplicationType `json:"PackagedApplicationType,omitempty"` // The folder that the application belongs to as the user sees it. ClientFolder NullableString `json:"ClientFolder,omitempty"` // Delegated admin scopes in which the containers of the application reside. - ContainerScopes []ContainerScopeResponseModel `json:"ContainerScopes"` + ContainerScopes []ContainerScopeResponseModel `json:"ContainerScopes,omitempty"` // The description of the application. Description NullableString `json:"Description,omitempty"` // Indicates whether or not this application is enumerable DoNotEnumerate *bool `json:"DoNotEnumerate,omitempty"` // Indicates whether or not this application can be launched. - Enabled bool `json:"Enabled"` + Enabled *bool `json:"Enabled,omitempty"` // Id of the icon used for the application. Used to be: IconUid (and it was not globally unique) Needs to be globally unique Might be constructed from site ID + internal Uid - IconId string `json:"IconId"` + IconId NullableString `json:"IconId,omitempty"` InstalledAppProperties *InstalledAppResponseModel `json:"InstalledAppProperties,omitempty"` PackagedAppProperties *AppVAppResponseModel `json:"PackagedAppProperties,omitempty"` AppVAppProperties *AppVAppResponseModel `json:"AppVAppProperties,omitempty"` // Location of published content. ContentLocation NullableString `json:"ContentLocation,omitempty"` // Name of the application. Only seen by administrators. - Name string `json:"Name"` + Name NullableString `json:"Name,omitempty"` // The name seen by end users who have access to the application. - PublishedName string `json:"PublishedName"` + PublishedName NullableString `json:"PublishedName,omitempty"` // The metadata of application. Metadata []NameValueStringPairModel `json:"Metadata,omitempty"` // Indicates whether or not this application is visible to users. - Visible bool `json:"Visible"` - SharingKind SharingKind `json:"SharingKind"` + Visible *bool `json:"Visible,omitempty"` + SharingKind *SharingKind `json:"SharingKind,omitempty"` // Tags associated with this application. Tags []string `json:"Tags,omitempty"` // The tenant(s) that the application is assigned to. If `null`, the application is not assigned to any tenants, and may be used by any tenant. @@ -75,19 +75,8 @@ type ApplicationResponseModel struct { // This constructor will assign default values to properties that have it defined, // and makes sure properties required by API are set, but the set of arguments // will change when the set of required properties is changed -func NewApplicationResponseModel(id string, applicationFolder RefResponseModel, applicationType ApplicationType, packagedApplicationType PackagedApplicationType, containerScopes []ContainerScopeResponseModel, enabled bool, iconId string, name string, publishedName string, visible bool, sharingKind SharingKind) *ApplicationResponseModel { +func NewApplicationResponseModel() *ApplicationResponseModel { this := ApplicationResponseModel{} - this.Id = id - this.ApplicationFolder = applicationFolder - this.ApplicationType = applicationType - this.PackagedApplicationType = packagedApplicationType - this.ContainerScopes = containerScopes - this.Enabled = enabled - this.IconId = iconId - this.Name = name - this.PublishedName = publishedName - this.Visible = visible - this.SharingKind = sharingKind return &this } @@ -99,28 +88,46 @@ func NewApplicationResponseModelWithDefaults() *ApplicationResponseModel { return &this } -// GetId returns the Id field value +// GetId returns the Id field value if set, zero value otherwise (both if not set or set to explicit null). func (o *ApplicationResponseModel) GetId() string { - if o == nil { + if o == nil || IsNil(o.Id.Get()) { var ret string return ret } - - return o.Id + return *o.Id.Get() } -// GetIdOk returns a tuple with the Id field value +// GetIdOk returns a tuple with the Id field value if set, nil otherwise // and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned func (o *ApplicationResponseModel) GetIdOk() (*string, bool) { if o == nil { return nil, false } - return &o.Id, true + return o.Id.Get(), o.Id.IsSet() +} + +// HasId returns a boolean if a field has been set. +func (o *ApplicationResponseModel) HasId() bool { + if o != nil && o.Id.IsSet() { + return true + } + + return false } -// SetId sets field value +// SetId gets a reference to the given NullableString and assigns it to the Id field. func (o *ApplicationResponseModel) SetId(v string) { - o.Id = v + o.Id.Set(&v) +} +// SetIdNil sets the value for Id to be an explicit nil +func (o *ApplicationResponseModel) SetIdNil() { + o.Id.Set(nil) +} + +// UnsetId ensures that no value is present for Id, not even an explicit nil +func (o *ApplicationResponseModel) UnsetId() { + o.Id.Unset() } // GetUid returns the Uid field value if set, zero value otherwise (both if not set or set to explicit null). @@ -168,76 +175,100 @@ func (o *ApplicationResponseModel) UnsetUid() { o.Uid.Unset() } -// GetApplicationFolder returns the ApplicationFolder field value +// GetApplicationFolder returns the ApplicationFolder field value if set, zero value otherwise. func (o *ApplicationResponseModel) GetApplicationFolder() RefResponseModel { - if o == nil { + if o == nil || IsNil(o.ApplicationFolder) { var ret RefResponseModel return ret } - - return o.ApplicationFolder + return *o.ApplicationFolder } -// GetApplicationFolderOk returns a tuple with the ApplicationFolder field value +// GetApplicationFolderOk returns a tuple with the ApplicationFolder field value if set, nil otherwise // and a boolean to check if the value has been set. func (o *ApplicationResponseModel) GetApplicationFolderOk() (*RefResponseModel, bool) { - if o == nil { + if o == nil || IsNil(o.ApplicationFolder) { return nil, false } - return &o.ApplicationFolder, true + return o.ApplicationFolder, true } -// SetApplicationFolder sets field value +// HasApplicationFolder returns a boolean if a field has been set. +func (o *ApplicationResponseModel) HasApplicationFolder() bool { + if o != nil && !IsNil(o.ApplicationFolder) { + return true + } + + return false +} + +// SetApplicationFolder gets a reference to the given RefResponseModel and assigns it to the ApplicationFolder field. func (o *ApplicationResponseModel) SetApplicationFolder(v RefResponseModel) { - o.ApplicationFolder = v + o.ApplicationFolder = &v } -// GetApplicationType returns the ApplicationType field value +// GetApplicationType returns the ApplicationType field value if set, zero value otherwise. func (o *ApplicationResponseModel) GetApplicationType() ApplicationType { - if o == nil { + if o == nil || IsNil(o.ApplicationType) { var ret ApplicationType return ret } - - return o.ApplicationType + return *o.ApplicationType } -// GetApplicationTypeOk returns a tuple with the ApplicationType field value +// GetApplicationTypeOk returns a tuple with the ApplicationType field value if set, nil otherwise // and a boolean to check if the value has been set. func (o *ApplicationResponseModel) GetApplicationTypeOk() (*ApplicationType, bool) { - if o == nil { + if o == nil || IsNil(o.ApplicationType) { return nil, false } - return &o.ApplicationType, true + return o.ApplicationType, true } -// SetApplicationType sets field value +// HasApplicationType returns a boolean if a field has been set. +func (o *ApplicationResponseModel) HasApplicationType() bool { + if o != nil && !IsNil(o.ApplicationType) { + return true + } + + return false +} + +// SetApplicationType gets a reference to the given ApplicationType and assigns it to the ApplicationType field. func (o *ApplicationResponseModel) SetApplicationType(v ApplicationType) { - o.ApplicationType = v + o.ApplicationType = &v } -// GetPackagedApplicationType returns the PackagedApplicationType field value +// GetPackagedApplicationType returns the PackagedApplicationType field value if set, zero value otherwise. func (o *ApplicationResponseModel) GetPackagedApplicationType() PackagedApplicationType { - if o == nil { + if o == nil || IsNil(o.PackagedApplicationType) { var ret PackagedApplicationType return ret } - - return o.PackagedApplicationType + return *o.PackagedApplicationType } -// GetPackagedApplicationTypeOk returns a tuple with the PackagedApplicationType field value +// GetPackagedApplicationTypeOk returns a tuple with the PackagedApplicationType field value if set, nil otherwise // and a boolean to check if the value has been set. func (o *ApplicationResponseModel) GetPackagedApplicationTypeOk() (*PackagedApplicationType, bool) { - if o == nil { + if o == nil || IsNil(o.PackagedApplicationType) { return nil, false } - return &o.PackagedApplicationType, true + return o.PackagedApplicationType, true +} + +// HasPackagedApplicationType returns a boolean if a field has been set. +func (o *ApplicationResponseModel) HasPackagedApplicationType() bool { + if o != nil && !IsNil(o.PackagedApplicationType) { + return true + } + + return false } -// SetPackagedApplicationType sets field value +// SetPackagedApplicationType gets a reference to the given PackagedApplicationType and assigns it to the PackagedApplicationType field. func (o *ApplicationResponseModel) SetPackagedApplicationType(v PackagedApplicationType) { - o.PackagedApplicationType = v + o.PackagedApplicationType = &v } // GetClientFolder returns the ClientFolder field value if set, zero value otherwise (both if not set or set to explicit null). @@ -282,26 +313,35 @@ func (o *ApplicationResponseModel) UnsetClientFolder() { o.ClientFolder.Unset() } -// GetContainerScopes returns the ContainerScopes field value +// GetContainerScopes returns the ContainerScopes field value if set, zero value otherwise (both if not set or set to explicit null). func (o *ApplicationResponseModel) GetContainerScopes() []ContainerScopeResponseModel { if o == nil { var ret []ContainerScopeResponseModel return ret } - return o.ContainerScopes } -// GetContainerScopesOk returns a tuple with the ContainerScopes field value +// GetContainerScopesOk returns a tuple with the ContainerScopes field value if set, nil otherwise // and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned func (o *ApplicationResponseModel) GetContainerScopesOk() ([]ContainerScopeResponseModel, bool) { - if o == nil { + if o == nil || IsNil(o.ContainerScopes) { return nil, false } return o.ContainerScopes, true } -// SetContainerScopes sets field value +// HasContainerScopes returns a boolean if a field has been set. +func (o *ApplicationResponseModel) HasContainerScopes() bool { + if o != nil && IsNil(o.ContainerScopes) { + return true + } + + return false +} + +// SetContainerScopes gets a reference to the given []ContainerScopeResponseModel and assigns it to the ContainerScopes field. func (o *ApplicationResponseModel) SetContainerScopes(v []ContainerScopeResponseModel) { o.ContainerScopes = v } @@ -380,52 +420,78 @@ func (o *ApplicationResponseModel) SetDoNotEnumerate(v bool) { o.DoNotEnumerate = &v } -// GetEnabled returns the Enabled field value +// GetEnabled returns the Enabled field value if set, zero value otherwise. func (o *ApplicationResponseModel) GetEnabled() bool { - if o == nil { + if o == nil || IsNil(o.Enabled) { var ret bool return ret } - - return o.Enabled + return *o.Enabled } -// GetEnabledOk returns a tuple with the Enabled field value +// GetEnabledOk returns a tuple with the Enabled field value if set, nil otherwise // and a boolean to check if the value has been set. func (o *ApplicationResponseModel) GetEnabledOk() (*bool, bool) { - if o == nil { + if o == nil || IsNil(o.Enabled) { return nil, false } - return &o.Enabled, true + return o.Enabled, true } -// SetEnabled sets field value +// HasEnabled returns a boolean if a field has been set. +func (o *ApplicationResponseModel) HasEnabled() bool { + if o != nil && !IsNil(o.Enabled) { + return true + } + + return false +} + +// SetEnabled gets a reference to the given bool and assigns it to the Enabled field. func (o *ApplicationResponseModel) SetEnabled(v bool) { - o.Enabled = v + o.Enabled = &v } -// GetIconId returns the IconId field value +// GetIconId returns the IconId field value if set, zero value otherwise (both if not set or set to explicit null). func (o *ApplicationResponseModel) GetIconId() string { - if o == nil { + if o == nil || IsNil(o.IconId.Get()) { var ret string return ret } - - return o.IconId + return *o.IconId.Get() } -// GetIconIdOk returns a tuple with the IconId field value +// GetIconIdOk returns a tuple with the IconId field value if set, nil otherwise // and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned func (o *ApplicationResponseModel) GetIconIdOk() (*string, bool) { if o == nil { return nil, false } - return &o.IconId, true + return o.IconId.Get(), o.IconId.IsSet() +} + +// HasIconId returns a boolean if a field has been set. +func (o *ApplicationResponseModel) HasIconId() bool { + if o != nil && o.IconId.IsSet() { + return true + } + + return false } -// SetIconId sets field value +// SetIconId gets a reference to the given NullableString and assigns it to the IconId field. func (o *ApplicationResponseModel) SetIconId(v string) { - o.IconId = v + o.IconId.Set(&v) +} +// SetIconIdNil sets the value for IconId to be an explicit nil +func (o *ApplicationResponseModel) SetIconIdNil() { + o.IconId.Set(nil) +} + +// UnsetIconId ensures that no value is present for IconId, not even an explicit nil +func (o *ApplicationResponseModel) UnsetIconId() { + o.IconId.Unset() } // GetInstalledAppProperties returns the InstalledAppProperties field value if set, zero value otherwise. @@ -566,52 +632,88 @@ func (o *ApplicationResponseModel) UnsetContentLocation() { o.ContentLocation.Unset() } -// GetName returns the Name field value +// GetName returns the Name field value if set, zero value otherwise (both if not set or set to explicit null). func (o *ApplicationResponseModel) GetName() string { - if o == nil { + if o == nil || IsNil(o.Name.Get()) { var ret string return ret } - - return o.Name + return *o.Name.Get() } -// GetNameOk returns a tuple with the Name field value +// GetNameOk returns a tuple with the Name field value if set, nil otherwise // and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned func (o *ApplicationResponseModel) GetNameOk() (*string, bool) { if o == nil { return nil, false } - return &o.Name, true + return o.Name.Get(), o.Name.IsSet() } -// SetName sets field value +// HasName returns a boolean if a field has been set. +func (o *ApplicationResponseModel) HasName() bool { + if o != nil && o.Name.IsSet() { + return true + } + + return false +} + +// SetName gets a reference to the given NullableString and assigns it to the Name field. func (o *ApplicationResponseModel) SetName(v string) { - o.Name = v + o.Name.Set(&v) +} +// SetNameNil sets the value for Name to be an explicit nil +func (o *ApplicationResponseModel) SetNameNil() { + o.Name.Set(nil) +} + +// UnsetName ensures that no value is present for Name, not even an explicit nil +func (o *ApplicationResponseModel) UnsetName() { + o.Name.Unset() } -// GetPublishedName returns the PublishedName field value +// GetPublishedName returns the PublishedName field value if set, zero value otherwise (both if not set or set to explicit null). func (o *ApplicationResponseModel) GetPublishedName() string { - if o == nil { + if o == nil || IsNil(o.PublishedName.Get()) { var ret string return ret } - - return o.PublishedName + return *o.PublishedName.Get() } -// GetPublishedNameOk returns a tuple with the PublishedName field value +// GetPublishedNameOk returns a tuple with the PublishedName field value if set, nil otherwise // and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned func (o *ApplicationResponseModel) GetPublishedNameOk() (*string, bool) { if o == nil { return nil, false } - return &o.PublishedName, true + return o.PublishedName.Get(), o.PublishedName.IsSet() } -// SetPublishedName sets field value +// HasPublishedName returns a boolean if a field has been set. +func (o *ApplicationResponseModel) HasPublishedName() bool { + if o != nil && o.PublishedName.IsSet() { + return true + } + + return false +} + +// SetPublishedName gets a reference to the given NullableString and assigns it to the PublishedName field. func (o *ApplicationResponseModel) SetPublishedName(v string) { - o.PublishedName = v + o.PublishedName.Set(&v) +} +// SetPublishedNameNil sets the value for PublishedName to be an explicit nil +func (o *ApplicationResponseModel) SetPublishedNameNil() { + o.PublishedName.Set(nil) +} + +// UnsetPublishedName ensures that no value is present for PublishedName, not even an explicit nil +func (o *ApplicationResponseModel) UnsetPublishedName() { + o.PublishedName.Unset() } // GetMetadata returns the Metadata field value if set, zero value otherwise (both if not set or set to explicit null). @@ -647,52 +749,68 @@ func (o *ApplicationResponseModel) SetMetadata(v []NameValueStringPairModel) { o.Metadata = v } -// GetVisible returns the Visible field value +// GetVisible returns the Visible field value if set, zero value otherwise. func (o *ApplicationResponseModel) GetVisible() bool { - if o == nil { + if o == nil || IsNil(o.Visible) { var ret bool return ret } - - return o.Visible + return *o.Visible } -// GetVisibleOk returns a tuple with the Visible field value +// GetVisibleOk returns a tuple with the Visible field value if set, nil otherwise // and a boolean to check if the value has been set. func (o *ApplicationResponseModel) GetVisibleOk() (*bool, bool) { - if o == nil { + if o == nil || IsNil(o.Visible) { return nil, false } - return &o.Visible, true + return o.Visible, true } -// SetVisible sets field value +// HasVisible returns a boolean if a field has been set. +func (o *ApplicationResponseModel) HasVisible() bool { + if o != nil && !IsNil(o.Visible) { + return true + } + + return false +} + +// SetVisible gets a reference to the given bool and assigns it to the Visible field. func (o *ApplicationResponseModel) SetVisible(v bool) { - o.Visible = v + o.Visible = &v } -// GetSharingKind returns the SharingKind field value +// GetSharingKind returns the SharingKind field value if set, zero value otherwise. func (o *ApplicationResponseModel) GetSharingKind() SharingKind { - if o == nil { + if o == nil || IsNil(o.SharingKind) { var ret SharingKind return ret } - - return o.SharingKind + return *o.SharingKind } -// GetSharingKindOk returns a tuple with the SharingKind field value +// GetSharingKindOk returns a tuple with the SharingKind field value if set, nil otherwise // and a boolean to check if the value has been set. func (o *ApplicationResponseModel) GetSharingKindOk() (*SharingKind, bool) { - if o == nil { + if o == nil || IsNil(o.SharingKind) { return nil, false } - return &o.SharingKind, true + return o.SharingKind, true +} + +// HasSharingKind returns a boolean if a field has been set. +func (o *ApplicationResponseModel) HasSharingKind() bool { + if o != nil && !IsNil(o.SharingKind) { + return true + } + + return false } -// SetSharingKind sets field value +// SetSharingKind gets a reference to the given SharingKind and assigns it to the SharingKind field. func (o *ApplicationResponseModel) SetSharingKind(v SharingKind) { - o.SharingKind = v + o.SharingKind = &v } // GetTags returns the Tags field value if set, zero value otherwise (both if not set or set to explicit null). @@ -975,25 +1093,39 @@ func (o ApplicationResponseModel) MarshalJSON() ([]byte, error) { func (o ApplicationResponseModel) ToMap() (map[string]interface{}, error) { toSerialize := map[string]interface{}{} - toSerialize["Id"] = o.Id + if o.Id.IsSet() { + toSerialize["Id"] = o.Id.Get() + } if o.Uid.IsSet() { toSerialize["Uid"] = o.Uid.Get() } - toSerialize["ApplicationFolder"] = o.ApplicationFolder - toSerialize["ApplicationType"] = o.ApplicationType - toSerialize["PackagedApplicationType"] = o.PackagedApplicationType + if !IsNil(o.ApplicationFolder) { + toSerialize["ApplicationFolder"] = o.ApplicationFolder + } + if !IsNil(o.ApplicationType) { + toSerialize["ApplicationType"] = o.ApplicationType + } + if !IsNil(o.PackagedApplicationType) { + toSerialize["PackagedApplicationType"] = o.PackagedApplicationType + } if o.ClientFolder.IsSet() { toSerialize["ClientFolder"] = o.ClientFolder.Get() } - toSerialize["ContainerScopes"] = o.ContainerScopes + if o.ContainerScopes != nil { + toSerialize["ContainerScopes"] = o.ContainerScopes + } if o.Description.IsSet() { toSerialize["Description"] = o.Description.Get() } if !IsNil(o.DoNotEnumerate) { toSerialize["DoNotEnumerate"] = o.DoNotEnumerate } - toSerialize["Enabled"] = o.Enabled - toSerialize["IconId"] = o.IconId + if !IsNil(o.Enabled) { + toSerialize["Enabled"] = o.Enabled + } + if o.IconId.IsSet() { + toSerialize["IconId"] = o.IconId.Get() + } if !IsNil(o.InstalledAppProperties) { toSerialize["InstalledAppProperties"] = o.InstalledAppProperties } @@ -1006,13 +1138,21 @@ func (o ApplicationResponseModel) ToMap() (map[string]interface{}, error) { if o.ContentLocation.IsSet() { toSerialize["ContentLocation"] = o.ContentLocation.Get() } - toSerialize["Name"] = o.Name - toSerialize["PublishedName"] = o.PublishedName + if o.Name.IsSet() { + toSerialize["Name"] = o.Name.Get() + } + if o.PublishedName.IsSet() { + toSerialize["PublishedName"] = o.PublishedName.Get() + } if o.Metadata != nil { toSerialize["Metadata"] = o.Metadata } - toSerialize["Visible"] = o.Visible - toSerialize["SharingKind"] = o.SharingKind + if !IsNil(o.Visible) { + toSerialize["Visible"] = o.Visible + } + if !IsNil(o.SharingKind) { + toSerialize["SharingKind"] = o.SharingKind + } if o.Tags != nil { toSerialize["Tags"] = o.Tags } diff --git a/citrixorchestration/model_application_type.go b/citrixorchestration/model_application_type.go index 094445b..a1d844b 100644 --- a/citrixorchestration/model_application_type.go +++ b/citrixorchestration/model_application_type.go @@ -29,6 +29,7 @@ const ( APPLICATIONTYPE_APP_LIBRARY_APP_V ApplicationType = "AppLibraryAppV" APPLICATIONTYPE_MSIX ApplicationType = "Msix" APPLICATIONTYPE_APP_ATTACH ApplicationType = "AppAttach" + APPLICATIONTYPE_FLEX_APP ApplicationType = "FlexApp" APPLICATIONTYPE_PACKAGED_APPLICATION ApplicationType = "PackagedApplication" ) @@ -43,6 +44,7 @@ var AllowedApplicationTypeEnumValues = []ApplicationType{ "AppLibraryAppV", "Msix", "AppAttach", + "FlexApp", "PackagedApplication", } diff --git a/citrixorchestration/model_backup_restore_status_request_model.go b/citrixorchestration/model_backup_restore_status_request_model.go index 9b423b6..ff8b670 100644 --- a/citrixorchestration/model_backup_restore_status_request_model.go +++ b/citrixorchestration/model_backup_restore_status_request_model.go @@ -62,6 +62,8 @@ type BackupRestoreStatusRequestModel struct { RestoreDetails []BackupRestoreRestoreSingleMemberModel `json:"RestoreDetails,omitempty"` // Simple Results (such as Get backed up member names) SimpleResults []string `json:"SimpleResults,omitempty"` + // Fixups from backups or restores + Fixups NullableString `json:"Fixups,omitempty"` RestoreType *BackupRestoreRestoreTypes `json:"RestoreType,omitempty"` } @@ -829,6 +831,48 @@ func (o *BackupRestoreStatusRequestModel) SetSimpleResults(v []string) { o.SimpleResults = v } +// GetFixups returns the Fixups field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *BackupRestoreStatusRequestModel) GetFixups() string { + if o == nil || IsNil(o.Fixups.Get()) { + var ret string + return ret + } + return *o.Fixups.Get() +} + +// GetFixupsOk returns a tuple with the Fixups field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *BackupRestoreStatusRequestModel) GetFixupsOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.Fixups.Get(), o.Fixups.IsSet() +} + +// HasFixups returns a boolean if a field has been set. +func (o *BackupRestoreStatusRequestModel) HasFixups() bool { + if o != nil && o.Fixups.IsSet() { + return true + } + + return false +} + +// SetFixups gets a reference to the given NullableString and assigns it to the Fixups field. +func (o *BackupRestoreStatusRequestModel) SetFixups(v string) { + o.Fixups.Set(&v) +} +// SetFixupsNil sets the value for Fixups to be an explicit nil +func (o *BackupRestoreStatusRequestModel) SetFixupsNil() { + o.Fixups.Set(nil) +} + +// UnsetFixups ensures that no value is present for Fixups, not even an explicit nil +func (o *BackupRestoreStatusRequestModel) UnsetFixups() { + o.Fixups.Unset() +} + // GetRestoreType returns the RestoreType field value if set, zero value otherwise. func (o *BackupRestoreStatusRequestModel) GetRestoreType() BackupRestoreRestoreTypes { if o == nil || IsNil(o.RestoreType) { @@ -928,6 +972,9 @@ func (o BackupRestoreStatusRequestModel) ToMap() (map[string]interface{}, error) if o.SimpleResults != nil { toSerialize["SimpleResults"] = o.SimpleResults } + if o.Fixups.IsSet() { + toSerialize["Fixups"] = o.Fixups.Get() + } if !IsNil(o.RestoreType) { toSerialize["RestoreType"] = o.RestoreType } diff --git a/citrixorchestration/model_collection_model_of_provisioned_virtual_machine_search_response_model.go b/citrixorchestration/model_collection_model_of_provisioned_virtual_machine_search_response_model.go new file mode 100644 index 0000000..0baf3e1 --- /dev/null +++ b/citrixorchestration/model_collection_model_of_provisioned_virtual_machine_search_response_model.go @@ -0,0 +1,212 @@ +/* +Citrix Virtual Apps and Desktops Rest API for Developer Portal + +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + +API version: devportal-onprem-ga +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package citrixorchestration + +import ( + "encoding/json" +) + +// checks if the CollectionModelOfProvisionedVirtualMachineSearchResponseModel type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &CollectionModelOfProvisionedVirtualMachineSearchResponseModel{} + +// CollectionModelOfProvisionedVirtualMachineSearchResponseModel Response object for collections of items. +type CollectionModelOfProvisionedVirtualMachineSearchResponseModel struct { + // List of items. + Items []ProvisionedVirtualMachineSearchResponseModel `json:"Items"` + // If present, indicates to the caller that the query was not complete, and they should call the API again specifying the continuation token as a query parameter. + ContinuationToken NullableString `json:"ContinuationToken,omitempty"` + // Indicates the total number of items in the collection, which may be more than the number of Items returned, if there is a ContinuationToken. Only returned in the response to `$search` APIs. + TotalItems NullableInt32 `json:"TotalItems,omitempty"` +} + +// NewCollectionModelOfProvisionedVirtualMachineSearchResponseModel instantiates a new CollectionModelOfProvisionedVirtualMachineSearchResponseModel object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewCollectionModelOfProvisionedVirtualMachineSearchResponseModel(items []ProvisionedVirtualMachineSearchResponseModel) *CollectionModelOfProvisionedVirtualMachineSearchResponseModel { + this := CollectionModelOfProvisionedVirtualMachineSearchResponseModel{} + this.Items = items + return &this +} + +// NewCollectionModelOfProvisionedVirtualMachineSearchResponseModelWithDefaults instantiates a new CollectionModelOfProvisionedVirtualMachineSearchResponseModel object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewCollectionModelOfProvisionedVirtualMachineSearchResponseModelWithDefaults() *CollectionModelOfProvisionedVirtualMachineSearchResponseModel { + this := CollectionModelOfProvisionedVirtualMachineSearchResponseModel{} + return &this +} + +// GetItems returns the Items field value +func (o *CollectionModelOfProvisionedVirtualMachineSearchResponseModel) GetItems() []ProvisionedVirtualMachineSearchResponseModel { + if o == nil { + var ret []ProvisionedVirtualMachineSearchResponseModel + return ret + } + + return o.Items +} + +// GetItemsOk returns a tuple with the Items field value +// and a boolean to check if the value has been set. +func (o *CollectionModelOfProvisionedVirtualMachineSearchResponseModel) GetItemsOk() ([]ProvisionedVirtualMachineSearchResponseModel, bool) { + if o == nil { + return nil, false + } + return o.Items, true +} + +// SetItems sets field value +func (o *CollectionModelOfProvisionedVirtualMachineSearchResponseModel) SetItems(v []ProvisionedVirtualMachineSearchResponseModel) { + o.Items = v +} + +// GetContinuationToken returns the ContinuationToken field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *CollectionModelOfProvisionedVirtualMachineSearchResponseModel) GetContinuationToken() string { + if o == nil || IsNil(o.ContinuationToken.Get()) { + var ret string + return ret + } + return *o.ContinuationToken.Get() +} + +// GetContinuationTokenOk returns a tuple with the ContinuationToken field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *CollectionModelOfProvisionedVirtualMachineSearchResponseModel) GetContinuationTokenOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.ContinuationToken.Get(), o.ContinuationToken.IsSet() +} + +// HasContinuationToken returns a boolean if a field has been set. +func (o *CollectionModelOfProvisionedVirtualMachineSearchResponseModel) HasContinuationToken() bool { + if o != nil && o.ContinuationToken.IsSet() { + return true + } + + return false +} + +// SetContinuationToken gets a reference to the given NullableString and assigns it to the ContinuationToken field. +func (o *CollectionModelOfProvisionedVirtualMachineSearchResponseModel) SetContinuationToken(v string) { + o.ContinuationToken.Set(&v) +} +// SetContinuationTokenNil sets the value for ContinuationToken to be an explicit nil +func (o *CollectionModelOfProvisionedVirtualMachineSearchResponseModel) SetContinuationTokenNil() { + o.ContinuationToken.Set(nil) +} + +// UnsetContinuationToken ensures that no value is present for ContinuationToken, not even an explicit nil +func (o *CollectionModelOfProvisionedVirtualMachineSearchResponseModel) UnsetContinuationToken() { + o.ContinuationToken.Unset() +} + +// GetTotalItems returns the TotalItems field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *CollectionModelOfProvisionedVirtualMachineSearchResponseModel) GetTotalItems() int32 { + if o == nil || IsNil(o.TotalItems.Get()) { + var ret int32 + return ret + } + return *o.TotalItems.Get() +} + +// GetTotalItemsOk returns a tuple with the TotalItems field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *CollectionModelOfProvisionedVirtualMachineSearchResponseModel) GetTotalItemsOk() (*int32, bool) { + if o == nil { + return nil, false + } + return o.TotalItems.Get(), o.TotalItems.IsSet() +} + +// HasTotalItems returns a boolean if a field has been set. +func (o *CollectionModelOfProvisionedVirtualMachineSearchResponseModel) HasTotalItems() bool { + if o != nil && o.TotalItems.IsSet() { + return true + } + + return false +} + +// SetTotalItems gets a reference to the given NullableInt32 and assigns it to the TotalItems field. +func (o *CollectionModelOfProvisionedVirtualMachineSearchResponseModel) SetTotalItems(v int32) { + o.TotalItems.Set(&v) +} +// SetTotalItemsNil sets the value for TotalItems to be an explicit nil +func (o *CollectionModelOfProvisionedVirtualMachineSearchResponseModel) SetTotalItemsNil() { + o.TotalItems.Set(nil) +} + +// UnsetTotalItems ensures that no value is present for TotalItems, not even an explicit nil +func (o *CollectionModelOfProvisionedVirtualMachineSearchResponseModel) UnsetTotalItems() { + o.TotalItems.Unset() +} + +func (o CollectionModelOfProvisionedVirtualMachineSearchResponseModel) MarshalJSON() ([]byte, error) { + toSerialize,err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o CollectionModelOfProvisionedVirtualMachineSearchResponseModel) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + toSerialize["Items"] = o.Items + if o.ContinuationToken.IsSet() { + toSerialize["ContinuationToken"] = o.ContinuationToken.Get() + } + if o.TotalItems.IsSet() { + toSerialize["TotalItems"] = o.TotalItems.Get() + } + return toSerialize, nil +} + +type NullableCollectionModelOfProvisionedVirtualMachineSearchResponseModel struct { + value *CollectionModelOfProvisionedVirtualMachineSearchResponseModel + isSet bool +} + +func (v NullableCollectionModelOfProvisionedVirtualMachineSearchResponseModel) Get() *CollectionModelOfProvisionedVirtualMachineSearchResponseModel { + return v.value +} + +func (v *NullableCollectionModelOfProvisionedVirtualMachineSearchResponseModel) Set(val *CollectionModelOfProvisionedVirtualMachineSearchResponseModel) { + v.value = val + v.isSet = true +} + +func (v NullableCollectionModelOfProvisionedVirtualMachineSearchResponseModel) IsSet() bool { + return v.isSet +} + +func (v *NullableCollectionModelOfProvisionedVirtualMachineSearchResponseModel) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableCollectionModelOfProvisionedVirtualMachineSearchResponseModel(val *CollectionModelOfProvisionedVirtualMachineSearchResponseModel) *NullableCollectionModelOfProvisionedVirtualMachineSearchResponseModel { + return &NullableCollectionModelOfProvisionedVirtualMachineSearchResponseModel{value: val, isSet: true} +} + +func (v NullableCollectionModelOfProvisionedVirtualMachineSearchResponseModel) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableCollectionModelOfProvisionedVirtualMachineSearchResponseModel) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/citrixorchestration/model_controller_service_type.go b/citrixorchestration/model_controller_service_type.go index 946ed96..2dc5505 100644 --- a/citrixorchestration/model_controller_service_type.go +++ b/citrixorchestration/model_controller_service_type.go @@ -33,11 +33,13 @@ const ( CONTROLLERSERVICETYPE_ORCH ControllerServiceType = "Orch" CONTROLLERSERVICETYPE_TRUST ControllerServiceType = "Trust" CONTROLLERSERVICETYPE_APP_V ControllerServiceType = "AppV" + CONTROLLERSERVICETYPE_VUS ControllerServiceType = "Vus" CONTROLLERSERVICETYPE_CONFIG ControllerServiceType = "Config" CONTROLLERSERVICETYPE_LOG ControllerServiceType = "Log" CONTROLLERSERVICETYPE_ANALYTICS ControllerServiceType = "Analytics" CONTROLLERSERVICETYPE_ADMIN ControllerServiceType = "Admin" CONTROLLERSERVICETYPE_APP_LIB ControllerServiceType = "AppLib" + CONTROLLERSERVICETYPE_IDENTITY ControllerServiceType = "Identity" ) // All allowed values of ControllerServiceType enum @@ -55,11 +57,13 @@ var AllowedControllerServiceTypeEnumValues = []ControllerServiceType{ "Orch", "Trust", "AppV", + "Vus", "Config", "Log", "Analytics", "Admin", "AppLib", + "Identity", } func (v *ControllerServiceType) UnmarshalJSON(src []byte) error { diff --git a/citrixorchestration/model_edit_app_lib_package_discovery_profile_request_model.go b/citrixorchestration/model_edit_app_lib_package_discovery_profile_request_model.go index 009de67..25c7e85 100644 --- a/citrixorchestration/model_edit_app_lib_package_discovery_profile_request_model.go +++ b/citrixorchestration/model_edit_app_lib_package_discovery_profile_request_model.go @@ -42,6 +42,8 @@ type EditAppLibPackageDiscoveryProfileRequestModel struct { DiscoverMsix NullableBool `json:"DiscoverMsix,omitempty"` // A value indicating whether or not to search should discover AppAttach Packages. DiscoverAppAttach NullableBool `json:"DiscoverAppAttach,omitempty"` + // A value indicating whether or not to search should discover FlexApp Packages. + DiscoverFlexApp NullableBool `json:"DiscoverFlexApp,omitempty"` // A value indicating whether or not the discovery should run automatically. AutomateDiscovery NullableBool `json:"AutomateDiscovery,omitempty"` AutoDiscoveryPeriod *AutoDiscoveryPeriod `json:"AutoDiscoveryPeriod,omitempty"` @@ -560,6 +562,48 @@ func (o *EditAppLibPackageDiscoveryProfileRequestModel) UnsetDiscoverAppAttach() o.DiscoverAppAttach.Unset() } +// GetDiscoverFlexApp returns the DiscoverFlexApp field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *EditAppLibPackageDiscoveryProfileRequestModel) GetDiscoverFlexApp() bool { + if o == nil || IsNil(o.DiscoverFlexApp.Get()) { + var ret bool + return ret + } + return *o.DiscoverFlexApp.Get() +} + +// GetDiscoverFlexAppOk returns a tuple with the DiscoverFlexApp field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *EditAppLibPackageDiscoveryProfileRequestModel) GetDiscoverFlexAppOk() (*bool, bool) { + if o == nil { + return nil, false + } + return o.DiscoverFlexApp.Get(), o.DiscoverFlexApp.IsSet() +} + +// HasDiscoverFlexApp returns a boolean if a field has been set. +func (o *EditAppLibPackageDiscoveryProfileRequestModel) HasDiscoverFlexApp() bool { + if o != nil && o.DiscoverFlexApp.IsSet() { + return true + } + + return false +} + +// SetDiscoverFlexApp gets a reference to the given NullableBool and assigns it to the DiscoverFlexApp field. +func (o *EditAppLibPackageDiscoveryProfileRequestModel) SetDiscoverFlexApp(v bool) { + o.DiscoverFlexApp.Set(&v) +} +// SetDiscoverFlexAppNil sets the value for DiscoverFlexApp to be an explicit nil +func (o *EditAppLibPackageDiscoveryProfileRequestModel) SetDiscoverFlexAppNil() { + o.DiscoverFlexApp.Set(nil) +} + +// UnsetDiscoverFlexApp ensures that no value is present for DiscoverFlexApp, not even an explicit nil +func (o *EditAppLibPackageDiscoveryProfileRequestModel) UnsetDiscoverFlexApp() { + o.DiscoverFlexApp.Unset() +} + // GetAutomateDiscovery returns the AutomateDiscovery field value if set, zero value otherwise (both if not set or set to explicit null). func (o *EditAppLibPackageDiscoveryProfileRequestModel) GetAutomateDiscovery() bool { if o == nil || IsNil(o.AutomateDiscovery.Get()) { @@ -722,6 +766,9 @@ func (o EditAppLibPackageDiscoveryProfileRequestModel) ToMap() (map[string]inter if o.DiscoverAppAttach.IsSet() { toSerialize["DiscoverAppAttach"] = o.DiscoverAppAttach.Get() } + if o.DiscoverFlexApp.IsSet() { + toSerialize["DiscoverFlexApp"] = o.DiscoverFlexApp.Get() + } if o.AutomateDiscovery.IsSet() { toSerialize["AutomateDiscovery"] = o.AutomateDiscovery.Get() } diff --git a/citrixorchestration/model_hypervisor_resource_search_resource_type.go b/citrixorchestration/model_hypervisor_resource_search_resource_type.go index e948523..137f0f7 100644 --- a/citrixorchestration/model_hypervisor_resource_search_resource_type.go +++ b/citrixorchestration/model_hypervisor_resource_search_resource_type.go @@ -23,6 +23,7 @@ const ( HYPERVISORRESOURCESEARCHRESOURCETYPE_TEMPLATE HypervisorResourceSearchResourceType = "Template" HYPERVISORRESOURCESEARCHRESOURCETYPE_VM HypervisorResourceSearchResourceType = "Vm" HYPERVISORRESOURCESEARCHRESOURCETYPE_LAUNCH_TEMPLATE_VERSION HypervisorResourceSearchResourceType = "LaunchTemplateVersion" + HYPERVISORRESOURCESEARCHRESOURCETYPE_FOLDER HypervisorResourceSearchResourceType = "Folder" ) // All allowed values of HypervisorResourceSearchResourceType enum @@ -30,6 +31,7 @@ var AllowedHypervisorResourceSearchResourceTypeEnumValues = []HypervisorResource "Template", "Vm", "LaunchTemplateVersion", + "Folder", } func (v *HypervisorResourceSearchResourceType) UnmarshalJSON(src []byte) error { diff --git a/citrixorchestration/model_job_type.go b/citrixorchestration/model_job_type.go index 8bf2649..8928987 100644 --- a/citrixorchestration/model_job_type.go +++ b/citrixorchestration/model_job_type.go @@ -263,6 +263,8 @@ const ( JOBTYPE_REPAIR_MACHINE_CATALOG_ACCOUNTS JobType = "RepairMachineCatalogAccounts" JOBTYPE_IMPORT_PROVISIONED_VIRTUAL_MACHINES JobType = "ImportProvisionedVirtualMachines" JOBTYPE_VALIDATE_MACHINE_CATALOG_CREATION JobType = "ValidateMachineCatalogCreation" + JOBTYPE_SEARCH_PROVISIONED_VIRTUAL_MACHINES JobType = "SearchProvisionedVirtualMachines" + JOBTYPE_GET_PROVISIONED_VIRTUAL_MACHINE_DETAILS JobType = "GetProvisionedVirtualMachineDetails" ) // All allowed values of JobType enum @@ -510,6 +512,8 @@ var AllowedJobTypeEnumValues = []JobType{ "RepairMachineCatalogAccounts", "ImportProvisionedVirtualMachines", "ValidateMachineCatalogCreation", + "SearchProvisionedVirtualMachines", + "GetProvisionedVirtualMachineDetails", } func (v *JobType) UnmarshalJSON(src []byte) error { diff --git a/citrixorchestration/model_machine_detail_response_model.go b/citrixorchestration/model_machine_detail_response_model.go index ffa33ec..f095bbf 100644 --- a/citrixorchestration/model_machine_detail_response_model.go +++ b/citrixorchestration/model_machine_detail_response_model.go @@ -155,6 +155,8 @@ type MachineDetailResponseModel struct { // Flag indicating whether the machine's configuration is out of sync with the catalog's latest configuration MachineConfigurationOutOfSync NullableBool `json:"MachineConfigurationOutOfSync,omitempty"` UpgradeDetail *MachineUpgradeDetail `json:"UpgradeDetail,omitempty"` + // The meta data of this machine. + Metadata []NameValueStringPairModel `json:"Metadata,omitempty"` // The name of the endpoint client device that the machine has been assigned to. AssignedClientName NullableString `json:"AssignedClientName,omitempty"` // The IP address of the endpoint client device that the machine has been assigned to. @@ -3240,6 +3242,39 @@ func (o *MachineDetailResponseModel) SetUpgradeDetail(v MachineUpgradeDetail) { o.UpgradeDetail = &v } +// GetMetadata returns the Metadata field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *MachineDetailResponseModel) GetMetadata() []NameValueStringPairModel { + if o == nil { + var ret []NameValueStringPairModel + return ret + } + return o.Metadata +} + +// GetMetadataOk returns a tuple with the Metadata field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *MachineDetailResponseModel) GetMetadataOk() ([]NameValueStringPairModel, bool) { + if o == nil || IsNil(o.Metadata) { + return nil, false + } + return o.Metadata, true +} + +// HasMetadata returns a boolean if a field has been set. +func (o *MachineDetailResponseModel) HasMetadata() bool { + if o != nil && IsNil(o.Metadata) { + return true + } + + return false +} + +// SetMetadata gets a reference to the given []NameValueStringPairModel and assigns it to the Metadata field. +func (o *MachineDetailResponseModel) SetMetadata(v []NameValueStringPairModel) { + o.Metadata = v +} + // GetAssignedClientName returns the AssignedClientName field value if set, zero value otherwise (both if not set or set to explicit null). func (o *MachineDetailResponseModel) GetAssignedClientName() string { if o == nil || IsNil(o.AssignedClientName.Get()) { @@ -3948,6 +3983,9 @@ func (o MachineDetailResponseModel) ToMap() (map[string]interface{}, error) { if !IsNil(o.UpgradeDetail) { toSerialize["UpgradeDetail"] = o.UpgradeDetail } + if o.Metadata != nil { + toSerialize["Metadata"] = o.Metadata + } if o.AssignedClientName.IsSet() { toSerialize["AssignedClientName"] = o.AssignedClientName.Get() } diff --git a/citrixorchestration/model_machine_response_model.go b/citrixorchestration/model_machine_response_model.go index e06dc8d..2bb179a 100644 --- a/citrixorchestration/model_machine_response_model.go +++ b/citrixorchestration/model_machine_response_model.go @@ -155,6 +155,8 @@ type MachineResponseModel struct { // Flag indicating whether the machine's configuration is out of sync with the catalog's latest configuration MachineConfigurationOutOfSync NullableBool `json:"MachineConfigurationOutOfSync,omitempty"` UpgradeDetail *MachineUpgradeDetail `json:"UpgradeDetail,omitempty"` + // The meta data of this machine. + Metadata []NameValueStringPairModel `json:"Metadata,omitempty"` } // NewMachineResponseModel instantiates a new MachineResponseModel object @@ -3213,6 +3215,39 @@ func (o *MachineResponseModel) SetUpgradeDetail(v MachineUpgradeDetail) { o.UpgradeDetail = &v } +// GetMetadata returns the Metadata field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *MachineResponseModel) GetMetadata() []NameValueStringPairModel { + if o == nil { + var ret []NameValueStringPairModel + return ret + } + return o.Metadata +} + +// GetMetadataOk returns a tuple with the Metadata field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *MachineResponseModel) GetMetadataOk() ([]NameValueStringPairModel, bool) { + if o == nil || IsNil(o.Metadata) { + return nil, false + } + return o.Metadata, true +} + +// HasMetadata returns a boolean if a field has been set. +func (o *MachineResponseModel) HasMetadata() bool { + if o != nil && IsNil(o.Metadata) { + return true + } + + return false +} + +// SetMetadata gets a reference to the given []NameValueStringPairModel and assigns it to the Metadata field. +func (o *MachineResponseModel) SetMetadata(v []NameValueStringPairModel) { + o.Metadata = v +} + func (o MachineResponseModel) MarshalJSON() ([]byte, error) { toSerialize,err := o.ToMap() if err != nil { @@ -3467,6 +3502,9 @@ func (o MachineResponseModel) ToMap() (map[string]interface{}, error) { if !IsNil(o.UpgradeDetail) { toSerialize["UpgradeDetail"] = o.UpgradeDetail } + if o.Metadata != nil { + toSerialize["Metadata"] = o.Metadata + } return toSerialize, nil } diff --git a/citrixorchestration/model_packaged_application_type.go b/citrixorchestration/model_packaged_application_type.go index a0a53ab..9f7b765 100644 --- a/citrixorchestration/model_packaged_application_type.go +++ b/citrixorchestration/model_packaged_application_type.go @@ -25,6 +25,7 @@ const ( PACKAGEDAPPLICATIONTYPE_APP_V_DUAL_ADMIN PackagedApplicationType = "AppVDualAdmin" PACKAGEDAPPLICATIONTYPE_MSIX PackagedApplicationType = "Msix" PACKAGEDAPPLICATIONTYPE_APP_ATTACH PackagedApplicationType = "AppAttach" + PACKAGEDAPPLICATIONTYPE_FLEX_APP PackagedApplicationType = "FlexApp" ) // All allowed values of PackagedApplicationType enum @@ -34,6 +35,7 @@ var AllowedPackagedApplicationTypeEnumValues = []PackagedApplicationType{ "AppVDualAdmin", "Msix", "AppAttach", + "FlexApp", } func (v *PackagedApplicationType) UnmarshalJSON(src []byte) error { diff --git a/citrixorchestration/model_provisioned_virtual_machine_custom_vm_data_response_model.go b/citrixorchestration/model_provisioned_virtual_machine_custom_vm_data_response_model.go new file mode 100644 index 0000000..d76baab --- /dev/null +++ b/citrixorchestration/model_provisioned_virtual_machine_custom_vm_data_response_model.go @@ -0,0 +1,1320 @@ +/* +Citrix Virtual Apps and Desktops Rest API for Developer Portal + +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + +API version: devportal-onprem-ga +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package citrixorchestration + +import ( + "encoding/json" +) + +// checks if the ProvisionedVirtualMachineCustomVmDataResponseModel type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &ProvisionedVirtualMachineCustomVmDataResponseModel{} + +// ProvisionedVirtualMachineCustomVmDataResponseModel Provisioned Virtual Machine CustomVmData response model +type ProvisionedVirtualMachineCustomVmDataResponseModel struct { + // Availability Zones + AvailabilityZone NullableString `json:"AvailabilityZone,omitempty"` + // WBCDiskId + DataDiskId NullableString `json:"DataDiskId,omitempty"` + // Data Disk Storage Type + DataDiskStorageType NullableString `json:"DataDiskStorageType,omitempty"` + // Ephemeral OS Disk Mode + EphemeralOsDiskMode NullableString `json:"EphemeralOsDiskMode,omitempty"` + // Disk Encryption Set Id + EncryptionSettingDESI NullableString `json:"EncryptionSettingDESI,omitempty"` + // Storage Type - Fail Safe + FailSafeStorageType *bool `json:"FailSafeStorageType,omitempty"` + // Host Group + HostGroupId NullableString `json:"HostGroupId,omitempty"` + // Identity Disk full path + IdentityDiskId NullableString `json:"IdentityDiskId,omitempty"` + // Identity Disk Storage Type + IdentityDiskStorageType NullableString `json:"IdentityDiskStorageType,omitempty"` + // OS Disk Use Temp Disk + IsOSDiskAzureTempDisk *bool `json:"IsOSDiskAzureTempDisk,omitempty"` + // Use Shared Image Gallery + IsSharedImageGalleryUsed NullableBool `json:"IsSharedImageGalleryUsed,omitempty"` + // Ephemeral OS Disk + IsUsingEphemeralOsDisk *bool `json:"IsUsingEphemeralOsDisk,omitempty"` + // License Type + LicenseType NullableString `json:"LicenseType,omitempty"` + // Machine Size + MachineSizeId NullableString `json:"MachineSizeId,omitempty"` + // Network Maps + NetworkInterfaceIds []string `json:"NetworkInterfaceIds,omitempty"` + // OS Disk full path + OSDiskId NullableString `json:"OSDiskId,omitempty"` + // OS Disk Storage Type + OsDiskStorageType NullableString `json:"OsDiskStorageType,omitempty"` + // Operation System + OsType NullableString `json:"OsType,omitempty"` + // Retaining System Disk + PersistOsDisk NullableBool `json:"PersistOsDisk,omitempty"` + // Retaining Write-back Cache Disk + PersistWbc NullableBool `json:"PersistWbc,omitempty"` + // Region Id + RegionId NullableString `json:"RegionId,omitempty"` + // Resource Group + ResourceGroupName NullableString `json:"ResourceGroupName,omitempty"` + // Security Type + SecurityType NullableString `json:"SecurityType,omitempty"` + // Azure Shared Image Gallery Machine To Replica Ratio + SIGMachineToReplicaRatio NullableInt32 `json:"SIGMachineToReplicaRatio,omitempty"` + // Azure Shared Image Replica Maximum + SIGReplicaMaximum NullableInt32 `json:"SIGReplicaMaximum,omitempty"` + // Storage Type At Shutdown + StorageTypeAtShutdown NullableString `json:"StorageTypeAtShutdown,omitempty"` + // VmMetadata hibernation configuration. + SupportsHibernation NullableBool `json:"SupportsHibernation,omitempty"` +} + +// NewProvisionedVirtualMachineCustomVmDataResponseModel instantiates a new ProvisionedVirtualMachineCustomVmDataResponseModel object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewProvisionedVirtualMachineCustomVmDataResponseModel() *ProvisionedVirtualMachineCustomVmDataResponseModel { + this := ProvisionedVirtualMachineCustomVmDataResponseModel{} + return &this +} + +// NewProvisionedVirtualMachineCustomVmDataResponseModelWithDefaults instantiates a new ProvisionedVirtualMachineCustomVmDataResponseModel object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewProvisionedVirtualMachineCustomVmDataResponseModelWithDefaults() *ProvisionedVirtualMachineCustomVmDataResponseModel { + this := ProvisionedVirtualMachineCustomVmDataResponseModel{} + return &this +} + +// GetAvailabilityZone returns the AvailabilityZone field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetAvailabilityZone() string { + if o == nil || IsNil(o.AvailabilityZone.Get()) { + var ret string + return ret + } + return *o.AvailabilityZone.Get() +} + +// GetAvailabilityZoneOk returns a tuple with the AvailabilityZone field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetAvailabilityZoneOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.AvailabilityZone.Get(), o.AvailabilityZone.IsSet() +} + +// HasAvailabilityZone returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasAvailabilityZone() bool { + if o != nil && o.AvailabilityZone.IsSet() { + return true + } + + return false +} + +// SetAvailabilityZone gets a reference to the given NullableString and assigns it to the AvailabilityZone field. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetAvailabilityZone(v string) { + o.AvailabilityZone.Set(&v) +} +// SetAvailabilityZoneNil sets the value for AvailabilityZone to be an explicit nil +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetAvailabilityZoneNil() { + o.AvailabilityZone.Set(nil) +} + +// UnsetAvailabilityZone ensures that no value is present for AvailabilityZone, not even an explicit nil +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) UnsetAvailabilityZone() { + o.AvailabilityZone.Unset() +} + +// GetDataDiskId returns the DataDiskId field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetDataDiskId() string { + if o == nil || IsNil(o.DataDiskId.Get()) { + var ret string + return ret + } + return *o.DataDiskId.Get() +} + +// GetDataDiskIdOk returns a tuple with the DataDiskId field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetDataDiskIdOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.DataDiskId.Get(), o.DataDiskId.IsSet() +} + +// HasDataDiskId returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasDataDiskId() bool { + if o != nil && o.DataDiskId.IsSet() { + return true + } + + return false +} + +// SetDataDiskId gets a reference to the given NullableString and assigns it to the DataDiskId field. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetDataDiskId(v string) { + o.DataDiskId.Set(&v) +} +// SetDataDiskIdNil sets the value for DataDiskId to be an explicit nil +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetDataDiskIdNil() { + o.DataDiskId.Set(nil) +} + +// UnsetDataDiskId ensures that no value is present for DataDiskId, not even an explicit nil +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) UnsetDataDiskId() { + o.DataDiskId.Unset() +} + +// GetDataDiskStorageType returns the DataDiskStorageType field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetDataDiskStorageType() string { + if o == nil || IsNil(o.DataDiskStorageType.Get()) { + var ret string + return ret + } + return *o.DataDiskStorageType.Get() +} + +// GetDataDiskStorageTypeOk returns a tuple with the DataDiskStorageType field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetDataDiskStorageTypeOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.DataDiskStorageType.Get(), o.DataDiskStorageType.IsSet() +} + +// HasDataDiskStorageType returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasDataDiskStorageType() bool { + if o != nil && o.DataDiskStorageType.IsSet() { + return true + } + + return false +} + +// SetDataDiskStorageType gets a reference to the given NullableString and assigns it to the DataDiskStorageType field. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetDataDiskStorageType(v string) { + o.DataDiskStorageType.Set(&v) +} +// SetDataDiskStorageTypeNil sets the value for DataDiskStorageType to be an explicit nil +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetDataDiskStorageTypeNil() { + o.DataDiskStorageType.Set(nil) +} + +// UnsetDataDiskStorageType ensures that no value is present for DataDiskStorageType, not even an explicit nil +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) UnsetDataDiskStorageType() { + o.DataDiskStorageType.Unset() +} + +// GetEphemeralOsDiskMode returns the EphemeralOsDiskMode field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetEphemeralOsDiskMode() string { + if o == nil || IsNil(o.EphemeralOsDiskMode.Get()) { + var ret string + return ret + } + return *o.EphemeralOsDiskMode.Get() +} + +// GetEphemeralOsDiskModeOk returns a tuple with the EphemeralOsDiskMode field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetEphemeralOsDiskModeOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.EphemeralOsDiskMode.Get(), o.EphemeralOsDiskMode.IsSet() +} + +// HasEphemeralOsDiskMode returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasEphemeralOsDiskMode() bool { + if o != nil && o.EphemeralOsDiskMode.IsSet() { + return true + } + + return false +} + +// SetEphemeralOsDiskMode gets a reference to the given NullableString and assigns it to the EphemeralOsDiskMode field. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetEphemeralOsDiskMode(v string) { + o.EphemeralOsDiskMode.Set(&v) +} +// SetEphemeralOsDiskModeNil sets the value for EphemeralOsDiskMode to be an explicit nil +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetEphemeralOsDiskModeNil() { + o.EphemeralOsDiskMode.Set(nil) +} + +// UnsetEphemeralOsDiskMode ensures that no value is present for EphemeralOsDiskMode, not even an explicit nil +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) UnsetEphemeralOsDiskMode() { + o.EphemeralOsDiskMode.Unset() +} + +// GetEncryptionSettingDESI returns the EncryptionSettingDESI field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetEncryptionSettingDESI() string { + if o == nil || IsNil(o.EncryptionSettingDESI.Get()) { + var ret string + return ret + } + return *o.EncryptionSettingDESI.Get() +} + +// GetEncryptionSettingDESIOk returns a tuple with the EncryptionSettingDESI field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetEncryptionSettingDESIOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.EncryptionSettingDESI.Get(), o.EncryptionSettingDESI.IsSet() +} + +// HasEncryptionSettingDESI returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasEncryptionSettingDESI() bool { + if o != nil && o.EncryptionSettingDESI.IsSet() { + return true + } + + return false +} + +// SetEncryptionSettingDESI gets a reference to the given NullableString and assigns it to the EncryptionSettingDESI field. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetEncryptionSettingDESI(v string) { + o.EncryptionSettingDESI.Set(&v) +} +// SetEncryptionSettingDESINil sets the value for EncryptionSettingDESI to be an explicit nil +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetEncryptionSettingDESINil() { + o.EncryptionSettingDESI.Set(nil) +} + +// UnsetEncryptionSettingDESI ensures that no value is present for EncryptionSettingDESI, not even an explicit nil +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) UnsetEncryptionSettingDESI() { + o.EncryptionSettingDESI.Unset() +} + +// GetFailSafeStorageType returns the FailSafeStorageType field value if set, zero value otherwise. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetFailSafeStorageType() bool { + if o == nil || IsNil(o.FailSafeStorageType) { + var ret bool + return ret + } + return *o.FailSafeStorageType +} + +// GetFailSafeStorageTypeOk returns a tuple with the FailSafeStorageType field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetFailSafeStorageTypeOk() (*bool, bool) { + if o == nil || IsNil(o.FailSafeStorageType) { + return nil, false + } + return o.FailSafeStorageType, true +} + +// HasFailSafeStorageType returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasFailSafeStorageType() bool { + if o != nil && !IsNil(o.FailSafeStorageType) { + return true + } + + return false +} + +// SetFailSafeStorageType gets a reference to the given bool and assigns it to the FailSafeStorageType field. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetFailSafeStorageType(v bool) { + o.FailSafeStorageType = &v +} + +// GetHostGroupId returns the HostGroupId field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetHostGroupId() string { + if o == nil || IsNil(o.HostGroupId.Get()) { + var ret string + return ret + } + return *o.HostGroupId.Get() +} + +// GetHostGroupIdOk returns a tuple with the HostGroupId field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetHostGroupIdOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.HostGroupId.Get(), o.HostGroupId.IsSet() +} + +// HasHostGroupId returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasHostGroupId() bool { + if o != nil && o.HostGroupId.IsSet() { + return true + } + + return false +} + +// SetHostGroupId gets a reference to the given NullableString and assigns it to the HostGroupId field. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetHostGroupId(v string) { + o.HostGroupId.Set(&v) +} +// SetHostGroupIdNil sets the value for HostGroupId to be an explicit nil +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetHostGroupIdNil() { + o.HostGroupId.Set(nil) +} + +// UnsetHostGroupId ensures that no value is present for HostGroupId, not even an explicit nil +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) UnsetHostGroupId() { + o.HostGroupId.Unset() +} + +// GetIdentityDiskId returns the IdentityDiskId field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetIdentityDiskId() string { + if o == nil || IsNil(o.IdentityDiskId.Get()) { + var ret string + return ret + } + return *o.IdentityDiskId.Get() +} + +// GetIdentityDiskIdOk returns a tuple with the IdentityDiskId field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetIdentityDiskIdOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.IdentityDiskId.Get(), o.IdentityDiskId.IsSet() +} + +// HasIdentityDiskId returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasIdentityDiskId() bool { + if o != nil && o.IdentityDiskId.IsSet() { + return true + } + + return false +} + +// SetIdentityDiskId gets a reference to the given NullableString and assigns it to the IdentityDiskId field. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetIdentityDiskId(v string) { + o.IdentityDiskId.Set(&v) +} +// SetIdentityDiskIdNil sets the value for IdentityDiskId to be an explicit nil +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetIdentityDiskIdNil() { + o.IdentityDiskId.Set(nil) +} + +// UnsetIdentityDiskId ensures that no value is present for IdentityDiskId, not even an explicit nil +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) UnsetIdentityDiskId() { + o.IdentityDiskId.Unset() +} + +// GetIdentityDiskStorageType returns the IdentityDiskStorageType field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetIdentityDiskStorageType() string { + if o == nil || IsNil(o.IdentityDiskStorageType.Get()) { + var ret string + return ret + } + return *o.IdentityDiskStorageType.Get() +} + +// GetIdentityDiskStorageTypeOk returns a tuple with the IdentityDiskStorageType field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetIdentityDiskStorageTypeOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.IdentityDiskStorageType.Get(), o.IdentityDiskStorageType.IsSet() +} + +// HasIdentityDiskStorageType returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasIdentityDiskStorageType() bool { + if o != nil && o.IdentityDiskStorageType.IsSet() { + return true + } + + return false +} + +// SetIdentityDiskStorageType gets a reference to the given NullableString and assigns it to the IdentityDiskStorageType field. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetIdentityDiskStorageType(v string) { + o.IdentityDiskStorageType.Set(&v) +} +// SetIdentityDiskStorageTypeNil sets the value for IdentityDiskStorageType to be an explicit nil +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetIdentityDiskStorageTypeNil() { + o.IdentityDiskStorageType.Set(nil) +} + +// UnsetIdentityDiskStorageType ensures that no value is present for IdentityDiskStorageType, not even an explicit nil +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) UnsetIdentityDiskStorageType() { + o.IdentityDiskStorageType.Unset() +} + +// GetIsOSDiskAzureTempDisk returns the IsOSDiskAzureTempDisk field value if set, zero value otherwise. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetIsOSDiskAzureTempDisk() bool { + if o == nil || IsNil(o.IsOSDiskAzureTempDisk) { + var ret bool + return ret + } + return *o.IsOSDiskAzureTempDisk +} + +// GetIsOSDiskAzureTempDiskOk returns a tuple with the IsOSDiskAzureTempDisk field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetIsOSDiskAzureTempDiskOk() (*bool, bool) { + if o == nil || IsNil(o.IsOSDiskAzureTempDisk) { + return nil, false + } + return o.IsOSDiskAzureTempDisk, true +} + +// HasIsOSDiskAzureTempDisk returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasIsOSDiskAzureTempDisk() bool { + if o != nil && !IsNil(o.IsOSDiskAzureTempDisk) { + return true + } + + return false +} + +// SetIsOSDiskAzureTempDisk gets a reference to the given bool and assigns it to the IsOSDiskAzureTempDisk field. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetIsOSDiskAzureTempDisk(v bool) { + o.IsOSDiskAzureTempDisk = &v +} + +// GetIsSharedImageGalleryUsed returns the IsSharedImageGalleryUsed field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetIsSharedImageGalleryUsed() bool { + if o == nil || IsNil(o.IsSharedImageGalleryUsed.Get()) { + var ret bool + return ret + } + return *o.IsSharedImageGalleryUsed.Get() +} + +// GetIsSharedImageGalleryUsedOk returns a tuple with the IsSharedImageGalleryUsed field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetIsSharedImageGalleryUsedOk() (*bool, bool) { + if o == nil { + return nil, false + } + return o.IsSharedImageGalleryUsed.Get(), o.IsSharedImageGalleryUsed.IsSet() +} + +// HasIsSharedImageGalleryUsed returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasIsSharedImageGalleryUsed() bool { + if o != nil && o.IsSharedImageGalleryUsed.IsSet() { + return true + } + + return false +} + +// SetIsSharedImageGalleryUsed gets a reference to the given NullableBool and assigns it to the IsSharedImageGalleryUsed field. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetIsSharedImageGalleryUsed(v bool) { + o.IsSharedImageGalleryUsed.Set(&v) +} +// SetIsSharedImageGalleryUsedNil sets the value for IsSharedImageGalleryUsed to be an explicit nil +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetIsSharedImageGalleryUsedNil() { + o.IsSharedImageGalleryUsed.Set(nil) +} + +// UnsetIsSharedImageGalleryUsed ensures that no value is present for IsSharedImageGalleryUsed, not even an explicit nil +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) UnsetIsSharedImageGalleryUsed() { + o.IsSharedImageGalleryUsed.Unset() +} + +// GetIsUsingEphemeralOsDisk returns the IsUsingEphemeralOsDisk field value if set, zero value otherwise. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetIsUsingEphemeralOsDisk() bool { + if o == nil || IsNil(o.IsUsingEphemeralOsDisk) { + var ret bool + return ret + } + return *o.IsUsingEphemeralOsDisk +} + +// GetIsUsingEphemeralOsDiskOk returns a tuple with the IsUsingEphemeralOsDisk field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetIsUsingEphemeralOsDiskOk() (*bool, bool) { + if o == nil || IsNil(o.IsUsingEphemeralOsDisk) { + return nil, false + } + return o.IsUsingEphemeralOsDisk, true +} + +// HasIsUsingEphemeralOsDisk returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasIsUsingEphemeralOsDisk() bool { + if o != nil && !IsNil(o.IsUsingEphemeralOsDisk) { + return true + } + + return false +} + +// SetIsUsingEphemeralOsDisk gets a reference to the given bool and assigns it to the IsUsingEphemeralOsDisk field. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetIsUsingEphemeralOsDisk(v bool) { + o.IsUsingEphemeralOsDisk = &v +} + +// GetLicenseType returns the LicenseType field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetLicenseType() string { + if o == nil || IsNil(o.LicenseType.Get()) { + var ret string + return ret + } + return *o.LicenseType.Get() +} + +// GetLicenseTypeOk returns a tuple with the LicenseType field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetLicenseTypeOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.LicenseType.Get(), o.LicenseType.IsSet() +} + +// HasLicenseType returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasLicenseType() bool { + if o != nil && o.LicenseType.IsSet() { + return true + } + + return false +} + +// SetLicenseType gets a reference to the given NullableString and assigns it to the LicenseType field. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetLicenseType(v string) { + o.LicenseType.Set(&v) +} +// SetLicenseTypeNil sets the value for LicenseType to be an explicit nil +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetLicenseTypeNil() { + o.LicenseType.Set(nil) +} + +// UnsetLicenseType ensures that no value is present for LicenseType, not even an explicit nil +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) UnsetLicenseType() { + o.LicenseType.Unset() +} + +// GetMachineSizeId returns the MachineSizeId field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetMachineSizeId() string { + if o == nil || IsNil(o.MachineSizeId.Get()) { + var ret string + return ret + } + return *o.MachineSizeId.Get() +} + +// GetMachineSizeIdOk returns a tuple with the MachineSizeId field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetMachineSizeIdOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.MachineSizeId.Get(), o.MachineSizeId.IsSet() +} + +// HasMachineSizeId returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasMachineSizeId() bool { + if o != nil && o.MachineSizeId.IsSet() { + return true + } + + return false +} + +// SetMachineSizeId gets a reference to the given NullableString and assigns it to the MachineSizeId field. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetMachineSizeId(v string) { + o.MachineSizeId.Set(&v) +} +// SetMachineSizeIdNil sets the value for MachineSizeId to be an explicit nil +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetMachineSizeIdNil() { + o.MachineSizeId.Set(nil) +} + +// UnsetMachineSizeId ensures that no value is present for MachineSizeId, not even an explicit nil +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) UnsetMachineSizeId() { + o.MachineSizeId.Unset() +} + +// GetNetworkInterfaceIds returns the NetworkInterfaceIds field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetNetworkInterfaceIds() []string { + if o == nil { + var ret []string + return ret + } + return o.NetworkInterfaceIds +} + +// GetNetworkInterfaceIdsOk returns a tuple with the NetworkInterfaceIds field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetNetworkInterfaceIdsOk() ([]string, bool) { + if o == nil || IsNil(o.NetworkInterfaceIds) { + return nil, false + } + return o.NetworkInterfaceIds, true +} + +// HasNetworkInterfaceIds returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasNetworkInterfaceIds() bool { + if o != nil && IsNil(o.NetworkInterfaceIds) { + return true + } + + return false +} + +// SetNetworkInterfaceIds gets a reference to the given []string and assigns it to the NetworkInterfaceIds field. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetNetworkInterfaceIds(v []string) { + o.NetworkInterfaceIds = v +} + +// GetOSDiskId returns the OSDiskId field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetOSDiskId() string { + if o == nil || IsNil(o.OSDiskId.Get()) { + var ret string + return ret + } + return *o.OSDiskId.Get() +} + +// GetOSDiskIdOk returns a tuple with the OSDiskId field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetOSDiskIdOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.OSDiskId.Get(), o.OSDiskId.IsSet() +} + +// HasOSDiskId returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasOSDiskId() bool { + if o != nil && o.OSDiskId.IsSet() { + return true + } + + return false +} + +// SetOSDiskId gets a reference to the given NullableString and assigns it to the OSDiskId field. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetOSDiskId(v string) { + o.OSDiskId.Set(&v) +} +// SetOSDiskIdNil sets the value for OSDiskId to be an explicit nil +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetOSDiskIdNil() { + o.OSDiskId.Set(nil) +} + +// UnsetOSDiskId ensures that no value is present for OSDiskId, not even an explicit nil +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) UnsetOSDiskId() { + o.OSDiskId.Unset() +} + +// GetOsDiskStorageType returns the OsDiskStorageType field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetOsDiskStorageType() string { + if o == nil || IsNil(o.OsDiskStorageType.Get()) { + var ret string + return ret + } + return *o.OsDiskStorageType.Get() +} + +// GetOsDiskStorageTypeOk returns a tuple with the OsDiskStorageType field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetOsDiskStorageTypeOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.OsDiskStorageType.Get(), o.OsDiskStorageType.IsSet() +} + +// HasOsDiskStorageType returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasOsDiskStorageType() bool { + if o != nil && o.OsDiskStorageType.IsSet() { + return true + } + + return false +} + +// SetOsDiskStorageType gets a reference to the given NullableString and assigns it to the OsDiskStorageType field. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetOsDiskStorageType(v string) { + o.OsDiskStorageType.Set(&v) +} +// SetOsDiskStorageTypeNil sets the value for OsDiskStorageType to be an explicit nil +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetOsDiskStorageTypeNil() { + o.OsDiskStorageType.Set(nil) +} + +// UnsetOsDiskStorageType ensures that no value is present for OsDiskStorageType, not even an explicit nil +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) UnsetOsDiskStorageType() { + o.OsDiskStorageType.Unset() +} + +// GetOsType returns the OsType field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetOsType() string { + if o == nil || IsNil(o.OsType.Get()) { + var ret string + return ret + } + return *o.OsType.Get() +} + +// GetOsTypeOk returns a tuple with the OsType field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetOsTypeOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.OsType.Get(), o.OsType.IsSet() +} + +// HasOsType returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasOsType() bool { + if o != nil && o.OsType.IsSet() { + return true + } + + return false +} + +// SetOsType gets a reference to the given NullableString and assigns it to the OsType field. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetOsType(v string) { + o.OsType.Set(&v) +} +// SetOsTypeNil sets the value for OsType to be an explicit nil +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetOsTypeNil() { + o.OsType.Set(nil) +} + +// UnsetOsType ensures that no value is present for OsType, not even an explicit nil +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) UnsetOsType() { + o.OsType.Unset() +} + +// GetPersistOsDisk returns the PersistOsDisk field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetPersistOsDisk() bool { + if o == nil || IsNil(o.PersistOsDisk.Get()) { + var ret bool + return ret + } + return *o.PersistOsDisk.Get() +} + +// GetPersistOsDiskOk returns a tuple with the PersistOsDisk field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetPersistOsDiskOk() (*bool, bool) { + if o == nil { + return nil, false + } + return o.PersistOsDisk.Get(), o.PersistOsDisk.IsSet() +} + +// HasPersistOsDisk returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasPersistOsDisk() bool { + if o != nil && o.PersistOsDisk.IsSet() { + return true + } + + return false +} + +// SetPersistOsDisk gets a reference to the given NullableBool and assigns it to the PersistOsDisk field. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetPersistOsDisk(v bool) { + o.PersistOsDisk.Set(&v) +} +// SetPersistOsDiskNil sets the value for PersistOsDisk to be an explicit nil +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetPersistOsDiskNil() { + o.PersistOsDisk.Set(nil) +} + +// UnsetPersistOsDisk ensures that no value is present for PersistOsDisk, not even an explicit nil +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) UnsetPersistOsDisk() { + o.PersistOsDisk.Unset() +} + +// GetPersistWbc returns the PersistWbc field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetPersistWbc() bool { + if o == nil || IsNil(o.PersistWbc.Get()) { + var ret bool + return ret + } + return *o.PersistWbc.Get() +} + +// GetPersistWbcOk returns a tuple with the PersistWbc field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetPersistWbcOk() (*bool, bool) { + if o == nil { + return nil, false + } + return o.PersistWbc.Get(), o.PersistWbc.IsSet() +} + +// HasPersistWbc returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasPersistWbc() bool { + if o != nil && o.PersistWbc.IsSet() { + return true + } + + return false +} + +// SetPersistWbc gets a reference to the given NullableBool and assigns it to the PersistWbc field. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetPersistWbc(v bool) { + o.PersistWbc.Set(&v) +} +// SetPersistWbcNil sets the value for PersistWbc to be an explicit nil +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetPersistWbcNil() { + o.PersistWbc.Set(nil) +} + +// UnsetPersistWbc ensures that no value is present for PersistWbc, not even an explicit nil +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) UnsetPersistWbc() { + o.PersistWbc.Unset() +} + +// GetRegionId returns the RegionId field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetRegionId() string { + if o == nil || IsNil(o.RegionId.Get()) { + var ret string + return ret + } + return *o.RegionId.Get() +} + +// GetRegionIdOk returns a tuple with the RegionId field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetRegionIdOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.RegionId.Get(), o.RegionId.IsSet() +} + +// HasRegionId returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasRegionId() bool { + if o != nil && o.RegionId.IsSet() { + return true + } + + return false +} + +// SetRegionId gets a reference to the given NullableString and assigns it to the RegionId field. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetRegionId(v string) { + o.RegionId.Set(&v) +} +// SetRegionIdNil sets the value for RegionId to be an explicit nil +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetRegionIdNil() { + o.RegionId.Set(nil) +} + +// UnsetRegionId ensures that no value is present for RegionId, not even an explicit nil +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) UnsetRegionId() { + o.RegionId.Unset() +} + +// GetResourceGroupName returns the ResourceGroupName field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetResourceGroupName() string { + if o == nil || IsNil(o.ResourceGroupName.Get()) { + var ret string + return ret + } + return *o.ResourceGroupName.Get() +} + +// GetResourceGroupNameOk returns a tuple with the ResourceGroupName field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetResourceGroupNameOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.ResourceGroupName.Get(), o.ResourceGroupName.IsSet() +} + +// HasResourceGroupName returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasResourceGroupName() bool { + if o != nil && o.ResourceGroupName.IsSet() { + return true + } + + return false +} + +// SetResourceGroupName gets a reference to the given NullableString and assigns it to the ResourceGroupName field. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetResourceGroupName(v string) { + o.ResourceGroupName.Set(&v) +} +// SetResourceGroupNameNil sets the value for ResourceGroupName to be an explicit nil +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetResourceGroupNameNil() { + o.ResourceGroupName.Set(nil) +} + +// UnsetResourceGroupName ensures that no value is present for ResourceGroupName, not even an explicit nil +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) UnsetResourceGroupName() { + o.ResourceGroupName.Unset() +} + +// GetSecurityType returns the SecurityType field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetSecurityType() string { + if o == nil || IsNil(o.SecurityType.Get()) { + var ret string + return ret + } + return *o.SecurityType.Get() +} + +// GetSecurityTypeOk returns a tuple with the SecurityType field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetSecurityTypeOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.SecurityType.Get(), o.SecurityType.IsSet() +} + +// HasSecurityType returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasSecurityType() bool { + if o != nil && o.SecurityType.IsSet() { + return true + } + + return false +} + +// SetSecurityType gets a reference to the given NullableString and assigns it to the SecurityType field. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetSecurityType(v string) { + o.SecurityType.Set(&v) +} +// SetSecurityTypeNil sets the value for SecurityType to be an explicit nil +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetSecurityTypeNil() { + o.SecurityType.Set(nil) +} + +// UnsetSecurityType ensures that no value is present for SecurityType, not even an explicit nil +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) UnsetSecurityType() { + o.SecurityType.Unset() +} + +// GetSIGMachineToReplicaRatio returns the SIGMachineToReplicaRatio field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetSIGMachineToReplicaRatio() int32 { + if o == nil || IsNil(o.SIGMachineToReplicaRatio.Get()) { + var ret int32 + return ret + } + return *o.SIGMachineToReplicaRatio.Get() +} + +// GetSIGMachineToReplicaRatioOk returns a tuple with the SIGMachineToReplicaRatio field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetSIGMachineToReplicaRatioOk() (*int32, bool) { + if o == nil { + return nil, false + } + return o.SIGMachineToReplicaRatio.Get(), o.SIGMachineToReplicaRatio.IsSet() +} + +// HasSIGMachineToReplicaRatio returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasSIGMachineToReplicaRatio() bool { + if o != nil && o.SIGMachineToReplicaRatio.IsSet() { + return true + } + + return false +} + +// SetSIGMachineToReplicaRatio gets a reference to the given NullableInt32 and assigns it to the SIGMachineToReplicaRatio field. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetSIGMachineToReplicaRatio(v int32) { + o.SIGMachineToReplicaRatio.Set(&v) +} +// SetSIGMachineToReplicaRatioNil sets the value for SIGMachineToReplicaRatio to be an explicit nil +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetSIGMachineToReplicaRatioNil() { + o.SIGMachineToReplicaRatio.Set(nil) +} + +// UnsetSIGMachineToReplicaRatio ensures that no value is present for SIGMachineToReplicaRatio, not even an explicit nil +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) UnsetSIGMachineToReplicaRatio() { + o.SIGMachineToReplicaRatio.Unset() +} + +// GetSIGReplicaMaximum returns the SIGReplicaMaximum field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetSIGReplicaMaximum() int32 { + if o == nil || IsNil(o.SIGReplicaMaximum.Get()) { + var ret int32 + return ret + } + return *o.SIGReplicaMaximum.Get() +} + +// GetSIGReplicaMaximumOk returns a tuple with the SIGReplicaMaximum field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetSIGReplicaMaximumOk() (*int32, bool) { + if o == nil { + return nil, false + } + return o.SIGReplicaMaximum.Get(), o.SIGReplicaMaximum.IsSet() +} + +// HasSIGReplicaMaximum returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasSIGReplicaMaximum() bool { + if o != nil && o.SIGReplicaMaximum.IsSet() { + return true + } + + return false +} + +// SetSIGReplicaMaximum gets a reference to the given NullableInt32 and assigns it to the SIGReplicaMaximum field. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetSIGReplicaMaximum(v int32) { + o.SIGReplicaMaximum.Set(&v) +} +// SetSIGReplicaMaximumNil sets the value for SIGReplicaMaximum to be an explicit nil +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetSIGReplicaMaximumNil() { + o.SIGReplicaMaximum.Set(nil) +} + +// UnsetSIGReplicaMaximum ensures that no value is present for SIGReplicaMaximum, not even an explicit nil +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) UnsetSIGReplicaMaximum() { + o.SIGReplicaMaximum.Unset() +} + +// GetStorageTypeAtShutdown returns the StorageTypeAtShutdown field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetStorageTypeAtShutdown() string { + if o == nil || IsNil(o.StorageTypeAtShutdown.Get()) { + var ret string + return ret + } + return *o.StorageTypeAtShutdown.Get() +} + +// GetStorageTypeAtShutdownOk returns a tuple with the StorageTypeAtShutdown field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetStorageTypeAtShutdownOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.StorageTypeAtShutdown.Get(), o.StorageTypeAtShutdown.IsSet() +} + +// HasStorageTypeAtShutdown returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasStorageTypeAtShutdown() bool { + if o != nil && o.StorageTypeAtShutdown.IsSet() { + return true + } + + return false +} + +// SetStorageTypeAtShutdown gets a reference to the given NullableString and assigns it to the StorageTypeAtShutdown field. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetStorageTypeAtShutdown(v string) { + o.StorageTypeAtShutdown.Set(&v) +} +// SetStorageTypeAtShutdownNil sets the value for StorageTypeAtShutdown to be an explicit nil +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetStorageTypeAtShutdownNil() { + o.StorageTypeAtShutdown.Set(nil) +} + +// UnsetStorageTypeAtShutdown ensures that no value is present for StorageTypeAtShutdown, not even an explicit nil +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) UnsetStorageTypeAtShutdown() { + o.StorageTypeAtShutdown.Unset() +} + +// GetSupportsHibernation returns the SupportsHibernation field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetSupportsHibernation() bool { + if o == nil || IsNil(o.SupportsHibernation.Get()) { + var ret bool + return ret + } + return *o.SupportsHibernation.Get() +} + +// GetSupportsHibernationOk returns a tuple with the SupportsHibernation field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) GetSupportsHibernationOk() (*bool, bool) { + if o == nil { + return nil, false + } + return o.SupportsHibernation.Get(), o.SupportsHibernation.IsSet() +} + +// HasSupportsHibernation returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) HasSupportsHibernation() bool { + if o != nil && o.SupportsHibernation.IsSet() { + return true + } + + return false +} + +// SetSupportsHibernation gets a reference to the given NullableBool and assigns it to the SupportsHibernation field. +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetSupportsHibernation(v bool) { + o.SupportsHibernation.Set(&v) +} +// SetSupportsHibernationNil sets the value for SupportsHibernation to be an explicit nil +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) SetSupportsHibernationNil() { + o.SupportsHibernation.Set(nil) +} + +// UnsetSupportsHibernation ensures that no value is present for SupportsHibernation, not even an explicit nil +func (o *ProvisionedVirtualMachineCustomVmDataResponseModel) UnsetSupportsHibernation() { + o.SupportsHibernation.Unset() +} + +func (o ProvisionedVirtualMachineCustomVmDataResponseModel) MarshalJSON() ([]byte, error) { + toSerialize,err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o ProvisionedVirtualMachineCustomVmDataResponseModel) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + if o.AvailabilityZone.IsSet() { + toSerialize["AvailabilityZone"] = o.AvailabilityZone.Get() + } + if o.DataDiskId.IsSet() { + toSerialize["DataDiskId"] = o.DataDiskId.Get() + } + if o.DataDiskStorageType.IsSet() { + toSerialize["DataDiskStorageType"] = o.DataDiskStorageType.Get() + } + if o.EphemeralOsDiskMode.IsSet() { + toSerialize["EphemeralOsDiskMode"] = o.EphemeralOsDiskMode.Get() + } + if o.EncryptionSettingDESI.IsSet() { + toSerialize["EncryptionSettingDESI"] = o.EncryptionSettingDESI.Get() + } + if !IsNil(o.FailSafeStorageType) { + toSerialize["FailSafeStorageType"] = o.FailSafeStorageType + } + if o.HostGroupId.IsSet() { + toSerialize["HostGroupId"] = o.HostGroupId.Get() + } + if o.IdentityDiskId.IsSet() { + toSerialize["IdentityDiskId"] = o.IdentityDiskId.Get() + } + if o.IdentityDiskStorageType.IsSet() { + toSerialize["IdentityDiskStorageType"] = o.IdentityDiskStorageType.Get() + } + if !IsNil(o.IsOSDiskAzureTempDisk) { + toSerialize["IsOSDiskAzureTempDisk"] = o.IsOSDiskAzureTempDisk + } + if o.IsSharedImageGalleryUsed.IsSet() { + toSerialize["IsSharedImageGalleryUsed"] = o.IsSharedImageGalleryUsed.Get() + } + if !IsNil(o.IsUsingEphemeralOsDisk) { + toSerialize["IsUsingEphemeralOsDisk"] = o.IsUsingEphemeralOsDisk + } + if o.LicenseType.IsSet() { + toSerialize["LicenseType"] = o.LicenseType.Get() + } + if o.MachineSizeId.IsSet() { + toSerialize["MachineSizeId"] = o.MachineSizeId.Get() + } + if o.NetworkInterfaceIds != nil { + toSerialize["NetworkInterfaceIds"] = o.NetworkInterfaceIds + } + if o.OSDiskId.IsSet() { + toSerialize["OSDiskId"] = o.OSDiskId.Get() + } + if o.OsDiskStorageType.IsSet() { + toSerialize["OsDiskStorageType"] = o.OsDiskStorageType.Get() + } + if o.OsType.IsSet() { + toSerialize["OsType"] = o.OsType.Get() + } + if o.PersistOsDisk.IsSet() { + toSerialize["PersistOsDisk"] = o.PersistOsDisk.Get() + } + if o.PersistWbc.IsSet() { + toSerialize["PersistWbc"] = o.PersistWbc.Get() + } + if o.RegionId.IsSet() { + toSerialize["RegionId"] = o.RegionId.Get() + } + if o.ResourceGroupName.IsSet() { + toSerialize["ResourceGroupName"] = o.ResourceGroupName.Get() + } + if o.SecurityType.IsSet() { + toSerialize["SecurityType"] = o.SecurityType.Get() + } + if o.SIGMachineToReplicaRatio.IsSet() { + toSerialize["SIGMachineToReplicaRatio"] = o.SIGMachineToReplicaRatio.Get() + } + if o.SIGReplicaMaximum.IsSet() { + toSerialize["SIGReplicaMaximum"] = o.SIGReplicaMaximum.Get() + } + if o.StorageTypeAtShutdown.IsSet() { + toSerialize["StorageTypeAtShutdown"] = o.StorageTypeAtShutdown.Get() + } + if o.SupportsHibernation.IsSet() { + toSerialize["SupportsHibernation"] = o.SupportsHibernation.Get() + } + return toSerialize, nil +} + +type NullableProvisionedVirtualMachineCustomVmDataResponseModel struct { + value *ProvisionedVirtualMachineCustomVmDataResponseModel + isSet bool +} + +func (v NullableProvisionedVirtualMachineCustomVmDataResponseModel) Get() *ProvisionedVirtualMachineCustomVmDataResponseModel { + return v.value +} + +func (v *NullableProvisionedVirtualMachineCustomVmDataResponseModel) Set(val *ProvisionedVirtualMachineCustomVmDataResponseModel) { + v.value = val + v.isSet = true +} + +func (v NullableProvisionedVirtualMachineCustomVmDataResponseModel) IsSet() bool { + return v.isSet +} + +func (v *NullableProvisionedVirtualMachineCustomVmDataResponseModel) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableProvisionedVirtualMachineCustomVmDataResponseModel(val *ProvisionedVirtualMachineCustomVmDataResponseModel) *NullableProvisionedVirtualMachineCustomVmDataResponseModel { + return &NullableProvisionedVirtualMachineCustomVmDataResponseModel{value: val, isSet: true} +} + +func (v NullableProvisionedVirtualMachineCustomVmDataResponseModel) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableProvisionedVirtualMachineCustomVmDataResponseModel) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/citrixorchestration/model_provisioned_virtual_machine_details_response_model.go b/citrixorchestration/model_provisioned_virtual_machine_details_response_model.go new file mode 100644 index 0000000..de6dbf4 --- /dev/null +++ b/citrixorchestration/model_provisioned_virtual_machine_details_response_model.go @@ -0,0 +1,1569 @@ +/* +Citrix Virtual Apps and Desktops Rest API for Developer Portal + +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + +API version: devportal-onprem-ga +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package citrixorchestration + +import ( + "encoding/json" +) + +// checks if the ProvisionedVirtualMachineDetailsResponseModel type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &ProvisionedVirtualMachineDetailsResponseModel{} + +// ProvisionedVirtualMachineDetailsResponseModel Response model for machine. +type ProvisionedVirtualMachineDetailsResponseModel struct { + // Accelerated Network + AcceleratedNetwork NullableBool `json:"AcceleratedNetwork,omitempty"` + // Active Directory Account Name + ADAccountName NullableString `json:"ADAccountName,omitempty"` + // Virtual Machine Sid + VMSid NullableString `json:"VMSid,omitempty"` + // Assigned Image + AssignedImage NullableString `json:"AssignedImage,omitempty"` + // Booted Image + BootedImage NullableString `json:"BootedImage,omitempty"` + CustomVmData *ProvisionedVirtualMachineCustomVmDataResponseModel `json:"CustomVmData,omitempty"` + // Cpu Count + CpuCount *int32 `json:"CpuCount,omitempty"` + // Creation Date + CreationDate NullableString `json:"CreationDate,omitempty"` + // Domain + Domain NullableString `json:"Domain,omitempty"` + // IntegrityMonitoring + EnableIntegrityMonitoring NullableBool `json:"EnableIntegrityMonitoring,omitempty"` + // From ProvScheme VMMetaData + EnableSecureBoot NullableBool `json:"EnableSecureBoot,omitempty"` + // From ProvScheme VMMetaData + EnableVTPM NullableBool `json:"EnableVTPM,omitempty"` + // From ProvScheme VMMetaData + EncryptionAtHost NullableBool `json:"EncryptionAtHost,omitempty"` + // The Errors of provisioned virtual machine + Errors []string `json:"Errors,omitempty"` + // Broker Hypervisor Connection Type - Plugin Factory Name + PluginId NullableString `json:"PluginId,omitempty"` + // Image Out Of Date, booted image name doesn't equal assigned image name + ImageOutOfDate *bool `json:"ImageOutOfDate,omitempty"` + // MemoryMB + MemoryMB *int32 `json:"MemoryMB,omitempty"` + // Hosting Unit Uid + HostingUnitUid *string `json:"HostingUnitUid,omitempty"` + // Hypervisor Connection Uid + HypervisorConnectionUid *string `json:"HypervisorConnectionUid,omitempty"` + // Identity Disk Id + IdentityDiskId NullableString `json:"IdentityDiskId,omitempty"` + // Last Boot Time + LastBootTime NullableString `json:"LastBootTime,omitempty"` + // Provisioning Scheme Type: MCS, PVS + ProvisioningSchemeType NullableString `json:"ProvisioningSchemeType,omitempty"` + // Provisioning Scheme Update Requested + ProvisioningSchemeUpdateRequested NullableString `json:"ProvisioningSchemeUpdateRequested,omitempty"` + // Provisioning SchemeVersion + ProvisioningSchemeVersion *int32 `json:"ProvisioningSchemeVersion,omitempty"` + // Use Full Disk Clone Provisioning + UseFullDiskCloneProvisioning *bool `json:"UseFullDiskCloneProvisioning,omitempty"` + // VMId, Azure - resourcegroup/VMName + VMId NullableString `json:"VMId,omitempty"` + // VM Name on the hypervisor + VMName NullableString `json:"VMName,omitempty"` + // Warnings, decode CustomVMData failed reason + Warnings []ProvisionedVirtualMachineDetailsWarningReponseModel `json:"Warnings,omitempty"` + // Windows Activation Status + WindowsActivationStatus NullableString `json:"WindowsActivationStatus,omitempty"` + // Windows Activation Status Error Code + WindowsActivationStatusErrorCode NullableString `json:"WindowsActivationStatusErrorCode,omitempty"` + // Windows Activation Status Virtual Machine Error + WindowsActivationStatusVirtualMachineError NullableString `json:"WindowsActivationStatusVirtualMachineError,omitempty"` + // Windows Activation Type Provisioned Virtual Machine + WindowsActivationTypeProvisionedVirtualMachine NullableString `json:"WindowsActivationTypeProvisionedVirtualMachine,omitempty"` + // Write Back Cache(WBC) Disk Size + WriteBackCacheDiskSize *int32 `json:"WriteBackCacheDiskSize,omitempty"` + // Write Back Cache(WBC) Memory Size + WriteBackCacheMemorySize *int32 `json:"WriteBackCacheMemorySize,omitempty"` +} + +// NewProvisionedVirtualMachineDetailsResponseModel instantiates a new ProvisionedVirtualMachineDetailsResponseModel object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewProvisionedVirtualMachineDetailsResponseModel() *ProvisionedVirtualMachineDetailsResponseModel { + this := ProvisionedVirtualMachineDetailsResponseModel{} + return &this +} + +// NewProvisionedVirtualMachineDetailsResponseModelWithDefaults instantiates a new ProvisionedVirtualMachineDetailsResponseModel object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewProvisionedVirtualMachineDetailsResponseModelWithDefaults() *ProvisionedVirtualMachineDetailsResponseModel { + this := ProvisionedVirtualMachineDetailsResponseModel{} + return &this +} + +// GetAcceleratedNetwork returns the AcceleratedNetwork field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetAcceleratedNetwork() bool { + if o == nil || IsNil(o.AcceleratedNetwork.Get()) { + var ret bool + return ret + } + return *o.AcceleratedNetwork.Get() +} + +// GetAcceleratedNetworkOk returns a tuple with the AcceleratedNetwork field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetAcceleratedNetworkOk() (*bool, bool) { + if o == nil { + return nil, false + } + return o.AcceleratedNetwork.Get(), o.AcceleratedNetwork.IsSet() +} + +// HasAcceleratedNetwork returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineDetailsResponseModel) HasAcceleratedNetwork() bool { + if o != nil && o.AcceleratedNetwork.IsSet() { + return true + } + + return false +} + +// SetAcceleratedNetwork gets a reference to the given NullableBool and assigns it to the AcceleratedNetwork field. +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetAcceleratedNetwork(v bool) { + o.AcceleratedNetwork.Set(&v) +} +// SetAcceleratedNetworkNil sets the value for AcceleratedNetwork to be an explicit nil +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetAcceleratedNetworkNil() { + o.AcceleratedNetwork.Set(nil) +} + +// UnsetAcceleratedNetwork ensures that no value is present for AcceleratedNetwork, not even an explicit nil +func (o *ProvisionedVirtualMachineDetailsResponseModel) UnsetAcceleratedNetwork() { + o.AcceleratedNetwork.Unset() +} + +// GetADAccountName returns the ADAccountName field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetADAccountName() string { + if o == nil || IsNil(o.ADAccountName.Get()) { + var ret string + return ret + } + return *o.ADAccountName.Get() +} + +// GetADAccountNameOk returns a tuple with the ADAccountName field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetADAccountNameOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.ADAccountName.Get(), o.ADAccountName.IsSet() +} + +// HasADAccountName returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineDetailsResponseModel) HasADAccountName() bool { + if o != nil && o.ADAccountName.IsSet() { + return true + } + + return false +} + +// SetADAccountName gets a reference to the given NullableString and assigns it to the ADAccountName field. +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetADAccountName(v string) { + o.ADAccountName.Set(&v) +} +// SetADAccountNameNil sets the value for ADAccountName to be an explicit nil +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetADAccountNameNil() { + o.ADAccountName.Set(nil) +} + +// UnsetADAccountName ensures that no value is present for ADAccountName, not even an explicit nil +func (o *ProvisionedVirtualMachineDetailsResponseModel) UnsetADAccountName() { + o.ADAccountName.Unset() +} + +// GetVMSid returns the VMSid field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetVMSid() string { + if o == nil || IsNil(o.VMSid.Get()) { + var ret string + return ret + } + return *o.VMSid.Get() +} + +// GetVMSidOk returns a tuple with the VMSid field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetVMSidOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.VMSid.Get(), o.VMSid.IsSet() +} + +// HasVMSid returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineDetailsResponseModel) HasVMSid() bool { + if o != nil && o.VMSid.IsSet() { + return true + } + + return false +} + +// SetVMSid gets a reference to the given NullableString and assigns it to the VMSid field. +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetVMSid(v string) { + o.VMSid.Set(&v) +} +// SetVMSidNil sets the value for VMSid to be an explicit nil +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetVMSidNil() { + o.VMSid.Set(nil) +} + +// UnsetVMSid ensures that no value is present for VMSid, not even an explicit nil +func (o *ProvisionedVirtualMachineDetailsResponseModel) UnsetVMSid() { + o.VMSid.Unset() +} + +// GetAssignedImage returns the AssignedImage field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetAssignedImage() string { + if o == nil || IsNil(o.AssignedImage.Get()) { + var ret string + return ret + } + return *o.AssignedImage.Get() +} + +// GetAssignedImageOk returns a tuple with the AssignedImage field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetAssignedImageOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.AssignedImage.Get(), o.AssignedImage.IsSet() +} + +// HasAssignedImage returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineDetailsResponseModel) HasAssignedImage() bool { + if o != nil && o.AssignedImage.IsSet() { + return true + } + + return false +} + +// SetAssignedImage gets a reference to the given NullableString and assigns it to the AssignedImage field. +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetAssignedImage(v string) { + o.AssignedImage.Set(&v) +} +// SetAssignedImageNil sets the value for AssignedImage to be an explicit nil +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetAssignedImageNil() { + o.AssignedImage.Set(nil) +} + +// UnsetAssignedImage ensures that no value is present for AssignedImage, not even an explicit nil +func (o *ProvisionedVirtualMachineDetailsResponseModel) UnsetAssignedImage() { + o.AssignedImage.Unset() +} + +// GetBootedImage returns the BootedImage field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetBootedImage() string { + if o == nil || IsNil(o.BootedImage.Get()) { + var ret string + return ret + } + return *o.BootedImage.Get() +} + +// GetBootedImageOk returns a tuple with the BootedImage field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetBootedImageOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.BootedImage.Get(), o.BootedImage.IsSet() +} + +// HasBootedImage returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineDetailsResponseModel) HasBootedImage() bool { + if o != nil && o.BootedImage.IsSet() { + return true + } + + return false +} + +// SetBootedImage gets a reference to the given NullableString and assigns it to the BootedImage field. +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetBootedImage(v string) { + o.BootedImage.Set(&v) +} +// SetBootedImageNil sets the value for BootedImage to be an explicit nil +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetBootedImageNil() { + o.BootedImage.Set(nil) +} + +// UnsetBootedImage ensures that no value is present for BootedImage, not even an explicit nil +func (o *ProvisionedVirtualMachineDetailsResponseModel) UnsetBootedImage() { + o.BootedImage.Unset() +} + +// GetCustomVmData returns the CustomVmData field value if set, zero value otherwise. +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetCustomVmData() ProvisionedVirtualMachineCustomVmDataResponseModel { + if o == nil || IsNil(o.CustomVmData) { + var ret ProvisionedVirtualMachineCustomVmDataResponseModel + return ret + } + return *o.CustomVmData +} + +// GetCustomVmDataOk returns a tuple with the CustomVmData field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetCustomVmDataOk() (*ProvisionedVirtualMachineCustomVmDataResponseModel, bool) { + if o == nil || IsNil(o.CustomVmData) { + return nil, false + } + return o.CustomVmData, true +} + +// HasCustomVmData returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineDetailsResponseModel) HasCustomVmData() bool { + if o != nil && !IsNil(o.CustomVmData) { + return true + } + + return false +} + +// SetCustomVmData gets a reference to the given ProvisionedVirtualMachineCustomVmDataResponseModel and assigns it to the CustomVmData field. +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetCustomVmData(v ProvisionedVirtualMachineCustomVmDataResponseModel) { + o.CustomVmData = &v +} + +// GetCpuCount returns the CpuCount field value if set, zero value otherwise. +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetCpuCount() int32 { + if o == nil || IsNil(o.CpuCount) { + var ret int32 + return ret + } + return *o.CpuCount +} + +// GetCpuCountOk returns a tuple with the CpuCount field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetCpuCountOk() (*int32, bool) { + if o == nil || IsNil(o.CpuCount) { + return nil, false + } + return o.CpuCount, true +} + +// HasCpuCount returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineDetailsResponseModel) HasCpuCount() bool { + if o != nil && !IsNil(o.CpuCount) { + return true + } + + return false +} + +// SetCpuCount gets a reference to the given int32 and assigns it to the CpuCount field. +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetCpuCount(v int32) { + o.CpuCount = &v +} + +// GetCreationDate returns the CreationDate field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetCreationDate() string { + if o == nil || IsNil(o.CreationDate.Get()) { + var ret string + return ret + } + return *o.CreationDate.Get() +} + +// GetCreationDateOk returns a tuple with the CreationDate field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetCreationDateOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.CreationDate.Get(), o.CreationDate.IsSet() +} + +// HasCreationDate returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineDetailsResponseModel) HasCreationDate() bool { + if o != nil && o.CreationDate.IsSet() { + return true + } + + return false +} + +// SetCreationDate gets a reference to the given NullableString and assigns it to the CreationDate field. +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetCreationDate(v string) { + o.CreationDate.Set(&v) +} +// SetCreationDateNil sets the value for CreationDate to be an explicit nil +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetCreationDateNil() { + o.CreationDate.Set(nil) +} + +// UnsetCreationDate ensures that no value is present for CreationDate, not even an explicit nil +func (o *ProvisionedVirtualMachineDetailsResponseModel) UnsetCreationDate() { + o.CreationDate.Unset() +} + +// GetDomain returns the Domain field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetDomain() string { + if o == nil || IsNil(o.Domain.Get()) { + var ret string + return ret + } + return *o.Domain.Get() +} + +// GetDomainOk returns a tuple with the Domain field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetDomainOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.Domain.Get(), o.Domain.IsSet() +} + +// HasDomain returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineDetailsResponseModel) HasDomain() bool { + if o != nil && o.Domain.IsSet() { + return true + } + + return false +} + +// SetDomain gets a reference to the given NullableString and assigns it to the Domain field. +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetDomain(v string) { + o.Domain.Set(&v) +} +// SetDomainNil sets the value for Domain to be an explicit nil +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetDomainNil() { + o.Domain.Set(nil) +} + +// UnsetDomain ensures that no value is present for Domain, not even an explicit nil +func (o *ProvisionedVirtualMachineDetailsResponseModel) UnsetDomain() { + o.Domain.Unset() +} + +// GetEnableIntegrityMonitoring returns the EnableIntegrityMonitoring field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetEnableIntegrityMonitoring() bool { + if o == nil || IsNil(o.EnableIntegrityMonitoring.Get()) { + var ret bool + return ret + } + return *o.EnableIntegrityMonitoring.Get() +} + +// GetEnableIntegrityMonitoringOk returns a tuple with the EnableIntegrityMonitoring field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetEnableIntegrityMonitoringOk() (*bool, bool) { + if o == nil { + return nil, false + } + return o.EnableIntegrityMonitoring.Get(), o.EnableIntegrityMonitoring.IsSet() +} + +// HasEnableIntegrityMonitoring returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineDetailsResponseModel) HasEnableIntegrityMonitoring() bool { + if o != nil && o.EnableIntegrityMonitoring.IsSet() { + return true + } + + return false +} + +// SetEnableIntegrityMonitoring gets a reference to the given NullableBool and assigns it to the EnableIntegrityMonitoring field. +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetEnableIntegrityMonitoring(v bool) { + o.EnableIntegrityMonitoring.Set(&v) +} +// SetEnableIntegrityMonitoringNil sets the value for EnableIntegrityMonitoring to be an explicit nil +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetEnableIntegrityMonitoringNil() { + o.EnableIntegrityMonitoring.Set(nil) +} + +// UnsetEnableIntegrityMonitoring ensures that no value is present for EnableIntegrityMonitoring, not even an explicit nil +func (o *ProvisionedVirtualMachineDetailsResponseModel) UnsetEnableIntegrityMonitoring() { + o.EnableIntegrityMonitoring.Unset() +} + +// GetEnableSecureBoot returns the EnableSecureBoot field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetEnableSecureBoot() bool { + if o == nil || IsNil(o.EnableSecureBoot.Get()) { + var ret bool + return ret + } + return *o.EnableSecureBoot.Get() +} + +// GetEnableSecureBootOk returns a tuple with the EnableSecureBoot field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetEnableSecureBootOk() (*bool, bool) { + if o == nil { + return nil, false + } + return o.EnableSecureBoot.Get(), o.EnableSecureBoot.IsSet() +} + +// HasEnableSecureBoot returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineDetailsResponseModel) HasEnableSecureBoot() bool { + if o != nil && o.EnableSecureBoot.IsSet() { + return true + } + + return false +} + +// SetEnableSecureBoot gets a reference to the given NullableBool and assigns it to the EnableSecureBoot field. +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetEnableSecureBoot(v bool) { + o.EnableSecureBoot.Set(&v) +} +// SetEnableSecureBootNil sets the value for EnableSecureBoot to be an explicit nil +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetEnableSecureBootNil() { + o.EnableSecureBoot.Set(nil) +} + +// UnsetEnableSecureBoot ensures that no value is present for EnableSecureBoot, not even an explicit nil +func (o *ProvisionedVirtualMachineDetailsResponseModel) UnsetEnableSecureBoot() { + o.EnableSecureBoot.Unset() +} + +// GetEnableVTPM returns the EnableVTPM field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetEnableVTPM() bool { + if o == nil || IsNil(o.EnableVTPM.Get()) { + var ret bool + return ret + } + return *o.EnableVTPM.Get() +} + +// GetEnableVTPMOk returns a tuple with the EnableVTPM field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetEnableVTPMOk() (*bool, bool) { + if o == nil { + return nil, false + } + return o.EnableVTPM.Get(), o.EnableVTPM.IsSet() +} + +// HasEnableVTPM returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineDetailsResponseModel) HasEnableVTPM() bool { + if o != nil && o.EnableVTPM.IsSet() { + return true + } + + return false +} + +// SetEnableVTPM gets a reference to the given NullableBool and assigns it to the EnableVTPM field. +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetEnableVTPM(v bool) { + o.EnableVTPM.Set(&v) +} +// SetEnableVTPMNil sets the value for EnableVTPM to be an explicit nil +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetEnableVTPMNil() { + o.EnableVTPM.Set(nil) +} + +// UnsetEnableVTPM ensures that no value is present for EnableVTPM, not even an explicit nil +func (o *ProvisionedVirtualMachineDetailsResponseModel) UnsetEnableVTPM() { + o.EnableVTPM.Unset() +} + +// GetEncryptionAtHost returns the EncryptionAtHost field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetEncryptionAtHost() bool { + if o == nil || IsNil(o.EncryptionAtHost.Get()) { + var ret bool + return ret + } + return *o.EncryptionAtHost.Get() +} + +// GetEncryptionAtHostOk returns a tuple with the EncryptionAtHost field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetEncryptionAtHostOk() (*bool, bool) { + if o == nil { + return nil, false + } + return o.EncryptionAtHost.Get(), o.EncryptionAtHost.IsSet() +} + +// HasEncryptionAtHost returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineDetailsResponseModel) HasEncryptionAtHost() bool { + if o != nil && o.EncryptionAtHost.IsSet() { + return true + } + + return false +} + +// SetEncryptionAtHost gets a reference to the given NullableBool and assigns it to the EncryptionAtHost field. +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetEncryptionAtHost(v bool) { + o.EncryptionAtHost.Set(&v) +} +// SetEncryptionAtHostNil sets the value for EncryptionAtHost to be an explicit nil +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetEncryptionAtHostNil() { + o.EncryptionAtHost.Set(nil) +} + +// UnsetEncryptionAtHost ensures that no value is present for EncryptionAtHost, not even an explicit nil +func (o *ProvisionedVirtualMachineDetailsResponseModel) UnsetEncryptionAtHost() { + o.EncryptionAtHost.Unset() +} + +// GetErrors returns the Errors field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetErrors() []string { + if o == nil { + var ret []string + return ret + } + return o.Errors +} + +// GetErrorsOk returns a tuple with the Errors field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetErrorsOk() ([]string, bool) { + if o == nil || IsNil(o.Errors) { + return nil, false + } + return o.Errors, true +} + +// HasErrors returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineDetailsResponseModel) HasErrors() bool { + if o != nil && IsNil(o.Errors) { + return true + } + + return false +} + +// SetErrors gets a reference to the given []string and assigns it to the Errors field. +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetErrors(v []string) { + o.Errors = v +} + +// GetPluginId returns the PluginId field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetPluginId() string { + if o == nil || IsNil(o.PluginId.Get()) { + var ret string + return ret + } + return *o.PluginId.Get() +} + +// GetPluginIdOk returns a tuple with the PluginId field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetPluginIdOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.PluginId.Get(), o.PluginId.IsSet() +} + +// HasPluginId returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineDetailsResponseModel) HasPluginId() bool { + if o != nil && o.PluginId.IsSet() { + return true + } + + return false +} + +// SetPluginId gets a reference to the given NullableString and assigns it to the PluginId field. +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetPluginId(v string) { + o.PluginId.Set(&v) +} +// SetPluginIdNil sets the value for PluginId to be an explicit nil +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetPluginIdNil() { + o.PluginId.Set(nil) +} + +// UnsetPluginId ensures that no value is present for PluginId, not even an explicit nil +func (o *ProvisionedVirtualMachineDetailsResponseModel) UnsetPluginId() { + o.PluginId.Unset() +} + +// GetImageOutOfDate returns the ImageOutOfDate field value if set, zero value otherwise. +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetImageOutOfDate() bool { + if o == nil || IsNil(o.ImageOutOfDate) { + var ret bool + return ret + } + return *o.ImageOutOfDate +} + +// GetImageOutOfDateOk returns a tuple with the ImageOutOfDate field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetImageOutOfDateOk() (*bool, bool) { + if o == nil || IsNil(o.ImageOutOfDate) { + return nil, false + } + return o.ImageOutOfDate, true +} + +// HasImageOutOfDate returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineDetailsResponseModel) HasImageOutOfDate() bool { + if o != nil && !IsNil(o.ImageOutOfDate) { + return true + } + + return false +} + +// SetImageOutOfDate gets a reference to the given bool and assigns it to the ImageOutOfDate field. +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetImageOutOfDate(v bool) { + o.ImageOutOfDate = &v +} + +// GetMemoryMB returns the MemoryMB field value if set, zero value otherwise. +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetMemoryMB() int32 { + if o == nil || IsNil(o.MemoryMB) { + var ret int32 + return ret + } + return *o.MemoryMB +} + +// GetMemoryMBOk returns a tuple with the MemoryMB field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetMemoryMBOk() (*int32, bool) { + if o == nil || IsNil(o.MemoryMB) { + return nil, false + } + return o.MemoryMB, true +} + +// HasMemoryMB returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineDetailsResponseModel) HasMemoryMB() bool { + if o != nil && !IsNil(o.MemoryMB) { + return true + } + + return false +} + +// SetMemoryMB gets a reference to the given int32 and assigns it to the MemoryMB field. +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetMemoryMB(v int32) { + o.MemoryMB = &v +} + +// GetHostingUnitUid returns the HostingUnitUid field value if set, zero value otherwise. +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetHostingUnitUid() string { + if o == nil || IsNil(o.HostingUnitUid) { + var ret string + return ret + } + return *o.HostingUnitUid +} + +// GetHostingUnitUidOk returns a tuple with the HostingUnitUid field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetHostingUnitUidOk() (*string, bool) { + if o == nil || IsNil(o.HostingUnitUid) { + return nil, false + } + return o.HostingUnitUid, true +} + +// HasHostingUnitUid returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineDetailsResponseModel) HasHostingUnitUid() bool { + if o != nil && !IsNil(o.HostingUnitUid) { + return true + } + + return false +} + +// SetHostingUnitUid gets a reference to the given string and assigns it to the HostingUnitUid field. +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetHostingUnitUid(v string) { + o.HostingUnitUid = &v +} + +// GetHypervisorConnectionUid returns the HypervisorConnectionUid field value if set, zero value otherwise. +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetHypervisorConnectionUid() string { + if o == nil || IsNil(o.HypervisorConnectionUid) { + var ret string + return ret + } + return *o.HypervisorConnectionUid +} + +// GetHypervisorConnectionUidOk returns a tuple with the HypervisorConnectionUid field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetHypervisorConnectionUidOk() (*string, bool) { + if o == nil || IsNil(o.HypervisorConnectionUid) { + return nil, false + } + return o.HypervisorConnectionUid, true +} + +// HasHypervisorConnectionUid returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineDetailsResponseModel) HasHypervisorConnectionUid() bool { + if o != nil && !IsNil(o.HypervisorConnectionUid) { + return true + } + + return false +} + +// SetHypervisorConnectionUid gets a reference to the given string and assigns it to the HypervisorConnectionUid field. +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetHypervisorConnectionUid(v string) { + o.HypervisorConnectionUid = &v +} + +// GetIdentityDiskId returns the IdentityDiskId field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetIdentityDiskId() string { + if o == nil || IsNil(o.IdentityDiskId.Get()) { + var ret string + return ret + } + return *o.IdentityDiskId.Get() +} + +// GetIdentityDiskIdOk returns a tuple with the IdentityDiskId field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetIdentityDiskIdOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.IdentityDiskId.Get(), o.IdentityDiskId.IsSet() +} + +// HasIdentityDiskId returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineDetailsResponseModel) HasIdentityDiskId() bool { + if o != nil && o.IdentityDiskId.IsSet() { + return true + } + + return false +} + +// SetIdentityDiskId gets a reference to the given NullableString and assigns it to the IdentityDiskId field. +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetIdentityDiskId(v string) { + o.IdentityDiskId.Set(&v) +} +// SetIdentityDiskIdNil sets the value for IdentityDiskId to be an explicit nil +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetIdentityDiskIdNil() { + o.IdentityDiskId.Set(nil) +} + +// UnsetIdentityDiskId ensures that no value is present for IdentityDiskId, not even an explicit nil +func (o *ProvisionedVirtualMachineDetailsResponseModel) UnsetIdentityDiskId() { + o.IdentityDiskId.Unset() +} + +// GetLastBootTime returns the LastBootTime field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetLastBootTime() string { + if o == nil || IsNil(o.LastBootTime.Get()) { + var ret string + return ret + } + return *o.LastBootTime.Get() +} + +// GetLastBootTimeOk returns a tuple with the LastBootTime field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetLastBootTimeOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.LastBootTime.Get(), o.LastBootTime.IsSet() +} + +// HasLastBootTime returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineDetailsResponseModel) HasLastBootTime() bool { + if o != nil && o.LastBootTime.IsSet() { + return true + } + + return false +} + +// SetLastBootTime gets a reference to the given NullableString and assigns it to the LastBootTime field. +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetLastBootTime(v string) { + o.LastBootTime.Set(&v) +} +// SetLastBootTimeNil sets the value for LastBootTime to be an explicit nil +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetLastBootTimeNil() { + o.LastBootTime.Set(nil) +} + +// UnsetLastBootTime ensures that no value is present for LastBootTime, not even an explicit nil +func (o *ProvisionedVirtualMachineDetailsResponseModel) UnsetLastBootTime() { + o.LastBootTime.Unset() +} + +// GetProvisioningSchemeType returns the ProvisioningSchemeType field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetProvisioningSchemeType() string { + if o == nil || IsNil(o.ProvisioningSchemeType.Get()) { + var ret string + return ret + } + return *o.ProvisioningSchemeType.Get() +} + +// GetProvisioningSchemeTypeOk returns a tuple with the ProvisioningSchemeType field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetProvisioningSchemeTypeOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.ProvisioningSchemeType.Get(), o.ProvisioningSchemeType.IsSet() +} + +// HasProvisioningSchemeType returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineDetailsResponseModel) HasProvisioningSchemeType() bool { + if o != nil && o.ProvisioningSchemeType.IsSet() { + return true + } + + return false +} + +// SetProvisioningSchemeType gets a reference to the given NullableString and assigns it to the ProvisioningSchemeType field. +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetProvisioningSchemeType(v string) { + o.ProvisioningSchemeType.Set(&v) +} +// SetProvisioningSchemeTypeNil sets the value for ProvisioningSchemeType to be an explicit nil +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetProvisioningSchemeTypeNil() { + o.ProvisioningSchemeType.Set(nil) +} + +// UnsetProvisioningSchemeType ensures that no value is present for ProvisioningSchemeType, not even an explicit nil +func (o *ProvisionedVirtualMachineDetailsResponseModel) UnsetProvisioningSchemeType() { + o.ProvisioningSchemeType.Unset() +} + +// GetProvisioningSchemeUpdateRequested returns the ProvisioningSchemeUpdateRequested field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetProvisioningSchemeUpdateRequested() string { + if o == nil || IsNil(o.ProvisioningSchemeUpdateRequested.Get()) { + var ret string + return ret + } + return *o.ProvisioningSchemeUpdateRequested.Get() +} + +// GetProvisioningSchemeUpdateRequestedOk returns a tuple with the ProvisioningSchemeUpdateRequested field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetProvisioningSchemeUpdateRequestedOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.ProvisioningSchemeUpdateRequested.Get(), o.ProvisioningSchemeUpdateRequested.IsSet() +} + +// HasProvisioningSchemeUpdateRequested returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineDetailsResponseModel) HasProvisioningSchemeUpdateRequested() bool { + if o != nil && o.ProvisioningSchemeUpdateRequested.IsSet() { + return true + } + + return false +} + +// SetProvisioningSchemeUpdateRequested gets a reference to the given NullableString and assigns it to the ProvisioningSchemeUpdateRequested field. +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetProvisioningSchemeUpdateRequested(v string) { + o.ProvisioningSchemeUpdateRequested.Set(&v) +} +// SetProvisioningSchemeUpdateRequestedNil sets the value for ProvisioningSchemeUpdateRequested to be an explicit nil +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetProvisioningSchemeUpdateRequestedNil() { + o.ProvisioningSchemeUpdateRequested.Set(nil) +} + +// UnsetProvisioningSchemeUpdateRequested ensures that no value is present for ProvisioningSchemeUpdateRequested, not even an explicit nil +func (o *ProvisionedVirtualMachineDetailsResponseModel) UnsetProvisioningSchemeUpdateRequested() { + o.ProvisioningSchemeUpdateRequested.Unset() +} + +// GetProvisioningSchemeVersion returns the ProvisioningSchemeVersion field value if set, zero value otherwise. +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetProvisioningSchemeVersion() int32 { + if o == nil || IsNil(o.ProvisioningSchemeVersion) { + var ret int32 + return ret + } + return *o.ProvisioningSchemeVersion +} + +// GetProvisioningSchemeVersionOk returns a tuple with the ProvisioningSchemeVersion field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetProvisioningSchemeVersionOk() (*int32, bool) { + if o == nil || IsNil(o.ProvisioningSchemeVersion) { + return nil, false + } + return o.ProvisioningSchemeVersion, true +} + +// HasProvisioningSchemeVersion returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineDetailsResponseModel) HasProvisioningSchemeVersion() bool { + if o != nil && !IsNil(o.ProvisioningSchemeVersion) { + return true + } + + return false +} + +// SetProvisioningSchemeVersion gets a reference to the given int32 and assigns it to the ProvisioningSchemeVersion field. +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetProvisioningSchemeVersion(v int32) { + o.ProvisioningSchemeVersion = &v +} + +// GetUseFullDiskCloneProvisioning returns the UseFullDiskCloneProvisioning field value if set, zero value otherwise. +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetUseFullDiskCloneProvisioning() bool { + if o == nil || IsNil(o.UseFullDiskCloneProvisioning) { + var ret bool + return ret + } + return *o.UseFullDiskCloneProvisioning +} + +// GetUseFullDiskCloneProvisioningOk returns a tuple with the UseFullDiskCloneProvisioning field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetUseFullDiskCloneProvisioningOk() (*bool, bool) { + if o == nil || IsNil(o.UseFullDiskCloneProvisioning) { + return nil, false + } + return o.UseFullDiskCloneProvisioning, true +} + +// HasUseFullDiskCloneProvisioning returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineDetailsResponseModel) HasUseFullDiskCloneProvisioning() bool { + if o != nil && !IsNil(o.UseFullDiskCloneProvisioning) { + return true + } + + return false +} + +// SetUseFullDiskCloneProvisioning gets a reference to the given bool and assigns it to the UseFullDiskCloneProvisioning field. +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetUseFullDiskCloneProvisioning(v bool) { + o.UseFullDiskCloneProvisioning = &v +} + +// GetVMId returns the VMId field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetVMId() string { + if o == nil || IsNil(o.VMId.Get()) { + var ret string + return ret + } + return *o.VMId.Get() +} + +// GetVMIdOk returns a tuple with the VMId field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetVMIdOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.VMId.Get(), o.VMId.IsSet() +} + +// HasVMId returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineDetailsResponseModel) HasVMId() bool { + if o != nil && o.VMId.IsSet() { + return true + } + + return false +} + +// SetVMId gets a reference to the given NullableString and assigns it to the VMId field. +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetVMId(v string) { + o.VMId.Set(&v) +} +// SetVMIdNil sets the value for VMId to be an explicit nil +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetVMIdNil() { + o.VMId.Set(nil) +} + +// UnsetVMId ensures that no value is present for VMId, not even an explicit nil +func (o *ProvisionedVirtualMachineDetailsResponseModel) UnsetVMId() { + o.VMId.Unset() +} + +// GetVMName returns the VMName field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetVMName() string { + if o == nil || IsNil(o.VMName.Get()) { + var ret string + return ret + } + return *o.VMName.Get() +} + +// GetVMNameOk returns a tuple with the VMName field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetVMNameOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.VMName.Get(), o.VMName.IsSet() +} + +// HasVMName returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineDetailsResponseModel) HasVMName() bool { + if o != nil && o.VMName.IsSet() { + return true + } + + return false +} + +// SetVMName gets a reference to the given NullableString and assigns it to the VMName field. +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetVMName(v string) { + o.VMName.Set(&v) +} +// SetVMNameNil sets the value for VMName to be an explicit nil +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetVMNameNil() { + o.VMName.Set(nil) +} + +// UnsetVMName ensures that no value is present for VMName, not even an explicit nil +func (o *ProvisionedVirtualMachineDetailsResponseModel) UnsetVMName() { + o.VMName.Unset() +} + +// GetWarnings returns the Warnings field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetWarnings() []ProvisionedVirtualMachineDetailsWarningReponseModel { + if o == nil { + var ret []ProvisionedVirtualMachineDetailsWarningReponseModel + return ret + } + return o.Warnings +} + +// GetWarningsOk returns a tuple with the Warnings field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetWarningsOk() ([]ProvisionedVirtualMachineDetailsWarningReponseModel, bool) { + if o == nil || IsNil(o.Warnings) { + return nil, false + } + return o.Warnings, true +} + +// HasWarnings returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineDetailsResponseModel) HasWarnings() bool { + if o != nil && IsNil(o.Warnings) { + return true + } + + return false +} + +// SetWarnings gets a reference to the given []ProvisionedVirtualMachineDetailsWarningReponseModel and assigns it to the Warnings field. +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetWarnings(v []ProvisionedVirtualMachineDetailsWarningReponseModel) { + o.Warnings = v +} + +// GetWindowsActivationStatus returns the WindowsActivationStatus field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetWindowsActivationStatus() string { + if o == nil || IsNil(o.WindowsActivationStatus.Get()) { + var ret string + return ret + } + return *o.WindowsActivationStatus.Get() +} + +// GetWindowsActivationStatusOk returns a tuple with the WindowsActivationStatus field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetWindowsActivationStatusOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.WindowsActivationStatus.Get(), o.WindowsActivationStatus.IsSet() +} + +// HasWindowsActivationStatus returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineDetailsResponseModel) HasWindowsActivationStatus() bool { + if o != nil && o.WindowsActivationStatus.IsSet() { + return true + } + + return false +} + +// SetWindowsActivationStatus gets a reference to the given NullableString and assigns it to the WindowsActivationStatus field. +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetWindowsActivationStatus(v string) { + o.WindowsActivationStatus.Set(&v) +} +// SetWindowsActivationStatusNil sets the value for WindowsActivationStatus to be an explicit nil +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetWindowsActivationStatusNil() { + o.WindowsActivationStatus.Set(nil) +} + +// UnsetWindowsActivationStatus ensures that no value is present for WindowsActivationStatus, not even an explicit nil +func (o *ProvisionedVirtualMachineDetailsResponseModel) UnsetWindowsActivationStatus() { + o.WindowsActivationStatus.Unset() +} + +// GetWindowsActivationStatusErrorCode returns the WindowsActivationStatusErrorCode field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetWindowsActivationStatusErrorCode() string { + if o == nil || IsNil(o.WindowsActivationStatusErrorCode.Get()) { + var ret string + return ret + } + return *o.WindowsActivationStatusErrorCode.Get() +} + +// GetWindowsActivationStatusErrorCodeOk returns a tuple with the WindowsActivationStatusErrorCode field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetWindowsActivationStatusErrorCodeOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.WindowsActivationStatusErrorCode.Get(), o.WindowsActivationStatusErrorCode.IsSet() +} + +// HasWindowsActivationStatusErrorCode returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineDetailsResponseModel) HasWindowsActivationStatusErrorCode() bool { + if o != nil && o.WindowsActivationStatusErrorCode.IsSet() { + return true + } + + return false +} + +// SetWindowsActivationStatusErrorCode gets a reference to the given NullableString and assigns it to the WindowsActivationStatusErrorCode field. +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetWindowsActivationStatusErrorCode(v string) { + o.WindowsActivationStatusErrorCode.Set(&v) +} +// SetWindowsActivationStatusErrorCodeNil sets the value for WindowsActivationStatusErrorCode to be an explicit nil +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetWindowsActivationStatusErrorCodeNil() { + o.WindowsActivationStatusErrorCode.Set(nil) +} + +// UnsetWindowsActivationStatusErrorCode ensures that no value is present for WindowsActivationStatusErrorCode, not even an explicit nil +func (o *ProvisionedVirtualMachineDetailsResponseModel) UnsetWindowsActivationStatusErrorCode() { + o.WindowsActivationStatusErrorCode.Unset() +} + +// GetWindowsActivationStatusVirtualMachineError returns the WindowsActivationStatusVirtualMachineError field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetWindowsActivationStatusVirtualMachineError() string { + if o == nil || IsNil(o.WindowsActivationStatusVirtualMachineError.Get()) { + var ret string + return ret + } + return *o.WindowsActivationStatusVirtualMachineError.Get() +} + +// GetWindowsActivationStatusVirtualMachineErrorOk returns a tuple with the WindowsActivationStatusVirtualMachineError field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetWindowsActivationStatusVirtualMachineErrorOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.WindowsActivationStatusVirtualMachineError.Get(), o.WindowsActivationStatusVirtualMachineError.IsSet() +} + +// HasWindowsActivationStatusVirtualMachineError returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineDetailsResponseModel) HasWindowsActivationStatusVirtualMachineError() bool { + if o != nil && o.WindowsActivationStatusVirtualMachineError.IsSet() { + return true + } + + return false +} + +// SetWindowsActivationStatusVirtualMachineError gets a reference to the given NullableString and assigns it to the WindowsActivationStatusVirtualMachineError field. +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetWindowsActivationStatusVirtualMachineError(v string) { + o.WindowsActivationStatusVirtualMachineError.Set(&v) +} +// SetWindowsActivationStatusVirtualMachineErrorNil sets the value for WindowsActivationStatusVirtualMachineError to be an explicit nil +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetWindowsActivationStatusVirtualMachineErrorNil() { + o.WindowsActivationStatusVirtualMachineError.Set(nil) +} + +// UnsetWindowsActivationStatusVirtualMachineError ensures that no value is present for WindowsActivationStatusVirtualMachineError, not even an explicit nil +func (o *ProvisionedVirtualMachineDetailsResponseModel) UnsetWindowsActivationStatusVirtualMachineError() { + o.WindowsActivationStatusVirtualMachineError.Unset() +} + +// GetWindowsActivationTypeProvisionedVirtualMachine returns the WindowsActivationTypeProvisionedVirtualMachine field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetWindowsActivationTypeProvisionedVirtualMachine() string { + if o == nil || IsNil(o.WindowsActivationTypeProvisionedVirtualMachine.Get()) { + var ret string + return ret + } + return *o.WindowsActivationTypeProvisionedVirtualMachine.Get() +} + +// GetWindowsActivationTypeProvisionedVirtualMachineOk returns a tuple with the WindowsActivationTypeProvisionedVirtualMachine field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetWindowsActivationTypeProvisionedVirtualMachineOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.WindowsActivationTypeProvisionedVirtualMachine.Get(), o.WindowsActivationTypeProvisionedVirtualMachine.IsSet() +} + +// HasWindowsActivationTypeProvisionedVirtualMachine returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineDetailsResponseModel) HasWindowsActivationTypeProvisionedVirtualMachine() bool { + if o != nil && o.WindowsActivationTypeProvisionedVirtualMachine.IsSet() { + return true + } + + return false +} + +// SetWindowsActivationTypeProvisionedVirtualMachine gets a reference to the given NullableString and assigns it to the WindowsActivationTypeProvisionedVirtualMachine field. +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetWindowsActivationTypeProvisionedVirtualMachine(v string) { + o.WindowsActivationTypeProvisionedVirtualMachine.Set(&v) +} +// SetWindowsActivationTypeProvisionedVirtualMachineNil sets the value for WindowsActivationTypeProvisionedVirtualMachine to be an explicit nil +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetWindowsActivationTypeProvisionedVirtualMachineNil() { + o.WindowsActivationTypeProvisionedVirtualMachine.Set(nil) +} + +// UnsetWindowsActivationTypeProvisionedVirtualMachine ensures that no value is present for WindowsActivationTypeProvisionedVirtualMachine, not even an explicit nil +func (o *ProvisionedVirtualMachineDetailsResponseModel) UnsetWindowsActivationTypeProvisionedVirtualMachine() { + o.WindowsActivationTypeProvisionedVirtualMachine.Unset() +} + +// GetWriteBackCacheDiskSize returns the WriteBackCacheDiskSize field value if set, zero value otherwise. +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetWriteBackCacheDiskSize() int32 { + if o == nil || IsNil(o.WriteBackCacheDiskSize) { + var ret int32 + return ret + } + return *o.WriteBackCacheDiskSize +} + +// GetWriteBackCacheDiskSizeOk returns a tuple with the WriteBackCacheDiskSize field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetWriteBackCacheDiskSizeOk() (*int32, bool) { + if o == nil || IsNil(o.WriteBackCacheDiskSize) { + return nil, false + } + return o.WriteBackCacheDiskSize, true +} + +// HasWriteBackCacheDiskSize returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineDetailsResponseModel) HasWriteBackCacheDiskSize() bool { + if o != nil && !IsNil(o.WriteBackCacheDiskSize) { + return true + } + + return false +} + +// SetWriteBackCacheDiskSize gets a reference to the given int32 and assigns it to the WriteBackCacheDiskSize field. +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetWriteBackCacheDiskSize(v int32) { + o.WriteBackCacheDiskSize = &v +} + +// GetWriteBackCacheMemorySize returns the WriteBackCacheMemorySize field value if set, zero value otherwise. +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetWriteBackCacheMemorySize() int32 { + if o == nil || IsNil(o.WriteBackCacheMemorySize) { + var ret int32 + return ret + } + return *o.WriteBackCacheMemorySize +} + +// GetWriteBackCacheMemorySizeOk returns a tuple with the WriteBackCacheMemorySize field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ProvisionedVirtualMachineDetailsResponseModel) GetWriteBackCacheMemorySizeOk() (*int32, bool) { + if o == nil || IsNil(o.WriteBackCacheMemorySize) { + return nil, false + } + return o.WriteBackCacheMemorySize, true +} + +// HasWriteBackCacheMemorySize returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineDetailsResponseModel) HasWriteBackCacheMemorySize() bool { + if o != nil && !IsNil(o.WriteBackCacheMemorySize) { + return true + } + + return false +} + +// SetWriteBackCacheMemorySize gets a reference to the given int32 and assigns it to the WriteBackCacheMemorySize field. +func (o *ProvisionedVirtualMachineDetailsResponseModel) SetWriteBackCacheMemorySize(v int32) { + o.WriteBackCacheMemorySize = &v +} + +func (o ProvisionedVirtualMachineDetailsResponseModel) MarshalJSON() ([]byte, error) { + toSerialize,err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o ProvisionedVirtualMachineDetailsResponseModel) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + if o.AcceleratedNetwork.IsSet() { + toSerialize["AcceleratedNetwork"] = o.AcceleratedNetwork.Get() + } + if o.ADAccountName.IsSet() { + toSerialize["ADAccountName"] = o.ADAccountName.Get() + } + if o.VMSid.IsSet() { + toSerialize["VMSid"] = o.VMSid.Get() + } + if o.AssignedImage.IsSet() { + toSerialize["AssignedImage"] = o.AssignedImage.Get() + } + if o.BootedImage.IsSet() { + toSerialize["BootedImage"] = o.BootedImage.Get() + } + if !IsNil(o.CustomVmData) { + toSerialize["CustomVmData"] = o.CustomVmData + } + if !IsNil(o.CpuCount) { + toSerialize["CpuCount"] = o.CpuCount + } + if o.CreationDate.IsSet() { + toSerialize["CreationDate"] = o.CreationDate.Get() + } + if o.Domain.IsSet() { + toSerialize["Domain"] = o.Domain.Get() + } + if o.EnableIntegrityMonitoring.IsSet() { + toSerialize["EnableIntegrityMonitoring"] = o.EnableIntegrityMonitoring.Get() + } + if o.EnableSecureBoot.IsSet() { + toSerialize["EnableSecureBoot"] = o.EnableSecureBoot.Get() + } + if o.EnableVTPM.IsSet() { + toSerialize["EnableVTPM"] = o.EnableVTPM.Get() + } + if o.EncryptionAtHost.IsSet() { + toSerialize["EncryptionAtHost"] = o.EncryptionAtHost.Get() + } + if o.Errors != nil { + toSerialize["Errors"] = o.Errors + } + if o.PluginId.IsSet() { + toSerialize["PluginId"] = o.PluginId.Get() + } + if !IsNil(o.ImageOutOfDate) { + toSerialize["ImageOutOfDate"] = o.ImageOutOfDate + } + if !IsNil(o.MemoryMB) { + toSerialize["MemoryMB"] = o.MemoryMB + } + if !IsNil(o.HostingUnitUid) { + toSerialize["HostingUnitUid"] = o.HostingUnitUid + } + if !IsNil(o.HypervisorConnectionUid) { + toSerialize["HypervisorConnectionUid"] = o.HypervisorConnectionUid + } + if o.IdentityDiskId.IsSet() { + toSerialize["IdentityDiskId"] = o.IdentityDiskId.Get() + } + if o.LastBootTime.IsSet() { + toSerialize["LastBootTime"] = o.LastBootTime.Get() + } + if o.ProvisioningSchemeType.IsSet() { + toSerialize["ProvisioningSchemeType"] = o.ProvisioningSchemeType.Get() + } + if o.ProvisioningSchemeUpdateRequested.IsSet() { + toSerialize["ProvisioningSchemeUpdateRequested"] = o.ProvisioningSchemeUpdateRequested.Get() + } + if !IsNil(o.ProvisioningSchemeVersion) { + toSerialize["ProvisioningSchemeVersion"] = o.ProvisioningSchemeVersion + } + if !IsNil(o.UseFullDiskCloneProvisioning) { + toSerialize["UseFullDiskCloneProvisioning"] = o.UseFullDiskCloneProvisioning + } + if o.VMId.IsSet() { + toSerialize["VMId"] = o.VMId.Get() + } + if o.VMName.IsSet() { + toSerialize["VMName"] = o.VMName.Get() + } + if o.Warnings != nil { + toSerialize["Warnings"] = o.Warnings + } + if o.WindowsActivationStatus.IsSet() { + toSerialize["WindowsActivationStatus"] = o.WindowsActivationStatus.Get() + } + if o.WindowsActivationStatusErrorCode.IsSet() { + toSerialize["WindowsActivationStatusErrorCode"] = o.WindowsActivationStatusErrorCode.Get() + } + if o.WindowsActivationStatusVirtualMachineError.IsSet() { + toSerialize["WindowsActivationStatusVirtualMachineError"] = o.WindowsActivationStatusVirtualMachineError.Get() + } + if o.WindowsActivationTypeProvisionedVirtualMachine.IsSet() { + toSerialize["WindowsActivationTypeProvisionedVirtualMachine"] = o.WindowsActivationTypeProvisionedVirtualMachine.Get() + } + if !IsNil(o.WriteBackCacheDiskSize) { + toSerialize["WriteBackCacheDiskSize"] = o.WriteBackCacheDiskSize + } + if !IsNil(o.WriteBackCacheMemorySize) { + toSerialize["WriteBackCacheMemorySize"] = o.WriteBackCacheMemorySize + } + return toSerialize, nil +} + +type NullableProvisionedVirtualMachineDetailsResponseModel struct { + value *ProvisionedVirtualMachineDetailsResponseModel + isSet bool +} + +func (v NullableProvisionedVirtualMachineDetailsResponseModel) Get() *ProvisionedVirtualMachineDetailsResponseModel { + return v.value +} + +func (v *NullableProvisionedVirtualMachineDetailsResponseModel) Set(val *ProvisionedVirtualMachineDetailsResponseModel) { + v.value = val + v.isSet = true +} + +func (v NullableProvisionedVirtualMachineDetailsResponseModel) IsSet() bool { + return v.isSet +} + +func (v *NullableProvisionedVirtualMachineDetailsResponseModel) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableProvisionedVirtualMachineDetailsResponseModel(val *ProvisionedVirtualMachineDetailsResponseModel) *NullableProvisionedVirtualMachineDetailsResponseModel { + return &NullableProvisionedVirtualMachineDetailsResponseModel{value: val, isSet: true} +} + +func (v NullableProvisionedVirtualMachineDetailsResponseModel) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableProvisionedVirtualMachineDetailsResponseModel) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/citrixorchestration/model_provisioned_virtual_machine_details_warning_reponse_model.go b/citrixorchestration/model_provisioned_virtual_machine_details_warning_reponse_model.go new file mode 100644 index 0000000..6cebc25 --- /dev/null +++ b/citrixorchestration/model_provisioned_virtual_machine_details_warning_reponse_model.go @@ -0,0 +1,173 @@ +/* +Citrix Virtual Apps and Desktops Rest API for Developer Portal + +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + +API version: devportal-onprem-ga +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package citrixorchestration + +import ( + "encoding/json" +) + +// checks if the ProvisionedVirtualMachineDetailsWarningReponseModel type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &ProvisionedVirtualMachineDetailsWarningReponseModel{} + +// ProvisionedVirtualMachineDetailsWarningReponseModel struct for ProvisionedVirtualMachineDetailsWarningReponseModel +type ProvisionedVirtualMachineDetailsWarningReponseModel struct { + Type *ProvisionedVirtualMachineDetailsWarningType `json:"Type,omitempty"` + // Message associated with warning + Message NullableString `json:"Message,omitempty"` +} + +// NewProvisionedVirtualMachineDetailsWarningReponseModel instantiates a new ProvisionedVirtualMachineDetailsWarningReponseModel object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewProvisionedVirtualMachineDetailsWarningReponseModel() *ProvisionedVirtualMachineDetailsWarningReponseModel { + this := ProvisionedVirtualMachineDetailsWarningReponseModel{} + return &this +} + +// NewProvisionedVirtualMachineDetailsWarningReponseModelWithDefaults instantiates a new ProvisionedVirtualMachineDetailsWarningReponseModel object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewProvisionedVirtualMachineDetailsWarningReponseModelWithDefaults() *ProvisionedVirtualMachineDetailsWarningReponseModel { + this := ProvisionedVirtualMachineDetailsWarningReponseModel{} + return &this +} + +// GetType returns the Type field value if set, zero value otherwise. +func (o *ProvisionedVirtualMachineDetailsWarningReponseModel) GetType() ProvisionedVirtualMachineDetailsWarningType { + if o == nil || IsNil(o.Type) { + var ret ProvisionedVirtualMachineDetailsWarningType + return ret + } + return *o.Type +} + +// GetTypeOk returns a tuple with the Type field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ProvisionedVirtualMachineDetailsWarningReponseModel) GetTypeOk() (*ProvisionedVirtualMachineDetailsWarningType, bool) { + if o == nil || IsNil(o.Type) { + return nil, false + } + return o.Type, true +} + +// HasType returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineDetailsWarningReponseModel) HasType() bool { + if o != nil && !IsNil(o.Type) { + return true + } + + return false +} + +// SetType gets a reference to the given ProvisionedVirtualMachineDetailsWarningType and assigns it to the Type field. +func (o *ProvisionedVirtualMachineDetailsWarningReponseModel) SetType(v ProvisionedVirtualMachineDetailsWarningType) { + o.Type = &v +} + +// GetMessage returns the Message field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineDetailsWarningReponseModel) GetMessage() string { + if o == nil || IsNil(o.Message.Get()) { + var ret string + return ret + } + return *o.Message.Get() +} + +// GetMessageOk returns a tuple with the Message field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineDetailsWarningReponseModel) GetMessageOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.Message.Get(), o.Message.IsSet() +} + +// HasMessage returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineDetailsWarningReponseModel) HasMessage() bool { + if o != nil && o.Message.IsSet() { + return true + } + + return false +} + +// SetMessage gets a reference to the given NullableString and assigns it to the Message field. +func (o *ProvisionedVirtualMachineDetailsWarningReponseModel) SetMessage(v string) { + o.Message.Set(&v) +} +// SetMessageNil sets the value for Message to be an explicit nil +func (o *ProvisionedVirtualMachineDetailsWarningReponseModel) SetMessageNil() { + o.Message.Set(nil) +} + +// UnsetMessage ensures that no value is present for Message, not even an explicit nil +func (o *ProvisionedVirtualMachineDetailsWarningReponseModel) UnsetMessage() { + o.Message.Unset() +} + +func (o ProvisionedVirtualMachineDetailsWarningReponseModel) MarshalJSON() ([]byte, error) { + toSerialize,err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o ProvisionedVirtualMachineDetailsWarningReponseModel) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + if !IsNil(o.Type) { + toSerialize["Type"] = o.Type + } + if o.Message.IsSet() { + toSerialize["Message"] = o.Message.Get() + } + return toSerialize, nil +} + +type NullableProvisionedVirtualMachineDetailsWarningReponseModel struct { + value *ProvisionedVirtualMachineDetailsWarningReponseModel + isSet bool +} + +func (v NullableProvisionedVirtualMachineDetailsWarningReponseModel) Get() *ProvisionedVirtualMachineDetailsWarningReponseModel { + return v.value +} + +func (v *NullableProvisionedVirtualMachineDetailsWarningReponseModel) Set(val *ProvisionedVirtualMachineDetailsWarningReponseModel) { + v.value = val + v.isSet = true +} + +func (v NullableProvisionedVirtualMachineDetailsWarningReponseModel) IsSet() bool { + return v.isSet +} + +func (v *NullableProvisionedVirtualMachineDetailsWarningReponseModel) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableProvisionedVirtualMachineDetailsWarningReponseModel(val *ProvisionedVirtualMachineDetailsWarningReponseModel) *NullableProvisionedVirtualMachineDetailsWarningReponseModel { + return &NullableProvisionedVirtualMachineDetailsWarningReponseModel{value: val, isSet: true} +} + +func (v NullableProvisionedVirtualMachineDetailsWarningReponseModel) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableProvisionedVirtualMachineDetailsWarningReponseModel) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/citrixorchestration/model_provisioned_virtual_machine_details_warning_type.go b/citrixorchestration/model_provisioned_virtual_machine_details_warning_type.go new file mode 100644 index 0000000..7ed64a7 --- /dev/null +++ b/citrixorchestration/model_provisioned_virtual_machine_details_warning_type.go @@ -0,0 +1,113 @@ +/* +Citrix Virtual Apps and Desktops Rest API for Developer Portal + +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + +API version: devportal-onprem-ga +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package citrixorchestration + +import ( + "encoding/json" + "fmt" +) + +// ProvisionedVirtualMachineDetailsWarningType +type ProvisionedVirtualMachineDetailsWarningType string + +// List of ProvisionedVirtualMachineDetailsWarningType +const ( + PROVISIONEDVIRTUALMACHINEDETAILSWARNINGTYPE_UNKNOWN ProvisionedVirtualMachineDetailsWarningType = "Unknown" + PROVISIONEDVIRTUALMACHINEDETAILSWARNINGTYPE_GET_PROVISIONED_VIRTUAL_MACHINE_CUSTOM_VM_DATA_FAILED ProvisionedVirtualMachineDetailsWarningType = "GetProvisionedVirtualMachineCustomVMDataFailed" + PROVISIONEDVIRTUALMACHINEDETAILSWARNINGTYPE_GET_PROVISIONING_SCHEME_VM_METADATA_FAILED ProvisionedVirtualMachineDetailsWarningType = "GetProvisioningSchemeVMMetadataFailed" +) + +// All allowed values of ProvisionedVirtualMachineDetailsWarningType enum +var AllowedProvisionedVirtualMachineDetailsWarningTypeEnumValues = []ProvisionedVirtualMachineDetailsWarningType{ + "Unknown", + "GetProvisionedVirtualMachineCustomVMDataFailed", + "GetProvisioningSchemeVMMetadataFailed", +} + +func (v *ProvisionedVirtualMachineDetailsWarningType) UnmarshalJSON(src []byte) error { + var value string + err := json.Unmarshal(src, &value) + if err != nil { + return err + } + enumTypeValue := ProvisionedVirtualMachineDetailsWarningType(value) + for _, existing := range AllowedProvisionedVirtualMachineDetailsWarningTypeEnumValues { + if existing == enumTypeValue { + *v = enumTypeValue + return nil + } + } + + return fmt.Errorf("%+v is not a valid ProvisionedVirtualMachineDetailsWarningType", value) +} + +// NewProvisionedVirtualMachineDetailsWarningTypeFromValue returns a pointer to a valid ProvisionedVirtualMachineDetailsWarningType +// for the value passed as argument, or an error if the value passed is not allowed by the enum +func NewProvisionedVirtualMachineDetailsWarningTypeFromValue(v string) (*ProvisionedVirtualMachineDetailsWarningType, error) { + ev := ProvisionedVirtualMachineDetailsWarningType(v) + if ev.IsValid() { + return &ev, nil + } else { + return nil, fmt.Errorf("invalid value '%v' for ProvisionedVirtualMachineDetailsWarningType: valid values are %v", v, AllowedProvisionedVirtualMachineDetailsWarningTypeEnumValues) + } +} + +// IsValid return true if the value is valid for the enum, false otherwise +func (v ProvisionedVirtualMachineDetailsWarningType) IsValid() bool { + for _, existing := range AllowedProvisionedVirtualMachineDetailsWarningTypeEnumValues { + if existing == v { + return true + } + } + return false +} + +// Ptr returns reference to ProvisionedVirtualMachineDetailsWarningType value +func (v ProvisionedVirtualMachineDetailsWarningType) Ptr() *ProvisionedVirtualMachineDetailsWarningType { + return &v +} + +type NullableProvisionedVirtualMachineDetailsWarningType struct { + value *ProvisionedVirtualMachineDetailsWarningType + isSet bool +} + +func (v NullableProvisionedVirtualMachineDetailsWarningType) Get() *ProvisionedVirtualMachineDetailsWarningType { + return v.value +} + +func (v *NullableProvisionedVirtualMachineDetailsWarningType) Set(val *ProvisionedVirtualMachineDetailsWarningType) { + v.value = val + v.isSet = true +} + +func (v NullableProvisionedVirtualMachineDetailsWarningType) IsSet() bool { + return v.isSet +} + +func (v *NullableProvisionedVirtualMachineDetailsWarningType) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableProvisionedVirtualMachineDetailsWarningType(val *ProvisionedVirtualMachineDetailsWarningType) *NullableProvisionedVirtualMachineDetailsWarningType { + return &NullableProvisionedVirtualMachineDetailsWarningType{value: val, isSet: true} +} + +func (v NullableProvisionedVirtualMachineDetailsWarningType) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableProvisionedVirtualMachineDetailsWarningType) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + diff --git a/citrixorchestration/model_provisioned_virtual_machine_search_filter_group_request_model.go b/citrixorchestration/model_provisioned_virtual_machine_search_filter_group_request_model.go new file mode 100644 index 0000000..a390a3c --- /dev/null +++ b/citrixorchestration/model_provisioned_virtual_machine_search_filter_group_request_model.go @@ -0,0 +1,238 @@ +/* +Citrix Virtual Apps and Desktops Rest API for Developer Portal + +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + +API version: devportal-onprem-ga +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package citrixorchestration + +import ( + "encoding/json" +) + +// checks if the ProvisionedVirtualMachineSearchFilterGroupRequestModel type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &ProvisionedVirtualMachineSearchFilterGroupRequestModel{} + +// ProvisionedVirtualMachineSearchFilterGroupRequestModel Advanced search filter group for machines and sessions +type ProvisionedVirtualMachineSearchFilterGroupRequestModel struct { + SearchFilterGroupType *ProvisionedVirtualMachineSearchFilterGroupType `json:"SearchFilterGroupType,omitempty"` + // The search filters in search filter group + SearchFilters []ProvisionedVirtualMachineSearchFilterRequestModel `json:"SearchFilters,omitempty"` + SearchFilterGroupsType *ProvisionedVirtualMachineSearchFilterGroupsType `json:"SearchFilterGroupsType,omitempty"` + // The search filter group in search filter groups + SearchFilterGroups []ProvisionedVirtualMachineSearchFilterGroupRequestModel `json:"SearchFilterGroups,omitempty"` +} + +// NewProvisionedVirtualMachineSearchFilterGroupRequestModel instantiates a new ProvisionedVirtualMachineSearchFilterGroupRequestModel object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewProvisionedVirtualMachineSearchFilterGroupRequestModel() *ProvisionedVirtualMachineSearchFilterGroupRequestModel { + this := ProvisionedVirtualMachineSearchFilterGroupRequestModel{} + return &this +} + +// NewProvisionedVirtualMachineSearchFilterGroupRequestModelWithDefaults instantiates a new ProvisionedVirtualMachineSearchFilterGroupRequestModel object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewProvisionedVirtualMachineSearchFilterGroupRequestModelWithDefaults() *ProvisionedVirtualMachineSearchFilterGroupRequestModel { + this := ProvisionedVirtualMachineSearchFilterGroupRequestModel{} + return &this +} + +// GetSearchFilterGroupType returns the SearchFilterGroupType field value if set, zero value otherwise. +func (o *ProvisionedVirtualMachineSearchFilterGroupRequestModel) GetSearchFilterGroupType() ProvisionedVirtualMachineSearchFilterGroupType { + if o == nil || IsNil(o.SearchFilterGroupType) { + var ret ProvisionedVirtualMachineSearchFilterGroupType + return ret + } + return *o.SearchFilterGroupType +} + +// GetSearchFilterGroupTypeOk returns a tuple with the SearchFilterGroupType field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ProvisionedVirtualMachineSearchFilterGroupRequestModel) GetSearchFilterGroupTypeOk() (*ProvisionedVirtualMachineSearchFilterGroupType, bool) { + if o == nil || IsNil(o.SearchFilterGroupType) { + return nil, false + } + return o.SearchFilterGroupType, true +} + +// HasSearchFilterGroupType returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineSearchFilterGroupRequestModel) HasSearchFilterGroupType() bool { + if o != nil && !IsNil(o.SearchFilterGroupType) { + return true + } + + return false +} + +// SetSearchFilterGroupType gets a reference to the given ProvisionedVirtualMachineSearchFilterGroupType and assigns it to the SearchFilterGroupType field. +func (o *ProvisionedVirtualMachineSearchFilterGroupRequestModel) SetSearchFilterGroupType(v ProvisionedVirtualMachineSearchFilterGroupType) { + o.SearchFilterGroupType = &v +} + +// GetSearchFilters returns the SearchFilters field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineSearchFilterGroupRequestModel) GetSearchFilters() []ProvisionedVirtualMachineSearchFilterRequestModel { + if o == nil { + var ret []ProvisionedVirtualMachineSearchFilterRequestModel + return ret + } + return o.SearchFilters +} + +// GetSearchFiltersOk returns a tuple with the SearchFilters field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineSearchFilterGroupRequestModel) GetSearchFiltersOk() ([]ProvisionedVirtualMachineSearchFilterRequestModel, bool) { + if o == nil || IsNil(o.SearchFilters) { + return nil, false + } + return o.SearchFilters, true +} + +// HasSearchFilters returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineSearchFilterGroupRequestModel) HasSearchFilters() bool { + if o != nil && IsNil(o.SearchFilters) { + return true + } + + return false +} + +// SetSearchFilters gets a reference to the given []ProvisionedVirtualMachineSearchFilterRequestModel and assigns it to the SearchFilters field. +func (o *ProvisionedVirtualMachineSearchFilterGroupRequestModel) SetSearchFilters(v []ProvisionedVirtualMachineSearchFilterRequestModel) { + o.SearchFilters = v +} + +// GetSearchFilterGroupsType returns the SearchFilterGroupsType field value if set, zero value otherwise. +func (o *ProvisionedVirtualMachineSearchFilterGroupRequestModel) GetSearchFilterGroupsType() ProvisionedVirtualMachineSearchFilterGroupsType { + if o == nil || IsNil(o.SearchFilterGroupsType) { + var ret ProvisionedVirtualMachineSearchFilterGroupsType + return ret + } + return *o.SearchFilterGroupsType +} + +// GetSearchFilterGroupsTypeOk returns a tuple with the SearchFilterGroupsType field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ProvisionedVirtualMachineSearchFilterGroupRequestModel) GetSearchFilterGroupsTypeOk() (*ProvisionedVirtualMachineSearchFilterGroupsType, bool) { + if o == nil || IsNil(o.SearchFilterGroupsType) { + return nil, false + } + return o.SearchFilterGroupsType, true +} + +// HasSearchFilterGroupsType returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineSearchFilterGroupRequestModel) HasSearchFilterGroupsType() bool { + if o != nil && !IsNil(o.SearchFilterGroupsType) { + return true + } + + return false +} + +// SetSearchFilterGroupsType gets a reference to the given ProvisionedVirtualMachineSearchFilterGroupsType and assigns it to the SearchFilterGroupsType field. +func (o *ProvisionedVirtualMachineSearchFilterGroupRequestModel) SetSearchFilterGroupsType(v ProvisionedVirtualMachineSearchFilterGroupsType) { + o.SearchFilterGroupsType = &v +} + +// GetSearchFilterGroups returns the SearchFilterGroups field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineSearchFilterGroupRequestModel) GetSearchFilterGroups() []ProvisionedVirtualMachineSearchFilterGroupRequestModel { + if o == nil { + var ret []ProvisionedVirtualMachineSearchFilterGroupRequestModel + return ret + } + return o.SearchFilterGroups +} + +// GetSearchFilterGroupsOk returns a tuple with the SearchFilterGroups field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineSearchFilterGroupRequestModel) GetSearchFilterGroupsOk() ([]ProvisionedVirtualMachineSearchFilterGroupRequestModel, bool) { + if o == nil || IsNil(o.SearchFilterGroups) { + return nil, false + } + return o.SearchFilterGroups, true +} + +// HasSearchFilterGroups returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineSearchFilterGroupRequestModel) HasSearchFilterGroups() bool { + if o != nil && IsNil(o.SearchFilterGroups) { + return true + } + + return false +} + +// SetSearchFilterGroups gets a reference to the given []ProvisionedVirtualMachineSearchFilterGroupRequestModel and assigns it to the SearchFilterGroups field. +func (o *ProvisionedVirtualMachineSearchFilterGroupRequestModel) SetSearchFilterGroups(v []ProvisionedVirtualMachineSearchFilterGroupRequestModel) { + o.SearchFilterGroups = v +} + +func (o ProvisionedVirtualMachineSearchFilterGroupRequestModel) MarshalJSON() ([]byte, error) { + toSerialize,err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o ProvisionedVirtualMachineSearchFilterGroupRequestModel) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + if !IsNil(o.SearchFilterGroupType) { + toSerialize["SearchFilterGroupType"] = o.SearchFilterGroupType + } + if o.SearchFilters != nil { + toSerialize["SearchFilters"] = o.SearchFilters + } + if !IsNil(o.SearchFilterGroupsType) { + toSerialize["SearchFilterGroupsType"] = o.SearchFilterGroupsType + } + if o.SearchFilterGroups != nil { + toSerialize["SearchFilterGroups"] = o.SearchFilterGroups + } + return toSerialize, nil +} + +type NullableProvisionedVirtualMachineSearchFilterGroupRequestModel struct { + value *ProvisionedVirtualMachineSearchFilterGroupRequestModel + isSet bool +} + +func (v NullableProvisionedVirtualMachineSearchFilterGroupRequestModel) Get() *ProvisionedVirtualMachineSearchFilterGroupRequestModel { + return v.value +} + +func (v *NullableProvisionedVirtualMachineSearchFilterGroupRequestModel) Set(val *ProvisionedVirtualMachineSearchFilterGroupRequestModel) { + v.value = val + v.isSet = true +} + +func (v NullableProvisionedVirtualMachineSearchFilterGroupRequestModel) IsSet() bool { + return v.isSet +} + +func (v *NullableProvisionedVirtualMachineSearchFilterGroupRequestModel) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableProvisionedVirtualMachineSearchFilterGroupRequestModel(val *ProvisionedVirtualMachineSearchFilterGroupRequestModel) *NullableProvisionedVirtualMachineSearchFilterGroupRequestModel { + return &NullableProvisionedVirtualMachineSearchFilterGroupRequestModel{value: val, isSet: true} +} + +func (v NullableProvisionedVirtualMachineSearchFilterGroupRequestModel) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableProvisionedVirtualMachineSearchFilterGroupRequestModel) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/citrixorchestration/model_provisioned_virtual_machine_search_filter_group_type.go b/citrixorchestration/model_provisioned_virtual_machine_search_filter_group_type.go new file mode 100644 index 0000000..5c1730e --- /dev/null +++ b/citrixorchestration/model_provisioned_virtual_machine_search_filter_group_type.go @@ -0,0 +1,111 @@ +/* +Citrix Virtual Apps and Desktops Rest API for Developer Portal + +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + +API version: devportal-onprem-ga +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package citrixorchestration + +import ( + "encoding/json" + "fmt" +) + +// ProvisionedVirtualMachineSearchFilterGroupType The search filter group type +type ProvisionedVirtualMachineSearchFilterGroupType string + +// List of ProvisionedVirtualMachineSearchFilterGroupType +const ( + PROVISIONEDVIRTUALMACHINESEARCHFILTERGROUPTYPE_OR ProvisionedVirtualMachineSearchFilterGroupType = "Or" + PROVISIONEDVIRTUALMACHINESEARCHFILTERGROUPTYPE_AND ProvisionedVirtualMachineSearchFilterGroupType = "And" +) + +// All allowed values of ProvisionedVirtualMachineSearchFilterGroupType enum +var AllowedProvisionedVirtualMachineSearchFilterGroupTypeEnumValues = []ProvisionedVirtualMachineSearchFilterGroupType{ + "Or", + "And", +} + +func (v *ProvisionedVirtualMachineSearchFilterGroupType) UnmarshalJSON(src []byte) error { + var value string + err := json.Unmarshal(src, &value) + if err != nil { + return err + } + enumTypeValue := ProvisionedVirtualMachineSearchFilterGroupType(value) + for _, existing := range AllowedProvisionedVirtualMachineSearchFilterGroupTypeEnumValues { + if existing == enumTypeValue { + *v = enumTypeValue + return nil + } + } + + return fmt.Errorf("%+v is not a valid ProvisionedVirtualMachineSearchFilterGroupType", value) +} + +// NewProvisionedVirtualMachineSearchFilterGroupTypeFromValue returns a pointer to a valid ProvisionedVirtualMachineSearchFilterGroupType +// for the value passed as argument, or an error if the value passed is not allowed by the enum +func NewProvisionedVirtualMachineSearchFilterGroupTypeFromValue(v string) (*ProvisionedVirtualMachineSearchFilterGroupType, error) { + ev := ProvisionedVirtualMachineSearchFilterGroupType(v) + if ev.IsValid() { + return &ev, nil + } else { + return nil, fmt.Errorf("invalid value '%v' for ProvisionedVirtualMachineSearchFilterGroupType: valid values are %v", v, AllowedProvisionedVirtualMachineSearchFilterGroupTypeEnumValues) + } +} + +// IsValid return true if the value is valid for the enum, false otherwise +func (v ProvisionedVirtualMachineSearchFilterGroupType) IsValid() bool { + for _, existing := range AllowedProvisionedVirtualMachineSearchFilterGroupTypeEnumValues { + if existing == v { + return true + } + } + return false +} + +// Ptr returns reference to ProvisionedVirtualMachineSearchFilterGroupType value +func (v ProvisionedVirtualMachineSearchFilterGroupType) Ptr() *ProvisionedVirtualMachineSearchFilterGroupType { + return &v +} + +type NullableProvisionedVirtualMachineSearchFilterGroupType struct { + value *ProvisionedVirtualMachineSearchFilterGroupType + isSet bool +} + +func (v NullableProvisionedVirtualMachineSearchFilterGroupType) Get() *ProvisionedVirtualMachineSearchFilterGroupType { + return v.value +} + +func (v *NullableProvisionedVirtualMachineSearchFilterGroupType) Set(val *ProvisionedVirtualMachineSearchFilterGroupType) { + v.value = val + v.isSet = true +} + +func (v NullableProvisionedVirtualMachineSearchFilterGroupType) IsSet() bool { + return v.isSet +} + +func (v *NullableProvisionedVirtualMachineSearchFilterGroupType) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableProvisionedVirtualMachineSearchFilterGroupType(val *ProvisionedVirtualMachineSearchFilterGroupType) *NullableProvisionedVirtualMachineSearchFilterGroupType { + return &NullableProvisionedVirtualMachineSearchFilterGroupType{value: val, isSet: true} +} + +func (v NullableProvisionedVirtualMachineSearchFilterGroupType) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableProvisionedVirtualMachineSearchFilterGroupType) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + diff --git a/citrixorchestration/model_provisioned_virtual_machine_search_filter_groups_type.go b/citrixorchestration/model_provisioned_virtual_machine_search_filter_groups_type.go new file mode 100644 index 0000000..a12d33e --- /dev/null +++ b/citrixorchestration/model_provisioned_virtual_machine_search_filter_groups_type.go @@ -0,0 +1,111 @@ +/* +Citrix Virtual Apps and Desktops Rest API for Developer Portal + +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + +API version: devportal-onprem-ga +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package citrixorchestration + +import ( + "encoding/json" + "fmt" +) + +// ProvisionedVirtualMachineSearchFilterGroupsType The search filter groups type +type ProvisionedVirtualMachineSearchFilterGroupsType string + +// List of ProvisionedVirtualMachineSearchFilterGroupsType +const ( + PROVISIONEDVIRTUALMACHINESEARCHFILTERGROUPSTYPE_OR ProvisionedVirtualMachineSearchFilterGroupsType = "Or" + PROVISIONEDVIRTUALMACHINESEARCHFILTERGROUPSTYPE_AND ProvisionedVirtualMachineSearchFilterGroupsType = "And" +) + +// All allowed values of ProvisionedVirtualMachineSearchFilterGroupsType enum +var AllowedProvisionedVirtualMachineSearchFilterGroupsTypeEnumValues = []ProvisionedVirtualMachineSearchFilterGroupsType{ + "Or", + "And", +} + +func (v *ProvisionedVirtualMachineSearchFilterGroupsType) UnmarshalJSON(src []byte) error { + var value string + err := json.Unmarshal(src, &value) + if err != nil { + return err + } + enumTypeValue := ProvisionedVirtualMachineSearchFilterGroupsType(value) + for _, existing := range AllowedProvisionedVirtualMachineSearchFilterGroupsTypeEnumValues { + if existing == enumTypeValue { + *v = enumTypeValue + return nil + } + } + + return fmt.Errorf("%+v is not a valid ProvisionedVirtualMachineSearchFilterGroupsType", value) +} + +// NewProvisionedVirtualMachineSearchFilterGroupsTypeFromValue returns a pointer to a valid ProvisionedVirtualMachineSearchFilterGroupsType +// for the value passed as argument, or an error if the value passed is not allowed by the enum +func NewProvisionedVirtualMachineSearchFilterGroupsTypeFromValue(v string) (*ProvisionedVirtualMachineSearchFilterGroupsType, error) { + ev := ProvisionedVirtualMachineSearchFilterGroupsType(v) + if ev.IsValid() { + return &ev, nil + } else { + return nil, fmt.Errorf("invalid value '%v' for ProvisionedVirtualMachineSearchFilterGroupsType: valid values are %v", v, AllowedProvisionedVirtualMachineSearchFilterGroupsTypeEnumValues) + } +} + +// IsValid return true if the value is valid for the enum, false otherwise +func (v ProvisionedVirtualMachineSearchFilterGroupsType) IsValid() bool { + for _, existing := range AllowedProvisionedVirtualMachineSearchFilterGroupsTypeEnumValues { + if existing == v { + return true + } + } + return false +} + +// Ptr returns reference to ProvisionedVirtualMachineSearchFilterGroupsType value +func (v ProvisionedVirtualMachineSearchFilterGroupsType) Ptr() *ProvisionedVirtualMachineSearchFilterGroupsType { + return &v +} + +type NullableProvisionedVirtualMachineSearchFilterGroupsType struct { + value *ProvisionedVirtualMachineSearchFilterGroupsType + isSet bool +} + +func (v NullableProvisionedVirtualMachineSearchFilterGroupsType) Get() *ProvisionedVirtualMachineSearchFilterGroupsType { + return v.value +} + +func (v *NullableProvisionedVirtualMachineSearchFilterGroupsType) Set(val *ProvisionedVirtualMachineSearchFilterGroupsType) { + v.value = val + v.isSet = true +} + +func (v NullableProvisionedVirtualMachineSearchFilterGroupsType) IsSet() bool { + return v.isSet +} + +func (v *NullableProvisionedVirtualMachineSearchFilterGroupsType) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableProvisionedVirtualMachineSearchFilterGroupsType(val *ProvisionedVirtualMachineSearchFilterGroupsType) *NullableProvisionedVirtualMachineSearchFilterGroupsType { + return &NullableProvisionedVirtualMachineSearchFilterGroupsType{value: val, isSet: true} +} + +func (v NullableProvisionedVirtualMachineSearchFilterGroupsType) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableProvisionedVirtualMachineSearchFilterGroupsType) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + diff --git a/citrixorchestration/model_provisioned_virtual_machine_search_filter_request_model.go b/citrixorchestration/model_provisioned_virtual_machine_search_filter_request_model.go new file mode 100644 index 0000000..aeba984 --- /dev/null +++ b/citrixorchestration/model_provisioned_virtual_machine_search_filter_request_model.go @@ -0,0 +1,191 @@ +/* +Citrix Virtual Apps and Desktops Rest API for Developer Portal + +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + +API version: devportal-onprem-ga +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package citrixorchestration + +import ( + "encoding/json" +) + +// checks if the ProvisionedVirtualMachineSearchFilterRequestModel type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &ProvisionedVirtualMachineSearchFilterRequestModel{} + +// ProvisionedVirtualMachineSearchFilterRequestModel Advanced search filter for machines. +type ProvisionedVirtualMachineSearchFilterRequestModel struct { + Property ProvisionedVirtualMachineSearchProperty `json:"Property"` + // Value to match. + Value NullableString `json:"Value,omitempty"` + Operator SearchOperator `json:"Operator"` +} + +// NewProvisionedVirtualMachineSearchFilterRequestModel instantiates a new ProvisionedVirtualMachineSearchFilterRequestModel object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewProvisionedVirtualMachineSearchFilterRequestModel(property ProvisionedVirtualMachineSearchProperty, operator SearchOperator) *ProvisionedVirtualMachineSearchFilterRequestModel { + this := ProvisionedVirtualMachineSearchFilterRequestModel{} + this.Property = property + this.Operator = operator + return &this +} + +// NewProvisionedVirtualMachineSearchFilterRequestModelWithDefaults instantiates a new ProvisionedVirtualMachineSearchFilterRequestModel object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewProvisionedVirtualMachineSearchFilterRequestModelWithDefaults() *ProvisionedVirtualMachineSearchFilterRequestModel { + this := ProvisionedVirtualMachineSearchFilterRequestModel{} + return &this +} + +// GetProperty returns the Property field value +func (o *ProvisionedVirtualMachineSearchFilterRequestModel) GetProperty() ProvisionedVirtualMachineSearchProperty { + if o == nil { + var ret ProvisionedVirtualMachineSearchProperty + return ret + } + + return o.Property +} + +// GetPropertyOk returns a tuple with the Property field value +// and a boolean to check if the value has been set. +func (o *ProvisionedVirtualMachineSearchFilterRequestModel) GetPropertyOk() (*ProvisionedVirtualMachineSearchProperty, bool) { + if o == nil { + return nil, false + } + return &o.Property, true +} + +// SetProperty sets field value +func (o *ProvisionedVirtualMachineSearchFilterRequestModel) SetProperty(v ProvisionedVirtualMachineSearchProperty) { + o.Property = v +} + +// GetValue returns the Value field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineSearchFilterRequestModel) GetValue() string { + if o == nil || IsNil(o.Value.Get()) { + var ret string + return ret + } + return *o.Value.Get() +} + +// GetValueOk returns a tuple with the Value field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineSearchFilterRequestModel) GetValueOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.Value.Get(), o.Value.IsSet() +} + +// HasValue returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineSearchFilterRequestModel) HasValue() bool { + if o != nil && o.Value.IsSet() { + return true + } + + return false +} + +// SetValue gets a reference to the given NullableString and assigns it to the Value field. +func (o *ProvisionedVirtualMachineSearchFilterRequestModel) SetValue(v string) { + o.Value.Set(&v) +} +// SetValueNil sets the value for Value to be an explicit nil +func (o *ProvisionedVirtualMachineSearchFilterRequestModel) SetValueNil() { + o.Value.Set(nil) +} + +// UnsetValue ensures that no value is present for Value, not even an explicit nil +func (o *ProvisionedVirtualMachineSearchFilterRequestModel) UnsetValue() { + o.Value.Unset() +} + +// GetOperator returns the Operator field value +func (o *ProvisionedVirtualMachineSearchFilterRequestModel) GetOperator() SearchOperator { + if o == nil { + var ret SearchOperator + return ret + } + + return o.Operator +} + +// GetOperatorOk returns a tuple with the Operator field value +// and a boolean to check if the value has been set. +func (o *ProvisionedVirtualMachineSearchFilterRequestModel) GetOperatorOk() (*SearchOperator, bool) { + if o == nil { + return nil, false + } + return &o.Operator, true +} + +// SetOperator sets field value +func (o *ProvisionedVirtualMachineSearchFilterRequestModel) SetOperator(v SearchOperator) { + o.Operator = v +} + +func (o ProvisionedVirtualMachineSearchFilterRequestModel) MarshalJSON() ([]byte, error) { + toSerialize,err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o ProvisionedVirtualMachineSearchFilterRequestModel) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + toSerialize["Property"] = o.Property + if o.Value.IsSet() { + toSerialize["Value"] = o.Value.Get() + } + toSerialize["Operator"] = o.Operator + return toSerialize, nil +} + +type NullableProvisionedVirtualMachineSearchFilterRequestModel struct { + value *ProvisionedVirtualMachineSearchFilterRequestModel + isSet bool +} + +func (v NullableProvisionedVirtualMachineSearchFilterRequestModel) Get() *ProvisionedVirtualMachineSearchFilterRequestModel { + return v.value +} + +func (v *NullableProvisionedVirtualMachineSearchFilterRequestModel) Set(val *ProvisionedVirtualMachineSearchFilterRequestModel) { + v.value = val + v.isSet = true +} + +func (v NullableProvisionedVirtualMachineSearchFilterRequestModel) IsSet() bool { + return v.isSet +} + +func (v *NullableProvisionedVirtualMachineSearchFilterRequestModel) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableProvisionedVirtualMachineSearchFilterRequestModel(val *ProvisionedVirtualMachineSearchFilterRequestModel) *NullableProvisionedVirtualMachineSearchFilterRequestModel { + return &NullableProvisionedVirtualMachineSearchFilterRequestModel{value: val, isSet: true} +} + +func (v NullableProvisionedVirtualMachineSearchFilterRequestModel) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableProvisionedVirtualMachineSearchFilterRequestModel) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/citrixorchestration/model_provisioned_virtual_machine_search_property.go b/citrixorchestration/model_provisioned_virtual_machine_search_property.go new file mode 100644 index 0000000..ba8f9c5 --- /dev/null +++ b/citrixorchestration/model_provisioned_virtual_machine_search_property.go @@ -0,0 +1,143 @@ +/* +Citrix Virtual Apps and Desktops Rest API for Developer Portal + +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + +API version: devportal-onprem-ga +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package citrixorchestration + +import ( + "encoding/json" + "fmt" +) + +// ProvisionedVirtualMachineSearchProperty Properties which can be used for provisioned virtual machines. +type ProvisionedVirtualMachineSearchProperty string + +// List of ProvisionedVirtualMachineSearchProperty +const ( + PROVISIONEDVIRTUALMACHINESEARCHPROPERTY_ACTIVE_OPERATION ProvisionedVirtualMachineSearchProperty = "ActiveOperation" + PROVISIONEDVIRTUALMACHINESEARCHPROPERTY_VM_SID ProvisionedVirtualMachineSearchProperty = "VMSid" + PROVISIONEDVIRTUALMACHINESEARCHPROPERTY_CPU_COUNT ProvisionedVirtualMachineSearchProperty = "CpuCount" + PROVISIONEDVIRTUALMACHINESEARCHPROPERTY_IDENTITY_TYPE ProvisionedVirtualMachineSearchProperty = "IdentityType" + PROVISIONEDVIRTUALMACHINESEARCHPROPERTY_IDENTITIES ProvisionedVirtualMachineSearchProperty = "Identities" + PROVISIONEDVIRTUALMACHINESEARCHPROPERTY_IMAGE_OUT_OF_DATE ProvisionedVirtualMachineSearchProperty = "ImageOutOfDate" + PROVISIONEDVIRTUALMACHINESEARCHPROPERTY_LAST_BOOT_TIME ProvisionedVirtualMachineSearchProperty = "LastBootTime" + PROVISIONEDVIRTUALMACHINESEARCHPROPERTY_MEMORY_MB ProvisionedVirtualMachineSearchProperty = "MemoryMB" + PROVISIONEDVIRTUALMACHINESEARCHPROPERTY_PERSISTENCY ProvisionedVirtualMachineSearchProperty = "Persistency" + PROVISIONEDVIRTUALMACHINESEARCHPROPERTY_PROVISIONING_SCHEME_NAME ProvisionedVirtualMachineSearchProperty = "ProvisioningSchemeName" + PROVISIONEDVIRTUALMACHINESEARCHPROPERTY_PROVISIONING_SCHEME_VERSION ProvisionedVirtualMachineSearchProperty = "ProvisioningSchemeVersion" + PROVISIONEDVIRTUALMACHINESEARCHPROPERTY_PROV_VM_CONFIGURATION_VERSION ProvisionedVirtualMachineSearchProperty = "ProvVMConfigurationVersion" + PROVISIONEDVIRTUALMACHINESEARCHPROPERTY_VM_NAME ProvisionedVirtualMachineSearchProperty = "VMName" + PROVISIONEDVIRTUALMACHINESEARCHPROPERTY_WINDOWS_ACTIVATION_TYPE_PROVISIONED_VIRTUAL_MACHINE ProvisionedVirtualMachineSearchProperty = "WindowsActivationTypeProvisionedVirtualMachine" + PROVISIONEDVIRTUALMACHINESEARCHPROPERTY_USE_WRITE_BACK_CACHE ProvisionedVirtualMachineSearchProperty = "UseWriteBackCache" + PROVISIONEDVIRTUALMACHINESEARCHPROPERTY_WRITE_BACK_CACHE_DISK_SIZE ProvisionedVirtualMachineSearchProperty = "WriteBackCacheDiskSize" + PROVISIONEDVIRTUALMACHINESEARCHPROPERTY_WRITE_BACK_CACHE_DISK_DRIVE_LETTER ProvisionedVirtualMachineSearchProperty = "WriteBackCacheDiskDriveLetter" + PROVISIONEDVIRTUALMACHINESEARCHPROPERTY_WRITE_BACK_CACHE_MEMORY_SIZE ProvisionedVirtualMachineSearchProperty = "WriteBackCacheMemorySize" +) + +// All allowed values of ProvisionedVirtualMachineSearchProperty enum +var AllowedProvisionedVirtualMachineSearchPropertyEnumValues = []ProvisionedVirtualMachineSearchProperty{ + "ActiveOperation", + "VMSid", + "CpuCount", + "IdentityType", + "Identities", + "ImageOutOfDate", + "LastBootTime", + "MemoryMB", + "Persistency", + "ProvisioningSchemeName", + "ProvisioningSchemeVersion", + "ProvVMConfigurationVersion", + "VMName", + "WindowsActivationTypeProvisionedVirtualMachine", + "UseWriteBackCache", + "WriteBackCacheDiskSize", + "WriteBackCacheDiskDriveLetter", + "WriteBackCacheMemorySize", +} + +func (v *ProvisionedVirtualMachineSearchProperty) UnmarshalJSON(src []byte) error { + var value string + err := json.Unmarshal(src, &value) + if err != nil { + return err + } + enumTypeValue := ProvisionedVirtualMachineSearchProperty(value) + for _, existing := range AllowedProvisionedVirtualMachineSearchPropertyEnumValues { + if existing == enumTypeValue { + *v = enumTypeValue + return nil + } + } + + return fmt.Errorf("%+v is not a valid ProvisionedVirtualMachineSearchProperty", value) +} + +// NewProvisionedVirtualMachineSearchPropertyFromValue returns a pointer to a valid ProvisionedVirtualMachineSearchProperty +// for the value passed as argument, or an error if the value passed is not allowed by the enum +func NewProvisionedVirtualMachineSearchPropertyFromValue(v string) (*ProvisionedVirtualMachineSearchProperty, error) { + ev := ProvisionedVirtualMachineSearchProperty(v) + if ev.IsValid() { + return &ev, nil + } else { + return nil, fmt.Errorf("invalid value '%v' for ProvisionedVirtualMachineSearchProperty: valid values are %v", v, AllowedProvisionedVirtualMachineSearchPropertyEnumValues) + } +} + +// IsValid return true if the value is valid for the enum, false otherwise +func (v ProvisionedVirtualMachineSearchProperty) IsValid() bool { + for _, existing := range AllowedProvisionedVirtualMachineSearchPropertyEnumValues { + if existing == v { + return true + } + } + return false +} + +// Ptr returns reference to ProvisionedVirtualMachineSearchProperty value +func (v ProvisionedVirtualMachineSearchProperty) Ptr() *ProvisionedVirtualMachineSearchProperty { + return &v +} + +type NullableProvisionedVirtualMachineSearchProperty struct { + value *ProvisionedVirtualMachineSearchProperty + isSet bool +} + +func (v NullableProvisionedVirtualMachineSearchProperty) Get() *ProvisionedVirtualMachineSearchProperty { + return v.value +} + +func (v *NullableProvisionedVirtualMachineSearchProperty) Set(val *ProvisionedVirtualMachineSearchProperty) { + v.value = val + v.isSet = true +} + +func (v NullableProvisionedVirtualMachineSearchProperty) IsSet() bool { + return v.isSet +} + +func (v *NullableProvisionedVirtualMachineSearchProperty) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableProvisionedVirtualMachineSearchProperty(val *ProvisionedVirtualMachineSearchProperty) *NullableProvisionedVirtualMachineSearchProperty { + return &NullableProvisionedVirtualMachineSearchProperty{value: val, isSet: true} +} + +func (v NullableProvisionedVirtualMachineSearchProperty) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableProvisionedVirtualMachineSearchProperty) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + diff --git a/citrixorchestration/model_provisioned_virtual_machine_search_request_model.go b/citrixorchestration/model_provisioned_virtual_machine_search_request_model.go new file mode 100644 index 0000000..59d894f --- /dev/null +++ b/citrixorchestration/model_provisioned_virtual_machine_search_request_model.go @@ -0,0 +1,287 @@ +/* +Citrix Virtual Apps and Desktops Rest API for Developer Portal + +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + +API version: devportal-onprem-ga +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package citrixorchestration + +import ( + "encoding/json" +) + +// checks if the ProvisionedVirtualMachineSearchRequestModel type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &ProvisionedVirtualMachineSearchRequestModel{} + +// ProvisionedVirtualMachineSearchRequestModel Request model for defining provisioned virtual machine. +type ProvisionedVirtualMachineSearchRequestModel struct { + // Basic search string. Specify a string which will match if contained within some string property of the machine. + BasicSearchString NullableString `json:"BasicSearchString,omitempty"` + // List of advanced search filters. + SearchFilters []ProvisionedVirtualMachineSearchFilterRequestModel `json:"SearchFilters,omitempty"` + // List of advanced search filter groups. + SearchFilterGroups []ProvisionedVirtualMachineSearchFilterGroupRequestModel `json:"SearchFilterGroups,omitempty"` + SearchFilterGroupsType *ProvisionedVirtualMachineSearchFilterGroupsType `json:"SearchFilterGroupsType,omitempty"` + // Sort criteria for the results, multiple sorting criteria can be specified here. + SortCriteriaItems []ProvisionedVirtualMachineSortCriteriaRequestModel `json:"SortCriteriaItems,omitempty"` +} + +// NewProvisionedVirtualMachineSearchRequestModel instantiates a new ProvisionedVirtualMachineSearchRequestModel object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewProvisionedVirtualMachineSearchRequestModel() *ProvisionedVirtualMachineSearchRequestModel { + this := ProvisionedVirtualMachineSearchRequestModel{} + return &this +} + +// NewProvisionedVirtualMachineSearchRequestModelWithDefaults instantiates a new ProvisionedVirtualMachineSearchRequestModel object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewProvisionedVirtualMachineSearchRequestModelWithDefaults() *ProvisionedVirtualMachineSearchRequestModel { + this := ProvisionedVirtualMachineSearchRequestModel{} + return &this +} + +// GetBasicSearchString returns the BasicSearchString field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineSearchRequestModel) GetBasicSearchString() string { + if o == nil || IsNil(o.BasicSearchString.Get()) { + var ret string + return ret + } + return *o.BasicSearchString.Get() +} + +// GetBasicSearchStringOk returns a tuple with the BasicSearchString field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineSearchRequestModel) GetBasicSearchStringOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.BasicSearchString.Get(), o.BasicSearchString.IsSet() +} + +// HasBasicSearchString returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineSearchRequestModel) HasBasicSearchString() bool { + if o != nil && o.BasicSearchString.IsSet() { + return true + } + + return false +} + +// SetBasicSearchString gets a reference to the given NullableString and assigns it to the BasicSearchString field. +func (o *ProvisionedVirtualMachineSearchRequestModel) SetBasicSearchString(v string) { + o.BasicSearchString.Set(&v) +} +// SetBasicSearchStringNil sets the value for BasicSearchString to be an explicit nil +func (o *ProvisionedVirtualMachineSearchRequestModel) SetBasicSearchStringNil() { + o.BasicSearchString.Set(nil) +} + +// UnsetBasicSearchString ensures that no value is present for BasicSearchString, not even an explicit nil +func (o *ProvisionedVirtualMachineSearchRequestModel) UnsetBasicSearchString() { + o.BasicSearchString.Unset() +} + +// GetSearchFilters returns the SearchFilters field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineSearchRequestModel) GetSearchFilters() []ProvisionedVirtualMachineSearchFilterRequestModel { + if o == nil { + var ret []ProvisionedVirtualMachineSearchFilterRequestModel + return ret + } + return o.SearchFilters +} + +// GetSearchFiltersOk returns a tuple with the SearchFilters field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineSearchRequestModel) GetSearchFiltersOk() ([]ProvisionedVirtualMachineSearchFilterRequestModel, bool) { + if o == nil || IsNil(o.SearchFilters) { + return nil, false + } + return o.SearchFilters, true +} + +// HasSearchFilters returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineSearchRequestModel) HasSearchFilters() bool { + if o != nil && IsNil(o.SearchFilters) { + return true + } + + return false +} + +// SetSearchFilters gets a reference to the given []ProvisionedVirtualMachineSearchFilterRequestModel and assigns it to the SearchFilters field. +func (o *ProvisionedVirtualMachineSearchRequestModel) SetSearchFilters(v []ProvisionedVirtualMachineSearchFilterRequestModel) { + o.SearchFilters = v +} + +// GetSearchFilterGroups returns the SearchFilterGroups field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineSearchRequestModel) GetSearchFilterGroups() []ProvisionedVirtualMachineSearchFilterGroupRequestModel { + if o == nil { + var ret []ProvisionedVirtualMachineSearchFilterGroupRequestModel + return ret + } + return o.SearchFilterGroups +} + +// GetSearchFilterGroupsOk returns a tuple with the SearchFilterGroups field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineSearchRequestModel) GetSearchFilterGroupsOk() ([]ProvisionedVirtualMachineSearchFilterGroupRequestModel, bool) { + if o == nil || IsNil(o.SearchFilterGroups) { + return nil, false + } + return o.SearchFilterGroups, true +} + +// HasSearchFilterGroups returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineSearchRequestModel) HasSearchFilterGroups() bool { + if o != nil && IsNil(o.SearchFilterGroups) { + return true + } + + return false +} + +// SetSearchFilterGroups gets a reference to the given []ProvisionedVirtualMachineSearchFilterGroupRequestModel and assigns it to the SearchFilterGroups field. +func (o *ProvisionedVirtualMachineSearchRequestModel) SetSearchFilterGroups(v []ProvisionedVirtualMachineSearchFilterGroupRequestModel) { + o.SearchFilterGroups = v +} + +// GetSearchFilterGroupsType returns the SearchFilterGroupsType field value if set, zero value otherwise. +func (o *ProvisionedVirtualMachineSearchRequestModel) GetSearchFilterGroupsType() ProvisionedVirtualMachineSearchFilterGroupsType { + if o == nil || IsNil(o.SearchFilterGroupsType) { + var ret ProvisionedVirtualMachineSearchFilterGroupsType + return ret + } + return *o.SearchFilterGroupsType +} + +// GetSearchFilterGroupsTypeOk returns a tuple with the SearchFilterGroupsType field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ProvisionedVirtualMachineSearchRequestModel) GetSearchFilterGroupsTypeOk() (*ProvisionedVirtualMachineSearchFilterGroupsType, bool) { + if o == nil || IsNil(o.SearchFilterGroupsType) { + return nil, false + } + return o.SearchFilterGroupsType, true +} + +// HasSearchFilterGroupsType returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineSearchRequestModel) HasSearchFilterGroupsType() bool { + if o != nil && !IsNil(o.SearchFilterGroupsType) { + return true + } + + return false +} + +// SetSearchFilterGroupsType gets a reference to the given ProvisionedVirtualMachineSearchFilterGroupsType and assigns it to the SearchFilterGroupsType field. +func (o *ProvisionedVirtualMachineSearchRequestModel) SetSearchFilterGroupsType(v ProvisionedVirtualMachineSearchFilterGroupsType) { + o.SearchFilterGroupsType = &v +} + +// GetSortCriteriaItems returns the SortCriteriaItems field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineSearchRequestModel) GetSortCriteriaItems() []ProvisionedVirtualMachineSortCriteriaRequestModel { + if o == nil { + var ret []ProvisionedVirtualMachineSortCriteriaRequestModel + return ret + } + return o.SortCriteriaItems +} + +// GetSortCriteriaItemsOk returns a tuple with the SortCriteriaItems field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineSearchRequestModel) GetSortCriteriaItemsOk() ([]ProvisionedVirtualMachineSortCriteriaRequestModel, bool) { + if o == nil || IsNil(o.SortCriteriaItems) { + return nil, false + } + return o.SortCriteriaItems, true +} + +// HasSortCriteriaItems returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineSearchRequestModel) HasSortCriteriaItems() bool { + if o != nil && IsNil(o.SortCriteriaItems) { + return true + } + + return false +} + +// SetSortCriteriaItems gets a reference to the given []ProvisionedVirtualMachineSortCriteriaRequestModel and assigns it to the SortCriteriaItems field. +func (o *ProvisionedVirtualMachineSearchRequestModel) SetSortCriteriaItems(v []ProvisionedVirtualMachineSortCriteriaRequestModel) { + o.SortCriteriaItems = v +} + +func (o ProvisionedVirtualMachineSearchRequestModel) MarshalJSON() ([]byte, error) { + toSerialize,err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o ProvisionedVirtualMachineSearchRequestModel) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + if o.BasicSearchString.IsSet() { + toSerialize["BasicSearchString"] = o.BasicSearchString.Get() + } + if o.SearchFilters != nil { + toSerialize["SearchFilters"] = o.SearchFilters + } + if o.SearchFilterGroups != nil { + toSerialize["SearchFilterGroups"] = o.SearchFilterGroups + } + if !IsNil(o.SearchFilterGroupsType) { + toSerialize["SearchFilterGroupsType"] = o.SearchFilterGroupsType + } + if o.SortCriteriaItems != nil { + toSerialize["SortCriteriaItems"] = o.SortCriteriaItems + } + return toSerialize, nil +} + +type NullableProvisionedVirtualMachineSearchRequestModel struct { + value *ProvisionedVirtualMachineSearchRequestModel + isSet bool +} + +func (v NullableProvisionedVirtualMachineSearchRequestModel) Get() *ProvisionedVirtualMachineSearchRequestModel { + return v.value +} + +func (v *NullableProvisionedVirtualMachineSearchRequestModel) Set(val *ProvisionedVirtualMachineSearchRequestModel) { + v.value = val + v.isSet = true +} + +func (v NullableProvisionedVirtualMachineSearchRequestModel) IsSet() bool { + return v.isSet +} + +func (v *NullableProvisionedVirtualMachineSearchRequestModel) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableProvisionedVirtualMachineSearchRequestModel(val *ProvisionedVirtualMachineSearchRequestModel) *NullableProvisionedVirtualMachineSearchRequestModel { + return &NullableProvisionedVirtualMachineSearchRequestModel{value: val, isSet: true} +} + +func (v NullableProvisionedVirtualMachineSearchRequestModel) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableProvisionedVirtualMachineSearchRequestModel) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/citrixorchestration/model_provisioned_virtual_machine_search_response_model.go b/citrixorchestration/model_provisioned_virtual_machine_search_response_model.go new file mode 100644 index 0000000..ea4023f --- /dev/null +++ b/citrixorchestration/model_provisioned_virtual_machine_search_response_model.go @@ -0,0 +1,836 @@ +/* +Citrix Virtual Apps and Desktops Rest API for Developer Portal + +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + +API version: devportal-onprem-ga +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package citrixorchestration + +import ( + "encoding/json" +) + +// checks if the ProvisionedVirtualMachineSearchResponseModel type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &ProvisionedVirtualMachineSearchResponseModel{} + +// ProvisionedVirtualMachineSearchResponseModel Response model for provisioned virtual machine. +type ProvisionedVirtualMachineSearchResponseModel struct { + // Active Operation. + ActiveOperation NullableString `json:"ActiveOperation,omitempty"` + // Provisioned Virtual Machine Sid. + VMSid NullableString `json:"VMSid,omitempty"` + // Cpu Count. + CpuCount *int32 `json:"CpuCount,omitempty"` + // Identity Type:ActiveDirectory, AzureAD, HybridAzureAD, Workgroup. + IdentityType NullableString `json:"IdentityType,omitempty"` + // ActiveDirectory, HybridAzureAD - Domain. AzureAD - TenantId. Workgroup - null. + Identities NullableString `json:"Identities,omitempty"` + // Booted image isn't same as assigned image. + ImageOutOfDate *bool `json:"ImageOutOfDate,omitempty"` + // Last boot time. + LastBootTime NullableString `json:"LastBootTime,omitempty"` + // Memory(MB). + MemoryMB *int32 `json:"MemoryMB,omitempty"` + // Persistency. + Persistency *bool `json:"Persistency,omitempty"` + // Provision Scheme Name. + ProvisioningSchemeName NullableString `json:"ProvisioningSchemeName,omitempty"` + // Provision Scheme Version. + ProvisioningSchemeVersion *int32 `json:"ProvisioningSchemeVersion,omitempty"` + // Provisioned Virtual Machine Configuration Version. + ProvVMConfigurationVersion *int32 `json:"ProvVMConfigurationVersion,omitempty"` + // Provisioned virtual machine name on hypervisor. + VMName NullableString `json:"VMName,omitempty"` + // Windows Activation Type. + WindowsActivationTypeProvisionedVirtualMachine NullableString `json:"WindowsActivationTypeProvisionedVirtualMachine,omitempty"` + // Whether use write back cache. + UseWriteBackCache *bool `json:"UseWriteBackCache,omitempty"` + // Write back cache disk size. + WriteBackCacheDiskSize *int32 `json:"WriteBackCacheDiskSize,omitempty"` + // Write back cache disk drive letter. + WriteBackCacheDiskDriveLetter *int32 `json:"WriteBackCacheDiskDriveLetter,omitempty"` + // Write back cache memory size. + WriteBackCacheMemorySize *int32 `json:"WriteBackCacheMemorySize,omitempty"` +} + +// NewProvisionedVirtualMachineSearchResponseModel instantiates a new ProvisionedVirtualMachineSearchResponseModel object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewProvisionedVirtualMachineSearchResponseModel() *ProvisionedVirtualMachineSearchResponseModel { + this := ProvisionedVirtualMachineSearchResponseModel{} + return &this +} + +// NewProvisionedVirtualMachineSearchResponseModelWithDefaults instantiates a new ProvisionedVirtualMachineSearchResponseModel object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewProvisionedVirtualMachineSearchResponseModelWithDefaults() *ProvisionedVirtualMachineSearchResponseModel { + this := ProvisionedVirtualMachineSearchResponseModel{} + return &this +} + +// GetActiveOperation returns the ActiveOperation field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineSearchResponseModel) GetActiveOperation() string { + if o == nil || IsNil(o.ActiveOperation.Get()) { + var ret string + return ret + } + return *o.ActiveOperation.Get() +} + +// GetActiveOperationOk returns a tuple with the ActiveOperation field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineSearchResponseModel) GetActiveOperationOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.ActiveOperation.Get(), o.ActiveOperation.IsSet() +} + +// HasActiveOperation returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineSearchResponseModel) HasActiveOperation() bool { + if o != nil && o.ActiveOperation.IsSet() { + return true + } + + return false +} + +// SetActiveOperation gets a reference to the given NullableString and assigns it to the ActiveOperation field. +func (o *ProvisionedVirtualMachineSearchResponseModel) SetActiveOperation(v string) { + o.ActiveOperation.Set(&v) +} +// SetActiveOperationNil sets the value for ActiveOperation to be an explicit nil +func (o *ProvisionedVirtualMachineSearchResponseModel) SetActiveOperationNil() { + o.ActiveOperation.Set(nil) +} + +// UnsetActiveOperation ensures that no value is present for ActiveOperation, not even an explicit nil +func (o *ProvisionedVirtualMachineSearchResponseModel) UnsetActiveOperation() { + o.ActiveOperation.Unset() +} + +// GetVMSid returns the VMSid field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineSearchResponseModel) GetVMSid() string { + if o == nil || IsNil(o.VMSid.Get()) { + var ret string + return ret + } + return *o.VMSid.Get() +} + +// GetVMSidOk returns a tuple with the VMSid field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineSearchResponseModel) GetVMSidOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.VMSid.Get(), o.VMSid.IsSet() +} + +// HasVMSid returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineSearchResponseModel) HasVMSid() bool { + if o != nil && o.VMSid.IsSet() { + return true + } + + return false +} + +// SetVMSid gets a reference to the given NullableString and assigns it to the VMSid field. +func (o *ProvisionedVirtualMachineSearchResponseModel) SetVMSid(v string) { + o.VMSid.Set(&v) +} +// SetVMSidNil sets the value for VMSid to be an explicit nil +func (o *ProvisionedVirtualMachineSearchResponseModel) SetVMSidNil() { + o.VMSid.Set(nil) +} + +// UnsetVMSid ensures that no value is present for VMSid, not even an explicit nil +func (o *ProvisionedVirtualMachineSearchResponseModel) UnsetVMSid() { + o.VMSid.Unset() +} + +// GetCpuCount returns the CpuCount field value if set, zero value otherwise. +func (o *ProvisionedVirtualMachineSearchResponseModel) GetCpuCount() int32 { + if o == nil || IsNil(o.CpuCount) { + var ret int32 + return ret + } + return *o.CpuCount +} + +// GetCpuCountOk returns a tuple with the CpuCount field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ProvisionedVirtualMachineSearchResponseModel) GetCpuCountOk() (*int32, bool) { + if o == nil || IsNil(o.CpuCount) { + return nil, false + } + return o.CpuCount, true +} + +// HasCpuCount returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineSearchResponseModel) HasCpuCount() bool { + if o != nil && !IsNil(o.CpuCount) { + return true + } + + return false +} + +// SetCpuCount gets a reference to the given int32 and assigns it to the CpuCount field. +func (o *ProvisionedVirtualMachineSearchResponseModel) SetCpuCount(v int32) { + o.CpuCount = &v +} + +// GetIdentityType returns the IdentityType field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineSearchResponseModel) GetIdentityType() string { + if o == nil || IsNil(o.IdentityType.Get()) { + var ret string + return ret + } + return *o.IdentityType.Get() +} + +// GetIdentityTypeOk returns a tuple with the IdentityType field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineSearchResponseModel) GetIdentityTypeOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.IdentityType.Get(), o.IdentityType.IsSet() +} + +// HasIdentityType returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineSearchResponseModel) HasIdentityType() bool { + if o != nil && o.IdentityType.IsSet() { + return true + } + + return false +} + +// SetIdentityType gets a reference to the given NullableString and assigns it to the IdentityType field. +func (o *ProvisionedVirtualMachineSearchResponseModel) SetIdentityType(v string) { + o.IdentityType.Set(&v) +} +// SetIdentityTypeNil sets the value for IdentityType to be an explicit nil +func (o *ProvisionedVirtualMachineSearchResponseModel) SetIdentityTypeNil() { + o.IdentityType.Set(nil) +} + +// UnsetIdentityType ensures that no value is present for IdentityType, not even an explicit nil +func (o *ProvisionedVirtualMachineSearchResponseModel) UnsetIdentityType() { + o.IdentityType.Unset() +} + +// GetIdentities returns the Identities field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineSearchResponseModel) GetIdentities() string { + if o == nil || IsNil(o.Identities.Get()) { + var ret string + return ret + } + return *o.Identities.Get() +} + +// GetIdentitiesOk returns a tuple with the Identities field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineSearchResponseModel) GetIdentitiesOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.Identities.Get(), o.Identities.IsSet() +} + +// HasIdentities returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineSearchResponseModel) HasIdentities() bool { + if o != nil && o.Identities.IsSet() { + return true + } + + return false +} + +// SetIdentities gets a reference to the given NullableString and assigns it to the Identities field. +func (o *ProvisionedVirtualMachineSearchResponseModel) SetIdentities(v string) { + o.Identities.Set(&v) +} +// SetIdentitiesNil sets the value for Identities to be an explicit nil +func (o *ProvisionedVirtualMachineSearchResponseModel) SetIdentitiesNil() { + o.Identities.Set(nil) +} + +// UnsetIdentities ensures that no value is present for Identities, not even an explicit nil +func (o *ProvisionedVirtualMachineSearchResponseModel) UnsetIdentities() { + o.Identities.Unset() +} + +// GetImageOutOfDate returns the ImageOutOfDate field value if set, zero value otherwise. +func (o *ProvisionedVirtualMachineSearchResponseModel) GetImageOutOfDate() bool { + if o == nil || IsNil(o.ImageOutOfDate) { + var ret bool + return ret + } + return *o.ImageOutOfDate +} + +// GetImageOutOfDateOk returns a tuple with the ImageOutOfDate field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ProvisionedVirtualMachineSearchResponseModel) GetImageOutOfDateOk() (*bool, bool) { + if o == nil || IsNil(o.ImageOutOfDate) { + return nil, false + } + return o.ImageOutOfDate, true +} + +// HasImageOutOfDate returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineSearchResponseModel) HasImageOutOfDate() bool { + if o != nil && !IsNil(o.ImageOutOfDate) { + return true + } + + return false +} + +// SetImageOutOfDate gets a reference to the given bool and assigns it to the ImageOutOfDate field. +func (o *ProvisionedVirtualMachineSearchResponseModel) SetImageOutOfDate(v bool) { + o.ImageOutOfDate = &v +} + +// GetLastBootTime returns the LastBootTime field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineSearchResponseModel) GetLastBootTime() string { + if o == nil || IsNil(o.LastBootTime.Get()) { + var ret string + return ret + } + return *o.LastBootTime.Get() +} + +// GetLastBootTimeOk returns a tuple with the LastBootTime field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineSearchResponseModel) GetLastBootTimeOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.LastBootTime.Get(), o.LastBootTime.IsSet() +} + +// HasLastBootTime returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineSearchResponseModel) HasLastBootTime() bool { + if o != nil && o.LastBootTime.IsSet() { + return true + } + + return false +} + +// SetLastBootTime gets a reference to the given NullableString and assigns it to the LastBootTime field. +func (o *ProvisionedVirtualMachineSearchResponseModel) SetLastBootTime(v string) { + o.LastBootTime.Set(&v) +} +// SetLastBootTimeNil sets the value for LastBootTime to be an explicit nil +func (o *ProvisionedVirtualMachineSearchResponseModel) SetLastBootTimeNil() { + o.LastBootTime.Set(nil) +} + +// UnsetLastBootTime ensures that no value is present for LastBootTime, not even an explicit nil +func (o *ProvisionedVirtualMachineSearchResponseModel) UnsetLastBootTime() { + o.LastBootTime.Unset() +} + +// GetMemoryMB returns the MemoryMB field value if set, zero value otherwise. +func (o *ProvisionedVirtualMachineSearchResponseModel) GetMemoryMB() int32 { + if o == nil || IsNil(o.MemoryMB) { + var ret int32 + return ret + } + return *o.MemoryMB +} + +// GetMemoryMBOk returns a tuple with the MemoryMB field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ProvisionedVirtualMachineSearchResponseModel) GetMemoryMBOk() (*int32, bool) { + if o == nil || IsNil(o.MemoryMB) { + return nil, false + } + return o.MemoryMB, true +} + +// HasMemoryMB returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineSearchResponseModel) HasMemoryMB() bool { + if o != nil && !IsNil(o.MemoryMB) { + return true + } + + return false +} + +// SetMemoryMB gets a reference to the given int32 and assigns it to the MemoryMB field. +func (o *ProvisionedVirtualMachineSearchResponseModel) SetMemoryMB(v int32) { + o.MemoryMB = &v +} + +// GetPersistency returns the Persistency field value if set, zero value otherwise. +func (o *ProvisionedVirtualMachineSearchResponseModel) GetPersistency() bool { + if o == nil || IsNil(o.Persistency) { + var ret bool + return ret + } + return *o.Persistency +} + +// GetPersistencyOk returns a tuple with the Persistency field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ProvisionedVirtualMachineSearchResponseModel) GetPersistencyOk() (*bool, bool) { + if o == nil || IsNil(o.Persistency) { + return nil, false + } + return o.Persistency, true +} + +// HasPersistency returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineSearchResponseModel) HasPersistency() bool { + if o != nil && !IsNil(o.Persistency) { + return true + } + + return false +} + +// SetPersistency gets a reference to the given bool and assigns it to the Persistency field. +func (o *ProvisionedVirtualMachineSearchResponseModel) SetPersistency(v bool) { + o.Persistency = &v +} + +// GetProvisioningSchemeName returns the ProvisioningSchemeName field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineSearchResponseModel) GetProvisioningSchemeName() string { + if o == nil || IsNil(o.ProvisioningSchemeName.Get()) { + var ret string + return ret + } + return *o.ProvisioningSchemeName.Get() +} + +// GetProvisioningSchemeNameOk returns a tuple with the ProvisioningSchemeName field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineSearchResponseModel) GetProvisioningSchemeNameOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.ProvisioningSchemeName.Get(), o.ProvisioningSchemeName.IsSet() +} + +// HasProvisioningSchemeName returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineSearchResponseModel) HasProvisioningSchemeName() bool { + if o != nil && o.ProvisioningSchemeName.IsSet() { + return true + } + + return false +} + +// SetProvisioningSchemeName gets a reference to the given NullableString and assigns it to the ProvisioningSchemeName field. +func (o *ProvisionedVirtualMachineSearchResponseModel) SetProvisioningSchemeName(v string) { + o.ProvisioningSchemeName.Set(&v) +} +// SetProvisioningSchemeNameNil sets the value for ProvisioningSchemeName to be an explicit nil +func (o *ProvisionedVirtualMachineSearchResponseModel) SetProvisioningSchemeNameNil() { + o.ProvisioningSchemeName.Set(nil) +} + +// UnsetProvisioningSchemeName ensures that no value is present for ProvisioningSchemeName, not even an explicit nil +func (o *ProvisionedVirtualMachineSearchResponseModel) UnsetProvisioningSchemeName() { + o.ProvisioningSchemeName.Unset() +} + +// GetProvisioningSchemeVersion returns the ProvisioningSchemeVersion field value if set, zero value otherwise. +func (o *ProvisionedVirtualMachineSearchResponseModel) GetProvisioningSchemeVersion() int32 { + if o == nil || IsNil(o.ProvisioningSchemeVersion) { + var ret int32 + return ret + } + return *o.ProvisioningSchemeVersion +} + +// GetProvisioningSchemeVersionOk returns a tuple with the ProvisioningSchemeVersion field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ProvisionedVirtualMachineSearchResponseModel) GetProvisioningSchemeVersionOk() (*int32, bool) { + if o == nil || IsNil(o.ProvisioningSchemeVersion) { + return nil, false + } + return o.ProvisioningSchemeVersion, true +} + +// HasProvisioningSchemeVersion returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineSearchResponseModel) HasProvisioningSchemeVersion() bool { + if o != nil && !IsNil(o.ProvisioningSchemeVersion) { + return true + } + + return false +} + +// SetProvisioningSchemeVersion gets a reference to the given int32 and assigns it to the ProvisioningSchemeVersion field. +func (o *ProvisionedVirtualMachineSearchResponseModel) SetProvisioningSchemeVersion(v int32) { + o.ProvisioningSchemeVersion = &v +} + +// GetProvVMConfigurationVersion returns the ProvVMConfigurationVersion field value if set, zero value otherwise. +func (o *ProvisionedVirtualMachineSearchResponseModel) GetProvVMConfigurationVersion() int32 { + if o == nil || IsNil(o.ProvVMConfigurationVersion) { + var ret int32 + return ret + } + return *o.ProvVMConfigurationVersion +} + +// GetProvVMConfigurationVersionOk returns a tuple with the ProvVMConfigurationVersion field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ProvisionedVirtualMachineSearchResponseModel) GetProvVMConfigurationVersionOk() (*int32, bool) { + if o == nil || IsNil(o.ProvVMConfigurationVersion) { + return nil, false + } + return o.ProvVMConfigurationVersion, true +} + +// HasProvVMConfigurationVersion returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineSearchResponseModel) HasProvVMConfigurationVersion() bool { + if o != nil && !IsNil(o.ProvVMConfigurationVersion) { + return true + } + + return false +} + +// SetProvVMConfigurationVersion gets a reference to the given int32 and assigns it to the ProvVMConfigurationVersion field. +func (o *ProvisionedVirtualMachineSearchResponseModel) SetProvVMConfigurationVersion(v int32) { + o.ProvVMConfigurationVersion = &v +} + +// GetVMName returns the VMName field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineSearchResponseModel) GetVMName() string { + if o == nil || IsNil(o.VMName.Get()) { + var ret string + return ret + } + return *o.VMName.Get() +} + +// GetVMNameOk returns a tuple with the VMName field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineSearchResponseModel) GetVMNameOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.VMName.Get(), o.VMName.IsSet() +} + +// HasVMName returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineSearchResponseModel) HasVMName() bool { + if o != nil && o.VMName.IsSet() { + return true + } + + return false +} + +// SetVMName gets a reference to the given NullableString and assigns it to the VMName field. +func (o *ProvisionedVirtualMachineSearchResponseModel) SetVMName(v string) { + o.VMName.Set(&v) +} +// SetVMNameNil sets the value for VMName to be an explicit nil +func (o *ProvisionedVirtualMachineSearchResponseModel) SetVMNameNil() { + o.VMName.Set(nil) +} + +// UnsetVMName ensures that no value is present for VMName, not even an explicit nil +func (o *ProvisionedVirtualMachineSearchResponseModel) UnsetVMName() { + o.VMName.Unset() +} + +// GetWindowsActivationTypeProvisionedVirtualMachine returns the WindowsActivationTypeProvisionedVirtualMachine field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineSearchResponseModel) GetWindowsActivationTypeProvisionedVirtualMachine() string { + if o == nil || IsNil(o.WindowsActivationTypeProvisionedVirtualMachine.Get()) { + var ret string + return ret + } + return *o.WindowsActivationTypeProvisionedVirtualMachine.Get() +} + +// GetWindowsActivationTypeProvisionedVirtualMachineOk returns a tuple with the WindowsActivationTypeProvisionedVirtualMachine field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineSearchResponseModel) GetWindowsActivationTypeProvisionedVirtualMachineOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.WindowsActivationTypeProvisionedVirtualMachine.Get(), o.WindowsActivationTypeProvisionedVirtualMachine.IsSet() +} + +// HasWindowsActivationTypeProvisionedVirtualMachine returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineSearchResponseModel) HasWindowsActivationTypeProvisionedVirtualMachine() bool { + if o != nil && o.WindowsActivationTypeProvisionedVirtualMachine.IsSet() { + return true + } + + return false +} + +// SetWindowsActivationTypeProvisionedVirtualMachine gets a reference to the given NullableString and assigns it to the WindowsActivationTypeProvisionedVirtualMachine field. +func (o *ProvisionedVirtualMachineSearchResponseModel) SetWindowsActivationTypeProvisionedVirtualMachine(v string) { + o.WindowsActivationTypeProvisionedVirtualMachine.Set(&v) +} +// SetWindowsActivationTypeProvisionedVirtualMachineNil sets the value for WindowsActivationTypeProvisionedVirtualMachine to be an explicit nil +func (o *ProvisionedVirtualMachineSearchResponseModel) SetWindowsActivationTypeProvisionedVirtualMachineNil() { + o.WindowsActivationTypeProvisionedVirtualMachine.Set(nil) +} + +// UnsetWindowsActivationTypeProvisionedVirtualMachine ensures that no value is present for WindowsActivationTypeProvisionedVirtualMachine, not even an explicit nil +func (o *ProvisionedVirtualMachineSearchResponseModel) UnsetWindowsActivationTypeProvisionedVirtualMachine() { + o.WindowsActivationTypeProvisionedVirtualMachine.Unset() +} + +// GetUseWriteBackCache returns the UseWriteBackCache field value if set, zero value otherwise. +func (o *ProvisionedVirtualMachineSearchResponseModel) GetUseWriteBackCache() bool { + if o == nil || IsNil(o.UseWriteBackCache) { + var ret bool + return ret + } + return *o.UseWriteBackCache +} + +// GetUseWriteBackCacheOk returns a tuple with the UseWriteBackCache field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ProvisionedVirtualMachineSearchResponseModel) GetUseWriteBackCacheOk() (*bool, bool) { + if o == nil || IsNil(o.UseWriteBackCache) { + return nil, false + } + return o.UseWriteBackCache, true +} + +// HasUseWriteBackCache returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineSearchResponseModel) HasUseWriteBackCache() bool { + if o != nil && !IsNil(o.UseWriteBackCache) { + return true + } + + return false +} + +// SetUseWriteBackCache gets a reference to the given bool and assigns it to the UseWriteBackCache field. +func (o *ProvisionedVirtualMachineSearchResponseModel) SetUseWriteBackCache(v bool) { + o.UseWriteBackCache = &v +} + +// GetWriteBackCacheDiskSize returns the WriteBackCacheDiskSize field value if set, zero value otherwise. +func (o *ProvisionedVirtualMachineSearchResponseModel) GetWriteBackCacheDiskSize() int32 { + if o == nil || IsNil(o.WriteBackCacheDiskSize) { + var ret int32 + return ret + } + return *o.WriteBackCacheDiskSize +} + +// GetWriteBackCacheDiskSizeOk returns a tuple with the WriteBackCacheDiskSize field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ProvisionedVirtualMachineSearchResponseModel) GetWriteBackCacheDiskSizeOk() (*int32, bool) { + if o == nil || IsNil(o.WriteBackCacheDiskSize) { + return nil, false + } + return o.WriteBackCacheDiskSize, true +} + +// HasWriteBackCacheDiskSize returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineSearchResponseModel) HasWriteBackCacheDiskSize() bool { + if o != nil && !IsNil(o.WriteBackCacheDiskSize) { + return true + } + + return false +} + +// SetWriteBackCacheDiskSize gets a reference to the given int32 and assigns it to the WriteBackCacheDiskSize field. +func (o *ProvisionedVirtualMachineSearchResponseModel) SetWriteBackCacheDiskSize(v int32) { + o.WriteBackCacheDiskSize = &v +} + +// GetWriteBackCacheDiskDriveLetter returns the WriteBackCacheDiskDriveLetter field value if set, zero value otherwise. +func (o *ProvisionedVirtualMachineSearchResponseModel) GetWriteBackCacheDiskDriveLetter() int32 { + if o == nil || IsNil(o.WriteBackCacheDiskDriveLetter) { + var ret int32 + return ret + } + return *o.WriteBackCacheDiskDriveLetter +} + +// GetWriteBackCacheDiskDriveLetterOk returns a tuple with the WriteBackCacheDiskDriveLetter field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ProvisionedVirtualMachineSearchResponseModel) GetWriteBackCacheDiskDriveLetterOk() (*int32, bool) { + if o == nil || IsNil(o.WriteBackCacheDiskDriveLetter) { + return nil, false + } + return o.WriteBackCacheDiskDriveLetter, true +} + +// HasWriteBackCacheDiskDriveLetter returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineSearchResponseModel) HasWriteBackCacheDiskDriveLetter() bool { + if o != nil && !IsNil(o.WriteBackCacheDiskDriveLetter) { + return true + } + + return false +} + +// SetWriteBackCacheDiskDriveLetter gets a reference to the given int32 and assigns it to the WriteBackCacheDiskDriveLetter field. +func (o *ProvisionedVirtualMachineSearchResponseModel) SetWriteBackCacheDiskDriveLetter(v int32) { + o.WriteBackCacheDiskDriveLetter = &v +} + +// GetWriteBackCacheMemorySize returns the WriteBackCacheMemorySize field value if set, zero value otherwise. +func (o *ProvisionedVirtualMachineSearchResponseModel) GetWriteBackCacheMemorySize() int32 { + if o == nil || IsNil(o.WriteBackCacheMemorySize) { + var ret int32 + return ret + } + return *o.WriteBackCacheMemorySize +} + +// GetWriteBackCacheMemorySizeOk returns a tuple with the WriteBackCacheMemorySize field value if set, nil otherwise +// and a boolean to check if the value has been set. +func (o *ProvisionedVirtualMachineSearchResponseModel) GetWriteBackCacheMemorySizeOk() (*int32, bool) { + if o == nil || IsNil(o.WriteBackCacheMemorySize) { + return nil, false + } + return o.WriteBackCacheMemorySize, true +} + +// HasWriteBackCacheMemorySize returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineSearchResponseModel) HasWriteBackCacheMemorySize() bool { + if o != nil && !IsNil(o.WriteBackCacheMemorySize) { + return true + } + + return false +} + +// SetWriteBackCacheMemorySize gets a reference to the given int32 and assigns it to the WriteBackCacheMemorySize field. +func (o *ProvisionedVirtualMachineSearchResponseModel) SetWriteBackCacheMemorySize(v int32) { + o.WriteBackCacheMemorySize = &v +} + +func (o ProvisionedVirtualMachineSearchResponseModel) MarshalJSON() ([]byte, error) { + toSerialize,err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o ProvisionedVirtualMachineSearchResponseModel) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + if o.ActiveOperation.IsSet() { + toSerialize["ActiveOperation"] = o.ActiveOperation.Get() + } + if o.VMSid.IsSet() { + toSerialize["VMSid"] = o.VMSid.Get() + } + if !IsNil(o.CpuCount) { + toSerialize["CpuCount"] = o.CpuCount + } + if o.IdentityType.IsSet() { + toSerialize["IdentityType"] = o.IdentityType.Get() + } + if o.Identities.IsSet() { + toSerialize["Identities"] = o.Identities.Get() + } + if !IsNil(o.ImageOutOfDate) { + toSerialize["ImageOutOfDate"] = o.ImageOutOfDate + } + if o.LastBootTime.IsSet() { + toSerialize["LastBootTime"] = o.LastBootTime.Get() + } + if !IsNil(o.MemoryMB) { + toSerialize["MemoryMB"] = o.MemoryMB + } + if !IsNil(o.Persistency) { + toSerialize["Persistency"] = o.Persistency + } + if o.ProvisioningSchemeName.IsSet() { + toSerialize["ProvisioningSchemeName"] = o.ProvisioningSchemeName.Get() + } + if !IsNil(o.ProvisioningSchemeVersion) { + toSerialize["ProvisioningSchemeVersion"] = o.ProvisioningSchemeVersion + } + if !IsNil(o.ProvVMConfigurationVersion) { + toSerialize["ProvVMConfigurationVersion"] = o.ProvVMConfigurationVersion + } + if o.VMName.IsSet() { + toSerialize["VMName"] = o.VMName.Get() + } + if o.WindowsActivationTypeProvisionedVirtualMachine.IsSet() { + toSerialize["WindowsActivationTypeProvisionedVirtualMachine"] = o.WindowsActivationTypeProvisionedVirtualMachine.Get() + } + if !IsNil(o.UseWriteBackCache) { + toSerialize["UseWriteBackCache"] = o.UseWriteBackCache + } + if !IsNil(o.WriteBackCacheDiskSize) { + toSerialize["WriteBackCacheDiskSize"] = o.WriteBackCacheDiskSize + } + if !IsNil(o.WriteBackCacheDiskDriveLetter) { + toSerialize["WriteBackCacheDiskDriveLetter"] = o.WriteBackCacheDiskDriveLetter + } + if !IsNil(o.WriteBackCacheMemorySize) { + toSerialize["WriteBackCacheMemorySize"] = o.WriteBackCacheMemorySize + } + return toSerialize, nil +} + +type NullableProvisionedVirtualMachineSearchResponseModel struct { + value *ProvisionedVirtualMachineSearchResponseModel + isSet bool +} + +func (v NullableProvisionedVirtualMachineSearchResponseModel) Get() *ProvisionedVirtualMachineSearchResponseModel { + return v.value +} + +func (v *NullableProvisionedVirtualMachineSearchResponseModel) Set(val *ProvisionedVirtualMachineSearchResponseModel) { + v.value = val + v.isSet = true +} + +func (v NullableProvisionedVirtualMachineSearchResponseModel) IsSet() bool { + return v.isSet +} + +func (v *NullableProvisionedVirtualMachineSearchResponseModel) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableProvisionedVirtualMachineSearchResponseModel(val *ProvisionedVirtualMachineSearchResponseModel) *NullableProvisionedVirtualMachineSearchResponseModel { + return &NullableProvisionedVirtualMachineSearchResponseModel{value: val, isSet: true} +} + +func (v NullableProvisionedVirtualMachineSearchResponseModel) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableProvisionedVirtualMachineSearchResponseModel) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/citrixorchestration/model_provisioned_virtual_machine_search_response_model_collection.go b/citrixorchestration/model_provisioned_virtual_machine_search_response_model_collection.go new file mode 100644 index 0000000..3d3ee5b --- /dev/null +++ b/citrixorchestration/model_provisioned_virtual_machine_search_response_model_collection.go @@ -0,0 +1,212 @@ +/* +Citrix Virtual Apps and Desktops Rest API for Developer Portal + +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + +API version: devportal-onprem-ga +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package citrixorchestration + +import ( + "encoding/json" +) + +// checks if the ProvisionedVirtualMachineSearchResponseModelCollection type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &ProvisionedVirtualMachineSearchResponseModelCollection{} + +// ProvisionedVirtualMachineSearchResponseModelCollection struct for ProvisionedVirtualMachineSearchResponseModelCollection +type ProvisionedVirtualMachineSearchResponseModelCollection struct { + // List of items. + Items []ProvisionedVirtualMachineSearchResponseModel `json:"Items"` + // If present, indicates to the caller that the query was not complete, and they should call the API again specifying the continuation token as a query parameter. + ContinuationToken NullableString `json:"ContinuationToken,omitempty"` + // Indicates the total number of items in the collection, which may be more than the number of Items returned, if there is a ContinuationToken. Only returned in the response to `$search` APIs. + TotalItems NullableInt32 `json:"TotalItems,omitempty"` +} + +// NewProvisionedVirtualMachineSearchResponseModelCollection instantiates a new ProvisionedVirtualMachineSearchResponseModelCollection object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewProvisionedVirtualMachineSearchResponseModelCollection(items []ProvisionedVirtualMachineSearchResponseModel) *ProvisionedVirtualMachineSearchResponseModelCollection { + this := ProvisionedVirtualMachineSearchResponseModelCollection{} + this.Items = items + return &this +} + +// NewProvisionedVirtualMachineSearchResponseModelCollectionWithDefaults instantiates a new ProvisionedVirtualMachineSearchResponseModelCollection object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewProvisionedVirtualMachineSearchResponseModelCollectionWithDefaults() *ProvisionedVirtualMachineSearchResponseModelCollection { + this := ProvisionedVirtualMachineSearchResponseModelCollection{} + return &this +} + +// GetItems returns the Items field value +func (o *ProvisionedVirtualMachineSearchResponseModelCollection) GetItems() []ProvisionedVirtualMachineSearchResponseModel { + if o == nil { + var ret []ProvisionedVirtualMachineSearchResponseModel + return ret + } + + return o.Items +} + +// GetItemsOk returns a tuple with the Items field value +// and a boolean to check if the value has been set. +func (o *ProvisionedVirtualMachineSearchResponseModelCollection) GetItemsOk() ([]ProvisionedVirtualMachineSearchResponseModel, bool) { + if o == nil { + return nil, false + } + return o.Items, true +} + +// SetItems sets field value +func (o *ProvisionedVirtualMachineSearchResponseModelCollection) SetItems(v []ProvisionedVirtualMachineSearchResponseModel) { + o.Items = v +} + +// GetContinuationToken returns the ContinuationToken field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineSearchResponseModelCollection) GetContinuationToken() string { + if o == nil || IsNil(o.ContinuationToken.Get()) { + var ret string + return ret + } + return *o.ContinuationToken.Get() +} + +// GetContinuationTokenOk returns a tuple with the ContinuationToken field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineSearchResponseModelCollection) GetContinuationTokenOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.ContinuationToken.Get(), o.ContinuationToken.IsSet() +} + +// HasContinuationToken returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineSearchResponseModelCollection) HasContinuationToken() bool { + if o != nil && o.ContinuationToken.IsSet() { + return true + } + + return false +} + +// SetContinuationToken gets a reference to the given NullableString and assigns it to the ContinuationToken field. +func (o *ProvisionedVirtualMachineSearchResponseModelCollection) SetContinuationToken(v string) { + o.ContinuationToken.Set(&v) +} +// SetContinuationTokenNil sets the value for ContinuationToken to be an explicit nil +func (o *ProvisionedVirtualMachineSearchResponseModelCollection) SetContinuationTokenNil() { + o.ContinuationToken.Set(nil) +} + +// UnsetContinuationToken ensures that no value is present for ContinuationToken, not even an explicit nil +func (o *ProvisionedVirtualMachineSearchResponseModelCollection) UnsetContinuationToken() { + o.ContinuationToken.Unset() +} + +// GetTotalItems returns the TotalItems field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisionedVirtualMachineSearchResponseModelCollection) GetTotalItems() int32 { + if o == nil || IsNil(o.TotalItems.Get()) { + var ret int32 + return ret + } + return *o.TotalItems.Get() +} + +// GetTotalItemsOk returns a tuple with the TotalItems field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisionedVirtualMachineSearchResponseModelCollection) GetTotalItemsOk() (*int32, bool) { + if o == nil { + return nil, false + } + return o.TotalItems.Get(), o.TotalItems.IsSet() +} + +// HasTotalItems returns a boolean if a field has been set. +func (o *ProvisionedVirtualMachineSearchResponseModelCollection) HasTotalItems() bool { + if o != nil && o.TotalItems.IsSet() { + return true + } + + return false +} + +// SetTotalItems gets a reference to the given NullableInt32 and assigns it to the TotalItems field. +func (o *ProvisionedVirtualMachineSearchResponseModelCollection) SetTotalItems(v int32) { + o.TotalItems.Set(&v) +} +// SetTotalItemsNil sets the value for TotalItems to be an explicit nil +func (o *ProvisionedVirtualMachineSearchResponseModelCollection) SetTotalItemsNil() { + o.TotalItems.Set(nil) +} + +// UnsetTotalItems ensures that no value is present for TotalItems, not even an explicit nil +func (o *ProvisionedVirtualMachineSearchResponseModelCollection) UnsetTotalItems() { + o.TotalItems.Unset() +} + +func (o ProvisionedVirtualMachineSearchResponseModelCollection) MarshalJSON() ([]byte, error) { + toSerialize,err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o ProvisionedVirtualMachineSearchResponseModelCollection) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + toSerialize["Items"] = o.Items + if o.ContinuationToken.IsSet() { + toSerialize["ContinuationToken"] = o.ContinuationToken.Get() + } + if o.TotalItems.IsSet() { + toSerialize["TotalItems"] = o.TotalItems.Get() + } + return toSerialize, nil +} + +type NullableProvisionedVirtualMachineSearchResponseModelCollection struct { + value *ProvisionedVirtualMachineSearchResponseModelCollection + isSet bool +} + +func (v NullableProvisionedVirtualMachineSearchResponseModelCollection) Get() *ProvisionedVirtualMachineSearchResponseModelCollection { + return v.value +} + +func (v *NullableProvisionedVirtualMachineSearchResponseModelCollection) Set(val *ProvisionedVirtualMachineSearchResponseModelCollection) { + v.value = val + v.isSet = true +} + +func (v NullableProvisionedVirtualMachineSearchResponseModelCollection) IsSet() bool { + return v.isSet +} + +func (v *NullableProvisionedVirtualMachineSearchResponseModelCollection) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableProvisionedVirtualMachineSearchResponseModelCollection(val *ProvisionedVirtualMachineSearchResponseModelCollection) *NullableProvisionedVirtualMachineSearchResponseModelCollection { + return &NullableProvisionedVirtualMachineSearchResponseModelCollection{value: val, isSet: true} +} + +func (v NullableProvisionedVirtualMachineSearchResponseModelCollection) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableProvisionedVirtualMachineSearchResponseModelCollection) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/citrixorchestration/model_provisioned_virtual_machine_sort_criteria_request_model.go b/citrixorchestration/model_provisioned_virtual_machine_sort_criteria_request_model.go new file mode 100644 index 0000000..f922987 --- /dev/null +++ b/citrixorchestration/model_provisioned_virtual_machine_sort_criteria_request_model.go @@ -0,0 +1,144 @@ +/* +Citrix Virtual Apps and Desktops Rest API for Developer Portal + +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + +API version: devportal-onprem-ga +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT. + +package citrixorchestration + +import ( + "encoding/json" +) + +// checks if the ProvisionedVirtualMachineSortCriteriaRequestModel type satisfies the MappedNullable interface at compile time +var _ MappedNullable = &ProvisionedVirtualMachineSortCriteriaRequestModel{} + +// ProvisionedVirtualMachineSortCriteriaRequestModel Machine sort criteria. +type ProvisionedVirtualMachineSortCriteriaRequestModel struct { + Property ProvisionedVirtualMachineSearchProperty `json:"Property"` + SortDirection ListSortDirection `json:"SortDirection"` +} + +// NewProvisionedVirtualMachineSortCriteriaRequestModel instantiates a new ProvisionedVirtualMachineSortCriteriaRequestModel object +// This constructor will assign default values to properties that have it defined, +// and makes sure properties required by API are set, but the set of arguments +// will change when the set of required properties is changed +func NewProvisionedVirtualMachineSortCriteriaRequestModel(property ProvisionedVirtualMachineSearchProperty, sortDirection ListSortDirection) *ProvisionedVirtualMachineSortCriteriaRequestModel { + this := ProvisionedVirtualMachineSortCriteriaRequestModel{} + this.Property = property + this.SortDirection = sortDirection + return &this +} + +// NewProvisionedVirtualMachineSortCriteriaRequestModelWithDefaults instantiates a new ProvisionedVirtualMachineSortCriteriaRequestModel object +// This constructor will only assign default values to properties that have it defined, +// but it doesn't guarantee that properties required by API are set +func NewProvisionedVirtualMachineSortCriteriaRequestModelWithDefaults() *ProvisionedVirtualMachineSortCriteriaRequestModel { + this := ProvisionedVirtualMachineSortCriteriaRequestModel{} + return &this +} + +// GetProperty returns the Property field value +func (o *ProvisionedVirtualMachineSortCriteriaRequestModel) GetProperty() ProvisionedVirtualMachineSearchProperty { + if o == nil { + var ret ProvisionedVirtualMachineSearchProperty + return ret + } + + return o.Property +} + +// GetPropertyOk returns a tuple with the Property field value +// and a boolean to check if the value has been set. +func (o *ProvisionedVirtualMachineSortCriteriaRequestModel) GetPropertyOk() (*ProvisionedVirtualMachineSearchProperty, bool) { + if o == nil { + return nil, false + } + return &o.Property, true +} + +// SetProperty sets field value +func (o *ProvisionedVirtualMachineSortCriteriaRequestModel) SetProperty(v ProvisionedVirtualMachineSearchProperty) { + o.Property = v +} + +// GetSortDirection returns the SortDirection field value +func (o *ProvisionedVirtualMachineSortCriteriaRequestModel) GetSortDirection() ListSortDirection { + if o == nil { + var ret ListSortDirection + return ret + } + + return o.SortDirection +} + +// GetSortDirectionOk returns a tuple with the SortDirection field value +// and a boolean to check if the value has been set. +func (o *ProvisionedVirtualMachineSortCriteriaRequestModel) GetSortDirectionOk() (*ListSortDirection, bool) { + if o == nil { + return nil, false + } + return &o.SortDirection, true +} + +// SetSortDirection sets field value +func (o *ProvisionedVirtualMachineSortCriteriaRequestModel) SetSortDirection(v ListSortDirection) { + o.SortDirection = v +} + +func (o ProvisionedVirtualMachineSortCriteriaRequestModel) MarshalJSON() ([]byte, error) { + toSerialize,err := o.ToMap() + if err != nil { + return []byte{}, err + } + return json.Marshal(toSerialize) +} + +func (o ProvisionedVirtualMachineSortCriteriaRequestModel) ToMap() (map[string]interface{}, error) { + toSerialize := map[string]interface{}{} + toSerialize["Property"] = o.Property + toSerialize["SortDirection"] = o.SortDirection + return toSerialize, nil +} + +type NullableProvisionedVirtualMachineSortCriteriaRequestModel struct { + value *ProvisionedVirtualMachineSortCriteriaRequestModel + isSet bool +} + +func (v NullableProvisionedVirtualMachineSortCriteriaRequestModel) Get() *ProvisionedVirtualMachineSortCriteriaRequestModel { + return v.value +} + +func (v *NullableProvisionedVirtualMachineSortCriteriaRequestModel) Set(val *ProvisionedVirtualMachineSortCriteriaRequestModel) { + v.value = val + v.isSet = true +} + +func (v NullableProvisionedVirtualMachineSortCriteriaRequestModel) IsSet() bool { + return v.isSet +} + +func (v *NullableProvisionedVirtualMachineSortCriteriaRequestModel) Unset() { + v.value = nil + v.isSet = false +} + +func NewNullableProvisionedVirtualMachineSortCriteriaRequestModel(val *ProvisionedVirtualMachineSortCriteriaRequestModel) *NullableProvisionedVirtualMachineSortCriteriaRequestModel { + return &NullableProvisionedVirtualMachineSortCriteriaRequestModel{value: val, isSet: true} +} + +func (v NullableProvisionedVirtualMachineSortCriteriaRequestModel) MarshalJSON() ([]byte, error) { + return json.Marshal(v.value) +} + +func (v *NullableProvisionedVirtualMachineSortCriteriaRequestModel) UnmarshalJSON(src []byte) error { + v.isSet = true + return json.Unmarshal(src, &v.value) +} + + diff --git a/citrixorchestration/model_provisioning_scheme_vm_metadata_response_model.go b/citrixorchestration/model_provisioning_scheme_vm_metadata_response_model.go index ba2dd18..74606b5 100644 --- a/citrixorchestration/model_provisioning_scheme_vm_metadata_response_model.go +++ b/citrixorchestration/model_provisioning_scheme_vm_metadata_response_model.go @@ -37,10 +37,20 @@ type ProvisioningSchemeVmMetadataResponseModel struct { DiskSecurityType NullableString `json:"DiskSecurityType,omitempty"` // VmMetadata confidential VM disk encryption set id configuration ConfidentialVmDiskEncryptionSetId NullableString `json:"ConfidentialVmDiskEncryptionSetId,omitempty"` + // VmMetadata VirtualMachine.Resources.Properties.SecurityProfile.UefiSettings.secureBootEnabled + EnableSecureBoot NullableBool `json:"EnableSecureBoot,omitempty"` + // VmMetadata VirtualMachine.Resources.Properties.SecurityProfile.UefiSettings.vTpmEnabled + EnableVTPM NullableBool `json:"EnableVTPM,omitempty"` + // VmMetadata VirtualMachine.Resources.Properties.SecurityProfile.EncryptionAtHost + EncryptionAtHost NullableBool `json:"EncryptionAtHost,omitempty"` // VmMetadata Labels Labels NullableString `json:"Labels,omitempty"` // VmMetadata zone name ZoneName NullableString `json:"ZoneName,omitempty"` + // VmMetadata storage type + StorageType NullableString `json:"StorageType,omitempty"` + // VmMetadata encryption key + EncryptionKeyId NullableString `json:"EncryptionKeyId,omitempty"` } // NewProvisioningSchemeVmMetadataResponseModel instantiates a new ProvisioningSchemeVmMetadataResponseModel object @@ -438,6 +448,132 @@ func (o *ProvisioningSchemeVmMetadataResponseModel) UnsetConfidentialVmDiskEncry o.ConfidentialVmDiskEncryptionSetId.Unset() } +// GetEnableSecureBoot returns the EnableSecureBoot field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisioningSchemeVmMetadataResponseModel) GetEnableSecureBoot() bool { + if o == nil || IsNil(o.EnableSecureBoot.Get()) { + var ret bool + return ret + } + return *o.EnableSecureBoot.Get() +} + +// GetEnableSecureBootOk returns a tuple with the EnableSecureBoot field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisioningSchemeVmMetadataResponseModel) GetEnableSecureBootOk() (*bool, bool) { + if o == nil { + return nil, false + } + return o.EnableSecureBoot.Get(), o.EnableSecureBoot.IsSet() +} + +// HasEnableSecureBoot returns a boolean if a field has been set. +func (o *ProvisioningSchemeVmMetadataResponseModel) HasEnableSecureBoot() bool { + if o != nil && o.EnableSecureBoot.IsSet() { + return true + } + + return false +} + +// SetEnableSecureBoot gets a reference to the given NullableBool and assigns it to the EnableSecureBoot field. +func (o *ProvisioningSchemeVmMetadataResponseModel) SetEnableSecureBoot(v bool) { + o.EnableSecureBoot.Set(&v) +} +// SetEnableSecureBootNil sets the value for EnableSecureBoot to be an explicit nil +func (o *ProvisioningSchemeVmMetadataResponseModel) SetEnableSecureBootNil() { + o.EnableSecureBoot.Set(nil) +} + +// UnsetEnableSecureBoot ensures that no value is present for EnableSecureBoot, not even an explicit nil +func (o *ProvisioningSchemeVmMetadataResponseModel) UnsetEnableSecureBoot() { + o.EnableSecureBoot.Unset() +} + +// GetEnableVTPM returns the EnableVTPM field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisioningSchemeVmMetadataResponseModel) GetEnableVTPM() bool { + if o == nil || IsNil(o.EnableVTPM.Get()) { + var ret bool + return ret + } + return *o.EnableVTPM.Get() +} + +// GetEnableVTPMOk returns a tuple with the EnableVTPM field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisioningSchemeVmMetadataResponseModel) GetEnableVTPMOk() (*bool, bool) { + if o == nil { + return nil, false + } + return o.EnableVTPM.Get(), o.EnableVTPM.IsSet() +} + +// HasEnableVTPM returns a boolean if a field has been set. +func (o *ProvisioningSchemeVmMetadataResponseModel) HasEnableVTPM() bool { + if o != nil && o.EnableVTPM.IsSet() { + return true + } + + return false +} + +// SetEnableVTPM gets a reference to the given NullableBool and assigns it to the EnableVTPM field. +func (o *ProvisioningSchemeVmMetadataResponseModel) SetEnableVTPM(v bool) { + o.EnableVTPM.Set(&v) +} +// SetEnableVTPMNil sets the value for EnableVTPM to be an explicit nil +func (o *ProvisioningSchemeVmMetadataResponseModel) SetEnableVTPMNil() { + o.EnableVTPM.Set(nil) +} + +// UnsetEnableVTPM ensures that no value is present for EnableVTPM, not even an explicit nil +func (o *ProvisioningSchemeVmMetadataResponseModel) UnsetEnableVTPM() { + o.EnableVTPM.Unset() +} + +// GetEncryptionAtHost returns the EncryptionAtHost field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisioningSchemeVmMetadataResponseModel) GetEncryptionAtHost() bool { + if o == nil || IsNil(o.EncryptionAtHost.Get()) { + var ret bool + return ret + } + return *o.EncryptionAtHost.Get() +} + +// GetEncryptionAtHostOk returns a tuple with the EncryptionAtHost field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisioningSchemeVmMetadataResponseModel) GetEncryptionAtHostOk() (*bool, bool) { + if o == nil { + return nil, false + } + return o.EncryptionAtHost.Get(), o.EncryptionAtHost.IsSet() +} + +// HasEncryptionAtHost returns a boolean if a field has been set. +func (o *ProvisioningSchemeVmMetadataResponseModel) HasEncryptionAtHost() bool { + if o != nil && o.EncryptionAtHost.IsSet() { + return true + } + + return false +} + +// SetEncryptionAtHost gets a reference to the given NullableBool and assigns it to the EncryptionAtHost field. +func (o *ProvisioningSchemeVmMetadataResponseModel) SetEncryptionAtHost(v bool) { + o.EncryptionAtHost.Set(&v) +} +// SetEncryptionAtHostNil sets the value for EncryptionAtHost to be an explicit nil +func (o *ProvisioningSchemeVmMetadataResponseModel) SetEncryptionAtHostNil() { + o.EncryptionAtHost.Set(nil) +} + +// UnsetEncryptionAtHost ensures that no value is present for EncryptionAtHost, not even an explicit nil +func (o *ProvisioningSchemeVmMetadataResponseModel) UnsetEncryptionAtHost() { + o.EncryptionAtHost.Unset() +} + // GetLabels returns the Labels field value if set, zero value otherwise (both if not set or set to explicit null). func (o *ProvisioningSchemeVmMetadataResponseModel) GetLabels() string { if o == nil || IsNil(o.Labels.Get()) { @@ -522,6 +658,90 @@ func (o *ProvisioningSchemeVmMetadataResponseModel) UnsetZoneName() { o.ZoneName.Unset() } +// GetStorageType returns the StorageType field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisioningSchemeVmMetadataResponseModel) GetStorageType() string { + if o == nil || IsNil(o.StorageType.Get()) { + var ret string + return ret + } + return *o.StorageType.Get() +} + +// GetStorageTypeOk returns a tuple with the StorageType field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisioningSchemeVmMetadataResponseModel) GetStorageTypeOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.StorageType.Get(), o.StorageType.IsSet() +} + +// HasStorageType returns a boolean if a field has been set. +func (o *ProvisioningSchemeVmMetadataResponseModel) HasStorageType() bool { + if o != nil && o.StorageType.IsSet() { + return true + } + + return false +} + +// SetStorageType gets a reference to the given NullableString and assigns it to the StorageType field. +func (o *ProvisioningSchemeVmMetadataResponseModel) SetStorageType(v string) { + o.StorageType.Set(&v) +} +// SetStorageTypeNil sets the value for StorageType to be an explicit nil +func (o *ProvisioningSchemeVmMetadataResponseModel) SetStorageTypeNil() { + o.StorageType.Set(nil) +} + +// UnsetStorageType ensures that no value is present for StorageType, not even an explicit nil +func (o *ProvisioningSchemeVmMetadataResponseModel) UnsetStorageType() { + o.StorageType.Unset() +} + +// GetEncryptionKeyId returns the EncryptionKeyId field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *ProvisioningSchemeVmMetadataResponseModel) GetEncryptionKeyId() string { + if o == nil || IsNil(o.EncryptionKeyId.Get()) { + var ret string + return ret + } + return *o.EncryptionKeyId.Get() +} + +// GetEncryptionKeyIdOk returns a tuple with the EncryptionKeyId field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *ProvisioningSchemeVmMetadataResponseModel) GetEncryptionKeyIdOk() (*string, bool) { + if o == nil { + return nil, false + } + return o.EncryptionKeyId.Get(), o.EncryptionKeyId.IsSet() +} + +// HasEncryptionKeyId returns a boolean if a field has been set. +func (o *ProvisioningSchemeVmMetadataResponseModel) HasEncryptionKeyId() bool { + if o != nil && o.EncryptionKeyId.IsSet() { + return true + } + + return false +} + +// SetEncryptionKeyId gets a reference to the given NullableString and assigns it to the EncryptionKeyId field. +func (o *ProvisioningSchemeVmMetadataResponseModel) SetEncryptionKeyId(v string) { + o.EncryptionKeyId.Set(&v) +} +// SetEncryptionKeyIdNil sets the value for EncryptionKeyId to be an explicit nil +func (o *ProvisioningSchemeVmMetadataResponseModel) SetEncryptionKeyIdNil() { + o.EncryptionKeyId.Set(nil) +} + +// UnsetEncryptionKeyId ensures that no value is present for EncryptionKeyId, not even an explicit nil +func (o *ProvisioningSchemeVmMetadataResponseModel) UnsetEncryptionKeyId() { + o.EncryptionKeyId.Unset() +} + func (o ProvisioningSchemeVmMetadataResponseModel) MarshalJSON() ([]byte, error) { toSerialize,err := o.ToMap() if err != nil { @@ -559,12 +779,27 @@ func (o ProvisioningSchemeVmMetadataResponseModel) ToMap() (map[string]interface if o.ConfidentialVmDiskEncryptionSetId.IsSet() { toSerialize["ConfidentialVmDiskEncryptionSetId"] = o.ConfidentialVmDiskEncryptionSetId.Get() } + if o.EnableSecureBoot.IsSet() { + toSerialize["EnableSecureBoot"] = o.EnableSecureBoot.Get() + } + if o.EnableVTPM.IsSet() { + toSerialize["EnableVTPM"] = o.EnableVTPM.Get() + } + if o.EncryptionAtHost.IsSet() { + toSerialize["EncryptionAtHost"] = o.EncryptionAtHost.Get() + } if o.Labels.IsSet() { toSerialize["Labels"] = o.Labels.Get() } if o.ZoneName.IsSet() { toSerialize["ZoneName"] = o.ZoneName.Get() } + if o.StorageType.IsSet() { + toSerialize["StorageType"] = o.StorageType.Get() + } + if o.EncryptionKeyId.IsSet() { + toSerialize["EncryptionKeyId"] = o.EncryptionKeyId.Get() + } return toSerialize, nil } diff --git a/citrixorchestration/model_update_machine_request_model.go b/citrixorchestration/model_update_machine_request_model.go index 79f8aba..de7319e 100644 --- a/citrixorchestration/model_update_machine_request_model.go +++ b/citrixorchestration/model_update_machine_request_model.go @@ -33,6 +33,8 @@ type UpdateMachineRequestModel struct { InMaintenanceMode NullableBool `json:"InMaintenanceMode,omitempty"` // Customized name of the machine that is displayed in StoreFront, if the machine has been published. It can be set only for private desktops. If `null`, will not be changed. If empty string (`\"\"`), the machine will be unassigned from any published name. PublishedName NullableString `json:"PublishedName,omitempty"` + // The metadata of machine. Set the value of the NameValueStringPairModel is null or empty will be remove this metadata. Not existing Name and Value NameValueStringPairModel object will be added. The same Name but different value object will be updated. + Metadata []NameValueStringPairModel `json:"Metadata,omitempty"` } // NewUpdateMachineRequestModel instantiates a new UpdateMachineRequestModel object @@ -337,6 +339,39 @@ func (o *UpdateMachineRequestModel) UnsetPublishedName() { o.PublishedName.Unset() } +// GetMetadata returns the Metadata field value if set, zero value otherwise (both if not set or set to explicit null). +func (o *UpdateMachineRequestModel) GetMetadata() []NameValueStringPairModel { + if o == nil { + var ret []NameValueStringPairModel + return ret + } + return o.Metadata +} + +// GetMetadataOk returns a tuple with the Metadata field value if set, nil otherwise +// and a boolean to check if the value has been set. +// NOTE: If the value is an explicit nil, `nil, true` will be returned +func (o *UpdateMachineRequestModel) GetMetadataOk() ([]NameValueStringPairModel, bool) { + if o == nil || IsNil(o.Metadata) { + return nil, false + } + return o.Metadata, true +} + +// HasMetadata returns a boolean if a field has been set. +func (o *UpdateMachineRequestModel) HasMetadata() bool { + if o != nil && IsNil(o.Metadata) { + return true + } + + return false +} + +// SetMetadata gets a reference to the given []NameValueStringPairModel and assigns it to the Metadata field. +func (o *UpdateMachineRequestModel) SetMetadata(v []NameValueStringPairModel) { + o.Metadata = v +} + func (o UpdateMachineRequestModel) MarshalJSON() ([]byte, error) { toSerialize,err := o.ToMap() if err != nil { @@ -368,6 +403,9 @@ func (o UpdateMachineRequestModel) ToMap() (map[string]interface{}, error) { if o.PublishedName.IsSet() { toSerialize["PublishedName"] = o.PublishedName.Get() } + if o.Metadata != nil { + toSerialize["Metadata"] = o.Metadata + } return toSerialize, nil } diff --git a/citrixorchestration/test/api_gpo_test.go b/citrixorchestration/test/api_gpo_test.go new file mode 100644 index 0000000..405f8fb --- /dev/null +++ b/citrixorchestration/test/api_gpo_test.go @@ -0,0 +1,483 @@ +/* +Citrix Virtual Apps and Desktops Rest API for Developer Portal + +Testing GpoDAASService + +*/ + +// Code generated by OpenAPI Generator (https://openapi-generator.tech); + +package citrixorchestration + +import ( + "context" + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" + "testing" + openapiclient "github.com/citrix/citrix-daas-rest-go/citrixorchestration" +) + +func Test_citrixorchestration_GpoDAASService(t *testing.T) { + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + + t.Run("Test GpoDAASService GpoComparePolicies", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + resp, httpRes, err := apiClient.GpoDAAS.GpoComparePolicies(context.Background()).Execute() + + require.Nil(t, err) + require.NotNil(t, resp) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test GpoDAASService GpoCopyGpoPolicies", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + httpRes, err := apiClient.GpoDAAS.GpoCopyGpoPolicies(context.Background()).Execute() + + require.Nil(t, err) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test GpoDAASService GpoCopyGpoPolicySet", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + var policySetGuid string + + resp, httpRes, err := apiClient.GpoDAAS.GpoCopyGpoPolicySet(context.Background(), policySetGuid).Execute() + + require.Nil(t, err) + require.NotNil(t, resp) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test GpoDAASService GpoCreateGpoFilter", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + resp, httpRes, err := apiClient.GpoDAAS.GpoCreateGpoFilter(context.Background()).Execute() + + require.Nil(t, err) + require.NotNil(t, resp) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test GpoDAASService GpoCreateGpoPolicy", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + resp, httpRes, err := apiClient.GpoDAAS.GpoCreateGpoPolicy(context.Background()).Execute() + + require.Nil(t, err) + require.NotNil(t, resp) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test GpoDAASService GpoCreateGpoPolicySet", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + resp, httpRes, err := apiClient.GpoDAAS.GpoCreateGpoPolicySet(context.Background()).Execute() + + require.Nil(t, err) + require.NotNil(t, resp) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test GpoDAASService GpoCreateGpoSetting", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + resp, httpRes, err := apiClient.GpoDAAS.GpoCreateGpoSetting(context.Background()).Execute() + + require.Nil(t, err) + require.NotNil(t, resp) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test GpoDAASService GpoDeleteGpoFilter", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + var filterGuid string + + httpRes, err := apiClient.GpoDAAS.GpoDeleteGpoFilter(context.Background(), filterGuid).Execute() + + require.Nil(t, err) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test GpoDAASService GpoDeleteGpoPolicy", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + var policyGuid string + + httpRes, err := apiClient.GpoDAAS.GpoDeleteGpoPolicy(context.Background(), policyGuid).Execute() + + require.Nil(t, err) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test GpoDAASService GpoDeleteGpoPolicySet", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + var policySetGuid string + + httpRes, err := apiClient.GpoDAAS.GpoDeleteGpoPolicySet(context.Background(), policySetGuid).Execute() + + require.Nil(t, err) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test GpoDAASService GpoDeleteGpoSetting", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + var settingGuid string + + httpRes, err := apiClient.GpoDAAS.GpoDeleteGpoSetting(context.Background(), settingGuid).Execute() + + require.Nil(t, err) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test GpoDAASService GpoDisableGpoPolicies", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + httpRes, err := apiClient.GpoDAAS.GpoDisableGpoPolicies(context.Background()).Execute() + + require.Nil(t, err) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test GpoDAASService GpoEnableGpoPolicies", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + httpRes, err := apiClient.GpoDAAS.GpoEnableGpoPolicies(context.Background()).Execute() + + require.Nil(t, err) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test GpoDAASService GpoGetFilterDefinitions", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + resp, httpRes, err := apiClient.GpoDAAS.GpoGetFilterDefinitions(context.Background()).Execute() + + require.Nil(t, err) + require.NotNil(t, resp) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test GpoDAASService GpoGetSettingDefinitions", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + resp, httpRes, err := apiClient.GpoDAAS.GpoGetSettingDefinitions(context.Background()).Execute() + + require.Nil(t, err) + require.NotNil(t, resp) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test GpoDAASService GpoGetSettingFullDetail", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + resp, httpRes, err := apiClient.GpoDAAS.GpoGetSettingFullDetail(context.Background()).Execute() + + require.Nil(t, err) + require.NotNil(t, resp) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test GpoDAASService GpoMoveGpoPolicies", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + httpRes, err := apiClient.GpoDAAS.GpoMoveGpoPolicies(context.Background()).Execute() + + require.Nil(t, err) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test GpoDAASService GpoRankGpoPolicies", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + resp, httpRes, err := apiClient.GpoDAAS.GpoRankGpoPolicies(context.Background()).Execute() + + require.Nil(t, err) + require.NotNil(t, resp) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test GpoDAASService GpoReadGpoFilter", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + var filterGuid string + + resp, httpRes, err := apiClient.GpoDAAS.GpoReadGpoFilter(context.Background(), filterGuid).Execute() + + require.Nil(t, err) + require.NotNil(t, resp) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test GpoDAASService GpoReadGpoFilters", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + resp, httpRes, err := apiClient.GpoDAAS.GpoReadGpoFilters(context.Background()).Execute() + + require.Nil(t, err) + require.NotNil(t, resp) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test GpoDAASService GpoReadGpoPolicies", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + resp, httpRes, err := apiClient.GpoDAAS.GpoReadGpoPolicies(context.Background()).Execute() + + require.Nil(t, err) + require.NotNil(t, resp) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test GpoDAASService GpoReadGpoPolicy", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + var policyGuid string + + resp, httpRes, err := apiClient.GpoDAAS.GpoReadGpoPolicy(context.Background(), policyGuid).Execute() + + require.Nil(t, err) + require.NotNil(t, resp) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test GpoDAASService GpoReadGpoPolicySet", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + var policySetGuid string + + resp, httpRes, err := apiClient.GpoDAAS.GpoReadGpoPolicySet(context.Background(), policySetGuid).Execute() + + require.Nil(t, err) + require.NotNil(t, resp) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test GpoDAASService GpoReadGpoPolicySets", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + resp, httpRes, err := apiClient.GpoDAAS.GpoReadGpoPolicySets(context.Background()).Execute() + + require.Nil(t, err) + require.NotNil(t, resp) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test GpoDAASService GpoReadGpoSetting", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + var settingGuid string + + resp, httpRes, err := apiClient.GpoDAAS.GpoReadGpoSetting(context.Background(), settingGuid).Execute() + + require.Nil(t, err) + require.NotNil(t, resp) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test GpoDAASService GpoReadGpoSettings", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + resp, httpRes, err := apiClient.GpoDAAS.GpoReadGpoSettings(context.Background()).Execute() + + require.Nil(t, err) + require.NotNil(t, resp) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test GpoDAASService GpoRemoveGpoPolicies", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + httpRes, err := apiClient.GpoDAAS.GpoRemoveGpoPolicies(context.Background()).Execute() + + require.Nil(t, err) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test GpoDAASService GpoRunSimulation", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + resp, httpRes, err := apiClient.GpoDAAS.GpoRunSimulation(context.Background()).Execute() + + require.Nil(t, err) + require.NotNil(t, resp) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test GpoDAASService GpoSearchFilters", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + resp, httpRes, err := apiClient.GpoDAAS.GpoSearchFilters(context.Background()).Execute() + + require.Nil(t, err) + require.NotNil(t, resp) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test GpoDAASService GpoSearchPolicies", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + resp, httpRes, err := apiClient.GpoDAAS.GpoSearchPolicies(context.Background()).Execute() + + require.Nil(t, err) + require.NotNil(t, resp) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test GpoDAASService GpoSearchPolicySets", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + resp, httpRes, err := apiClient.GpoDAAS.GpoSearchPolicySets(context.Background()).Execute() + + require.Nil(t, err) + require.NotNil(t, resp) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test GpoDAASService GpoSearchSettings", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + resp, httpRes, err := apiClient.GpoDAAS.GpoSearchSettings(context.Background()).Execute() + + require.Nil(t, err) + require.NotNil(t, resp) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test GpoDAASService GpoUpdateGpoFilter", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + var filterGuid string + + httpRes, err := apiClient.GpoDAAS.GpoUpdateGpoFilter(context.Background(), filterGuid).Execute() + + require.Nil(t, err) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test GpoDAASService GpoUpdateGpoPolicy", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + var policyGuid string + + httpRes, err := apiClient.GpoDAAS.GpoUpdateGpoPolicy(context.Background(), policyGuid).Execute() + + require.Nil(t, err) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test GpoDAASService GpoUpdateGpoPolicySet", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + var policySetGuid string + + httpRes, err := apiClient.GpoDAAS.GpoUpdateGpoPolicySet(context.Background(), policySetGuid).Execute() + + require.Nil(t, err) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test GpoDAASService GpoUpdateGpoSetting", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + var settingGuid string + + httpRes, err := apiClient.GpoDAAS.GpoUpdateGpoSetting(context.Background(), settingGuid).Execute() + + require.Nil(t, err) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + + t.Run("Test GpoDAASService GpoUpdatePolicySetBlob", func(t *testing.T) { + + t.Skip("skip test") // remove to run test + + var policySetGuid string + + httpRes, err := apiClient.GpoDAAS.GpoUpdatePolicySetBlob(context.Background(), policySetGuid).Execute() + + require.Nil(t, err) + assert.Equal(t, 200, httpRes.StatusCode) + + }) + +}