Jump to

• Request
• Response
• Examples

Create an application

post

/apiplatform/management/v1/applications

Creates an application.

Users requesting this resource must be assigned the API Manager, Plan Manager, or Application Developer role.

Request

Supported Media Types

• application/json

Body ()

Root Schema : CreateApplicationRequest

Match All

Show Source

• object ApplicationIdentity
• object ApplicationDef
• object ApplicationKey

{
    "allOf":[
        {
            "$ref":"#/definitions/ApplicationIdentity"
        },
        {
            "$ref":"#/definitions/ApplicationDef"
        },
        {
            "$ref":"#/definitions/ApplicationKey"
        }
    ]
}

Nested Schema : ApplicationIdentity

Type: object

Show Source

• name: string
  The application's name.

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

Nested Schema : ApplicationDef

Type: object

Show Source

• contact(optional): object contact
  The application owner's contact information.
• description(optional): string
  The application's description.
• types(optional): array types

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string",
            "description":"The application's description."
        },
        "contact":{
            "type":"object",
            "description":"The application owner's contact information.",
            "properties":{
                "firstName":{
                    "type":"string",
                    "description":"The owner's first name."
                },
                "lastName":{
                    "type":"string",
                    "description":"The owner's last name."
                },
                "phone":{
                    "type":"string",
                    "description":"The owner's phone number."
                },
                "company":{
                    "type":"string",
                    "description":"The owner's company."
                },
                "email":{
                    "type":"string",
                    "description":"The owner's email address."
                }
            }
        },
        "types":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : ApplicationKey

Type: object

Show Source

• key(optional): string
  The application's key.

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string",
            "description":"The application's key."
        }
    }
}

Nested Schema : contact

Type: object

The application owner's contact information.

Show Source

• company(optional): string
  The owner's company.
• email(optional): string
  The owner's email address.
• firstName(optional): string
  The owner's first name.
• lastName(optional): string
  The owner's last name.
• phone(optional): string
  The owner's phone number.

{
    "type":"object",
    "description":"The application owner's contact information.",
    "properties":{
        "firstName":{
            "type":"string",
            "description":"The owner's first name."
        },
        "lastName":{
            "type":"string",
            "description":"The owner's last name."
        },
        "phone":{
            "type":"string",
            "description":"The owner's phone number."
        },
        "company":{
            "type":"string",
            "description":"The owner's company."
        },
        "email":{
            "type":"string",
            "description":"The owner's email address."
        }
    }
}

Nested Schema : types

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

The application was created.

Body ()

Root Schema : ApplicationId

Type: object

Show Source

• id: string
  The application's ID.

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

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 create an application 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 @app.json
https://example.com/apiplatform/management/v1/applications

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 app.json) , including details about the new application.

{
 "name": "Temperature",
 "description":"Application for Temperature",
 "contact": {" firstName":"John","lastName":"Richard", "email":"[e-mail]","phone":"011-223-456","company":"example"},
  "types": [ "100"]
}

Example of Response Headers

The following shows an example of the response headers.

HTTP/1.1 200 OK
Server: Oracle-Traffic-Director/12.2.1.0.0
Date:  Thu, 16 Mar 2017 07:24:42 GMT
Content-Length:  12
Content-Type:  application/json
X-oracle-dms-ecid:  f102c33f-1c5b-4409-806d-03bf5706c492-000267d0
X-oracle-dms-rid: 0:1
Via: 1.1 otd_opc
Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0

Example of Response Body

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

{
    "id": "103"
}

Back to Top