Jump to

• Request
• Response
• Examples

Update an application

put

/developers/services/v1/applications/{id}

Updates the {appId} application.

Users requesting this resource must be assigned the API Manager, Plan Manager, or Application Developer role and be issued the Manage Application grant for the application.

Request

Path Parameters

• appId: string
  A unique ID referencing a specific application.

Body ()

Root Schema : UpdateApplicationRequest

Match All

Show Source

• object UpdateApplicationRequest-allOf[0]
• object ApplicationDef

{
    "allOf":[
        {
            "type":"object",
            "properties":{
                "name":{
                    "type":"string"
                }
            }
        },
        {
            "$ref":"#/definitions/ApplicationDef"
        }
    ]
}

Nested Schema : UpdateApplicationRequest-allOf[0]

Type: object

Show Source

• name(optional): string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        }
    }
}

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":{
        "types":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "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."
                }
            }
        },
        "description":{
            "type":"string",
            "description":"The application's description."
        }
    }
}

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

204 Response

The application 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":{
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "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":{
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "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":{
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "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 an {appId} application 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
https://example.com:443/developers/services/v1/applications/{id}

{id} is the unique ID for an application. To retrieve available applications, see Get applications.

Example of Request Body

The following shows an example of the request body.

{
 "name": "Temperature",
 "description":"Application for Temperature",
 "contact": {"firstName":"John", "lastName":"Fernandaz", "phone":"87654321", "company": "oracle", "email":"[e-mail]"},
  }

Example of Response Headers

The following shows an example of the response headers.

HTTP/1.1 204 No Content
Server: Oracle Traffic Director
Date: Wed, 20 Dec 2017 05:19:46 GMT
Content-type: application/json
X-oracle-dms-ecid: 6^3rv0_eR00000000
X-oracle-dms-rid: 0:1

Back to Top