Table of Contents (exploded view)
Abstract for IBM z/OS Management Facility Programming Guide
Summary of changes
Changes made in z/OSMF Version 2 Release 1, SA32-1066-08
Changes made in z/OSMF Version 2 Release 1, SA32-1066-07
Changes made in z/OSMF Version 2 Release 1, SA32-1066-06
Changes made in z/OSMF Version 2 Release 1, SA32-1066-05
Changes made in z/OSMF Version 2 Release 1, SA32-1066-04
Changes made in z/OSMF Version 2 Release 1, SA32-1066-03
Changes made in z/OSMF Version 2 Release 1, SA32-1066-02
Changes made in z/OSMF Version 2 Release 1, SA32-1066-01
For z/OSMF Version 2 Release 1, SA32-1066-00
Using the z/OSMF REST services
Application Linking Manager interface services
Event types, requestors, and handlers shipped with z/OSMF
Register an event type
Register an event handler
Obtain a list of all tasks that are eligible to be handlers
Obtain a list of handlers for an event type
Unregister an event handler
Unregister an event type
Application server routing services
Retrieve data from an application server
Update data for an application server
Delete data from an application server
Cloud provisioning services
Resource pool services
Obtain an IP address
Release an IP address
Obtain a port
Release a port
Obtain a SNA application name
Release a SNA application name
Add a classification rule
Remove a classification rule
Resource management services
Get a domain
List the domains
Get a tenant
List the tenants
Software services template services
Create a software services template
Create a new version of a software services template
Create a new software services template based on an existing one
Modify a software services template
Delete a software services template
Get a software services template
Get software services template documentation
Get prompt variables for a software services template
Get source information for a software services template
List the software services templates
Publish a software services template
Test a software services template
Refresh a software services template
Archive a software services template
Add an approval for a software services template
Get an approval for a software services template
List the approvals for a software services template
Approve an approval record for a software services template
Reject the use of your user ID with a software services template
Delete an approval for a software services template
Published software service template services
Run a published software service template
Get a published software service template
Get consumer documentation for a published software service template
Get prompt variables for a published software service template
List the published software service templates
Software services instance services
Create a software services instance
Get the contents of a software services instance
List the software services instances
Get the variables for a software services instance
Get key-value variables for a software services instance
Update a software services instance
Update variables in a software services instance
Delete a software services instance
Perform an action against a software services instance
Get the response for an action performed against a software services instance
List the responses for actions performed against a software services instance
Delete the response for an action performed against a software services instance
Software service instance name services
Create software service instance names
List the software service instance names
Create a variable name
Create unique variable names
Data persistence services
Persist user or application data
Retrieve persisted user or application data
Delete persisted user or application data
Multisystem routing services
Retrieve data from one or more systems
Update data for one or more systems
Delete data from one or more systems
Authenticate with a secondary z/OSMF instance
Authenticate with an HTTP proxy server
Notification services
Get all of the notifications received by the current user
Send a notification from a z/OSMF task, when the content is the message from the bundle file
Send a notification and mail from a z/OSMF task or z/OSMF user
Send a notification from a third party product
Software management services
List the software instances defined to z/OSMF
Retrieve the properties of a software instance
List the data sets included in a software instance
Add a new software instance
Export a defined software instance
Modify the properties of a software instance
Load the products, features, and FMIDs for a software instance
Delete a software instance
Topology services
List the systems defined to z/OSMF
List the groups defined to z/OSMF
List the systems included in a group
List the sysplexes defined to z/OSMF
List the systems included in a sysplex
List the systems included in a CPC
TSO/E address space services
Start or reconnect to a TSO/E address space
Start an application in a TSO/E address space
Send messages to a TSO/E address space
Send messages to an application
Ping a TSO/E address space
Receive messages from a TSO/E address space
Receive messages from an application
End a TSO/E address space
WLM resource pooling services
Prime a WLM resource pool
Delete a WLM resource pool
Construct a WLM service definition
Construct a WLM service definition with remove and install
z/OS console services
Issue a command
Get a command response
Get the detect result for unsolicited messages
z/OS data set and file REST interface
List the z/OS data sets on a system
List the members of a z/OS data set
Retrieve the contents of a z/OS data set or member
Write data to a z/OS data set or member
Create a sequential and partitioned data set
Delete a sequential and partitioned data set
Delete a partitioned data set member
z/OS Data set and member utilities
Access Method Services Interface
List the files and directories of a UNIX file path
Retrieve the contents of a z/OS UNIX file
Write data to a z/OS UNIX file
Create a UNIX file or directory
Delete a UNIX file or directory
z/OS UNIX file utilities
List z/OS UNIX Filesystems
Create z/OS UNIX zFS Filesystem
Delete z/OS UNIX zFS Filesystem
Mount a UNIX file system
Unmount a UNIX file system
JSON document specifications for z/OS data set and file REST interface requests
Error reporting categories
z/OS jobs REST interface
Obtain the status of a job
List the jobs for an owner, prefix, or job ID
List the spool files for a job
Retrieve the contents of a job spool file
Submit a job
Hold a job
Release a job
Change the job class
Cancel a job
Cancel a job and purge its output
JSON document specifications for z/OS jobs REST interface requests
Error reporting categories
z/OSMF information retrieval service
Retrieve z/OSMF information
z/OSMF system variable services
Create or update system variables
Get system variables
Import system variables
Export system variables
Delete system variables
z/OSMF workflow services
Create a workflow
Get the properties of a workflow
List the workflows for a system or sysplex
Start a workflow
Cancel a workflow
Delete a workflow
Retrieve a workflow definition
Archive a workflow instance
List the archived workflows for a system
Get the properties of an archived workflow
Delete an archived workflow
Creating workflow definitions for z/OS
Terms you should know
The Workflows task schema
Creating the workflow definition file
Structure of a workflow definition file
Creating and viewing the workflow definition file
Sample XML files for your reference
References to external files
Defining entities for a workflow
Specifying the workflow root element
Specifying the workflow metadata
Including a manifest of translated text
Enabling a workflow definition file for future upgrades
Collecting user feedback
Defining steps for your workflow
Parent steps and leaf steps
Template steps
Using variables in template steps
REST steps
Calling steps
Automated steps
Making a step conditional
Using translatable strings
Using rich translatable strings
Defining variables for your workflow
Using Velocity templates for variable substitution and other functions
Specifying the variable element and its attributes
Sub-elements of the variable element
Using the element atCreate to qualify a variable definition
How to refer to a variable
Providing a workflow variable input file
Workflow XML reference
Creating your own z/OSMF plug-ins
Developing web-based applications
Using the z/OSMF core JavaScript APIs
isContentChanged function
shouldClose function
programmaticallyCloseTab function
cleanupBeforeDestroy function
cleanupBeforeDestroyComplete function
getUserSessionId function
definePublicObject function
retrievePublicObject function
deletePublicObject function
Using the Application Linking Manager JavaScript APIs
sendEvent function
getHandlers function
hasLaunchContext function
getEventFromUrl function
subscribe function
onLoadingComplete function
Logging client messages in the z/OSMF log
Modifying the default settings for the client side logger
Retrieving files and resources for your application
Authoring end user assistance
Creating help plug-ins
Developing panel help
Developing message help
Checklist for writing effective messages
Creating the table of contents
Categorizing help plug-ins
Identifying the contents of help plug-ins
Adding links to help plug-ins
Adding your applications to z/OSMF
Securing your applications
Preparing software for cloud provisioning
Enabling tracing for the z/OS jobs REST interface
Creating product information files for the Software Management task
Portable Software Instance
Index for IBM z/OS Management Facility Programming