Jump to

• Request
• Response
• Examples

Update a Service

put

/apiplatform/management/v1/services/{serviceId}

Updates the {serviceId} service.

Users requesting this resource must be assigned the Service Manager role and must be issued the Manage Service grant for the specified service.

Request

Supported Media Types

• application/json

Path Parameters

• serviceId: string
  A unique ID referencing a specific service.

Body ()

Root Schema : UpdateServiceRequest

Match All

Show Source

• object ServiceDef

{
    "allOf":[
        {
            "$ref":"#/definitions/ServiceDef"
        }
    ]
}

Nested Schema : ServiceDef

Type: object

Show Source

• description(optional): string
  The service's description.
• implementation(optional): object implementation
  The service's configuration.
• specification(optional): object specification
  The service's configuration.
• type(optional): string
  The service's type. One of HTTP, REST or SOAP.

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string",
            "description":"The service's description."
        },
        "type":{
            "type":"string",
            "description":"The service's type. One of HTTP, REST or SOAP."
        },
        "implementation":{
            "type":"object",
            "description":"The service's configuration.",
            "properties":{
            }
        },
        "specification":{
            "type":"object",
            "description":"The service's configuration.",
            "properties":{
                "wsdl":{
                    "type":"object",
                    "description":"The WSDL specification configuration",
                    "properties":{
                        "artifact":{
                            "type":"string",
                            "description":"pathname of the artifact."
                        },
                        "root":{
                            "type":"string",
                            "description":"in case the artifact is a ZIP file containing WSDLs and XML Schemas, root points to the root WSDL defining the SOAP service.."
                        },
                        "binding":{
                            "type":"string",
                            "description":"binding defining the SOAP service (as a QName)."
                        }
                    }
                },
                "type":{
                    "type":"string",
                    "description":"The specification type. Currently limited to WSDL."
                }
            }
        }
    }
}

Nested Schema : implementation

Type: object

The service's configuration.

Show Source

{
    "type":"object",
    "description":"The service's configuration.",
    "properties":{
    }
}

Nested Schema : specification

Type: object

The service's configuration.

Show Source

• type(optional): string
  The specification type. Currently limited to WSDL.
• wsdl(optional): object wsdl
  The WSDL specification configuration

{
    "type":"object",
    "description":"The service's configuration.",
    "properties":{
        "wsdl":{
            "type":"object",
            "description":"The WSDL specification configuration",
            "properties":{
                "artifact":{
                    "type":"string",
                    "description":"pathname of the artifact."
                },
                "root":{
                    "type":"string",
                    "description":"in case the artifact is a ZIP file containing WSDLs and XML Schemas, root points to the root WSDL defining the SOAP service.."
                },
                "binding":{
                    "type":"string",
                    "description":"binding defining the SOAP service (as a QName)."
                }
            }
        },
        "type":{
            "type":"string",
            "description":"The specification type. Currently limited to WSDL."
        }
    }
}

Nested Schema : wsdl

Type: object

The WSDL specification configuration

Show Source

• artifact(optional): string
  pathname of the artifact.
• binding(optional): string
  binding defining the SOAP service (as a QName).
• root(optional): string
  in case the artifact is a ZIP file containing WSDLs and XML Schemas, root points to the root WSDL defining the SOAP service..

{
    "type":"object",
    "description":"The WSDL specification configuration",
    "properties":{
        "artifact":{
            "type":"string",
            "description":"pathname of the artifact."
        },
        "root":{
            "type":"string",
            "description":"in case the artifact is a ZIP file containing WSDLs and XML Schemas, root points to the root WSDL defining the SOAP service.."
        },
        "binding":{
            "type":"string",
            "description":"binding defining the SOAP service (as a QName)."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

The service was updated.

400 Response

Bad request, indicates a problem with the input parameters.

Body ()

Root Schema : Error

Type: object

Show Source

• detail(optional): string
  Detailed error message
• errorCode(optional): string
  Application specific error code
• errorDetails(optional): array errorDetails
  additional errors
• errorPath(optional): string
• instance(optional): string
  URI to the link that provides more detail about the error
• status(optional): string
  HTTP status code
• title: string
  Summary error message
• type: string
  Error type

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code"
        },
        "errorDetails":{
            "type":"array",
            "description":"additional errors",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errorDetails

Type: array

additional errors

Show Source

• Array of: object Error

{
    "type":"array",
    "description":"additional errors",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

403 Response

Forbidden.

Body ()

Root Schema : Error

Type: object

Show Source

• detail(optional): string
  Detailed error message
• errorCode(optional): string
  Application specific error code
• errorDetails(optional): array errorDetails
  additional errors
• errorPath(optional): string
• instance(optional): string
  URI to the link that provides more detail about the error
• status(optional): string
  HTTP status code
• title: string
  Summary error message
• type: string
  Error type

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code"
        },
        "errorDetails":{
            "type":"array",
            "description":"additional errors",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errorDetails

Type: array

additional errors

Show Source

• Array of: object Error

{
    "type":"array",
    "description":"additional errors",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

500 Response

Unexpected error.

Body ()

Root Schema : Error

Type: object

Show Source

• detail(optional): string
  Detailed error message
• errorCode(optional): string
  Application specific error code
• errorDetails(optional): array errorDetails
  additional errors
• errorPath(optional): string
• instance(optional): string
  URI to the link that provides more detail about the error
• status(optional): string
  HTTP status code
• title: string
  Summary error message
• type: string
  Error type

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code"
        },
        "errorDetails":{
            "type":"array",
            "description":"additional errors",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errorDetails

Type: array

additional errors

Show Source

• Array of: object Error

{
    "type":"array",
    "description":"additional errors",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

Back to Top

Examples

The following example shows how to update a service by submitting a PUT request on the REST resource using cURL. For more information about cURL, see Use cURL

curl -i -X PUT 
-u apicsadmin:password
-H "Content-Type:application/json"
-d @service-update.json
https://example.com/apiplatform/management/v1/services/{serviceId}

where {serviceId} is a unique Id of a specific service. See Get Services.

Example of Request Body

The following shows an example of the request body, included with the request above in a file named service-update.json.

{
    "name": "traffic",
    "description": "canned service",
    "implementation": {
        "executions": {
            "request":  [ "1"  ],
            "response": [ "2" ]
        },
        "policies": [
            {
                "id": "1",
                "type": "o:BackendRequest",
                "version": "1.0",
                "config": {
                    "endpoints": [
                        {
                            "url":  "http://host:80/endpoint"
                        }
                    ]
                }
            },
            {
                "id": "2",
                "type": "o:BackendResponse",
                "version": "1.0",
                "config": {}
            }
        ]
    }
}

Example of Response Headers

The following shows an example of the response headers.

HTTP/1.1 204 No Content
Server: Oracle-Traffic-Director/12.2.1.0.0
Date:  Sun, 22 Oct 2017 08:34:10 GMT
X-oracle-dms-ecid:  49d14691-2176-4c99-aed3-38438604f528-00001e4e
X-oracle-dms-rid: 0:1
Via: 1.1 otd_opc
Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0

Back to Top