Update a service

Use the HTTP method PUT to update a IBM® z/OS® Connect service.
By default, a service has the status started. However, it can be set to a specific initial status by appending a query string to the URI with a status. For example:

/zosConnect/services/{serviceName}?status=stopped
HTTP method
PUT
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: Added in V1.1.0 of the administration interface.
Description
Updates the named service in IBM z/OS Connect.
Note: The service needs to be stopped before updating.
Security
Users with Admin or Operations authority can update a service, users with Invoke or Reader authority cannot. For more information about user authorization, see Overview of IBM z/OS Connect security.
Request body
The service archive file. The content type for the request is application/zip.
Response body
Note: The enhanced administration interface V1.2.0 includes version information for services in the response body.
{
    "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
{
    "zosConnect": {
        "serviceName": "patient",
        "serviceDescription": "Patient lookup service",
        "serviceProvider": "imsmobile-2.0",
        “version”: “1.1.0”
        "ServiceURL": "https://server1.mycom.com:53633/zosConnect/services/patientService",
        "serviceInvokeURL": "https://server1.mycom.com:53633/zosConnect/services/patientService?action=invoke",
        "dataXformProvider": "DATA_UNAVAILABLE",
        "serviceStatus": "Started"
    },
    "patient": {
        "imsServiceType": "ims-sar",
        "serviceDescription": "Patient lookup service",
        "id": "patient",
        "tranCode": "IVTNO",
        "serviceProviderName": "imsmobile-2.0",
        "status": "Started"
    }
}
Errors
The following errors can occur:
400 Bad request
Invalid or missing service archive

409 Conflict
A z/OS Connect service must be stopped before it can be updated.

415 Unsupported Media Type
Content-Type is not application/zip:

500 Internal Server Error
Server issue, might require administrator intervention.