httpHeaders | global custom headers used for all, colon and semicolon separated. For example, n1:v1;n2:v2;n3:v3. |
credentials | global credentials used for all call backs. User name and password are colon separated. |
events.name | event name |
events.body | body for callback, required if having events |
events.httpHeaders | custom headers - override global headers |
events.credentials | used if 3rd party requires basic authentication - overrides global credentials |
assignmentId |
The assignment ID to add task to |
taskName |
The name of the task to be added |
type |
The type of the task |
stream |
The stream |
application |
The application name |
path |
the path to checkout to |
checkoutFromLevel |
the level to checkout from |
owner |
The user |
releaseId |
The default release |
runtimeConfiguration |
The runtime configuration |
checkout |
default to only add, if true, also checkout the task |
AddTask |
runtimeConfiguration=TPZP |
assignmentId | The ID of the assignment to build |
level | Tasks in the assignment at this level will be built |
runtimeConfiguration | The runtime configuration |
mtype | Components with this name in the assignment will be built, if specified |
mname | Component of this type in the assignment will be built, if specified |
buildAutomatically | The request parameters for the build will come from a file written to the Jenkins build directory. This option is only valid when used in combination with a Git to ISPW Integration step |
BuildAssignment #1 |
runtimeConfiguration=TPZP |
BuildAssignment #2 |
buildAutomatically = true |
releaseId | The ID of the release to build |
assignmentId | The ID of the assignment to add the impacts to during the build |
level | Tasks in the release at this level will be built |
runtimeConfiguration | The runtime configuration |
mtype | Components with this name in the release will be built, if specified |
mname | Component of this type in the release will be built, if specified |
buildAutomatically | The request parameters for the build will come from a file written to the Jenkins build directory. This option is only valid when used in combination with a Git to ISPW Integration step |
BuildRelease #1 |
runtimeConfiguration=TPZP |
BuildRelease #2 |
buildAutomatically = true |
application | A task with this application will be built |
level | A task at this level will be built |
mname | A task with this name will be built |
mtype | A task with this type will be built |
runtimeConfiguration | The runtime configuration |
taskId | A task with this task ID will be built. If the task ID is specified then application, level, mname, and mtype are not required and will be ignored |
assignmentId | The ID of the assignment to build the task in. This will be looked up if it is not specified |
buildAutomatically | The request parameters for the build will come from a file written to the Jenkins build directory. This option is only valid when used in combination with a Git to ISPW Integration step |
BuildTask #1 |
runtimeConfiguration=TPZP |
BuildTask #2 |
runtimeConfiguration=TPZP |
BuildTask #3 |
runtimeConfiguration=TPZP |
BuildTask #4 |
runtimeConfiguration=TPZP |
assignmentId |
The assignment ID to add task to |
stream |
The stream |
application |
The application name |
moduleName |
The name of the task to be loaded |
moduleType |
The type of the task |
currentLevel |
the current level of the task |
startingLevel |
the starting level for the task |
userId |
The user ID |
runtimeConfiguration |
The runtime configuration |
release |
The release |
TaskLoad |
runtimeConfiguration=TPZP |
requestId | The deployment with the request ID to be cancelled |
runtimeConfiguration |
The runtime configuration |
runtimeConfiguration=TPZP |
assignmentId | The assignment ID to be cancelled or closed |
runtimeConfiguration |
The runtime configuration |
CancelAssignment action |
runtimeConfiguration=TPZP |
CloseAssignment action |
runtimeConfiguration=TPZP |
releaseId | The releaseID to be cancelled or closed |
runtimeConfiguration |
The runtime configuration |
CancelRelease action |
runtimeConfiguration=TPZP |
CloseRelease action |
runtimeConfiguration=TPZP |
CreateAssignment action: | CreateRelease action: | ||||||||||||||||||||||||||||||||||
Required:
|
Required:
|
runtimeConfiguration | see ISPW administrator for valid values |
assignmentId (DeployAsignment) or releaseId (DeployRelease) | The container for which you intend to deploy tasks. |
level | All tasks in the container at this level will be generated |
mname | component with this name in the container will be deployed |
mtype | component with this type in the container will be deployed |
changeType | S for standard, I for incidental, or E for emergency. Default value of S |
executionStatus | I for immediate execution or at start date/time, H to create request in hold |
dpenvlst | the DPENVLST parameter |
system | allows you to specify a specific System for the Deploy |
DeployAssignment | |
runtimeConfiguration=TPZP |
runtimeConfiguration=TPZP |
runtimeConfiguration | see ISPW administrator for valid values |
assignmentId (GenerateTasksInAssignment) or releaseId (GenerateTasksInRelease) | The container ID for which you intend to generate tasks. |
level | All tasks in the container at this level will be generated |
mname | component with this name in the container will be generated |
mtype | component with this type in the container will be generated |
autoDeploy | promotes can be set up to automatically Deploy as well by an option set up by the ISPW. The default is to not use Auto Deploy |
GenerateTasksInAssignment | GenerateTasksInRelease |
runtimeConfiguration=TPZP |
runtimeConfiguration=TPZP |
assignmentId | The assignment ID |
level (GetAssignmentTaskList) | All tasks in the assignment at this level will be displayed |
GetAssignmentInfo | GetAssignmentTaskList |
assignmentId=PLAY000313 |
assignmentId=PLAY000313 |
application |
The ISPW application ID. Trailing
wildcards are supported, i.e. FOO* |
containerId |
The container ID (Assignment ID, Release ID
or Set ID). Trailing wildcards are supported, i.e.
PRFX0000* |
containerType |
The type of container: A=Assignment, R=Release, S=Set |
description | The description for the container. Trailing
wildcards are supported such as REF123* |
includeClosedContainers |
Whether to include closed containers in the
list. Valid values are true or false (default) |
owner | The owner of the container. Trailing
wildcards are supported, i.e. MYID* |
path |
The default container path. Trailing
wildcards are supported, i.e. DEV* |
refNumber |
Site defined number typically used to
associate the container with a problem ticket number or
change request number. Trailing wildcards are supported, i.e. MYISSUE* |
releaseId |
The 10-character release number, if
associated with an assignment. Trailing wildcards are
supported, i.e. RELEASE1* |
stream |
The ISPW stream name. Trailing wildcards
are supported, i.e. BAR* |
tag |
User-definable four-character field.
Trailing wildcards are supported, i.e. TAG* (Case
sensitive) |
userId |
The owner or joined user for a container |
GetContainerList |
application=PLAY |
releaseId | The release ID |
taskId (GetReleaseTaskInfo/GetReleaseTaskGenerateListing) | The task ID |
level (GetReleaseTaskList) | All tasks in the release at this level will be displayed |
GetReleaseTaskInfo | GetReleaseTaskGenerateListing | GetReleaseTaskList |
releaseId=JKGENRELID |
releaseId=JKGENRELID |
releaseId=JKGENRELID |
setId | The set ID you want info on |
GetSetInfoAction |
setId=S000015218 |
setId | The set ID you want info on |
GetSetTaskList |
setId=S000015218 |
runtimeConfiguration | see ISPW administrator for valid values |
assignmentId (PromoteAssignment) or releaseId (PromoteRelease) | The container ID for which you intend to promote tasks. |
level | All tasks in the release at this level will be generated |
mname | component with this name in the container will be promoted |
mtype | component with this type in the container will be promoted |
override |
override the higher version if presented in the
next level. Default to no override. |
changeType | optional, S for standard, I for incidental, or E for emergency. Default value of S. |
executionStatus | I for immediate execution or at start date/time, H to create request in hold |
autoDeploy | promotes can be set up to automatically Deploy as well by an option set up by the ISPW. The default is to not use Auto Deploy |
PromoteAssignment | PromoteRelease |
runtimeConfiguration=TPZP |
runtimeConfiguration=TPZP |
runtimeConfiguration | see ISPW administrator for valid values |
assignmentId (FallbackAssignment) or releaseId (FallbackRelease) | The container ID for which you intend to fallback tasks. |
level | All tasks in the container at this level will fallback |
mname | component with this name in the container will fallback |
mtype | component with this type in the container will fallback |
FallbackAssignment | FallbackRelease |
runtimeConfiguration=TPZP |
runtimeConfiguration=TPZP |
runtimeConfiguration | see ISPW administrator for valid values |
assignmentId (RegressAsignment) or releaseId (RegressRelease) | The container for which you intend to regress the tasks |
level | All tasks in the container at this level will be generated |
mname | component with this name in the container will be regressed |
mtype | component with this type in the container will be regressed |
changeType | S for standard, I for incidental, or E for emergency. Default value of S |
executionStatus | I for immediate execution or at start date/time, H to create request in hold |
RegressAssignment | RegressRelease |
runtimeConfiguration=TPZP |
runtimeConfiguration=TPZP |
assignmentId |
The assignment ID to move task from |
containerId |
The target container ID to move to |
containerType |
'A' or 'R'. A for assignment and R for
release |
runtimeConfiguration |
The runtime configuration |
level |
All tasks at this level will be transferred |
mname |
The component name to be transferred |
mtype |
The component type to be transferred |
taskId |
The task ID to be transferred |
TransferTask |
runtimeConfiguration=TPZP |
inProgress |
True/false value indicating whether or not
to include active tasks that are not in Production. The
default value is true. |
production |
True/false value indicating whether or not to include current Production tasks. The default value is false. |
historical |
True/false value indicating whether or not to include tasks that were once in Production. The default value is false. |
startDate | Specify the start date in yyyy-mm-dd format to filter a range based on last update. |
endDate |
Specify the end date in yyyy-mm-dd format to filter a range based on last update. |
application | Container's primary application code. Containers may include components from multiple applications. Trailing wildcards are supported, i.e. FOO* |
environment |
ISPW environment for this version (such as OUTS, TEST, HOLD, or PROD). Trailing wildcards are supported, i.e. PRO* |
group |
Component or task belonging to this application owner group. Trailing wildcards are supported, i.e. FOO* |
lastUpdatedBy |
User ID that requested the last significant operation (see Operation). |
level |
Level of this component when the last operation was requested. Trailing wildcards are supported, i.e. DEV* |
name |
A component name (case sensitive). Trailing wildcards are supported, i.e. TPROG* |
operation |
Last operation performed on this component. Valid operation values include Browse, Checkout, Delete, Edit, Fallback, Generate, Implement, Loaded, Promote, Regress, Transfer, and Update Replace Version |
owner |
User who performed the checkout of the component. |
refNumber |
Optional, site-definable field typically used to associate the assignment with a problem ticket number or change request number. Trailing wildcards are supported, i.e. MYISSUE* |
releaseId |
Release a component belongs to. Trailing wildcards are supported, i.e. RELEASE1* |
stream |
2- to 8-character code defines the application structure with which the application is associated. Trailing wildcards are supported, i.e. BAR* |
type |
The one-to four-character acronym for the type of component, such as COB for a Cobol program or COPY for a copybook. Trailing wildcards are supported, i.e. C* |
GetWorkList |
inProgress=true |
level |
All tasks at this level will be removed |
mname |
The component name to be removed |
mtype |
The component type to be removed |
taskId |
The task ID to be removed |
RemoveFromRelease |
releaseId=RLS123 |
setId |
the set ID |
action |
the action to be operated on the set, supported actions: hold, release, lock, unlock, delete, restart, terminate; or approve, deny, reset (approver must be provided) |
runtimeConfiguration |
the runtime configuration |
approver |
the approver name, must be provided if use
action - approve, deny, reset |
SetOperation |
runtimeConfiguration=TPZP action=deny approver=dummy setId=S000143423 |