JSON Services for CICS project

This topic describes scenarios typical for the JSON Services for CICS® project.

With this project you can expose CICS applications as web services with JSON payloads, create new RESTful applications, call existing JSON applications, and convert JSON from any source to and from application data.

The following scenarios are supported:
  • Scenario: Create New Service Interface (bottom-up)

    Generate a JSON schema and runtime-specific message processing from a high-level language data structure. You can use this option when you expose an application program as a service provider.

    This scenario uses the Request-Response interaction pattern. With this interaction pattern, an existing CICS PROGRAM is exposed as a JSON web service. You begin with existing language data structures and use the wizard to generate the JSON request and response schema.

    Generated artifacts

    • JSON request file
    • JSON response file
    • WSBIND file
  • Scenario: Create New Service Implementation (top-down)

    Generate high-level language data structures and runtime-specific message processing from a JSON schema. You can use this option to (1) Create a new service provider application program or (2) Expose an existing application program as a service provider.

    There are two interaction pattern choices available for this scenario. Either Request-Response or RESTful may be selected from the interaction pattern dialog.

    Request-Response interaction pattern

    New language structures for JSON web services are created using an interface that is described within existing JSON Request and Response schemas. An application must be created to use the new language structures. The Request-Response pattern can be used to generate JSON Web Services that target either Commarea or Channel attached CICS PROGRAMs. This option can only be used in provider mode, where CICS acts as the server.

    RESTful interaction pattern

    New language structures for JSON web services are created using an interface that is described within existing JSON Request and Response schemas. The RESTful interaction pattern is used in combination with HTTP. In this context, the resource's identity is its URI. The data type is its Media Type, and the actions are made up of the standard HTTP methods (GET, PUT, POST, and DELETE). An application must be created to use the new language structures, and it has to behave differently depending on the HTTP method that was used for the incoming request.

    Generated artifacts (Request-Response interaction pattern)

    • Request file copybook
    • Response file copybook
    • WSBIND file

    Generated artifacts (RESTful interaction pattern)

    • Request file copybook
    • WSBIND file

Related concepts

Related reference