The GET
method of the executionplans
API retrieves the details of one or more Execution Plans.
You must obtain an authToken by using the login
API. The token authenticates the user performing the operation. For details, see
TSWS authentication
.
API | Method | Description |
---|---|---|
Applications | GET | Retrieve the details of one application or all applications |
PUT | Update an existing application | |
POST | Create a new application | |
DELETE | Delete an application | |
Execution Plans | GET | Retrieve the details of one or more Execution Plans |
PUT | Create a new Execution Plan or Update an existing Execution Plan | |
DELETE | Delete an Execution Plan | |
Scripts | GET | Retrieve the details of one script or all scripts |
Locations | GET | Retrieve the details of all locations |
The executionplan
API uses the GET
method to retrieve Execution Plans. Use the following request syntax:
For retrieving a single Execution Plan | https://<PresentationServerHostName>/tsws/10.0/api/appvis/synthetic/api/executionplans/getById?executionPlanId=<EPID> |
For retrieving all Execution Plans | https://<PresentationServerHostName>/tsws/10.0/api/appvis/synthetic/api/executionplans/getAll |
For retrieving all Execution Plans for a single application | https://<PresentationServerHostName>/tsws/10.0/api/appvis/synthetic/api/executionplans/getAllByApplication?applicationId=<AID> |
In the above examples:
<PresentationServerHostName>
indicates the host name of the TrueSight Presentation Server.<EPID>
indicates the ID of the Execution Plan.<AID>
indicates the ID of the application on the Presentation Server (not the synthetic application ID).After accessing the REST client, perform the following steps:
https://localhost/tsws/10.0/api/appvis/synthetic/api/executionplans/getById?executionPlanId=112
Add a new header row and select Authorization as the header type.
login
API. Element | Description |
---|---|
authToken | Value of authToken |
Query parameters | |
executionPlanId | ID of the Execution Plan (for retrieving a single Execution Plan only) |
applicationId | ID of the application on the Presentation Server (not the synthetic application ID) (for retrieving all Execution Plans for an application only) |
The following sample is the JSON code returned by the API for a single Execution Plan.
Parameter | Description | Value |
---|---|---|
executionPlanId | ID of the Execution Plan | String representing a numeric value |
blackOuts | Blackout periods defined for the Execution Plan (can be multiple) | |
startAtTimeOffset | Clock used for calculating the blackout period |
|
terminateAt | Date from when the blackout period is no longer used | One of the following:
|
daysOfRunTillHour | End time for the blackout period | Format: hh:mm Example: 21:00 |
daysOfRunFromHour | Start time for the blackout period | Format: hh:mm Example: 17:00 |
triggerType | Trigger for the blackout period | DAYS_OF_WEEK_BLACKOUT |
daysOfWeek | Days of the week when the blackout period is in effect | Comma-separated numeric values (0-6). Example: 0,2,5 indicates that the blackout is in effect on Sunday, Tuesday, and Friday. |
blackoutName | Name or description of the blackout period | String Logical name or description given to the blackout period |
startAt | Date from when the blackout period is in use. | One of the following:
|
projectType | Type of Silk Performer project | String representing a numeric value |
scriptFileName | Name of the script run by the Execution Plan | String |
description | Description of the Execution Plan | String |
executionPlanName | Name of the Execution Plan | String |
version | Execution Plan version This number is updated every time the Execution Plan is updated. | String representing a numeric value |
scriptFileCRC | Cyclic Redundancy Check of the script file This is used for verifying that this is the correct file. | String representing a numeric value |
scheduler | Schedule defined for the Execution Plan | |
startAtTimeOffset | Clock used for calculating the schedule |
|
terminateAt | Date from when the schedule is no longer used | One of the following:
|
transactionTimeout | Number of minutes a transaction is allowed to run before it is automatically timed out | String representing a numeric value |
startAtWithRandomDelay | Range, in minutes, within which the Execution Plan starts | String representing a numeric value |
startAt | Date from when the schedule is in use | One of the following:
|
intervalInMinutes | Number of minutes between runs of the Execution Plan | String representing a numeric value |
scriptId | ID of the script used by the Execution Plan | String representing a numeric value |
agentGroups | Locations defined for the Execution Plan | |
name | Name of the location | String |
id | ID of the location | Number |
scriptFileSize | Size of the script file used by the Execution Plan in bytes | String representing a numeric value |
activeStatus | Indication of whether the Execution Plan is active | String representing a boolean value 0 - False 1 - True |
attributeChangedEnvelopVersion | Version number that is incremented each time there is a change in blackouts, schedule, or Execution Plan name | String representing a numeric value |
activeBy | Array of two Boolean values indicating if the Execution Plan is active at the Execution Plan level, and at the Application level | Array |
attributes | Attributes of the script run by the Execution Plan (can be multiple) | |
encrypted | Indicates whether the attribute is encrypted | 0 - False 1 - True |
defaultValue | Default value of the attribute | Varies depending on the attribute |
name | Name of the attribute | String |
length | Length of the attribute | Number |
encryptionType | Type of encryption used for this attribute | 0 - No encryption 1,2 - Indicates encryption type |
description | Description of the attribute | String |
type | Data type of the attribute |
|
value | Value of the attribute | Varies depending on the attribute |
order | Serial number of the appearance of the attribute in the user interface | Number |
applicationId | ID of the application in the Presentation Server | String representing a numeric value |
syntheticApplicationId | ID of the application | String representing a numeric value |
syntheticApplicationName | Name of the application | String |
attributeChangedScriptVersion | Version number that is incremented each time there is a change in script attributes | String representing a numeric value |
2 Comments
Diane Porter
Harihara Subramanian