Get the status of a service

Use the HTTP method GET to obtain information, including the status, about a specific IBM® z/OS® Connect service.

HTTP method
GET
URI
/zosConnect/services/{serviceName}

If the service name contains forward slashes, they must be escaped by using %2F. For example, if the service name is MyService/v1, it must be provided as MyService%2Fv1.

Note: Enhanced in V1.1.0 of the administration interface. Service status is now reported.
Description
Gets the details, including the status, of the requested IBM z/OS Connect service.
Security
Users with Admin, Operations or Reader authority can get the status of a service; users with Invoke authority cannot. For more information about user authorization, see Overview of IBM z/OS Connect security.
Response body
Note: The enhanced administration interface V1.2.0 includes version information for services in the response body.

The output is returned in two parts. The first part contains the IBM z/OS Connect configuration parameters and the second part has the configuration that is returned by the service provider implementation. 

{
    "zosConnect": {
        "serviceName": "<service name>",
        "serviceDescription": "<service description>",
        "serviceProvider": "<service provider>",
        “version”: “<version>”,
        "serviceURL": "<service URL>",
        "serviceInvokeURL": "<service invocation URL>",
        "dataXformProvider": "<data transformation provider>",
        "serviceStatus": "<service status>"
    },
    "<service name>": {
        ( ... <service provider-specific information> ... )
    }
    }
}
Example response body

The following sample shows the JSON payload that is returned from the SAMPLE-1.0 service provider:

{ 
  "zosConnect": { 
    "serviceName": "recordOpsCreate",
    "serviceDescription": "Creates a new record", 
    "serviceProvider": "SAMPLE-1.0", 
    “version”: “1.1.0”
    "serviceURL": "https://host:port/zosConnect/services/recordOpsCreate", 
    "serviceInvokeURL": "https://host:port/zosConnect/services/recordOpsCreate?action=invoke",
    "dataXformProvider": "jsonByte-1.0", 
    "serviceStatus": "Started"
  }, 
  recordOpsCreate: { 
    "targetProgram": "CREATREC", 
    "timeout": "300ms" 
  } 
}
Note: Alternatively, use the HTTP method GET with the action=status query parameter to retrieve the status of a service. 
/zosConnect/services/{serviceName}?action=status
The sample response body is as follows:
{
    "zosConnect": 
    {
        "serviceName": "recordOpsCreate", 
        "serviceDescription": "Creates a new record", 
        "serviceProvider": "SAMPLE-1.0", 
        “version”: “1.1.0”
        "serviceURL": "https://host:port/zosConnect/services/recordOpsCreate",
        "serviceInvokeURL: "https://host:port/zosConnect/services/recordOpsCreate?action=invoke",
        "dataXformProvider: "jsonByte-1.0",
        "serviceStatus: "Started"
  }
}