Summary of API commands
Here are the API commands, grouped according to their purpose:
- Manipulating objects and their data:
- Create
- Creates a resource definition or a CICSĀ® Configuration Manager repository object.
- Update
- Modifies a resource definition or a CICS Configuration Manager repository object.
- Copy
- Copies resource definitions between groups or CICS configurations.
- Delete
- Deletes resource definitions or CICS Configuration Manager repository objects.
- Alter
- Alters selected attribute values across one or more resource definitions, without affecting other attribute values.
- Rename
- Renames resource definitions, and optionally moves them to another group.
- Associating objects with other objects:
- Retrieving object information:
- Inquire
- Returns all the fields for a single resource definition, CICS Configuration Manager repository object, or CICS Configuration Manager journal object.
- List
- Returns selected fields from one or more resource definitions, CICS Configuration Manager repository objects, or CICS Configuration Manager journal objects.
- Packaging changes to resource definitions:
- Ready
- Indicates that the resource definitions in a change package are ready for migration.
- Unready
- Indicates that the resource definitions in a change package are no longer ready for migration.
- Approve
- Adds to a change package the approval of a particular approver role.
- Disapprove
- Removes from a change package the approval of a particular approver role.
- Migrate
- Copies the resource definitions in a change package from source to target CICS configurations, and invokes commands in the change package on target CICS configurations, according to the specified migration scheme.
- Backout
- Backs out a previous change package migration.
- Altering in-memory images of resource definitions in active CICS regions:
- Discard
- Discards the in-memory image of resource definitions from active CICS regions.
- Install
- Dynamically makes resource definitions available to an active CICS region.
- Newcopy
- Reloads in-memory copies of resource definitions associated with a CICS program definition or document template definition.
- Importing resource definitions from an export file:
- Import
- Imports resource definitions from an export file received from another CICS Configuration Manager system. Optionally, if the export file contains change package details, also registers change packages in the importing CICS Configuration Manager repository.
- Recovering historical versions of resource definitions
from the journal:
- Recover
- Recovers before or after images of historical resource definitions from the journal.