Using the web URL Help: best practice

Prev Next

Use the web URL Help to learn which preconfigured queries, SQL tables, and arguments are available for your ePO - On-prem web URL queries.

Use these Help commands when creating web URL queries:

  • https://<localHost>:8443/remote/core.help?

  • https://<localHost>:8443/remote/core.listQueries?:output=terse

  • https://<localHost>:8443/remote/core.help?command=core.executeQuery

  • https://<localHost>:8443/remote/core.listTables

Using the core.help command

All commands and their basic parameters for creating ePO - On-prem web URLs are listed in the core.help command output.

Type this command to see the Help.

https://<localHost>:8443/remote/core.help?

Using the core.listQueries Help command

To run an existing query using the ePO - On-prem web URL, use the queryID number appended to the base core.executeQuery command. Type this command to see the listQueries Help.

https://<localHost>:8443/remote/core.listQueries?:output=terse

Type the following command to query with an ID:

https://<localHost>:8443/remote/core.executeQuery?queryId=<IdNumber>

Using the core.executeQuery Help command

Before you can create a ePO - On-prem web URL query, or change query parameters exported from an existing query, you must know which commands and arguments are available.

Type this command to see the core.executeQuery Help.

https://<localHost>:8443/remote/core.help?command=core.executeQuery

This table lists core.executeQuery Help.

Note

Optional parameters and options appear in square brackets "[...]."

Web URL core.executeQuery Help

Command

Arguments

Parameters

Options

Description

core.executeQuery

queryId

Executes a SQUID query. Returns the data from the execution of the query or displays on error.

[database=<>]

The name of the remote database; if blank, the default database for the given database type is used.

core.executeQuery

target=

The SQUID target type to query. Optionally, you can add "." and the database type before the target. For example, databaseType.target.

[select=<>]

The SQUID select clause of the query; if blank, all columns are returned.

[where=<>]

The SQUID where clause of the query; if blank, all rows are returned.

[order=<>]

The SQUID order-by clause of the query; if blank, database order is returned.

[group=<>]

The SQUID group-by clause of the query; if blank, no grouping is performed.

[database=<>]

The name of the remote database; if blank, the default database for the given database type is used.

[depth=<>]

The SQUID depth to fetch sub-results. (default: 5).

[joinTables=<>]

The comma-separated list of SQUID targets to join with the target type; "*" means join all types.



Using the core.listTables Help command

To create a ePO - On-prem web URL query or to change query parameters exported from an existing query, you must know the names of the SQL tables and their parameters. These three commands provide that information.

  • https://<localHost>:8443/remote/core.listTables — Lists all SQL tables and their parameters

  • https://<localHost>:8443/remote/core.listTables?:output=terse — Lists a summary of all SQL tables and their parameters

  • https://<localHost>:8443/remote/core.listTables?table=<tableName> — Lists all arguments for a specific SQL table

Type this command to see the core.listTables Help.

https://<localHost>:8443/remote/core.listTables?:output=terse

To list only the parameters for a specific table, use this command:

https://<localHost>:8443/remote/core.listTables?table=<tableName>