Provide documentation of API support for hotfix management activities
My user story is as follows:
As a Systems Engineer
I want to obtain the API specification for all Pega systems management activities
So that I can manage the lifecycle of hotfixes using an 'as code' approach.What does success look like?
- The location of all API documentation for Pega 7.x has been identified and documented.
- I know the level of API support for the following operations:
- How to deploy a hotfix in an uncommitted state.
- How to deploy a hotfix in a committed state.
- How to change the state of a hotfix from uncommitted to committed.
- How to query what hotfixes have been applied.
- How to query the state of an applied hotfix.
- How to rollback an uncommitted hotfix.
- I know the degree of API support for Pega 7.2.x and Pega 7.3.x
Please provide links to the relevant product documentation (or self-discovery methods) which will allow for successful completion of this user story.
Pegasystems Inc.
US
Pegasystems Inc.
IN
SystemManagement ServicePackage holds all the methods shown below that are exposed as Rest APIs that can used to Import,Export and manage hotfixes.
SystemManagement ServicePackage holds all the methods shown below that are exposed as Rest APIs that can used to Import,Export and manage hotfixes.
- OOTB CMD line Utility prpcServiceUtils.bat which can be found PRPC core build distribution Image in folder /scripts/utils makes a call to the exposed Rest APIs mentioned above for import,export, HotFix management.
- Invoking Rest API directly- You can use the above exposed Rest APIs and can also invoke them directly.
The url to be used is in format https://<hostname>:<port>/<contextname>/PRRestService/<tenant url hash> SystemManagement/v2/<service name>
Service name : HotFix
Http Operation: Post
Inputs
|
InputName |
Description |
Default Value |
|
Operation |
Type of Hotfix Operation Install/GenerateDDL/Scan/Commit/Rollback |
None |
|
DLFilePath |
Path to the DL File and is valid only for GenerateDDL and Install Operations |
None |
|
CatalogPath |
Path of the Catalog file required only for scan operation |
None |
|
byPassSchema |
Set to true to bypass schema when installing DL |
false |
|
force |
Import a DL if it requires more configuration. |
false |
|
Async |
Flag to execute the import operation in async/sync modes |
true |