Skip to content

app_qoe

Overview

API to add, delete, get, modify global application qoe

Version information

Version : v2

URI scheme

Host :
BasePath : /sdwan/nitro/v2/config_editor/
Schemes : HTTP

Tags

  • app_qoe : Operations related to app_qoe

Paths

POST operation for app_qoe

POST /app_qoe

Description

This operation is to add application QoE objects

Responses

HTTP Code Description Schema
200 Resource successfully added app_qoe_post_success_schema
400 Failed: bad input parameter ErrorSchema
401 Unauthorized: Failed Authentication ErrorSchema
403 Unauthorized: Forbidden ErrorSchema
405 Failed: Data format unacceptable ErrorSchema
415 Failed: Data format unacceptable ErrorSchema
500 Failed: Internal Server Error ErrorSchema

Produces

  • application/json

Tags

  • app_qoe

Get operation for app_qoe

GET /app_qoe

Description

This operation is to get the application QoE objects

Responses

HTTP Code Description Schema
200 API Successfully executed app_qoe_response_schema
400 Failed: bad input parameter ErrorSchema
401 Unauthorized: Failed Authentication ErrorSchema
403 Unauthorized: Forbidden ErrorSchema
405 Failed: Data format unacceptable ErrorSchema
415 Failed: Data format unacceptable ErrorSchema
500 Failed: Internal Server Error ErrorSchema

Produces

  • application/json

Tags

  • app_qoe

PUT operation for app_qoe

PUT /app_qoe

Description

This operation is to modify existing application QoE object

Parameters

Type Name Schema
Body body
optional
app_qoe_request_schema

Responses

HTTP Code Description Schema
200 Resource modified added app_qoe_put_success_schema
400 Failed: bad input parameter ErrorSchema
401 Unauthorized: Failed Authentication ErrorSchema
403 Unauthorized: Forbidden ErrorSchema
405 Failed: Data format unacceptable ErrorSchema
415 Failed: Data format unacceptable ErrorSchema
500 Failed: Internal Server Error ErrorSchema

Consumes

  • application/json

Produces

  • application/json

Tags

  • app_qoe

DELETE operation for app_qoe

DELETE /app_qoe/{deletePathParam}

Description

This operation is to delete the application QoE object

Parameters

Type Name Description Schema
Path deletePathParam
required
Object Primary Key for DELETE operation object

Responses

HTTP Code Description Schema
200 Resource delete added app_qoe_delete_success_schema
400 Failed: bad input parameter ErrorSchema
401 Unauthorized: Failed Authentication ErrorSchema
403 Unauthorized: Forbidden ErrorSchema
405 Failed: Data format unacceptable ErrorSchema
415 Failed: Data format unacceptable ErrorSchema
500 Failed: Internal Server Error ErrorSchema

Produces

  • application/json

Tags

  • app_qoe

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

app_qoe

Name Schema
application_name
optional
application_name
application_object_name
optional
application_object_name
id
optional
id
package_name
optional
package_name
qoe_profile
optional
qoe_profile
type
optional
type

app_qoe_delete_success_schema

Name Schema
app_qoe
optional
app_qoe

app_qoe

Name Description Schema
message
optional
Example : "resource deleted succesfully" string

app_qoe_post_success_schema

Name Schema
app_qoe
optional
app_qoe

app_qoe

Name Description Schema
message
optional
Example : "resource added succesfully" string

app_qoe_put_success_schema

Name Schema
app_qoe
optional
app_qoe

app_qoe

Name Description Schema
message
optional
Example : "resource modified succesfully" string

app_qoe_request_schema

Name Schema
app_qoe
optional
app_qoe

app_qoe_response_schema

Type : < app_qoe_response_schema > array

app_qoe_response_schema

Name Schema
application_name
optional
application_name
application_object_name
optional
application_object_name
id
optional
id
package_name
optional
package_name
qoe_profile
optional
qoe_profile
type
optional
type

application_name

Application name

Type : string

application_object_name

Application object name

Type : string

id

Auto-generated ID to uniquely identify application qoe

Type : integer

package_name

Config package name using which the API operation should be performed.

Type : string

qoe_profile

QoE profile to be applied to the application QoE

Type : string

type

Specifies whether the QoE entry is for an application or an application object

Type : enum (application, application_objects)