workato-platform-cli 1.0.0rc5.dev5__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- workato_platform_cli/__init__.py +135 -0
- workato_platform_cli/_version.py +34 -0
- workato_platform_cli/cli/__init__.py +126 -0
- workato_platform_cli/cli/commands/__init__.py +0 -0
- workato_platform_cli/cli/commands/api_clients.py +627 -0
- workato_platform_cli/cli/commands/api_collections.py +497 -0
- workato_platform_cli/cli/commands/assets.py +82 -0
- workato_platform_cli/cli/commands/connections.py +1205 -0
- workato_platform_cli/cli/commands/connectors/__init__.py +0 -0
- workato_platform_cli/cli/commands/connectors/command.py +178 -0
- workato_platform_cli/cli/commands/connectors/connector_manager.py +351 -0
- workato_platform_cli/cli/commands/data_tables.py +345 -0
- workato_platform_cli/cli/commands/guide.py +315 -0
- workato_platform_cli/cli/commands/init.py +229 -0
- workato_platform_cli/cli/commands/profiles.py +364 -0
- workato_platform_cli/cli/commands/projects/__init__.py +0 -0
- workato_platform_cli/cli/commands/projects/command.py +513 -0
- workato_platform_cli/cli/commands/projects/project_manager.py +338 -0
- workato_platform_cli/cli/commands/properties.py +174 -0
- workato_platform_cli/cli/commands/pull.py +327 -0
- workato_platform_cli/cli/commands/push/__init__.py +0 -0
- workato_platform_cli/cli/commands/push/command.py +320 -0
- workato_platform_cli/cli/commands/recipes/__init__.py +0 -0
- workato_platform_cli/cli/commands/recipes/command.py +847 -0
- workato_platform_cli/cli/commands/recipes/validator.py +1740 -0
- workato_platform_cli/cli/commands/workspace.py +73 -0
- workato_platform_cli/cli/containers.py +80 -0
- workato_platform_cli/cli/resources/data/connection-data.json +7364 -0
- workato_platform_cli/cli/resources/data/picklist-data.json +3706 -0
- workato_platform_cli/cli/resources/docs/README.md +178 -0
- workato_platform_cli/cli/resources/docs/actions.md +452 -0
- workato_platform_cli/cli/resources/docs/block-structure.md +424 -0
- workato_platform_cli/cli/resources/docs/connections-parameters.md +11946 -0
- workato_platform_cli/cli/resources/docs/data-mapping.md +779 -0
- workato_platform_cli/cli/resources/docs/formulas/array-list-formulas.md +1276 -0
- workato_platform_cli/cli/resources/docs/formulas/conditions.md +102 -0
- workato_platform_cli/cli/resources/docs/formulas/date-formulas.md +798 -0
- workato_platform_cli/cli/resources/docs/formulas/number-formulas.md +507 -0
- workato_platform_cli/cli/resources/docs/formulas/other-formulas.md +419 -0
- workato_platform_cli/cli/resources/docs/formulas/string-formulas.md +1353 -0
- workato_platform_cli/cli/resources/docs/formulas.md +214 -0
- workato_platform_cli/cli/resources/docs/naming-conventions.md +163 -0
- workato_platform_cli/cli/resources/docs/recipe-deployment-workflow.md +352 -0
- workato_platform_cli/cli/resources/docs/recipe-fundamentals.md +179 -0
- workato_platform_cli/cli/resources/docs/triggers.md +360 -0
- workato_platform_cli/cli/utils/__init__.py +10 -0
- workato_platform_cli/cli/utils/config/__init__.py +33 -0
- workato_platform_cli/cli/utils/config/manager.py +1001 -0
- workato_platform_cli/cli/utils/config/models.py +89 -0
- workato_platform_cli/cli/utils/config/profiles.py +491 -0
- workato_platform_cli/cli/utils/config/workspace.py +113 -0
- workato_platform_cli/cli/utils/exception_handler.py +531 -0
- workato_platform_cli/cli/utils/gitignore.py +32 -0
- workato_platform_cli/cli/utils/ignore_patterns.py +44 -0
- workato_platform_cli/cli/utils/spinner.py +63 -0
- workato_platform_cli/cli/utils/version_checker.py +237 -0
- workato_platform_cli/client/__init__.py +0 -0
- workato_platform_cli/client/workato_api/__init__.py +202 -0
- workato_platform_cli/client/workato_api/api/__init__.py +15 -0
- workato_platform_cli/client/workato_api/api/api_platform_api.py +2875 -0
- workato_platform_cli/client/workato_api/api/connections_api.py +1807 -0
- workato_platform_cli/client/workato_api/api/connectors_api.py +840 -0
- workato_platform_cli/client/workato_api/api/data_tables_api.py +604 -0
- workato_platform_cli/client/workato_api/api/export_api.py +621 -0
- workato_platform_cli/client/workato_api/api/folders_api.py +621 -0
- workato_platform_cli/client/workato_api/api/packages_api.py +1197 -0
- workato_platform_cli/client/workato_api/api/projects_api.py +590 -0
- workato_platform_cli/client/workato_api/api/properties_api.py +620 -0
- workato_platform_cli/client/workato_api/api/recipes_api.py +1379 -0
- workato_platform_cli/client/workato_api/api/users_api.py +285 -0
- workato_platform_cli/client/workato_api/api_client.py +807 -0
- workato_platform_cli/client/workato_api/api_response.py +21 -0
- workato_platform_cli/client/workato_api/configuration.py +601 -0
- workato_platform_cli/client/workato_api/docs/APIPlatformApi.md +844 -0
- workato_platform_cli/client/workato_api/docs/ApiClient.md +46 -0
- workato_platform_cli/client/workato_api/docs/ApiClientApiCollectionsInner.md +30 -0
- workato_platform_cli/client/workato_api/docs/ApiClientApiPoliciesInner.md +30 -0
- workato_platform_cli/client/workato_api/docs/ApiClientCreateRequest.md +46 -0
- workato_platform_cli/client/workato_api/docs/ApiClientListResponse.md +32 -0
- workato_platform_cli/client/workato_api/docs/ApiClientResponse.md +29 -0
- workato_platform_cli/client/workato_api/docs/ApiCollection.md +38 -0
- workato_platform_cli/client/workato_api/docs/ApiCollectionCreateRequest.md +32 -0
- workato_platform_cli/client/workato_api/docs/ApiEndpoint.md +41 -0
- workato_platform_cli/client/workato_api/docs/ApiKey.md +36 -0
- workato_platform_cli/client/workato_api/docs/ApiKeyCreateRequest.md +32 -0
- workato_platform_cli/client/workato_api/docs/ApiKeyListResponse.md +32 -0
- workato_platform_cli/client/workato_api/docs/ApiKeyResponse.md +29 -0
- workato_platform_cli/client/workato_api/docs/Asset.md +39 -0
- workato_platform_cli/client/workato_api/docs/AssetReference.md +37 -0
- workato_platform_cli/client/workato_api/docs/Connection.md +44 -0
- workato_platform_cli/client/workato_api/docs/ConnectionCreateRequest.md +35 -0
- workato_platform_cli/client/workato_api/docs/ConnectionUpdateRequest.md +34 -0
- workato_platform_cli/client/workato_api/docs/ConnectionsApi.md +526 -0
- workato_platform_cli/client/workato_api/docs/ConnectorAction.md +33 -0
- workato_platform_cli/client/workato_api/docs/ConnectorVersion.md +32 -0
- workato_platform_cli/client/workato_api/docs/ConnectorsApi.md +249 -0
- workato_platform_cli/client/workato_api/docs/CreateExportManifestRequest.md +29 -0
- workato_platform_cli/client/workato_api/docs/CreateFolderRequest.md +30 -0
- workato_platform_cli/client/workato_api/docs/CustomConnector.md +35 -0
- workato_platform_cli/client/workato_api/docs/CustomConnectorCodeResponse.md +29 -0
- workato_platform_cli/client/workato_api/docs/CustomConnectorCodeResponseData.md +29 -0
- workato_platform_cli/client/workato_api/docs/CustomConnectorListResponse.md +29 -0
- workato_platform_cli/client/workato_api/docs/DataTable.md +34 -0
- workato_platform_cli/client/workato_api/docs/DataTableColumn.md +37 -0
- workato_platform_cli/client/workato_api/docs/DataTableColumnRequest.md +37 -0
- workato_platform_cli/client/workato_api/docs/DataTableCreateRequest.md +31 -0
- workato_platform_cli/client/workato_api/docs/DataTableCreateResponse.md +29 -0
- workato_platform_cli/client/workato_api/docs/DataTableListResponse.md +29 -0
- workato_platform_cli/client/workato_api/docs/DataTableRelation.md +30 -0
- workato_platform_cli/client/workato_api/docs/DataTablesApi.md +172 -0
- workato_platform_cli/client/workato_api/docs/DeleteProject403Response.md +29 -0
- workato_platform_cli/client/workato_api/docs/Error.md +29 -0
- workato_platform_cli/client/workato_api/docs/ExportApi.md +175 -0
- workato_platform_cli/client/workato_api/docs/ExportManifestRequest.md +35 -0
- workato_platform_cli/client/workato_api/docs/ExportManifestResponse.md +29 -0
- workato_platform_cli/client/workato_api/docs/ExportManifestResponseResult.md +36 -0
- workato_platform_cli/client/workato_api/docs/Folder.md +35 -0
- workato_platform_cli/client/workato_api/docs/FolderAssetsResponse.md +29 -0
- workato_platform_cli/client/workato_api/docs/FolderAssetsResponseResult.md +29 -0
- workato_platform_cli/client/workato_api/docs/FolderCreationResponse.md +35 -0
- workato_platform_cli/client/workato_api/docs/FoldersApi.md +176 -0
- workato_platform_cli/client/workato_api/docs/ImportResults.md +32 -0
- workato_platform_cli/client/workato_api/docs/OAuthUrlResponse.md +29 -0
- workato_platform_cli/client/workato_api/docs/OAuthUrlResponseData.md +29 -0
- workato_platform_cli/client/workato_api/docs/OpenApiSpec.md +30 -0
- workato_platform_cli/client/workato_api/docs/PackageDetailsResponse.md +35 -0
- workato_platform_cli/client/workato_api/docs/PackageDetailsResponseRecipeStatusInner.md +30 -0
- workato_platform_cli/client/workato_api/docs/PackageResponse.md +33 -0
- workato_platform_cli/client/workato_api/docs/PackagesApi.md +364 -0
- workato_platform_cli/client/workato_api/docs/PicklistRequest.md +30 -0
- workato_platform_cli/client/workato_api/docs/PicklistResponse.md +29 -0
- workato_platform_cli/client/workato_api/docs/PlatformConnector.md +36 -0
- workato_platform_cli/client/workato_api/docs/PlatformConnectorListResponse.md +32 -0
- workato_platform_cli/client/workato_api/docs/Project.md +32 -0
- workato_platform_cli/client/workato_api/docs/ProjectsApi.md +173 -0
- workato_platform_cli/client/workato_api/docs/PropertiesApi.md +186 -0
- workato_platform_cli/client/workato_api/docs/Recipe.md +58 -0
- workato_platform_cli/client/workato_api/docs/RecipeConfigInner.md +33 -0
- workato_platform_cli/client/workato_api/docs/RecipeConnectionUpdateRequest.md +30 -0
- workato_platform_cli/client/workato_api/docs/RecipeListResponse.md +29 -0
- workato_platform_cli/client/workato_api/docs/RecipeStartResponse.md +31 -0
- workato_platform_cli/client/workato_api/docs/RecipesApi.md +367 -0
- workato_platform_cli/client/workato_api/docs/RuntimeUserConnectionCreateRequest.md +34 -0
- workato_platform_cli/client/workato_api/docs/RuntimeUserConnectionResponse.md +29 -0
- workato_platform_cli/client/workato_api/docs/RuntimeUserConnectionResponseData.md +30 -0
- workato_platform_cli/client/workato_api/docs/SuccessResponse.md +29 -0
- workato_platform_cli/client/workato_api/docs/UpsertProjectPropertiesRequest.md +29 -0
- workato_platform_cli/client/workato_api/docs/User.md +48 -0
- workato_platform_cli/client/workato_api/docs/UsersApi.md +84 -0
- workato_platform_cli/client/workato_api/docs/ValidationError.md +30 -0
- workato_platform_cli/client/workato_api/docs/ValidationErrorErrorsValue.md +28 -0
- workato_platform_cli/client/workato_api/exceptions.py +216 -0
- workato_platform_cli/client/workato_api/models/__init__.py +83 -0
- workato_platform_cli/client/workato_api/models/api_client.py +185 -0
- workato_platform_cli/client/workato_api/models/api_client_api_collections_inner.py +89 -0
- workato_platform_cli/client/workato_api/models/api_client_api_policies_inner.py +89 -0
- workato_platform_cli/client/workato_api/models/api_client_create_request.py +138 -0
- workato_platform_cli/client/workato_api/models/api_client_list_response.py +101 -0
- workato_platform_cli/client/workato_api/models/api_client_response.py +91 -0
- workato_platform_cli/client/workato_api/models/api_collection.py +110 -0
- workato_platform_cli/client/workato_api/models/api_collection_create_request.py +97 -0
- workato_platform_cli/client/workato_api/models/api_endpoint.py +117 -0
- workato_platform_cli/client/workato_api/models/api_key.py +102 -0
- workato_platform_cli/client/workato_api/models/api_key_create_request.py +93 -0
- workato_platform_cli/client/workato_api/models/api_key_list_response.py +101 -0
- workato_platform_cli/client/workato_api/models/api_key_response.py +91 -0
- workato_platform_cli/client/workato_api/models/asset.py +124 -0
- workato_platform_cli/client/workato_api/models/asset_reference.py +110 -0
- workato_platform_cli/client/workato_api/models/connection.py +173 -0
- workato_platform_cli/client/workato_api/models/connection_create_request.py +99 -0
- workato_platform_cli/client/workato_api/models/connection_update_request.py +97 -0
- workato_platform_cli/client/workato_api/models/connector_action.py +100 -0
- workato_platform_cli/client/workato_api/models/connector_version.py +99 -0
- workato_platform_cli/client/workato_api/models/create_export_manifest_request.py +91 -0
- workato_platform_cli/client/workato_api/models/create_folder_request.py +89 -0
- workato_platform_cli/client/workato_api/models/custom_connector.py +117 -0
- workato_platform_cli/client/workato_api/models/custom_connector_code_response.py +91 -0
- workato_platform_cli/client/workato_api/models/custom_connector_code_response_data.py +87 -0
- workato_platform_cli/client/workato_api/models/custom_connector_list_response.py +95 -0
- workato_platform_cli/client/workato_api/models/data_table.py +107 -0
- workato_platform_cli/client/workato_api/models/data_table_column.py +125 -0
- workato_platform_cli/client/workato_api/models/data_table_column_request.py +130 -0
- workato_platform_cli/client/workato_api/models/data_table_create_request.py +99 -0
- workato_platform_cli/client/workato_api/models/data_table_create_response.py +91 -0
- workato_platform_cli/client/workato_api/models/data_table_list_response.py +95 -0
- workato_platform_cli/client/workato_api/models/data_table_relation.py +90 -0
- workato_platform_cli/client/workato_api/models/delete_project403_response.py +87 -0
- workato_platform_cli/client/workato_api/models/error.py +87 -0
- workato_platform_cli/client/workato_api/models/export_manifest_request.py +107 -0
- workato_platform_cli/client/workato_api/models/export_manifest_response.py +91 -0
- workato_platform_cli/client/workato_api/models/export_manifest_response_result.py +112 -0
- workato_platform_cli/client/workato_api/models/folder.py +110 -0
- workato_platform_cli/client/workato_api/models/folder_assets_response.py +91 -0
- workato_platform_cli/client/workato_api/models/folder_assets_response_result.py +95 -0
- workato_platform_cli/client/workato_api/models/folder_creation_response.py +110 -0
- workato_platform_cli/client/workato_api/models/import_results.py +93 -0
- workato_platform_cli/client/workato_api/models/o_auth_url_response.py +91 -0
- workato_platform_cli/client/workato_api/models/o_auth_url_response_data.py +87 -0
- workato_platform_cli/client/workato_api/models/open_api_spec.py +96 -0
- workato_platform_cli/client/workato_api/models/package_details_response.py +126 -0
- workato_platform_cli/client/workato_api/models/package_details_response_recipe_status_inner.py +99 -0
- workato_platform_cli/client/workato_api/models/package_response.py +109 -0
- workato_platform_cli/client/workato_api/models/picklist_request.py +89 -0
- workato_platform_cli/client/workato_api/models/picklist_response.py +88 -0
- workato_platform_cli/client/workato_api/models/platform_connector.py +116 -0
- workato_platform_cli/client/workato_api/models/platform_connector_list_response.py +101 -0
- workato_platform_cli/client/workato_api/models/project.py +93 -0
- workato_platform_cli/client/workato_api/models/recipe.py +174 -0
- workato_platform_cli/client/workato_api/models/recipe_config_inner.py +100 -0
- workato_platform_cli/client/workato_api/models/recipe_connection_update_request.py +89 -0
- workato_platform_cli/client/workato_api/models/recipe_list_response.py +95 -0
- workato_platform_cli/client/workato_api/models/recipe_start_response.py +91 -0
- workato_platform_cli/client/workato_api/models/runtime_user_connection_create_request.py +97 -0
- workato_platform_cli/client/workato_api/models/runtime_user_connection_response.py +91 -0
- workato_platform_cli/client/workato_api/models/runtime_user_connection_response_data.py +89 -0
- workato_platform_cli/client/workato_api/models/success_response.py +87 -0
- workato_platform_cli/client/workato_api/models/upsert_project_properties_request.py +88 -0
- workato_platform_cli/client/workato_api/models/user.py +151 -0
- workato_platform_cli/client/workato_api/models/validation_error.py +102 -0
- workato_platform_cli/client/workato_api/models/validation_error_errors_value.py +143 -0
- workato_platform_cli/client/workato_api/rest.py +213 -0
- workato_platform_cli/client/workato_api/test/__init__.py +0 -0
- workato_platform_cli/client/workato_api/test/test_api_client.py +94 -0
- workato_platform_cli/client/workato_api/test/test_api_client_api_collections_inner.py +52 -0
- workato_platform_cli/client/workato_api/test/test_api_client_api_policies_inner.py +52 -0
- workato_platform_cli/client/workato_api/test/test_api_client_create_request.py +75 -0
- workato_platform_cli/client/workato_api/test/test_api_client_list_response.py +114 -0
- workato_platform_cli/client/workato_api/test/test_api_client_response.py +104 -0
- workato_platform_cli/client/workato_api/test/test_api_collection.py +72 -0
- workato_platform_cli/client/workato_api/test/test_api_collection_create_request.py +57 -0
- workato_platform_cli/client/workato_api/test/test_api_endpoint.py +75 -0
- workato_platform_cli/client/workato_api/test/test_api_key.py +64 -0
- workato_platform_cli/client/workato_api/test/test_api_key_create_request.py +56 -0
- workato_platform_cli/client/workato_api/test/test_api_key_list_response.py +78 -0
- workato_platform_cli/client/workato_api/test/test_api_key_response.py +68 -0
- workato_platform_cli/client/workato_api/test/test_api_platform_api.py +101 -0
- workato_platform_cli/client/workato_api/test/test_asset.py +67 -0
- workato_platform_cli/client/workato_api/test/test_asset_reference.py +62 -0
- workato_platform_cli/client/workato_api/test/test_connection.py +81 -0
- workato_platform_cli/client/workato_api/test/test_connection_create_request.py +59 -0
- workato_platform_cli/client/workato_api/test/test_connection_update_request.py +56 -0
- workato_platform_cli/client/workato_api/test/test_connections_api.py +73 -0
- workato_platform_cli/client/workato_api/test/test_connector_action.py +59 -0
- workato_platform_cli/client/workato_api/test/test_connector_version.py +58 -0
- workato_platform_cli/client/workato_api/test/test_connectors_api.py +52 -0
- workato_platform_cli/client/workato_api/test/test_create_export_manifest_request.py +88 -0
- workato_platform_cli/client/workato_api/test/test_create_folder_request.py +53 -0
- workato_platform_cli/client/workato_api/test/test_custom_connector.py +76 -0
- workato_platform_cli/client/workato_api/test/test_custom_connector_code_response.py +54 -0
- workato_platform_cli/client/workato_api/test/test_custom_connector_code_response_data.py +52 -0
- workato_platform_cli/client/workato_api/test/test_custom_connector_list_response.py +82 -0
- workato_platform_cli/client/workato_api/test/test_data_table.py +88 -0
- workato_platform_cli/client/workato_api/test/test_data_table_column.py +72 -0
- workato_platform_cli/client/workato_api/test/test_data_table_column_request.py +64 -0
- workato_platform_cli/client/workato_api/test/test_data_table_create_request.py +82 -0
- workato_platform_cli/client/workato_api/test/test_data_table_create_response.py +90 -0
- workato_platform_cli/client/workato_api/test/test_data_table_list_response.py +94 -0
- workato_platform_cli/client/workato_api/test/test_data_table_relation.py +54 -0
- workato_platform_cli/client/workato_api/test/test_data_tables_api.py +45 -0
- workato_platform_cli/client/workato_api/test/test_delete_project403_response.py +51 -0
- workato_platform_cli/client/workato_api/test/test_error.py +52 -0
- workato_platform_cli/client/workato_api/test/test_export_api.py +45 -0
- workato_platform_cli/client/workato_api/test/test_export_manifest_request.py +69 -0
- workato_platform_cli/client/workato_api/test/test_export_manifest_response.py +68 -0
- workato_platform_cli/client/workato_api/test/test_export_manifest_response_result.py +66 -0
- workato_platform_cli/client/workato_api/test/test_folder.py +64 -0
- workato_platform_cli/client/workato_api/test/test_folder_assets_response.py +80 -0
- workato_platform_cli/client/workato_api/test/test_folder_assets_response_result.py +78 -0
- workato_platform_cli/client/workato_api/test/test_folder_creation_response.py +64 -0
- workato_platform_cli/client/workato_api/test/test_folders_api.py +45 -0
- workato_platform_cli/client/workato_api/test/test_import_results.py +58 -0
- workato_platform_cli/client/workato_api/test/test_o_auth_url_response.py +54 -0
- workato_platform_cli/client/workato_api/test/test_o_auth_url_response_data.py +52 -0
- workato_platform_cli/client/workato_api/test/test_open_api_spec.py +54 -0
- workato_platform_cli/client/workato_api/test/test_package_details_response.py +64 -0
- workato_platform_cli/client/workato_api/test/test_package_details_response_recipe_status_inner.py +52 -0
- workato_platform_cli/client/workato_api/test/test_package_response.py +58 -0
- workato_platform_cli/client/workato_api/test/test_packages_api.py +59 -0
- workato_platform_cli/client/workato_api/test/test_picklist_request.py +53 -0
- workato_platform_cli/client/workato_api/test/test_picklist_response.py +52 -0
- workato_platform_cli/client/workato_api/test/test_platform_connector.py +94 -0
- workato_platform_cli/client/workato_api/test/test_platform_connector_list_response.py +106 -0
- workato_platform_cli/client/workato_api/test/test_project.py +57 -0
- workato_platform_cli/client/workato_api/test/test_projects_api.py +45 -0
- workato_platform_cli/client/workato_api/test/test_properties_api.py +45 -0
- workato_platform_cli/client/workato_api/test/test_recipe.py +124 -0
- workato_platform_cli/client/workato_api/test/test_recipe_config_inner.py +55 -0
- workato_platform_cli/client/workato_api/test/test_recipe_connection_update_request.py +54 -0
- workato_platform_cli/client/workato_api/test/test_recipe_list_response.py +134 -0
- workato_platform_cli/client/workato_api/test/test_recipe_start_response.py +54 -0
- workato_platform_cli/client/workato_api/test/test_recipes_api.py +59 -0
- workato_platform_cli/client/workato_api/test/test_runtime_user_connection_create_request.py +59 -0
- workato_platform_cli/client/workato_api/test/test_runtime_user_connection_response.py +56 -0
- workato_platform_cli/client/workato_api/test/test_runtime_user_connection_response_data.py +54 -0
- workato_platform_cli/client/workato_api/test/test_success_response.py +52 -0
- workato_platform_cli/client/workato_api/test/test_upsert_project_properties_request.py +52 -0
- workato_platform_cli/client/workato_api/test/test_user.py +85 -0
- workato_platform_cli/client/workato_api/test/test_users_api.py +38 -0
- workato_platform_cli/client/workato_api/test/test_validation_error.py +52 -0
- workato_platform_cli/client/workato_api/test/test_validation_error_errors_value.py +50 -0
- workato_platform_cli/client/workato_api_README.md +205 -0
- workato_platform_cli-1.0.0rc5.dev5.dist-info/METADATA +185 -0
- workato_platform_cli-1.0.0rc5.dev5.dist-info/RECORD +306 -0
- workato_platform_cli-1.0.0rc5.dev5.dist-info/WHEEL +4 -0
- workato_platform_cli-1.0.0rc5.dev5.dist-info/entry_points.txt +2 -0
- workato_platform_cli-1.0.0rc5.dev5.dist-info/licenses/LICENSE +7 -0
|
@@ -0,0 +1,798 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Date formulas
|
|
3
|
+
date: 2017-03-30 05:00:00 Z
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Date formulas
|
|
7
|
+
|
|
8
|
+
::: details Video guide: Learn how to transform dates with formula mode
|
|
9
|
+
<Video src="https://www.youtube.com/embed/Saq5ybJauVM"/>
|
|
10
|
+
:::
|
|
11
|
+
|
|
12
|
+
Workato supports a variety of date and datetime formulas.
|
|
13
|
+
|
|
14
|
+
Formulas in Workato are allowlisted Ruby methods. Syntax and functionality for these formulas are generally unchanged. Most formulas return an error and stop the job if the formula operates on nulls (expressed as `nil` in Ruby), except for `present?`, `presence`, and `blank?`.
|
|
15
|
+
|
|
16
|
+
You can refer to the Ruby documentation on [time](http://ruby-doc.org/core-2.3.3/Time.html) for more information. However, only allowlisted Ruby methods are supported. To request the addition of new formulas to the allowlist, [submit a support ticket](https://support.workato.com/en/support/tickets/new).
|
|
17
|
+
|
|
18
|
+
## Date arithmetic
|
|
19
|
+
|
|
20
|
+
Use the following keywords to perform arithmetic with date and datetime data:
|
|
21
|
+
|
|
22
|
+
- `seconds`
|
|
23
|
+
- `minutes`
|
|
24
|
+
- `days`
|
|
25
|
+
- `months`
|
|
26
|
+
- `years`
|
|
27
|
+
|
|
28
|
+
When combined with a formula, you can perform addition and subtraction.
|
|
29
|
+
|
|
30
|
+
### Sample usage
|
|
31
|
+
|
|
32
|
+
| Date Arithmetic | Output |
|
|
33
|
+
| ------------------------------------------ | ------------ |
|
|
34
|
+
| <kbd>"2020-01-01"</kbd>.to_date + 2.days | "2020-01-03" |
|
|
35
|
+
| <kbd>"2020-01-01"</kbd>.to_date - 2.days | "2019-12-30" |
|
|
36
|
+
| <kbd>"2020-01-01"</kbd>.to_date + 2.months | "2020-03-01" |
|
|
37
|
+
| <kbd>"2020-01-01"</kbd>.to_date - 2.months | "2019-11-01" |
|
|
38
|
+
| <kbd>"2020-01-01"</kbd>.to_date + 2.years | "2022-01-01" |
|
|
39
|
+
| <kbd>"2020-01-01"</kbd>.to_date - 2.years | "2018-01-01" |
|
|
40
|
+
|
|
41
|
+
---
|
|
42
|
+
|
|
43
|
+
## `now`
|
|
44
|
+
|
|
45
|
+
Returns the time and date at runtime in US Pacific Time Zone (PST).
|
|
46
|
+
|
|
47
|
+
### Sample usage
|
|
48
|
+
|
|
49
|
+
| Formula | Result |
|
|
50
|
+
| ------------- | ---------------------------------- |
|
|
51
|
+
| now | "2022-02-01T07:00:00.000000-08:00" |
|
|
52
|
+
| now + 8.hours | "2022-02-01T15:00:00.000000-08:00" |
|
|
53
|
+
| now + 2.days | "2022-02-03T07:00:00.000000-08:00" |
|
|
54
|
+
|
|
55
|
+
### How it works
|
|
56
|
+
|
|
57
|
+
The formula calculates the timestamp when the job is processed. Each step using this formula returns the timestamp at which the step runs.
|
|
58
|
+
|
|
59
|
+
::: tip Output datapill
|
|
60
|
+
If you only want the date without the time, try using the <u>[today](/formulas/date-formulas.md#today)</u> formula instead.
|
|
61
|
+
:::
|
|
62
|
+
|
|
63
|
+
### See also
|
|
64
|
+
|
|
65
|
+
- [today](/formulas/date-formulas.md#today): Returns the date at runtime.
|
|
66
|
+
- [in_time_zone](/formulas/date-formulas.md#in-time-zone): Converts a time value to a different time zone.
|
|
67
|
+
|
|
68
|
+
---
|
|
69
|
+
|
|
70
|
+
## `today`
|
|
71
|
+
|
|
72
|
+
Returns the date at runtime in US Pacific Time Zone.
|
|
73
|
+
|
|
74
|
+
### Sample usage
|
|
75
|
+
|
|
76
|
+
| Formula | Result |
|
|
77
|
+
| --------------- | ----------------------------------- |
|
|
78
|
+
| today | "2022-02-01" |
|
|
79
|
+
| today + 8.hours | "2022-02-01T15:00:00.000000-08:00" |
|
|
80
|
+
| today + 2.days | "2022-02-03" |
|
|
81
|
+
|
|
82
|
+
### How it works
|
|
83
|
+
|
|
84
|
+
The formula calculates the timestamp when the job is processed. Each step using this formula returns the date at which the step runs.
|
|
85
|
+
|
|
86
|
+
::: tip Output datapill
|
|
87
|
+
If you want the date and time, try using the <u>[now](/formulas/date-formulas.md#now)</u> formula instead.
|
|
88
|
+
:::
|
|
89
|
+
|
|
90
|
+
### See also
|
|
91
|
+
|
|
92
|
+
- [now](/formulas/date-formulas.md#now): Returns the time and date at runtime.
|
|
93
|
+
- [in_time_zone](/formulas/date-formulas.md#in-time-zone): Converts a time value to a different time zone.
|
|
94
|
+
|
|
95
|
+
---
|
|
96
|
+
|
|
97
|
+
## `from_now`
|
|
98
|
+
|
|
99
|
+
Returns a future timestamp by a specified time duration. The timestamp is calculated at runtime.
|
|
100
|
+
|
|
101
|
+
### Syntax
|
|
102
|
+
|
|
103
|
+
<kbd>Unit</kbd>.from_now
|
|
104
|
+
|
|
105
|
+
- <kbd>Unit</kbd> - A time value to offset.
|
|
106
|
+
|
|
107
|
+
### Sample usage
|
|
108
|
+
|
|
109
|
+
| Formula | Result |
|
|
110
|
+
| ------------------------------ | ----------------------------------- |
|
|
111
|
+
| <kbd>30.seconds</kbd>.from_now | "2022-02-01T07:00:30.000000-08:00" |
|
|
112
|
+
| <kbd>2.months</kbd>.from_now | "2022-04-01T07:00:00.000000-08:00" |
|
|
113
|
+
| <kbd>3.days</kbd>.from_now | "2022-02-04T07:00:00.000000-08:00" |
|
|
114
|
+
|
|
115
|
+
### How it works
|
|
116
|
+
|
|
117
|
+
The formula calculates the current timestamp and offsets by a specified time duration. This timestamp is calculated when the job is processed. Each step using this formula returns a timestamp.
|
|
118
|
+
|
|
119
|
+
::: tip UNITS
|
|
120
|
+
You can use any of the following units: `seconds`, `minutes`, `hours`, `days`, `months`, or `years`.
|
|
121
|
+
:::
|
|
122
|
+
|
|
123
|
+
### See also
|
|
124
|
+
|
|
125
|
+
- [ago](/formulas/date-formulas.md#ago): Returns an earlier timestamp by a specified time duration.
|
|
126
|
+
- [now](/formulas/date-formulas.md#now): Returns the time and date at runtime.
|
|
127
|
+
- [today](/formulas/date-formulas.md#today): Returns the date at runtime.
|
|
128
|
+
|
|
129
|
+
---
|
|
130
|
+
|
|
131
|
+
## `ago`
|
|
132
|
+
|
|
133
|
+
Returns an earlier timestamp by a specified time duration. The timestamp is calculated at runtime.
|
|
134
|
+
|
|
135
|
+
### Syntax
|
|
136
|
+
|
|
137
|
+
<kbd>Unit</kbd>.ago
|
|
138
|
+
|
|
139
|
+
- <kbd>Unit</kbd> - A time value to offset.
|
|
140
|
+
|
|
141
|
+
### Sample usage
|
|
142
|
+
|
|
143
|
+
| Formula | Result |
|
|
144
|
+
| --------------- | --------------------------- |
|
|
145
|
+
| <kbd>2.months</kbd>.ago | "2020-10-04 14:45:29 -0700" |
|
|
146
|
+
| <kbd>3.days</kbd>.ago | "2020-12-01 14:45:29 -0700" |
|
|
147
|
+
| <kbd>30.seconds</kbd>.ago | "2020-12-04 14:15:29 -0700" |
|
|
148
|
+
|
|
149
|
+
### How it works
|
|
150
|
+
|
|
151
|
+
The formula calculates the current timestamp and offsets by a specified time duration. This timestamp is calculated when the job is processed. Each step using this formula returns a timestamp for each step that runs.
|
|
152
|
+
|
|
153
|
+
::: tip Units
|
|
154
|
+
You can use any of the following units: `seconds`, `minutes`, `hours`, `days`, `months`, or `years`.
|
|
155
|
+
:::
|
|
156
|
+
|
|
157
|
+
### See also
|
|
158
|
+
|
|
159
|
+
- [from_now](/formulas/date-formulas.md#from-now): Returns a future timestamp by a specified time duration.
|
|
160
|
+
- [now](/formulas/date-formulas.md#now): Returns the time and date at runtime.
|
|
161
|
+
- [today](/formulas/date-formulas.md#today): Returns the date at runtime.
|
|
162
|
+
|
|
163
|
+
---
|
|
164
|
+
|
|
165
|
+
## `wday`
|
|
166
|
+
|
|
167
|
+
Returns day of the week. Sunday returns 0, Monday returns 1.
|
|
168
|
+
|
|
169
|
+
### Syntax
|
|
170
|
+
|
|
171
|
+
<kbd>Date</kbd>.wday
|
|
172
|
+
|
|
173
|
+
- <kbd>Date</kbd> - A date or datetime datatype.
|
|
174
|
+
|
|
175
|
+
### Sample usage
|
|
176
|
+
|
|
177
|
+
| Example | Result |
|
|
178
|
+
| -------------------------------------------------------- | ------ |
|
|
179
|
+
| today.wday | 4 |
|
|
180
|
+
| <kbd>"01/12/2020"</kbd>.to_date(format:"DD/MM/YYYY").wday | 2 |
|
|
181
|
+
|
|
182
|
+
### How it works
|
|
183
|
+
|
|
184
|
+
The formula calculates the current day when the job is processed. The day of the week is converted into an integer output. Sunday = 0, Monday = 1.
|
|
185
|
+
|
|
186
|
+
::: tip Quicktip: Convert to date datatype
|
|
187
|
+
This formula only works with date or datetime datatype. Use [to_date](/formulas/date-formulas.md#to-date) to convert a string into a date datatype.
|
|
188
|
+
:::
|
|
189
|
+
|
|
190
|
+
### See also
|
|
191
|
+
|
|
192
|
+
- [yday](/formulas/date-formulas.md#yday): Returns the day number of the year.
|
|
193
|
+
- [yweek](/formulas/date-formulas.md#yweek): Returns the week number of the year.
|
|
194
|
+
|
|
195
|
+
---
|
|
196
|
+
|
|
197
|
+
## `yday`
|
|
198
|
+
|
|
199
|
+
Returns day number of the year.
|
|
200
|
+
|
|
201
|
+
### Syntax
|
|
202
|
+
|
|
203
|
+
<kbd>Date</kbd>.yday
|
|
204
|
+
|
|
205
|
+
- <kbd>Date</kbd> - A date or datetime datatype.
|
|
206
|
+
|
|
207
|
+
### Sample usage
|
|
208
|
+
|
|
209
|
+
| Example | Result |
|
|
210
|
+
| --------------------------------------------------------- | ------ |
|
|
211
|
+
| today.yday | 338 |
|
|
212
|
+
| <kbd>"2020-01-01"</kbd>.to_date(format:"YYYY-MM-DD").yday | 1 |
|
|
213
|
+
| <kbd>"2020-02-01"</kbd>.to_date(format:"YYYY-MM-DD").yday | 32 |
|
|
214
|
+
|
|
215
|
+
### How it works
|
|
216
|
+
|
|
217
|
+
The formula calculates the current day when the job is processed. The day of the year is converted to an integer output.
|
|
218
|
+
|
|
219
|
+
::: tip Quicktip: Convert to date datatype
|
|
220
|
+
This formula only works with date or datetime datatype. Use [to_date](/formulas/date-formulas.md#to-date) to convert a string into a date datatype.
|
|
221
|
+
:::
|
|
222
|
+
|
|
223
|
+
### See also
|
|
224
|
+
|
|
225
|
+
- [wday](/formulas/date-formulas.md#wday): Returns the day number of the week.
|
|
226
|
+
- [yweek](/formulas/date-formulas.md#yweek): Returns the week number of the year.
|
|
227
|
+
|
|
228
|
+
---
|
|
229
|
+
|
|
230
|
+
## `yweek`
|
|
231
|
+
|
|
232
|
+
Returns week number of the year.
|
|
233
|
+
|
|
234
|
+
### Syntax
|
|
235
|
+
|
|
236
|
+
<kbd>Date</kbd>.yweek
|
|
237
|
+
|
|
238
|
+
- <kbd>Date</kbd> - A date or datetime datatype.
|
|
239
|
+
|
|
240
|
+
### Sample usage
|
|
241
|
+
|
|
242
|
+
| Example | Result |
|
|
243
|
+
| ---------------------------------------------------------- | ------ |
|
|
244
|
+
| today.yweek | 49 |
|
|
245
|
+
| <kbd>"2020-01-01"</kbd>.to_date(format:"YYYY-MM-DD").yweek | 1 |
|
|
246
|
+
| <kbd>"2020-02-01"</kbd>.to_date(format:"YYYY-MM-DD").yweek | 5 |
|
|
247
|
+
|
|
248
|
+
### How it works
|
|
249
|
+
|
|
250
|
+
The formula calculates the current day when the job is processed. The week of the year is converted to an integer output.
|
|
251
|
+
|
|
252
|
+
::: tip Quicktip: Convert to date datatype
|
|
253
|
+
This formula only works with date or datetime datatype. Use [to_date](/formulas/date-formulas.md#to-date) to convert a string into a date datatype.
|
|
254
|
+
:::
|
|
255
|
+
|
|
256
|
+
### See also
|
|
257
|
+
|
|
258
|
+
- [wday](/formulas/date-formulas.md#wday): Returns the day number of the week.
|
|
259
|
+
- [yday](/formulas/date-formulas.md#yday): Returns the day number of the year.
|
|
260
|
+
|
|
261
|
+
---
|
|
262
|
+
|
|
263
|
+
## `beginning_of_hour`
|
|
264
|
+
|
|
265
|
+
Returns datetime for top-of-the-hour for a given datetime.
|
|
266
|
+
|
|
267
|
+
### Syntax
|
|
268
|
+
|
|
269
|
+
<kbd>Datetime</kbd>.beginning_of_hour
|
|
270
|
+
|
|
271
|
+
- <kbd>Datetime</kbd> - An input datetime.
|
|
272
|
+
|
|
273
|
+
### Sample usage
|
|
274
|
+
|
|
275
|
+
| Formula | Result |
|
|
276
|
+
| --------------------------------------------------------------- | ---------------------------------- |
|
|
277
|
+
| today.to_time.beginning_of_hour | "2020-12-02T16:00:00.000000-07:00" |
|
|
278
|
+
| <kbd>"2020-06-01T01:30:45.000000+00:00"</kbd>.to_time.beginning_of_hour | "2020-06-01T01:00:00.000000+00:00" |
|
|
279
|
+
| <kbd>"2020-06-01"</kbd>.to_time.beginning_of_hour | "2020-06-01T00:00:00.000000+00:00" |
|
|
280
|
+
|
|
281
|
+
---
|
|
282
|
+
|
|
283
|
+
## `beginning_of_day`
|
|
284
|
+
|
|
285
|
+
Returns datetime for midnight on date of a given date/datetime.
|
|
286
|
+
|
|
287
|
+
### Syntax
|
|
288
|
+
|
|
289
|
+
<kbd>Date</kbd>.beginning_of_day
|
|
290
|
+
|
|
291
|
+
- <kbd>Date</kbd> - An input date or datetime.
|
|
292
|
+
|
|
293
|
+
### Sample usage
|
|
294
|
+
|
|
295
|
+
| Formula | Result |
|
|
296
|
+
| -------------------------------------------------------------- | ---------------------------------- |
|
|
297
|
+
| today.beginning_of_day | "2020-12-02T00:00:00.000000-07:00" |
|
|
298
|
+
| <kbd>"2020-06-01"</kbd>.to_date.beginning_of_day | "2020-06-01T00:00:00.000000+00:00" |
|
|
299
|
+
| <kbd>"2020-06-01T01:30:45.000000+00:00"</kbd>.beginning_of_day | "2020-06-01T00:00:00.000000+00:00" |
|
|
300
|
+
|
|
301
|
+
---
|
|
302
|
+
|
|
303
|
+
## `beginning_of_week`
|
|
304
|
+
|
|
305
|
+
Returns date for the start of the week (Monday) for a given date/timestamp.
|
|
306
|
+
|
|
307
|
+
### Syntax
|
|
308
|
+
|
|
309
|
+
<kbd>Date</kbd>.beginning_of_week
|
|
310
|
+
|
|
311
|
+
- <kbd>Date</kbd> - An input date or datetime.
|
|
312
|
+
|
|
313
|
+
### Sample usage
|
|
314
|
+
|
|
315
|
+
| Formula | Result |
|
|
316
|
+
| --------------------------------------------------------------- | ---------------------------------- |
|
|
317
|
+
| today.beginning_of_week | "2020-11-30T00:00:00.000000+00:00" |
|
|
318
|
+
| <kbd>"2020-06-01"</kbd>.to_date.beginning_of_week | "2020-06-01T00:00:00.000000+00:00" |
|
|
319
|
+
| <kbd>"2020-06-01T01:30:45.000000+00:00"</kbd>.beginning_of_week | "2020-06-01T00:00:00.000000+00:00" |
|
|
320
|
+
|
|
321
|
+
---
|
|
322
|
+
|
|
323
|
+
## `beginning_of_month`
|
|
324
|
+
|
|
325
|
+
Returns first day of the month for a given date/datetime.
|
|
326
|
+
|
|
327
|
+
### Syntax
|
|
328
|
+
|
|
329
|
+
<kbd>Date</kbd>.beginning_of_month
|
|
330
|
+
|
|
331
|
+
- <kbd>Date</kbd> - An input date or datetime.
|
|
332
|
+
|
|
333
|
+
### Sample usage
|
|
334
|
+
|
|
335
|
+
| Formula | Result |
|
|
336
|
+
| ---------------------------------------------------------------- | ---------------------------------- |
|
|
337
|
+
| today.beginning_of_month | "2020-12-01T00:00:00.000000+00:00" |
|
|
338
|
+
| <kbd>"2020-06-01"</kbd>.to_date.beginning_of_month | "2020-06-01T00:00:00.000000+00:00" |
|
|
339
|
+
| <kbd>"2020-06-01T01:30:45.000000+00:00"</kbd>.beginning_of_month | "2020-06-01T00:00:00.000000+00:00" |
|
|
340
|
+
|
|
341
|
+
---
|
|
342
|
+
|
|
343
|
+
## `beginning_of_year`
|
|
344
|
+
|
|
345
|
+
Returns first day of the year for a given date/datetime.
|
|
346
|
+
|
|
347
|
+
### Syntax
|
|
348
|
+
|
|
349
|
+
<kbd>Date</kbd>.beginning_of_year
|
|
350
|
+
|
|
351
|
+
- <kbd>Date</kbd> - An input date or datetime.
|
|
352
|
+
|
|
353
|
+
### Sample usage
|
|
354
|
+
|
|
355
|
+
| Formula | Result |
|
|
356
|
+
| --------------------------------------------------------------- | ---------------------------------- |
|
|
357
|
+
| today.beginning_of_year | "2020-01-01T00:00:00.000000+00:00" |
|
|
358
|
+
| <kbd>"2020-06-01"</kbd>.to_date.beginning_of_year | "2020-01-01T00:00:00.000000+00:00" |
|
|
359
|
+
| <kbd>"2020-06-01T01:30:45.000000+00:00"</kbd>.beginning_of_year | "2020-01-01T00:00:00.000000+00:00" |
|
|
360
|
+
|
|
361
|
+
---
|
|
362
|
+
|
|
363
|
+
## `end_of_month`
|
|
364
|
+
|
|
365
|
+
Returns last day of the month for a given date/datetime. This formula will return a date or datetime based on the input data.
|
|
366
|
+
|
|
367
|
+
### Syntax
|
|
368
|
+
|
|
369
|
+
<kbd>Date</kbd>.end_of_month
|
|
370
|
+
|
|
371
|
+
- <kbd>Date</kbd> - An input date or datetime.
|
|
372
|
+
|
|
373
|
+
### Sample usage
|
|
374
|
+
|
|
375
|
+
| Formula | Result |
|
|
376
|
+
| ---------------------------------------------------------------- | ---------------------------------- |
|
|
377
|
+
| today.end_of_month | "2020-12-31" |
|
|
378
|
+
| <kbd>"2020-06-01"</kbd>.to_date.end_of_month | "2020-06-30" |
|
|
379
|
+
| <kbd>"2020-06-01T01:30:45.000000+00:00"</kbd>.to_time.end_of_month | "2020-06-30T23:59:59.999999+00:00" |
|
|
380
|
+
|
|
381
|
+
---
|
|
382
|
+
|
|
383
|
+
## `strftime`
|
|
384
|
+
|
|
385
|
+
Returns a datetime input as a user-defined string.
|
|
386
|
+
|
|
387
|
+
### Syntax
|
|
388
|
+
|
|
389
|
+
<kbd>Date</kbd>.strftime(<span style="color:#FF0000">format</span>)
|
|
390
|
+
|
|
391
|
+
- <kbd>Date</kbd> - An input date or datetime.
|
|
392
|
+
- <span style="color:#FF0000">format</span> - The format of the user-defined datetime written as a string.
|
|
393
|
+
|
|
394
|
+
### Sample usage
|
|
395
|
+
|
|
396
|
+
| Formula | Result |
|
|
397
|
+
| ----------------------------------------------------------------------------- | --------------------------- |
|
|
398
|
+
| <kbd>"2020-06-05T17:13:27.000000-07:00"</kbd>.to_date.strftime("%Y/%m/%d") | "2020/06/05" |
|
|
399
|
+
| <kbd>"2020-06-05T17:13:27.000000-07:00"</kbd>.strftime("%Y-%m-%dT%H:%M:%S%z") | "2020-06-05T17:13:27-0700" |
|
|
400
|
+
| <kbd>"2020-06-05T17:13:27.000000-07:00"</kbd>.strftime("%B %e, %l:%M%p") | "June 5, 5:13 pm" |
|
|
401
|
+
| <kbd>"2020-06-05T17:13:27.000000-07:00"</kbd>.strftime("%A, %d %B %Y %k:%M") | "Friday, 05 June 2020 0:00" |
|
|
402
|
+
|
|
403
|
+
### Parameters
|
|
404
|
+
|
|
405
|
+
As previously shown, each code (`%B`, `%e`, `%I`, for example) refers to a specific element of `datetime`. You can also add static text and punctuation, such as commas (`,`), slashes (`/`), and colons (`:`). Refer to the following list of frequently used codes:
|
|
406
|
+
|
|
407
|
+
| Code | Meaning | Example<br>(2020-06-05T17:13:27.000000-07:00) |
|
|
408
|
+
| ---------------- | -------------------------------------- | ---------------------------------------- |
|
|
409
|
+
| %Y | Year with century | 2020 |
|
|
410
|
+
| %m | Month with zero-prefix | 06 |
|
|
411
|
+
| %B | Full month name | June |
|
|
412
|
+
| %b | Abbreviated month name | Jun |
|
|
413
|
+
| %d | Day of the month with zero-prefix | 05 |
|
|
414
|
+
| %e | Day of the month without zero-prefix | 5 |
|
|
415
|
+
| %H | Hour of the day (24-hour) | 17 |
|
|
416
|
+
| %k | Hour of day without 0 prefix (24-hour) | 17 |
|
|
417
|
+
| %I (capital i) | Hour of the day (12-hour) | 05 |
|
|
418
|
+
| %l (lowercase L) | Hour of day without 0 prefix (12-hour) | 5 |
|
|
419
|
+
| %p | AM or PM | PM |
|
|
420
|
+
| %M | Minute of the hour | 13 |
|
|
421
|
+
| %S | Second of the minute | 27 |
|
|
422
|
+
| %L | Millisecond of the second | 000 |
|
|
423
|
+
| %z | Time zone offset from UTC | -0700 |
|
|
424
|
+
| %:z | Time zone formatted offset from UTC | -07:00 |
|
|
425
|
+
| %Z | Time zone abbrev. name | UTC |
|
|
426
|
+
| %A | Full day name | Friday |
|
|
427
|
+
|
|
428
|
+
To access the full list, check out the [Ruby documentation](http://ruby-doc.org/core-2.3.3/Time.html#method-i-strftime)
|
|
429
|
+
|
|
430
|
+
### How it works
|
|
431
|
+
|
|
432
|
+
Allows the user to define a datetime format. Returns the datetime input in the specified format.
|
|
433
|
+
|
|
434
|
+
::: tip Input datatype
|
|
435
|
+
The input must be a date or datetime datatype. You can use the <u>[to_date](/formulas/date-formulas.md#to-date)</u> formula to convert a string into a date datatype.
|
|
436
|
+
:::
|
|
437
|
+
|
|
438
|
+
### See also
|
|
439
|
+
|
|
440
|
+
- [to_date](/formulas/date-formulas.md#to-date): Returns a date in date datatype.
|
|
441
|
+
|
|
442
|
+
---
|
|
443
|
+
|
|
444
|
+
## `in_time_zone`
|
|
445
|
+
|
|
446
|
+
Converts a date or datetime to a different time zone using [IANA time zone names](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). Returns a datetime. If no time zone is specified, the value defaults to Pacific Time (PT).
|
|
447
|
+
|
|
448
|
+
### Syntax
|
|
449
|
+
|
|
450
|
+
<kbd>Date</kbd>.in_time_zone(<span style="color:#FF0000">format</span>)
|
|
451
|
+
|
|
452
|
+
- <kbd>Date</kbd> - An input date or datetime.
|
|
453
|
+
- <span style="color:#FF0000">format</span> - The target timezone.
|
|
454
|
+
|
|
455
|
+
### Sample usage
|
|
456
|
+
|
|
457
|
+
| Formula | Result |
|
|
458
|
+
| ---------------------------------------------------------- | ---------------------------------- |
|
|
459
|
+
| today.in_time_zone("America/New_York") | "2020-12-01T00:00:00.000000-04:00" |
|
|
460
|
+
| today.to_time.in_time_zone("America/New_York") | "2020-12-01T20:00:00.000000-04:00" |
|
|
461
|
+
| <kbd>"2020-06-01"</kbd>.to_time.in_time_zone | "2020-05-31T17:00:00.000000-07:00" |
|
|
462
|
+
| <kbd>"2020-06-01T01:30:45.000000+00:00"</kbd>.in_time_zone | "2020-05-31T18:30:45.000000-07:00" |
|
|
463
|
+
|
|
464
|
+
---
|
|
465
|
+
|
|
466
|
+
## `dst?`
|
|
467
|
+
|
|
468
|
+
Returns true if the input datetime is within Daylight Savings Time.
|
|
469
|
+
|
|
470
|
+
### Syntax
|
|
471
|
+
|
|
472
|
+
<kbd>Datetime</kbd>.dst?
|
|
473
|
+
|
|
474
|
+
- <kbd>Datetime</kbd> - An input date or datetime.
|
|
475
|
+
|
|
476
|
+
### Sample usage
|
|
477
|
+
|
|
478
|
+
| Formula | Result |
|
|
479
|
+
| ------------------------------------------------------------- | ------ |
|
|
480
|
+
| today.to_time.dst? | false |
|
|
481
|
+
| today.in_time_zone("America/New_York").dst? | true |
|
|
482
|
+
| <kbd>"2020-06-01"</kbd>.in_time_zone("America/New_York").dst? | true |
|
|
483
|
+
| <kbd>"2020-09-06T18:30:15.671720-05:00"</kbd>.to_time.dst? | false |
|
|
484
|
+
|
|
485
|
+
### Regions reference
|
|
486
|
+
|
|
487
|
+
Refer to the following table for the timezone name to use in the formula.
|
|
488
|
+
|
|
489
|
+
| Region | Timezone to use in formula | UTC zone | DST offset? |
|
|
490
|
+
|------------------------------|--------------------------------|-----------|--------------------|
|
|
491
|
+
| International Date Line West | Pacific/Midway | UTC-11 | |
|
|
492
|
+
| Midway Island | Pacific/Midway | UTC-11 | |
|
|
493
|
+
| American Samoa | Pacific/Pago_Pago | UTC-11 | |
|
|
494
|
+
| Hawaii | Pacific/Honolulu | UTC-10 | |
|
|
495
|
+
| Alaska | America/Juneau | UTC-9 | :white_check_mark: |
|
|
496
|
+
| Pacific Time (US & Canada) | America/Los_Angeles | UTC-8 | :white_check_mark: |
|
|
497
|
+
| Tijuana | America/Tijuana | UTC-8 | :white_check_mark: |
|
|
498
|
+
| Mountain Time (US & Canada) | America/Denver | UTC-7 | :white_check_mark: |
|
|
499
|
+
| Arizona | America/Phoenix | UTC-7 | |
|
|
500
|
+
| Chihuahua | America/Chihuahua | UTC-7 | :white_check_mark: |
|
|
501
|
+
| Mazatlan | America/Mazatlan | UTC-7 | :white_check_mark: |
|
|
502
|
+
| Central Time (US & Canada) | America/Chicago | UTC-6 | :white_check_mark: |
|
|
503
|
+
| Saskatchewan | America/Regina | UTC-6 | |
|
|
504
|
+
| Guadalajara | America/Mexico_City | UTC-6 | :white_check_mark: |
|
|
505
|
+
| Mexico City | America/Mexico_City | UTC-6 | :white_check_mark: |
|
|
506
|
+
| Monterrey | America/Monterrey | UTC-6 | :white_check_mark: |
|
|
507
|
+
| Central America | America/Guatemala | UTC-6 | |
|
|
508
|
+
| Eastern Time (US & Canada) | America/New_York | UTC-5 | :white_check_mark: |
|
|
509
|
+
| Indiana (East) | America/Indiana/Indianapolis | UTC-5 | :white_check_mark: |
|
|
510
|
+
| Bogota | America/Bogota | UTC-5 | |
|
|
511
|
+
| Lima | America/Lima | UTC-5 | |
|
|
512
|
+
| Quito | America/Lima | UTC-5 | |
|
|
513
|
+
| Atlantic Time (Canada) | America/Halifax | UTC-4 | :white_check_mark: |
|
|
514
|
+
| Caracas | America/Caracas | UTC-4 | |
|
|
515
|
+
| La Paz | America/La_Paz | UTC-4 | |
|
|
516
|
+
| Santiago | America/Santiago | UTC-4 | :white_check_mark: |
|
|
517
|
+
| Georgetown | America/Guyana | UTC-4 | |
|
|
518
|
+
| Newfoundland | America/St_Johns | UTC-3:30 | :white_check_mark: |
|
|
519
|
+
| Brasilia | America/Sao_Paulo | UTC-3 | |
|
|
520
|
+
| Buenos Aires | America/Argentina/Buenos_Aires | UTC-3 | |
|
|
521
|
+
| Montevideo | America/Montevideo | UTC-3 | |
|
|
522
|
+
| Greenland | America/Godthab | UTC-3 | :white_check_mark: |
|
|
523
|
+
| Mid-Atlantic | Atlantic/South_Georgia | UTC-2 | |
|
|
524
|
+
| Azores | Atlantic/Azores | UTC-1 | :white_check_mark: |
|
|
525
|
+
| Cape Verde Is. | Atlantic/Cape_Verde | UTC-1 | |
|
|
526
|
+
| Dublin | Europe/Dublin | UTC-1 | :white_check_mark: |
|
|
527
|
+
| Lisbon | Europe/Lisbon | UTC+0 | :white_check_mark: |
|
|
528
|
+
| Edinburgh | Europe/London | UTC+0 | :white_check_mark: |
|
|
529
|
+
| London | Europe/London | UTC+0 | :white_check_mark: |
|
|
530
|
+
| Monrovia | Africa/Monrovia | UTC+0 | |
|
|
531
|
+
| UTC | Etc/UTC | UTC+0 | |
|
|
532
|
+
| Casablanca | Africa/Casablanca | UTC+1 | |
|
|
533
|
+
| Belgrade | Europe/Belgrade | UTC+1 | :white_check_mark: |
|
|
534
|
+
| Bratislava | Europe/Bratislava | UTC+1 | :white_check_mark: |
|
|
535
|
+
| Budapest | Europe/Budapest | UTC+1 | :white_check_mark: |
|
|
536
|
+
| Ljubljana | Europe/Ljubljana | UTC+1 | :white_check_mark: |
|
|
537
|
+
| Prague | Europe/Prague | UTC+1 | :white_check_mark: |
|
|
538
|
+
| Sarajevo | Europe/Sarajevo | UTC+1 | :white_check_mark: |
|
|
539
|
+
| Skopje | Europe/Skopje | UTC+1 | :white_check_mark: |
|
|
540
|
+
| Warsaw | Europe/Warsaw | UTC+1 | :white_check_mark: |
|
|
541
|
+
| Zagreb | Europe/Zagreb | UTC+1 | :white_check_mark: |
|
|
542
|
+
| Brussels | Europe/Brussels | UTC+1 | :white_check_mark: |
|
|
543
|
+
| Copenhagen | Europe/Copenhagen | UTC+1 | :white_check_mark: |
|
|
544
|
+
| Madrid | Europe/Madrid | UTC+1 | :white_check_mark: |
|
|
545
|
+
| Paris | Europe/Paris | UTC+1 | :white_check_mark: |
|
|
546
|
+
| Amsterdam | Europe/Amsterdam | UTC+1 | :white_check_mark: |
|
|
547
|
+
| Berlin | Europe/Berlin | UTC+1 | :white_check_mark: |
|
|
548
|
+
| Bern | Europe/Zurich | UTC+1 | :white_check_mark: |
|
|
549
|
+
| Zurich | Europe/Zurich | UTC+1 | :white_check_mark: |
|
|
550
|
+
| Rome | Europe/Rome | UTC+1 | :white_check_mark: |
|
|
551
|
+
| Stockholm | Europe/Stockholm | UTC+1 | :white_check_mark: |
|
|
552
|
+
| Vienna | Europe/Vienna | UTC+1 | :white_check_mark: |
|
|
553
|
+
| West Central Africa | Africa/Algiers | UTC+1 | |
|
|
554
|
+
| Bucharest | Europe/Bucharest | UTC+2 | :white_check_mark: |
|
|
555
|
+
| Cairo | Africa/Cairo | UTC+2 | |
|
|
556
|
+
| Helsinki | Europe/Helsinki | UTC+2 | :white_check_mark: |
|
|
557
|
+
| Kyiv | Europe/Kiev | UTC+2 | :white_check_mark: |
|
|
558
|
+
| Riga | Europe/Riga | UTC+2 | :white_check_mark: |
|
|
559
|
+
| Sofia | Europe/Sofia | UTC+2 | :white_check_mark: |
|
|
560
|
+
| Tallinn | Europe/Tallinn | UTC+2 | :white_check_mark: |
|
|
561
|
+
| Vilnius | Europe/Vilnius | UTC+2 | :white_check_mark: |
|
|
562
|
+
| Athens | Europe/Athens | UTC+2 | :white_check_mark: |
|
|
563
|
+
| Jerusalem | Asia/Jerusalem | UTC+2 | :white_check_mark: |
|
|
564
|
+
| Harare | Africa/Harare | UTC+2 | |
|
|
565
|
+
| Pretoria | Africa/Johannesburg | UTC+2 | |
|
|
566
|
+
| Kaliningrad | Europe/Kaliningrad | UTC+2 | |
|
|
567
|
+
| Istanbul | Europe/Istanbul | UTC+3 | |
|
|
568
|
+
| Minsk | Europe/Minsk | UTC+3 | |
|
|
569
|
+
| Moscow | Europe/Moscow | UTC+3 | |
|
|
570
|
+
| St. Petersburg | Europe/Moscow | UTC+3 | |
|
|
571
|
+
| Kuwait | Asia/Kuwait | UTC+3 | |
|
|
572
|
+
| Riyadh | Asia/Riyadh | UTC+3 | |
|
|
573
|
+
| Nairobi | Africa/Nairobi | UTC+3 | |
|
|
574
|
+
| Baghdad | Asia/Baghdad | UTC+3 | |
|
|
575
|
+
| Tehran | Asia/Tehran | UTC+3:30 | :white_check_mark: |
|
|
576
|
+
| Volgograd | Europe/Volgograd | UTC+4 | |
|
|
577
|
+
| Samara | Europe/Samara | UTC+4 | |
|
|
578
|
+
| Abu Dhabi | Asia/Muscat | UTC+4 | |
|
|
579
|
+
| Muscat | Asia/Muscat | UTC+4 | |
|
|
580
|
+
| Baku | Asia/Baku | UTC+4 | |
|
|
581
|
+
| Tbilisi | Asia/Tbilisi | UTC+4 | |
|
|
582
|
+
| Yerevan | Asia/Yerevan | UTC+4 | |
|
|
583
|
+
| Kabul | Asia/Kabul | UTC+4:30 | :white_check_mark: |
|
|
584
|
+
| Ekaterinburg | Asia/Yekaterinburg | UTC+5 | |
|
|
585
|
+
| Islamabad | Asia/Karachi | UTC+5 | |
|
|
586
|
+
| Karachi | Asia/Karachi | UTC+5 | |
|
|
587
|
+
| Tashkent | Asia/Tashkent | UTC+5 | |
|
|
588
|
+
| Sri Jayawardenepura | Asia/Colombo | UTC+5:30 | :white_check_mark: |
|
|
589
|
+
| Chennai | Asia/Kolkata | UTC+5:30 | :white_check_mark: |
|
|
590
|
+
| Kolkata | Asia/Kolkata | UTC+5:30 | :white_check_mark: |
|
|
591
|
+
| Mumbai | Asia/Kolkata | UTC+5:30 | :white_check_mark: |
|
|
592
|
+
| New Delhi | Asia/Kolkata | UTC+5:30 | :white_check_mark: |
|
|
593
|
+
| Kathmandu | Asia/Kathmandu | UTC+5:45 | :white_check_mark: |
|
|
594
|
+
| Astana | Asia/Dhaka | UTC+6 | |
|
|
595
|
+
| Dhaka | Asia/Dhaka | UTC+6 | |
|
|
596
|
+
| Almaty | Asia/Almaty | UTC+6 | |
|
|
597
|
+
| Urumqi | Asia/Urumqi | UTC+6 | |
|
|
598
|
+
| Rangoon | Asia/Rangoon | UTC+6:30 | :white_check_mark: |
|
|
599
|
+
| Novosibirsk | Asia/Novosibirsk | UTC+7 | |
|
|
600
|
+
| Bangkok | Asia/Bangkok | UTC+7 | |
|
|
601
|
+
| Hanoi | Asia/Bangkok | UTC+7 | |
|
|
602
|
+
| Jakarta | Asia/Jakarta | UTC+7 | |
|
|
603
|
+
| Krasnoyarsk | Asia/Krasnoyarsk | UTC+7 | |
|
|
604
|
+
| Beijing | Asia/Shanghai | UTC+8 | |
|
|
605
|
+
| Chongqing | Asia/Chongqing | UTC+8 | |
|
|
606
|
+
| Hong Kong | Asia/Hong_Kong | UTC+8 | |
|
|
607
|
+
| Kuala Lumpur | Asia/Kuala_Lumpur | UTC+8 | |
|
|
608
|
+
| Singapore | Asia/Singapore | UTC+8 | |
|
|
609
|
+
| Taipei | Asia/Taipei | UTC+8 | |
|
|
610
|
+
| Perth | Australia/Perth | UTC+8 | |
|
|
611
|
+
| Irkutsk | Asia/Irkutsk | UTC+8 | |
|
|
612
|
+
| Ulaanbaatar | Asia/Ulaanbaatar | UTC+8 | |
|
|
613
|
+
| Seoul | Asia/Seoul | UTC+9 | |
|
|
614
|
+
| Osaka | Asia/Tokyo | UTC+9 | |
|
|
615
|
+
| Sapporo | Asia/Tokyo | UTC+9 | |
|
|
616
|
+
| Tokyo | Asia/Tokyo | UTC+9 | |
|
|
617
|
+
| Yakutsk | Asia/Yakutsk | UTC+9 | |
|
|
618
|
+
| Darwin | Australia/Darwin | UTC+9:30 | |
|
|
619
|
+
| Adelaide | Australia/Adelaide | UTC+9:30 | :white_check_mark: |
|
|
620
|
+
| Canberra | Australia/Melbourne | UTC+10 | :white_check_mark: |
|
|
621
|
+
| Melbourne | Australia/Melbourne | UTC+10 | :white_check_mark: |
|
|
622
|
+
| Sydney | Australia/Sydney | UTC+10 | :white_check_mark: |
|
|
623
|
+
| Brisbane | Australia/Brisbane | UTC+10 | |
|
|
624
|
+
| Hobart | Australia/Hobart | UTC+10 | :white_check_mark: |
|
|
625
|
+
| Vladivostok | Asia/Vladivostok | UTC+10 | |
|
|
626
|
+
| Guam | Pacific/Guam | UTC+10 | |
|
|
627
|
+
| Port Moresby | Pacific/Port_Moresby | UTC+10 | |
|
|
628
|
+
| Magadan | Asia/Magadan | UTC+11 | |
|
|
629
|
+
| Srednekolymsk | Asia/Srednekolymsk | UTC+11 | |
|
|
630
|
+
| Solomon Is. | Pacific/Guadalcanal | UTC+11 | |
|
|
631
|
+
| New Caledonia | Pacific/Noumea | UTC+11 | |
|
|
632
|
+
| Fiji | Pacific/Fiji | UTC+12 | :white_check_mark: |
|
|
633
|
+
| Kamchatka | Asia/Kamchatka | UTC+12 | |
|
|
634
|
+
| Marshall Is. | Pacific/Majuro | UTC+12 | |
|
|
635
|
+
| Auckland | Pacific/Auckland | UTC+12 | :white_check_mark: |
|
|
636
|
+
| Wellington | Pacific/Auckland | UTC+12 | :white_check_mark: |
|
|
637
|
+
| Nuku'alofa | Pacific/Tongatapu | UTC+13 | |
|
|
638
|
+
| Tokelau Is. | Pacific/Fakaofo | UTC+13 | |
|
|
639
|
+
| Samoa | Pacific/Apia | UTC+13 | |
|
|
640
|
+
| Chatham Is. | Pacific/Chatham | UTC+13:45 | :white_check_mark: |
|
|
641
|
+
|
|
642
|
+
---
|
|
643
|
+
|
|
644
|
+
## `to_date`
|
|
645
|
+
|
|
646
|
+
This formula converts input data into a date and returns the date formatted as `YYYY-MM-DD`.
|
|
647
|
+
|
|
648
|
+
|
|
649
|
+
### Syntax
|
|
650
|
+
|
|
651
|
+
<kbd>String</kbd>.to_date(format: <span style="color:#FF0000">format</span>)
|
|
652
|
+
|
|
653
|
+
- <kbd>String</kbd> - A string input that describes a date or datetime.
|
|
654
|
+
- <span style="color:#FF0000">format</span> - (optional) The format of the input date string. If not specified, Workato parses the input string automatically.
|
|
655
|
+
|
|
656
|
+
::: warning FORMAT PARAMETER DOESN'T AFFECT OUTPUT FORMAT
|
|
657
|
+
The `format` parameter defines only the input format. It does not affect the output format, which is always returned as `YYYY-MM-DD`.
|
|
658
|
+
:::
|
|
659
|
+
|
|
660
|
+
### Sample usage
|
|
661
|
+
|
|
662
|
+
| Formula | Result |
|
|
663
|
+
| -------------------------------------------------------------- | ------------ |
|
|
664
|
+
| <kbd>"23-01-2020 10:30 pm"</kbd>.to_date(format: "DD-MM-YYYY") | "2020-01-23" |
|
|
665
|
+
| <kbd>"01-23-2020 10:30 pm"</kbd>.to_date(format: "MM-DD-YYYY") | "2020-01-23" |
|
|
666
|
+
| <kbd>"2020/01/23"</kbd>.to_date(format: "YYYY/MM/DD") | "2020-01-23" |
|
|
667
|
+
| <kbd>"06/27/25"</kbd>.to_date(format: "%m/%d/%y") | "2025-06-27" |
|
|
668
|
+
|
|
669
|
+
### How it works
|
|
670
|
+
|
|
671
|
+
Converts the input data into a date datatype.
|
|
672
|
+
|
|
673
|
+
::: tip INPUT DATA BEST PRACTICE
|
|
674
|
+
We recommend that you specify the input data format. If you don't specify the input data format, Workato parses the input string automatically.
|
|
675
|
+
|
|
676
|
+
The input string must resemble a date for this formula to work.
|
|
677
|
+
:::
|
|
678
|
+
|
|
679
|
+
### See also
|
|
680
|
+
|
|
681
|
+
- [strftime](/formulas/date-formulas.md#strftime): Returns datetime is a custom format.
|
|
682
|
+
- [to_time](/formulas/date-formulas.md#to-time): Converts a string to an ISO timestamp.
|
|
683
|
+
|
|
684
|
+
---
|
|
685
|
+
|
|
686
|
+
## `to_time`
|
|
687
|
+
|
|
688
|
+
Converts a string to an ISO timestamp. The response will use the UTC timezone (+00:00).
|
|
689
|
+
|
|
690
|
+
### Syntax
|
|
691
|
+
|
|
692
|
+
<kbd>String</kbd>.to_time(format: <span style="color:#FF0000">format</span>)
|
|
693
|
+
|
|
694
|
+
- <kbd>String</kbd> - An input string that describes a date or datetime.
|
|
695
|
+
- <span style="color:#FF0000">format</span> - (optional) The format of the user-defined datetime written as a string.
|
|
696
|
+
|
|
697
|
+
### Sample usage
|
|
698
|
+
|
|
699
|
+
| Formula | Result |
|
|
700
|
+
| ----------------------------------------------------- | ------------- |
|
|
701
|
+
| <kbd>"2020-04-02T12:30:30.462659-07:00"</kbd>.to_time(format: "%Y-%m-%dT%H:%M:%S") | "2020-04-02T19:30:30.000+00:00" |
|
|
702
|
+
| <kbd>"2020-04-02"</kbd>.to_time | "2020-04-02T00:00:00.000+00:00" |
|
|
703
|
+
|
|
704
|
+
### How it works
|
|
705
|
+
|
|
706
|
+
Converts the input string into a datetime datatype. The output datetime will be converted to the UTC timezone (+00:00).
|
|
707
|
+
|
|
708
|
+
::: tip Autofill time
|
|
709
|
+
If the input data does not include the time, the output will default to `00:00:00.000000 +00:00`.
|
|
710
|
+
:::
|
|
711
|
+
|
|
712
|
+
### See also
|
|
713
|
+
|
|
714
|
+
- [strftime](/formulas/date-formulas.md#strftime): Returns datetime is a custom format.
|
|
715
|
+
- [to_date](/formulas/date-formulas.md#to-date): This formula converts the date-like input into a date. Returns the date formatted as YYYY-MM-DD.
|
|
716
|
+
|
|
717
|
+
### Parameters
|
|
718
|
+
|
|
719
|
+
As previously shown, each code (`%B`, `%e`, `%I`, for example) refers to a specific element of `datetime`. You can also add static text and punctuation, such as commas (`,`), slashes (`/`), and colons (`:`). Refer to the following list of frequently used codes:
|
|
720
|
+
|
|
721
|
+
| Code | Meaning | Example<br>(2020-06-05T17:13:27.000000-07:00) |
|
|
722
|
+
| ---------------- | -------------------------------------- | ---------------------------------------- |
|
|
723
|
+
| %Y | Year with century | 2020 |
|
|
724
|
+
| %m | Month with zero-prefix | 06 |
|
|
725
|
+
| %B | Full month name | June |
|
|
726
|
+
| %b | Abbreviated month name | Jun |
|
|
727
|
+
| %d | Day of the month with zero-prefix | 05 |
|
|
728
|
+
| %e | Day of the month without zero-prefix | 5 |
|
|
729
|
+
| %H | Hour of the day (24-hour) | 17 |
|
|
730
|
+
| %k | Hour of day without 0 prefix (24-hour) | 17 |
|
|
731
|
+
| %I (capital i) | Hour of the day (12-hour) | 05 |
|
|
732
|
+
| %l (lowercase L) | Hour of day without 0 prefix (12-hour) | 5 |
|
|
733
|
+
| %p | AM or PM | PM |
|
|
734
|
+
| %M | Minute of the hour | 13 |
|
|
735
|
+
| %S | Second of the minute | 27 |
|
|
736
|
+
| %L | Millisecond of the second | 000 |
|
|
737
|
+
| %z | Time zone offset from UTC | -0700 |
|
|
738
|
+
| %:z | Time zone formatted offset from UTC | -07:00 |
|
|
739
|
+
| %Z | Time zone abbrev. name | UTC |
|
|
740
|
+
| %A | Full day name | Friday |
|
|
741
|
+
|
|
742
|
+
To access the full list, check out the [Ruby documentation](http://ruby-doc.org/core-2.3.3/Time.html#method-i-strftime)
|
|
743
|
+
|
|
744
|
+
---
|
|
745
|
+
|
|
746
|
+
## `to_i`
|
|
747
|
+
|
|
748
|
+
Convert datetime into epoch time. Returns an epoch time in UTC (+00:00).
|
|
749
|
+
|
|
750
|
+
### Syntax
|
|
751
|
+
|
|
752
|
+
<kbd>Datetime</kbd>.to_i
|
|
753
|
+
|
|
754
|
+
- <kbd>Datetime</kbd> - An input datetime.
|
|
755
|
+
|
|
756
|
+
### Sample usage
|
|
757
|
+
|
|
758
|
+
| Formula | Result |
|
|
759
|
+
| ------------------------------------------------- | ---------- |
|
|
760
|
+
| today.to_time.to_i | 1645660800 |
|
|
761
|
+
| now.to_i | 1645714000 |
|
|
762
|
+
|
|
763
|
+
### How it works
|
|
764
|
+
|
|
765
|
+
Converts the input datetime into an integer, it will return epoch time in seconds, not milliseconds. The output datetime will be converted to the UTC timezone (+00:00).
|
|
766
|
+
|
|
767
|
+
::: tip Converting between Epoch time to datetime
|
|
768
|
+
|
|
769
|
+
Convert time formats easily with Workato formulas.
|
|
770
|
+
|
|
771
|
+
#### How to convert human readable time to epoch time
|
|
772
|
+
|
|
773
|
+
Use `to_i` to convert a datetime datapill to epoch time (in UTC). Learn more about [how it works](/formulas/date-formulas.md#to-i).
|
|
774
|
+
|
|
775
|
+
#### How to convert epoch time to human-readable time
|
|
776
|
+
|
|
777
|
+
Use the following formula to convert an epoch time to human-readable datetime.
|
|
778
|
+
|
|
779
|
+
Note that the output will be in UTC timezone (+00:00).
|
|
780
|
+
|
|
781
|
+
`"1970-01-01".to_time + `<kbd>Epoch time</kbd>`.seconds`
|
|
782
|
+
|
|
783
|
+
If you plan to convert epoch time to a specific timezone, you must specify it with [in_time_zone](/formulas/date-formulas.md#in-time-zone).
|
|
784
|
+
|
|
785
|
+
`"1970-01-01".to_time.in_time_zone("US/Pacific") + `<kbd>Epoch time</kbd>`.seconds`
|
|
786
|
+
:::
|
|
787
|
+
|
|
788
|
+
::: danger Wrong datatype: undefined method `to_i`
|
|
789
|
+
Epoch time requires a datetime datapill. If you are using a date datapill, it will cause an error.
|
|
790
|
+
|
|
791
|
+
Use [to_time](/formulas/date-formulas.md#to-time) to convert a date into a datetime before converting to epoch time.
|
|
792
|
+
:::
|
|
793
|
+
|
|
794
|
+
### See also
|
|
795
|
+
|
|
796
|
+
- [to_time](/formulas/date-formulas.md#to-time): Converts a string to an ISO timestamp.
|
|
797
|
+
- [to_date](/formulas/date-formulas.md#to-date): This formula converts the date-like input into a date. Returns the date formatted as YYYY-MM-DD.
|
|
798
|
+
- [in_time_zone](/formulas/date-formulas.md#in-time-zone): Converts a time value to a different time zone.
|