Jump to

• Request
• Response

Display the sip manipulation testing result

put

https://cloud-native-SBC-IP/status/v1/hmr/config/test

This operation displays the sip manipulation testing result

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Sip HMR test configuration

Show Source

• mDebugging: boolean
• mDirection: string
• mLocalIP: string
• mManipulationPattern: string
• mManipulationString: string
• mRemoteIP: string
• mSipManipulation: string
• mSipMessage: string
• mTGRPContext: string

{
    "type":"object",
    "description":"Sip HMR test configuration",
    "properties":{
        "mSipManipulation":{
            "type":"string"
        },
        "mDebugging":{
            "type":"boolean"
        },
        "mDirection":{
            "type":"string"
        },
        "mManipulationString":{
            "type":"string"
        },
        "mManipulationPattern":{
            "type":"string"
        },
        "mTGRPContext":{
            "type":"string"
        },
        "mLocalIP":{
            "type":"string"
        },
        "mRemoteIP":{
            "type":"string"
        },
        "mSipMessage":{
            "type":"string"
        }
    }
}

Back to Top

Response

200 Response

response containing a list of operation results from all targeted services/instance

Body ()

Root Schema : OperationResults

Type: object

List of operation results from services/instances

Show Source

• results: array results

{
    "type":"object",
    "description":"List of operation results from services/instances",
    "properties":{
        "results":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OperationResult"
            }
        }
    }
}

Nested Schema : results

Type: array

Show Source

• Array of: object OperationResult
  operation result for a particular service/instance

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OperationResult"
    }
}

Nested Schema : OperationResult

Type: object

operation result for a particular service/instance

Show Source

• error: string
• instance: string
• result(required): string
• service: string
  Allowed Values: [ "SE", "ME", "TE", "TC" ]

  core cnSBC micro-services (SE/ME/TE) plus TC which is used to get TEs

{
    "type":"object",
    "required":[
        "result"
    ],
    "description":"operation result for a particular service/instance",
    "properties":{
        "service":{
            "$ref":"#/components/schemas/Service"
        },
        "instance":{
            "type":"string"
        },
        "error":{
            "type":"string"
        },
        "result":{
            "type":"string"
        }
    }
}

400 Response

text description for a bad operation request response

Body ()

Root Schema : schema

Type: string

500 Response

text description for an internal server error response

Body ()

Root Schema : schema

Type: string

Back to Top