REST API for the Management Service in Oracle API Platform Cloud Service

Create a Service

post

/apiplatform/management/v1/services

Creates a Service.

Users requesting this resource must be assigned the Service Manager role.

Request

Supported Media Types

application/json

Root Schema : CreateServiceRequest

Match All

Show Source

object ServiceIdentity
object ServiceDef
object ServiceState

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

Nested Schema : ServiceIdentity

Type: object

Show Source

name: string

The service's name.
version(optional): string

The service's version.

{
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"The service's name."
        },
        "version":{
            "type":"string",
            "description":"The service's version."
        }
    }
}

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 : ServiceState

Type: object

Show Source

state(optional): string

The service's state. ACTIVE indicates it can be referenced in policies; INACTIVE indicates it can't be referenced in policies.
stateComments(optional): string

Comments about the service's state.
stateUpdatedAt(optional): string

The date and time the service state was last updated.
stateUpdatedBy(optional): string

The user who last updated the service state.

{
    "type":"object",
    "properties":{
        "state":{
            "type":"string",
            "description":"The service's state. <code>ACTIVE</code> indicates it can be referenced in policies; <code>INACTIVE</code> indicates it can't be referenced in policies."
        },
        "stateComments":{
            "type":"string",
            "description":"Comments about the service's state."
        },
        "stateUpdatedBy":{
            "type":"string",
            "description":"The user who last updated the service state."
        },
        "stateUpdatedAt":{
            "type":"string",
            "description":"The date and time the service state was last updated."
        }
    }
}

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)."
        }
    }
}

Response

Supported Media Types

application/json

201 Response

The service was created.

Root Schema : ServiceId

Type: object

Show Source

id: string

The service's ID.

{
    "type":"object",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The service's ID."
        }
    }
}

400 Response

Bad request, indicates a problem with the input parameters.

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.

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.

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"
    }
}

Examples

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

curl -i -X POST 
-H "Authorization: Bearer access_token"
-H "Content-Type:application/json"
-d @services-post.json
https://example.com/apiplatform/management/v1/services

Example of Request Body

The following shows an example of the request body in JSON format (included with the request above in a file named services-post.json) including details about the new service.

{
    "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 201 Created
Server: Oracle-Traffic-Director/12.2.1.0.0
Date: Wed, 26 Jul 2017 17:10:11 GMT
Content-Length:  12
Content-type: application/json
X-oracle-dms-ecid: kKFfG1P0000000000
X-oracle-dms-rid: 0:1
Via: 1.1 otd_opc-config
Proxy-agent: Oracle-Traffic-Director/12.2.1.2.0

Example of Response Body

The following example shows the contents of the response body in JSON format, including the ID of the created service.

{ 
    "id": "100"
}