Comma-separated list of field names that are added to the default set of fields.
You can include the following additional fields:
resourceContextresourceStatus.subResourceTypesresourceStatus.subResourceStatusesmanifestmanifest.scopes or manifest.intentsisBuiltinisolatedUrideactivationReasonsIf true, the latest version of the app is returned.
If false, the current version of the app is returned.
This is relevant while an app is being updated. During this time typically two versions of the same app exist, the current version and the latest version with status=PENDING.
Comma-separated list of field names that are added to the default set of fields.
You can include the following additional fields:
resourceContextresourceStatus.subResourceTypesresourceStatus.subResourceStatusesmanifestmanifest.scopes or manifest.intentsisBuiltinisolatedUrideactivationReasonsThe filter parameter, as explained here.
Filtering is supported on the following fields:
idresourceStatus.subResourceTypesmanifest.description or manifest.version Examples:id = 'my.custom-app'id contains 'custom'id starts-with 'my.'not(id starts-with 'my.')id in ('my.custom-app', 'my.other-custom-app')resourceStatus.subResourceTypes contains 'DOCUMENTS'resourceStatus.subResourceTypes contains 'DOCUMENTS' or resourceStatus.subResourceTypes contains 'FUNCTIONS'not (id starts-with 'dynatrace.classic.') (to exclude classic apps)not (manifest.document-types is-empty)manifest.document-types contains 'Notebook' (to filter the json content of the top-level manifest field document-types for apps that provide the Notebook document type)If this parameter is omitted, all apps will be returned.
The maximum nesting depth (via parentheses) is 3. The maximum expression length is 256 characters.
Fields that are used for filtering are always included in the response, even if they are not in the default set of fields.
|\n|config.includeAllAppVersions|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If true, all versions of every app are included in the response.
If false, only the current version of every app is included.
This is relevant while an app is being updated. During this time typically two versions of the same app exist, the current version and the latest version with status=PENDING.
true, apps that are DEACTIVATED are included in the response. |\n|config.includeNonRunnable|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If true, apps that the user is not allowed to run because of missing permissions are included in the response. |\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[AppInfoList](#appinfolist)|200|OK|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client side error. | Server side error.|\n\n\nA whitespace separated list of search terms. For an action to match, each search term must be contained in either: app name, app description, action name or action description.
Search terms are case insensitive and each additional search term restricts actions further. Maximum length is 256 characters.
|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[SearchAppActionList](#searchappactionlist)|200|OK|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client side error. | Server side error.|\n\n\nDEACTIVATED |\n|description*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The description of the app |\n|id*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The id of the app |\n|isBuiltin|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Whether this is a built-in app or not. Built-in apps are provided by Dynatrace and installed on every environment.
|\n|isolatedUri|AppIsolatedUri|Representation of an app's isolated uri. |\n|manifest|AppInfoManifest|The manifest of the app |\n|modificationInfo*required|ModificationInfo|Modification information about the app |\n|name*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the app |\n|resourceContext|ResourceContext|Additional resource context information |\n|resourceStatus*required|ResourceStatus|The status of the app plus additional details. |\n|signatureInfo*required|AppSignatureInfo|Representation of an app's signature verification. |\n|version*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the app |\n\n### AppInfoList\n\nA list of minimal app representations.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|apps*required|Array<AppInfo>|The list of minimal app representations. |\n\n### AppIsolatedUri\n\nRepresentation of an app's isolated uri.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|baseUrl*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The base URL of an app |\n|url*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The URL of an app |\n|widgetUrl*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The base URL for widgets of an app |\n\n### AppSignatureInfo\n\nRepresentation of an app's signature verification.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|publisher|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The organization name of the app publisher. |\n|signed*required|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|App is signed and its signature has been verified. |\n\n### AppStub\n\nA minimal representation of an installed/updated app.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|id*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Id of the installed/updated app |\n|warnings|Array<Warning>|Contains warning information although the request was successful |\n\n### ConstraintViolation\n\nContains information about a constraint violation caused by invalid input.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|errorCode|\"DependencyVersionIncompatible\" | \"DependencyUnknown\"|An optional error code that contains more detailed error information.
Possible error codes:
DependencyVersionIncompatible: The app's manifest contains a dependency with an incompatible version.DependencyUnknown: The app's manifest contains a dependency that is unknown.DependencyVersionIncompatible. |\n|dependency|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the dependency. This value is present if the error code is DependencyUnknown or DependencyVersionIncompatible. |\n|incompatibleVersion|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version that is incompatible. This value is present if the error code is DependencyVersionIncompatible. |\n\n### Error\n\nContains information for 4xx and 5xx errors.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|code*required|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The HTTP status code |\n|details|ErrorDetails|Contains details for 4xx and 5xx errors. |\n|help|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Additional information related to the error |\n|message*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The error message |\n|retryAfterSeconds|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Seconds to wait until the next retry |\n\n### ErrorDetails\n\nContains details for 4xx and 5xx errors.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|constraintViolations|Array<ConstraintViolation>|A list of constraint violations |\n|errorCode|\"MaxNumberOfInstalledAppsExceeded\"|An optional error code that contains more detailed error information than the HTTP response code alone.
Possible error codes:
MaxNumberOfInstalledAppsExceeded: The app bundle couldn't be uploaded because the max number of apps was exceeded. Learn more: https://dt-url.net/upgrade-licenseOperations that are allowed on the app depending on the user's permissions.
run: user is allowed to run the app.
update: user is allowed to update the app.
uninstall: user is allowed to uninstall the app.
Details about the state when an error occurred. Only present if the app's status is ERROR.
PENDING_INSTALL: The error occurred while installing the app.
PENDING_UPDATE: The error occurred while updating the app.
PENDING_DELETE: The error occurred while deleting the app.
OK: At least one sub resource failed while the app was already running.
The pending operation of the app. Only present if the app's status is PENDING.
INSTALL: The app is currently being installed.
UPDATE: The app is currently being updated.
DELETE: The app is currently being deleted.
The status of the app.
OK: The app is fully installed and running.
PENDING: The app is currently being installed, updated or deleted.
PENDING_DELETION: A new version of the app was successfully installed and this version is scheduled for deletion.
DEACTIVATED: The app is deactivated and cannot be executed.
ERROR: The app failed with an error.
status is FAILED |\n|status*required|\"SCHEDULED\" | \"DEPLOYING\" | \"DEPLOYED\" | \"FAILED\" | \"NO_RESOURCES\"|The deployment status of the app's sub resource:
SCHEDULED: Only the uploaded app bundle is persisted.
DEPLOYING: The app's sub resources are currently being deployed.
DEPLOYED: The app's sub resources were successfully deployed.
FAILED: The deployment of the app's sub resources failed.
NO_RESOURCES: The app bundle does not contain any sub resources of this type
The sub resource type.
FUNCTIONS: app functions.
FILES: static files of an app.
SETTINGS_SCHEMAS: settings schemas of an app.
DOCUMENTS: documents, e.g. templates, that are part of an app bundle.