Jump to

• Request
• Response

Add a new config element: SD.sti-header-mapping-ruleset

post

https://cloud-native-SBC-IP/config/v1/sd/sti-header-mapping-ruleset

Add a new config element: SD.sti-header-mapping-ruleset

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

configure a set of rules for SIP and HTTP header mapping

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• mapping-rules: array mapping-rules
  list of rules required for SIP and HTTP header mapping
• name(required): string
  Minimum Length: 1

  Pattern: ^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  name of the instance of sti-header-mapping-ruleset

{
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "description":"name of the instance of sti-header-mapping-ruleset",
            "minLength":1,
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "mapping-rules":{
            "description":"list of rules required for SIP and HTTP header mapping",
            "items":{
                "$ref":"#/components/schemas/StiHeaderMappingRules"
            },
            "type":"array"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure a set of rules for SIP and HTTP header mapping",
    "type":"object"
}

Nested Schema : mapping-rules

Type: array

list of rules required for SIP and HTTP header mapping

Show Source

• Array of: object StiHeaderMappingRules
  list of SIP and HTTP header mapping rules

{
    "description":"list of rules required for SIP and HTTP header mapping",
    "items":{
        "$ref":"#/components/schemas/StiHeaderMappingRules"
    },
    "type":"array"
}

Nested Schema : StiHeaderMappingRules

Type: object

list of SIP and HTTP header mapping rules

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• direction: string
  Allowed Values: [ "outbound", "inbound" ]
• id(required): string
  Minimum Length: 1

  Pattern: ^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  unique identifier for the mapping rule
• role: string
  Allowed Values: [ "STI-AS", "STI-VS" ]
• source-header: string
  Pattern: ^$|^[A-Za-z0-9@.!%*_+`'~-]+(\[(([0-9]+)|([~^]))\])?$

  name of the SIP or HTTP header to be picked from the ingress INVITE or HTTP response
• source-param: string
  Pattern: ^$|^[A-Za-z0-9@.!%*_+`'~-]+(;.+)?$

  SIP or HTTP header param based on the source header. If source-header is empty, this should be a key in HTTP body JSON claim
• target-header: string
  Pattern: ^$|^[A-Za-z0-9@.!%*_+`'~-]+(\[(([0-9]+)|([~^]))\])?$

  name of the SIP or HTTP header to be added or modified to the egress INVITE or the HTTP request
• target-param: string
  Pattern: ^$|^[A-Za-z0-9@.!%*_+`'~-]+(;.+)?$

  SIP or HTTP header param based on target header. If target-header is empty, this should be a key in HTTP body JSON claim

{
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "description":"unique identifier for the mapping rule",
            "minLength":1,
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "source-header":{
            "description":"name of the SIP or HTTP header to be picked from the ingress INVITE or HTTP response",
            "pattern":"^$|^[A-Za-z0-9@.!%*_+`'~-]+(\\[(([0-9]+)|([~^]))\\])?$",
            "type":"string"
        },
        "source-param":{
            "description":"SIP or HTTP header param based on the source header. If source-header is empty, this should be a key in HTTP body JSON claim",
            "pattern":"^$|^[A-Za-z0-9@.!%*_+`'~-]+(;.+)?$",
            "type":"string"
        },
        "target-header":{
            "description":"name of the SIP or HTTP header to be added or modified to the egress INVITE or the HTTP request",
            "pattern":"^$|^[A-Za-z0-9@.!%*_+`'~-]+(\\[(([0-9]+)|([~^]))\\])?$",
            "type":"string"
        },
        "target-param":{
            "description":"SIP or HTTP header param based on target header. If target-header is empty, this should be a key in HTTP body JSON claim",
            "pattern":"^$|^[A-Za-z0-9@.!%*_+`'~-]+(;.+)?$",
            "type":"string"
        },
        "direction":{
            "$ref":"#/components/schemas/StiHeaderMappingDirectionConstraintEnum"
        },
        "role":{
            "$ref":"#/components/schemas/StiServerRoleConstraintEnum"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"list of SIP and HTTP header mapping rules",
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

return one config element: StiHeaderMappingRuleset

Body ()

Root Schema : schema

Type: object

configure a set of rules for SIP and HTTP header mapping

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• mapping-rules: array mapping-rules
  list of rules required for SIP and HTTP header mapping
• name(required): string
  Minimum Length: 1

  Pattern: ^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  name of the instance of sti-header-mapping-ruleset

{
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "description":"name of the instance of sti-header-mapping-ruleset",
            "minLength":1,
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "mapping-rules":{
            "description":"list of rules required for SIP and HTTP header mapping",
            "items":{
                "$ref":"#/components/schemas/StiHeaderMappingRules"
            },
            "type":"array"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"configure a set of rules for SIP and HTTP header mapping",
    "type":"object"
}

Nested Schema : mapping-rules

Type: array

list of rules required for SIP and HTTP header mapping

Show Source

• Array of: object StiHeaderMappingRules
  list of SIP and HTTP header mapping rules

{
    "description":"list of rules required for SIP and HTTP header mapping",
    "items":{
        "$ref":"#/components/schemas/StiHeaderMappingRules"
    },
    "type":"array"
}

Nested Schema : StiHeaderMappingRules

Type: object

list of SIP and HTTP header mapping rules

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• direction: string
  Allowed Values: [ "outbound", "inbound" ]
• id(required): string
  Minimum Length: 1

  Pattern: ^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$

  unique identifier for the mapping rule
• role: string
  Allowed Values: [ "STI-AS", "STI-VS" ]
• source-header: string
  Pattern: ^$|^[A-Za-z0-9@.!%*_+`'~-]+(\[(([0-9]+)|([~^]))\])?$

  name of the SIP or HTTP header to be picked from the ingress INVITE or HTTP response
• source-param: string
  Pattern: ^$|^[A-Za-z0-9@.!%*_+`'~-]+(;.+)?$

  SIP or HTTP header param based on the source header. If source-header is empty, this should be a key in HTTP body JSON claim
• target-header: string
  Pattern: ^$|^[A-Za-z0-9@.!%*_+`'~-]+(\[(([0-9]+)|([~^]))\])?$

  name of the SIP or HTTP header to be added or modified to the egress INVITE or the HTTP request
• target-param: string
  Pattern: ^$|^[A-Za-z0-9@.!%*_+`'~-]+(;.+)?$

  SIP or HTTP header param based on target header. If target-header is empty, this should be a key in HTTP body JSON claim

{
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "description":"unique identifier for the mapping rule",
            "minLength":1,
            "pattern":"^[A-Za-z0-9_][A-Za-z0-9._\\-]{0,127}$",
            "type":"string"
        },
        "source-header":{
            "description":"name of the SIP or HTTP header to be picked from the ingress INVITE or HTTP response",
            "pattern":"^$|^[A-Za-z0-9@.!%*_+`'~-]+(\\[(([0-9]+)|([~^]))\\])?$",
            "type":"string"
        },
        "source-param":{
            "description":"SIP or HTTP header param based on the source header. If source-header is empty, this should be a key in HTTP body JSON claim",
            "pattern":"^$|^[A-Za-z0-9@.!%*_+`'~-]+(;.+)?$",
            "type":"string"
        },
        "target-header":{
            "description":"name of the SIP or HTTP header to be added or modified to the egress INVITE or the HTTP request",
            "pattern":"^$|^[A-Za-z0-9@.!%*_+`'~-]+(\\[(([0-9]+)|([~^]))\\])?$",
            "type":"string"
        },
        "target-param":{
            "description":"SIP or HTTP header param based on target header. If target-header is empty, this should be a key in HTTP body JSON claim",
            "pattern":"^$|^[A-Za-z0-9@.!%*_+`'~-]+(;.+)?$",
            "type":"string"
        },
        "direction":{
            "$ref":"#/components/schemas/StiHeaderMappingDirectionConstraintEnum"
        },
        "role":{
            "$ref":"#/components/schemas/StiServerRoleConstraintEnum"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "description":"list of SIP and HTTP header mapping rules",
    "type":"object"
}

404 Response

Not Found

Body ()

Root Schema : ApiValidationError

Type: object

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• code: string
• errors: array errors
• message: string
• timestamp: string

{
    "properties":{
        "timestamp":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "errors":{
            "items":{
                "$ref":"#/components/schemas/Errors"
            },
            "type":"array"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

Show Source

• Array of: object Errors

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

Nested Schema : Errors

Type: object

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• attribute: string
• code: string
• message: string
• type: string
  Allowed Values: [ "error", "fatal", "warn" ]

{
    "properties":{
        "attribute":{
            "type":"string"
        },
        "type":{
            "$ref":"#/components/schemas/TypeEnum"
        },
        "message":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "type":"object"
}

406 Response

Validation Failure

Body ()

Root Schema : ApiValidationError

Type: object

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• code: string
• errors: array errors
• message: string
• timestamp: string

{
    "properties":{
        "timestamp":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "errors":{
            "items":{
                "$ref":"#/components/schemas/Errors"
            },
            "type":"array"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

Show Source

• Array of: object Errors

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

Nested Schema : Errors

Type: object

Show Source

• _elementKey: string
  Read Only: true

  Identifier for the element or sub-element
• attribute: string
• code: string
• message: string
• type: string
  Allowed Values: [ "error", "fatal", "warn" ]

{
    "properties":{
        "attribute":{
            "type":"string"
        },
        "type":{
            "$ref":"#/components/schemas/TypeEnum"
        },
        "message":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "_elementKey":{
            "description":"Identifier for the element or sub-element",
            "readOnly":true,
            "type":"string"
        }
    },
    "type":"object"
}

Back to Top