Advanced optional parameters
Depending on the query whose results you want to view, you can complete your URL with the
following parameters:
- Mandatory parameters
-
- engineName
- Specify the name of one or more engines to be used as filter.
- objectType
- Specify an object type as filter. The following are the supported object types
in the Dynamic Workload Console:
- com.ibm.tws.objects.plan.JobInPlan
- com.ibm.tws.objects.plan.JobStreamInPlan
- com.ibm.tws.objects.plan.CriticalJobInPlan
- com.ibm.tws.objects.plan.WorkstattionInPlan
- com.ibm.tws.objects.plan.PromptInPlan
- com.ibm.tws.objects.plan.ResourceInPlan
- com.ibm.tws.objects.plan.DomainInPlan
- plan
- Specify a plan name as filter.
- query
- Specify a query to filter the results.Note: Special characters must be replaced by encoded values. For example, # (number sign) must be replaced by %23, + (plus sign) must be replaced by %2B.
- Example
- A query like
@!@.@+state=#Waiting
must be written like this:@!@.@%2Bstate=%23Waiting
- Optional parameters
-
- columns
- Specify the columns that you want to display in your result table. The following
three options are available:
- ALL
- Display all columns.
- DEFAULT
- Diplay only the default columns.
- Customized columns
- Display the customized column to get a specific column result. For
example,
“columns”: “Status,Internal Status”
.
If not specified, the default columns for this query are shown.
- encrypt
- Specify if you want to encrypt or not the engine name parameter. If true, the engine name has to be encrypted by using Base64 encode.
- taskName
- Specify the name of an existing task as filter.Note: it is not recommended to specify both the taskName and query parameters in the URL. If both parameters are specified, the taskName parameter has the priority.