Jump to

• Request
• Response
• Examples

Partially Update Configuration Objects

patch

/pdc/config

Updates a subset of attributes in the configuration object you specify.

You must pass the type query parameter set to the type of configuration object to update. The request payload must include the attributes you want to update and one of the following attributes:

• name: The configuration object's name.
• internalId: The unique ID (UUID) internally generated by Pricing Design Center when the pricing configuration was committed. You must include this attribute to update the name of the configuration object.

Request

Query Parameters

• type(required): string
  The configuration object's type.

  Valid pricing configuration objects: ZONE_RESULT_CONFIGURATION, VALUE_MAP, STANDARD_ZONE_MODEL, GEO_ZONE_MODEL, BALANCE_ELEMENT, RUM_CONFIGURATION, HOLIDAY_CALENDAR, ATTRIBUTE_SPEC_MAP, BUSINESS_PROFILE, ITEM_TYPE_SELECTOR, CUSTOM_ANALYZER_RULE, POLICY_SPECIFICATION, DYNAMIC_QUOTA_SELECTOR, POLICY_LABEL, DELIVERABLE, PSCTEMPLATE, TAX_CODE, TAX_EXEMPTION_CODE, or PRICE_TAG_CONFIG.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• attributeSpecMaps: array attributeSpecMaps
• balanceElements: array balanceElements
• businessProfiles: array businessProfiles
• customAnalyzerRules: array customAnalyzerRules
• deliverables: array deliverables
• dynamicQuotaSelectors: array dynamicQuotaSelectors
• geoZoneModel: array geoZoneModel
• holidayCalendar: array holidayCalendar
• itemTypeSelectors: array itemTypeSelectors
• policyLabels: array policyLabels
• policySpecifications: array policySpecifications
• priceTagConfigs: array priceTagConfigs
• productSpecCharacteristicTemplates: array productSpecCharacteristicTemplates
• rumConfigurations: array rumConfigurations
• standardZoneModel: array standardZoneModel
• taxCodes: array taxCodes
• taxExemptionCodes: array taxExemptionCodes
• valueMap: array valueMap
• zoneResultConfiguration: array zoneResultConfiguration

{
    "properties":{
        "taxCodes":{
            "items":{
                "$ref":"#/components/schemas/TaxCodeJXB"
            },
            "type":"array"
        },
        "taxExemptionCodes":{
            "items":{
                "$ref":"#/components/schemas/TaxExemptionCodeJXB"
            },
            "type":"array"
        },
        "zoneResultConfiguration":{
            "items":{
                "$ref":"#/components/schemas/ZoneResultConfigurationJXB"
            },
            "type":"array"
        },
        "holidayCalendar":{
            "items":{
                "$ref":"#/components/schemas/HolidayCalendarJXB"
            },
            "type":"array"
        },
        "balanceElements":{
            "items":{
                "$ref":"#/components/schemas/BalanceElementJXB"
            },
            "type":"array"
        },
        "rumConfigurations":{
            "items":{
                "$ref":"#/components/schemas/RumConfigurationJXB"
            },
            "type":"array"
        },
        "valueMap":{
            "items":{
                "$ref":"#/components/schemas/ValueMapJXB"
            },
            "type":"array"
        },
        "businessProfiles":{
            "items":{
                "$ref":"#/components/schemas/BusinessProfileJXB"
            },
            "type":"array"
        },
        "itemTypeSelectors":{
            "items":{
                "$ref":"#/components/schemas/ItemTypeSelectorJXB"
            },
            "type":"array"
        },
        "dynamicQuotaSelectors":{
            "items":{
                "$ref":"#/components/schemas/DynamicQuotaSelectorJXB"
            },
            "type":"array"
        },
        "standardZoneModel":{
            "items":{
                "$ref":"#/components/schemas/StandardZoneModelJXB"
            },
            "type":"array"
        },
        "geoZoneModel":{
            "items":{
                "$ref":"#/components/schemas/GeoZoneModelJXB"
            },
            "type":"array"
        },
        "attributeSpecMaps":{
            "items":{
                "$ref":"#/components/schemas/AttributeSpecMapJXB"
            },
            "type":"array"
        },
        "customAnalyzerRules":{
            "items":{
                "$ref":"#/components/schemas/CustomAnalyzerRuleJXB"
            },
            "type":"array"
        },
        "policySpecifications":{
            "items":{
                "$ref":"#/components/schemas/PolicySpecificationJXB"
            },
            "type":"array"
        },
        "policyLabels":{
            "items":{
                "$ref":"#/components/schemas/PolicyLabelJXB"
            },
            "type":"array"
        },
        "deliverables":{
            "items":{
                "$ref":"#/components/schemas/DeliverableJXB"
            },
            "type":"array"
        },
        "productSpecCharacteristicTemplates":{
            "items":{
                "$ref":"#/components/schemas/ProductSpecCharacteristicTemplateJXB"
            },
            "type":"array"
        },
        "priceTagConfigs":{
            "items":{
                "$ref":"#/components/schemas/PriceTagConfigJXB"
            },
            "type":"array"
        }
    },
    "type":"object"
}

Nested Schema : attributeSpecMaps

Type: array

Show Source

• Array of: object AttributeSpecMapJXB

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

Nested Schema : balanceElements

Type: array

Show Source

• Array of: object BalanceElementJXB

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

Nested Schema : businessProfiles

Type: array

Show Source

• Array of: object BusinessProfileJXB

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

Nested Schema : customAnalyzerRules

Type: array

Show Source

• Array of: object CustomAnalyzerRuleJXB

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

Nested Schema : deliverables

Type: array

Show Source

• Array of: object DeliverableJXB

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

Nested Schema : dynamicQuotaSelectors

Type: array

Show Source

• Array of: object DynamicQuotaSelectorJXB

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

Nested Schema : geoZoneModel

Type: array

Show Source

• Array of: object GeoZoneModelJXB

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

Nested Schema : holidayCalendar

Type: array

Show Source

• Array of: object HolidayCalendarJXB

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

Nested Schema : itemTypeSelectors

Type: array

Show Source

• Array of: object ItemTypeSelectorJXB

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

Nested Schema : policyLabels

Type: array

Show Source

• Array of: object PolicyLabelJXB

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

Nested Schema : policySpecifications

Type: array

Show Source

• Array of: object PolicySpecificationJXB

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

Nested Schema : priceTagConfigs

Type: array

Show Source

• Array of: object PriceTagConfigJXB

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

Nested Schema : productSpecCharacteristicTemplates

Type: array

Show Source

• Array of: object ProductSpecCharacteristicTemplateJXB

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

Nested Schema : rumConfigurations

Type: array

Show Source

• Array of: object RumConfigurationJXB

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

Nested Schema : standardZoneModel

Type: array

Show Source

• Array of: object StandardZoneModelJXB

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

Nested Schema : taxCodes

Type: array

Show Source

• Array of: object TaxCodeJXB

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

Nested Schema : taxExemptionCodes

Type: array

Show Source

• Array of: object TaxExemptionCodeJXB

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

Nested Schema : valueMap

Type: array

Show Source

• Array of: object ValueMapJXB

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

Nested Schema : zoneResultConfiguration

Type: array

Show Source

• Array of: object ZoneResultConfigurationJXB

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

Nested Schema : AttributeSpecMapJXB

Type: object

Show Source

• customerSpecName: string
• description: string
• eventRUMSpec: array eventRUMSpec
• externalID: string
• internalId: string
• name: string
• newName: string
• obsolete: boolean
• priceListName: string
• productSpecName: string

{
    "properties":{
        "name":{
            "type":"string"
        },
        "newName":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "internalId":{
            "type":"string"
        },
        "priceListName":{
            "type":"string"
        },
        "obsolete":{
            "type":"boolean"
        },
        "eventRUMSpec":{
            "items":{
                "$ref":"#/components/schemas/EventRUMSpecJXB"
            },
            "type":"array"
        },
        "productSpecName":{
            "type":"string"
        },
        "customerSpecName":{
            "type":"string"
        },
        "externalID":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : eventRUMSpec

Type: array

Show Source

• Array of: object EventRUMSpecJXB

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

Nested Schema : EventRUMSpecJXB

Type: object

Show Source

• description: string
• eventSpecName: string
• externalID: string
• internalId: string
• name: string
• newName: string
• obsolete: boolean
• priceListName: string
• rumSpec: array rumSpec

{
    "properties":{
        "name":{
            "type":"string"
        },
        "newName":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "internalId":{
            "type":"string"
        },
        "priceListName":{
            "type":"string"
        },
        "obsolete":{
            "type":"boolean"
        },
        "eventSpecName":{
            "type":"string"
        },
        "rumSpec":{
            "items":{
                "$ref":"#/components/schemas/RUMSpecJXB"
            },
            "type":"array"
        },
        "externalID":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : rumSpec

Type: array

Show Source

• Array of: object RUMSpecJXB

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

Nested Schema : RUMSpecJXB

Type: object

Show Source

• rumExpression: object ARumExpressionJXB
• rumName: string

{
    "properties":{
        "rumExpression":{
            "$ref":"#/components/schemas/ARumExpressionJXB"
        },
        "rumName":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : ARumExpressionJXB

Type: object

Show Source

• binaryRUMExpression: object BinaryRUMExpressionJXB
• eventFieldExpression: object EventFieldExpressionJXB
• numericRumExpression: object NumericRumExpressionJXB

{
    "properties":{
        "binaryRUMExpression":{
            "$ref":"#/components/schemas/BinaryRUMExpressionJXB"
        },
        "numericRumExpression":{
            "$ref":"#/components/schemas/NumericRumExpressionJXB"
        },
        "eventFieldExpression":{
            "$ref":"#/components/schemas/EventFieldExpressionJXB"
        }
    },
    "type":"object"
}

Nested Schema : BinaryRUMExpressionJXB

Type: object

Show Source

• leftOperand: object ARumExpressionJXB
• operation: string
  Allowed Values: [ "ADD", "DIVIDE", "MULTIPLY", "SUBTRACT" ]
• rightOperand: object ARumExpressionJXB

{
    "properties":{
        "leftOperand":{
            "$ref":"#/components/schemas/ARumExpressionJXB"
        },
        "rightOperand":{
            "$ref":"#/components/schemas/ARumExpressionJXB"
        },
        "operation":{
            "$ref":"#/components/schemas/RumOperatorJXB"
        }
    },
    "type":"object"
}

Nested Schema : EventFieldExpressionJXB

Type: object

Show Source

• fieldName: string

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

Nested Schema : NumericRumExpressionJXB

Type: object

Show Source

• value: number (double)

{
    "properties":{
        "value":{
            "format":"double",
            "type":"number"
        }
    },
    "type":"object"
}

Nested Schema : BalanceElementJXB

Type: object

Show Source

• code: string
• consumptionRule: string
  Allowed Values: [ "EARLIEST_EXPIRATION", "EARLIEST_EXPIRATION_EARLIEST_START", "EARLIEST_EXPIRATION_LATEST_START", "EARLIEST_START", "EARLIEST_START_EARLIEST_EXPIRATION", "EARLIEST_START_LATEST_EXPIRATION", "LATEST_EXPIRATION", "LATEST_EXPIRATION_EARLIEST_START", "LATEST_EXPIRATION_LATEST_START", "LATEST_START", "LATEST_START_EARLIEST_EXPIRATION", "LATEST_START_LATEST_EXPIRATION", "NONE" ]

  Specify the order in which sub-balances of a balance element are consumed.
• counter: boolean
• description: string
• expiryNotification: boolean
• externalID: string
• foldable: boolean
• internalId: string
• name: string
• newName: string
• numericCode: integer (int64)
• obsolete: boolean
• priceListName: string
• roundingRules: array roundingRules
• symbol: string
• transientElement: boolean

{
    "properties":{
        "name":{
            "type":"string"
        },
        "newName":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "internalId":{
            "type":"string"
        },
        "priceListName":{
            "type":"string"
        },
        "obsolete":{
            "type":"boolean"
        },
        "code":{
            "type":"string"
        },
        "numericCode":{
            "format":"int64",
            "type":"integer"
        },
        "symbol":{
            "type":"string"
        },
        "transientElement":{
            "type":"boolean"
        },
        "foldable":{
            "type":"boolean"
        },
        "counter":{
            "type":"boolean"
        },
        "expiryNotification":{
            "type":"boolean"
        },
        "roundingRules":{
            "items":{
                "$ref":"#/components/schemas/RoundingRuleJXB"
            },
            "type":"array"
        },
        "consumptionRule":{
            "$ref":"#/components/schemas/ConsumptionRuleTypeJXB"
        },
        "externalID":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : roundingRules

Type: array

Show Source

• Array of: object RoundingRuleJXB

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

Nested Schema : RoundingRuleJXB

Type: object

Show Source

• applyToChildEvents: boolean
• eventName: string
• precision: integer
• processingStage: string
  Allowed Values: [ "ALTERATION", "AR", "CHARGING", "TAXATION" ]
• roundingMode: string
  Allowed Values: [ "DOWN", "DOWN_ALT", "EVEN", "FLOOR", "FLOOR_ALT", "NEAREST", "UP" ]

  Specifies how a RUM quantity is rounded.
• toleranceMax: number (double)
• toleranceMin: number (double)
• tolerancePercentage: number (double)

{
    "properties":{
        "eventName":{
            "type":"string"
        },
        "applyToChildEvents":{
            "type":"boolean"
        },
        "precision":{
            "type":"integer"
        },
        "toleranceMin":{
            "format":"double",
            "type":"number"
        },
        "toleranceMax":{
            "format":"double",
            "type":"number"
        },
        "tolerancePercentage":{
            "format":"double",
            "type":"number"
        },
        "roundingMode":{
            "$ref":"#/components/schemas/RoundingModeJXB"
        },
        "processingStage":{
            "$ref":"#/components/schemas/ProcessingStageJXB"
        }
    },
    "type":"object"
}

Nested Schema : BusinessProfileJXB

Type: object

Show Source

• businessProfileItems: array businessProfileItems
• businessProfileRules: array businessProfileRules
• description: string
• externalID: string
• internalId: string
• name: string
• newName: string
• obsolete: boolean
• priceListName: string

{
    "properties":{
        "name":{
            "type":"string"
        },
        "newName":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "internalId":{
            "type":"string"
        },
        "priceListName":{
            "type":"string"
        },
        "obsolete":{
            "type":"boolean"
        },
        "businessProfileRules":{
            "items":{
                "$ref":"#/components/schemas/BusinessProfileRuleJXB"
            },
            "type":"array"
        },
        "businessProfileItems":{
            "items":{
                "$ref":"#/components/schemas/BusinessProfileItemJXB"
            },
            "type":"array"
        },
        "externalID":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : businessProfileItems

Type: array

Show Source

• Array of: object BusinessProfileItemJXB

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

Nested Schema : businessProfileRules

Type: array

Show Source

• Array of: object BusinessProfileRuleJXB

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

Nested Schema : BusinessProfileItemJXB

Type: object

Show Source

• name: string
• value: string

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

Nested Schema : BusinessProfileRuleJXB

Type: object

Show Source

• rule: string

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

Nested Schema : CustomAnalyzerRuleJXB

Type: object

Show Source

• customRuleExpression: object CustomRuleExpressionJXB
• customRuleScopes: array customRuleScopes
• description: string
• externalID: string
• internalId: string
• name: string
• newName: string
• obsolete: boolean
• priceListName: string

{
    "properties":{
        "name":{
            "type":"string"
        },
        "newName":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "internalId":{
            "type":"string"
        },
        "priceListName":{
            "type":"string"
        },
        "obsolete":{
            "type":"boolean"
        },
        "customRuleScopes":{
            "items":{
                "$ref":"#/components/schemas/CustomRuleScopeJXB"
            },
            "type":"array"
        },
        "customRuleExpression":{
            "$ref":"#/components/schemas/CustomRuleExpressionJXB"
        },
        "externalID":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : CustomRuleExpressionJXB

Type: object

Show Source

• complexCRExpression: object ComplexCRExpressionJXB
• dynamicFieldCRExpression: object DynamicFieldCRExpressionJXB
• fieldToFieldCRExpression: object FieldToFieldCRExpressionJXB
• fieldToValueCRExpression: object FieldToValueCRExpressionJXB

{
    "properties":{
        "fieldToFieldCRExpression":{
            "$ref":"#/components/schemas/FieldToFieldCRExpressionJXB"
        },
        "fieldToValueCRExpression":{
            "$ref":"#/components/schemas/FieldToValueCRExpressionJXB"
        },
        "dynamicFieldCRExpression":{
            "$ref":"#/components/schemas/DynamicFieldCRExpressionJXB"
        },
        "complexCRExpression":{
            "$ref":"#/components/schemas/ComplexCRExpressionJXB"
        }
    },
    "type":"object"
}

Nested Schema : customRuleScopes

Type: array

Show Source

• Array of: object CustomRuleScopeJXB

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

Nested Schema : ComplexCRExpressionJXB

Type: object

Show Source

• leftOperand: object CustomRuleExpressionJXB
• operator: string
  Allowed Values: [ "AND", "EQUAL_TO", "GREATER_THAN", "GREATER_THAN_EQUAL", "INTERSECT", "IN_LIST", "LESS_THAN", "LESS_THAN_EQUAL", "NOT", "NOT_EQUAL_TO", "OR", "REGEX" ]
• rightOperand: object CustomRuleExpressionJXB
• seperator: string

{
    "properties":{
        "seperator":{
            "type":"string"
        },
        "operator":{
            "$ref":"#/components/schemas/CRExpressionOperatorJXB"
        },
        "leftOperand":{
            "$ref":"#/components/schemas/CustomRuleExpressionJXB"
        },
        "rightOperand":{
            "$ref":"#/components/schemas/CustomRuleExpressionJXB"
        }
    },
    "type":"object"
}

Nested Schema : DynamicFieldCRExpressionJXB

Type: object

Show Source

• lhsFieldIdentifier: object FieldIdentifierJXB
• operator: string
  Allowed Values: [ "AND", "EQUAL_TO", "GREATER_THAN", "GREATER_THAN_EQUAL", "INTERSECT", "IN_LIST", "LESS_THAN", "LESS_THAN_EQUAL", "NOT", "NOT_EQUAL_TO", "OR", "REGEX" ]
• rhsFieldIdentifier: object FieldIdentifierJXB
• seperator: string

{
    "properties":{
        "seperator":{
            "type":"string"
        },
        "operator":{
            "$ref":"#/components/schemas/CRExpressionOperatorJXB"
        },
        "lhsFieldIdentifier":{
            "$ref":"#/components/schemas/FieldIdentifierJXB"
        },
        "rhsFieldIdentifier":{
            "$ref":"#/components/schemas/FieldIdentifierJXB"
        }
    },
    "type":"object"
}

Nested Schema : FieldToFieldCRExpressionJXB

Type: object

Show Source

• lhsFieldKind: string
  Allowed Values: [ "CUSTOMER_SPEC_FIELD", "EVENT_SPEC_FIELD", "PRODUCT_SPEC_FIELD", "PROFILE_SPEC_FIELD" ]
• lhsFieldName: string
• operator: string
  Allowed Values: [ "AND", "EQUAL_TO", "GREATER_THAN", "GREATER_THAN_EQUAL", "INTERSECT", "IN_LIST", "LESS_THAN", "LESS_THAN_EQUAL", "NOT", "NOT_EQUAL_TO", "OR", "REGEX" ]
• rhsFieldKind: string
  Allowed Values: [ "CUSTOMER_SPEC_FIELD", "EVENT_SPEC_FIELD", "PRODUCT_SPEC_FIELD", "PROFILE_SPEC_FIELD" ]
• rhsFieldName: string
• seperator: string

{
    "properties":{
        "seperator":{
            "type":"string"
        },
        "operator":{
            "$ref":"#/components/schemas/CRExpressionOperatorJXB"
        },
        "lhsFieldName":{
            "type":"string"
        },
        "lhsFieldKind":{
            "$ref":"#/components/schemas/FieldKindJXB"
        },
        "rhsFieldName":{
            "type":"string"
        },
        "rhsFieldKind":{
            "$ref":"#/components/schemas/FieldKindJXB"
        }
    },
    "type":"object"
}

Nested Schema : FieldToValueCRExpressionJXB

Type: object

Show Source

• fieldKind: string
  Allowed Values: [ "CUSTOMER_SPEC_FIELD", "EVENT_SPEC_FIELD", "PRODUCT_SPEC_FIELD", "PROFILE_SPEC_FIELD" ]
• fieldName: string
• fieldValue: string
• operator: string
  Allowed Values: [ "AND", "EQUAL_TO", "GREATER_THAN", "GREATER_THAN_EQUAL", "INTERSECT", "IN_LIST", "LESS_THAN", "LESS_THAN_EQUAL", "NOT", "NOT_EQUAL_TO", "OR", "REGEX" ]
• seperator: string

{
    "properties":{
        "seperator":{
            "type":"string"
        },
        "operator":{
            "$ref":"#/components/schemas/CRExpressionOperatorJXB"
        },
        "fieldName":{
            "type":"string"
        },
        "fieldKind":{
            "$ref":"#/components/schemas/FieldKindJXB"
        },
        "fieldValue":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : FieldIdentifierJXB

Type: object

Show Source

• fieldSelector: object FieldSelectorJXB
• qualifier: string
  Allowed Values: [ "ORIGINATING", "TERMINATING" ]

{
    "properties":{
        "qualifier":{
            "$ref":"#/components/schemas/FieldQualifierJXB"
        },
        "fieldSelector":{
            "$ref":"#/components/schemas/FieldSelectorJXB"
        }
    },
    "type":"object"
}

Nested Schema : FieldSelectorJXB

Type: object

Show Source

• conditionFieldKind: string
  Allowed Values: [ "CUSTOMER_SPEC_FIELD", "EVENT_SPEC_FIELD", "PRODUCT_SPEC_FIELD", "PROFILE_SPEC_FIELD" ]
• conditionFieldName: string
• operator: string
  Allowed Values: [ "AND", "EQUAL_TO", "GREATER_THAN", "GREATER_THAN_EQUAL", "INTERSECT", "IN_LIST", "LESS_THAN", "LESS_THAN_EQUAL", "NOT", "NOT_EQUAL_TO", "OR", "REGEX" ]
• selectorFieldKind: string
  Allowed Values: [ "CUSTOMER_SPEC_FIELD", "EVENT_SPEC_FIELD", "PRODUCT_SPEC_FIELD", "PROFILE_SPEC_FIELD" ]
• selectorFieldName: string

{
    "properties":{
        "operator":{
            "$ref":"#/components/schemas/CRExpressionOperatorJXB"
        },
        "selectorFieldName":{
            "type":"string"
        },
        "selectorFieldKind":{
            "$ref":"#/components/schemas/FieldKindJXB"
        },
        "conditionFieldName":{
            "type":"string"
        },
        "conditionFieldKind":{
            "$ref":"#/components/schemas/FieldKindJXB"
        }
    },
    "type":"object"
}

Nested Schema : CustomRuleScopeJXB

Type: object

Show Source

• customerSpecName: string
• eventSpecName: string
• productSpecName: string
• profileSpecName: string

{
    "properties":{
        "customerSpecName":{
            "type":"string"
        },
        "productSpecName":{
            "type":"string"
        },
        "eventSpecName":{
            "type":"string"
        },
        "profileSpecName":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : DeliverableJXB

Type: object

Show Source

• deliverableType: string
  Allowed Values: [ "PRODUCT", "SERVICE" ]
• description: string
• entitlement: object EntitlementJXB
• externalID: string
• internalId: string
• name: string
• newName: string
• obsolete: boolean
• permittedName: string
• permittedType: string
  Allowed Values: [ "CUSTOMER", "PRODUCT" ]
• priceListName: string
• productType: string
  Allowed Values: [ "ADMINISTRATIVE", "PHYSICAL_GOODS" ]
• revenueBasisItem: object RevenueBasisItemJXB
• revenueGlid: string

{
    "properties":{
        "name":{
            "type":"string"
        },
        "newName":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "internalId":{
            "type":"string"
        },
        "priceListName":{
            "type":"string"
        },
        "obsolete":{
            "type":"boolean"
        },
        "deliverableType":{
            "$ref":"#/components/schemas/DeliverableTypeJXB"
        },
        "permittedType":{
            "$ref":"#/components/schemas/DeliverablePermittedTypeJXB"
        },
        "permittedName":{
            "type":"string"
        },
        "productType":{
            "$ref":"#/components/schemas/DeliverableProductTypeJXB"
        },
        "revenueGlid":{
            "type":"string"
        },
        "entitlement":{
            "$ref":"#/components/schemas/EntitlementJXB"
        },
        "revenueBasisItem":{
            "$ref":"#/components/schemas/RevenueBasisItemJXB"
        },
        "externalID":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : EntitlementJXB

Type: object

Show Source

• allowanceValidityMode: string
  Allowed Values: [ "ALWAYS", "CURRENT_BILLING", "CURRENT_RECURRING", "MULTIPLE_BILLING", "MULTIPLE_RECURRING", "NEXT_BILLING" ]
• allowanceValidityPeriod: integer
• allowanceValue: number (double)
• description: string
• entitlementType: string
  Allowed Values: [ "ALLOWANCE_ONE_TIME", "ALLOWANCE_RECURRING", "FEATURE" ]
• featureValue: string
• name: string
• resourceBalElemNumCode: integer (int64)
• revenueBasisItem: object RevenueBasisItemJXB
• subscriptionCycle: string
  Allowed Values: [ "ANNUAL", "BIMONTHLY", "MONTHLY", "QUARTERLY", "SEMI_ANNUAL" ]

{
    "properties":{
        "entitlementType":{
            "$ref":"#/components/schemas/EntitlementTypeJXB"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "featureValue":{
            "type":"string"
        },
        "resourceBalElemNumCode":{
            "format":"int64",
            "type":"integer"
        },
        "allowanceValidityMode":{
            "$ref":"#/components/schemas/AllowanceValidityModeJXB"
        },
        "allowanceValidityPeriod":{
            "type":"integer"
        },
        "allowanceValue":{
            "format":"double",
            "type":"number"
        },
        "subscriptionCycle":{
            "$ref":"#/components/schemas/RecurringSubscriptionCycleJXB"
        },
        "revenueBasisItem":{
            "$ref":"#/components/schemas/RevenueBasisItemJXB"
        }
    },
    "type":"object"
}

Nested Schema : RevenueBasisItemJXB

Type: object

Show Source

• amount: number (double)
• currencyBalElemNumCode: integer (int64)
• milestoneType: string
  Allowed Values: [ "FUTURE", "IMMEDIATE" ]
• quantity: number (double)
• scalable: boolean
• timeUnit: string
  Allowed Values: [ "DAY", "MONTH", "YEAR" ]
• timeValue: integer
• type: string
  Allowed Values: [ "RATE_BASED", "VALUE_BASED" ]

{
    "properties":{
        "type":{
            "$ref":"#/components/schemas/RevenueBasisItemTypeJXB"
        },
        "amount":{
            "format":"double",
            "type":"number"
        },
        "currencyBalElemNumCode":{
            "format":"int64",
            "type":"integer"
        },
        "timeUnit":{
            "$ref":"#/components/schemas/RevBasisTimeUnitJXB"
        },
        "timeValue":{
            "type":"integer"
        },
        "milestoneType":{
            "$ref":"#/components/schemas/MilestoneTypeJXB"
        },
        "scalable":{
            "type":"boolean"
        },
        "quantity":{
            "format":"double",
            "type":"number"
        }
    },
    "type":"object"
}

Nested Schema : DynamicQuotaSelectorJXB

Type: object

Show Source

• applicableToAllChildEvent: boolean
• applicableToName: string
• description: string
• eventSpecName: string
• externalID: string
• internalId: string
• name: string
• newName: string
• obsolete: boolean
• priceListName: string
• validityPeriod: array validityPeriod

{
    "properties":{
        "name":{
            "type":"string"
        },
        "newName":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "internalId":{
            "type":"string"
        },
        "priceListName":{
            "type":"string"
        },
        "obsolete":{
            "type":"boolean"
        },
        "applicableToName":{
            "type":"string"
        },
        "eventSpecName":{
            "type":"string"
        },
        "applicableToAllChildEvent":{
            "type":"boolean"
        },
        "validityPeriod":{
            "items":{
                "$ref":"#/components/schemas/ValidityPeriodJXB"
            },
            "type":"array"
        },
        "externalID":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : validityPeriod

Type: array

Show Source

• Array of: object ValidityPeriodJXB

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

Nested Schema : ValidityPeriodJXB

Type: object

Show Source

• defaultRule: object RuleJXB
• rule: array rule
• validFrom: string

{
    "properties":{
        "validFrom":{
            "type":"string"
        },
        "rule":{
            "items":{
                "$ref":"#/components/schemas/RuleJXB"
            },
            "type":"array"
        },
        "defaultRule":{
            "$ref":"#/components/schemas/RuleJXB"
        }
    },
    "type":"object"
}

Nested Schema : RuleJXB

Type: object

Show Source

• configuration: array configuration
• dynamicQuotaComplexExpression: array dynamicQuotaComplexExpression
• dynamicQuotaFieldToValueExpression: array dynamicQuotaFieldToValueExpression
• requestedUnits: array requestedUnits
• ruleName: string
• ruleOrder: integer

{
    "properties":{
        "ruleName":{
            "type":"string"
        },
        "ruleOrder":{
            "type":"integer"
        },
        "dynamicQuotaFieldToValueExpression":{
            "items":{
                "$ref":"#/components/schemas/DynamicQuotaFieldToValueExpressionJXB"
            },
            "type":"array"
        },
        "dynamicQuotaComplexExpression":{
            "items":{
                "$ref":"#/components/schemas/DynamicQuotaComplexExpressionJXB"
            },
            "type":"array"
        },
        "configuration":{
            "items":{
                "$ref":"#/components/schemas/ConfigurationJXB"
            },
            "type":"array"
        },
        "requestedUnits":{
            "items":{
                "$ref":"#/components/schemas/RequestedUnitJXB"
            },
            "type":"array"
        }
    },
    "type":"object"
}

Nested Schema : rule

Type: array

Show Source

• Array of: object RuleJXB

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

Nested Schema : configuration

Type: array

Show Source

• Array of: object ConfigurationJXB

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

Nested Schema : dynamicQuotaComplexExpression

Type: array

Show Source

• Array of: object DynamicQuotaComplexExpressionJXB

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

Nested Schema : dynamicQuotaFieldToValueExpression

Type: array

Show Source

• Array of: object DynamicQuotaFieldToValueExpressionJXB

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

Nested Schema : requestedUnits

Type: array

Show Source

• Array of: object RequestedUnitJXB

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

Nested Schema : ConfigurationJXB

Type: object

Show Source

• key: string
• unit: string
  Allowed Values: [ "BYTES", "DAYS", "GBYTES", "HOURS", "KBYTES", "MBYTES", "MINUTES", "NONE", "SECONDS" ]
• value: number (double)

{
    "properties":{
        "key":{
            "type":"string"
        },
        "value":{
            "format":"double",
            "type":"number"
        },
        "unit":{
            "$ref":"#/components/schemas/DqsUnitJXB"
        }
    },
    "type":"object"
}

Nested Schema : DynamicQuotaComplexExpressionJXB

Type: object

Show Source

• dynamicQuotaBinaryExpression: object DynamicQuotaBinaryExpressionJXB
• operator: string
  Allowed Values: [ "EQUAL_TO", "GREATER_THAN", "GREATER_THAN_EQUAL", "LESS_THAN", "LESS_THAN_EQUAL", "NOT_EQUAL_TO" ]
• value: number (double)

{
    "properties":{
        "operator":{
            "$ref":"#/components/schemas/DqsComplexExpressionOperatorJXB"
        },
        "value":{
            "format":"double",
            "type":"number"
        },
        "dynamicQuotaBinaryExpression":{
            "$ref":"#/components/schemas/DynamicQuotaBinaryExpressionJXB"
        }
    },
    "type":"object"
}

Nested Schema : DynamicQuotaBinaryExpressionJXB

Type: object

Show Source

• dynamicQuotaBinaryOperator: string
  Allowed Values: [ "ADD", "DIVIDE", "MULTIPLY", "SUBTRACT" ]
• leftOperand: object DynamicQuotaBinaryOperandExpressionJXB
• rightOperand: object DynamicQuotaBinaryOperandExpressionJXB

{
    "properties":{
        "leftOperand":{
            "$ref":"#/components/schemas/DynamicQuotaBinaryOperandExpressionJXB"
        },
        "rightOperand":{
            "$ref":"#/components/schemas/DynamicQuotaBinaryOperandExpressionJXB"
        },
        "dynamicQuotaBinaryOperator":{
            "$ref":"#/components/schemas/DqsBinaryOperatorJXB"
        }
    },
    "type":"object"
}

Nested Schema : DynamicQuotaBinaryOperandExpressionJXB

Type: object

Show Source

• dynamicQuotaBalanceExpression: object DynamicQuotaBalanceExpressionJXB
• dynamicQuotaBinaryExpression: object DynamicQuotaBinaryExpressionJXB
• dynamicQuotaNumberExpression: object DynamicQuotaNumberExpressionJXB

{
    "properties":{
        "dynamicQuotaBalanceExpression":{
            "$ref":"#/components/schemas/DynamicQuotaBalanceExpressionJXB"
        },
        "dynamicQuotaNumberExpression":{
            "$ref":"#/components/schemas/DynamicQuotaNumberExpressionJXB"
        },
        "dynamicQuotaBinaryExpression":{
            "$ref":"#/components/schemas/DynamicQuotaBinaryExpressionJXB"
        }
    },
    "type":"object"
}

Nested Schema : DynamicQuotaBalanceExpressionJXB

Type: object

Show Source

• balanceElementNumCode: integer (int64)

{
    "properties":{
        "balanceElementNumCode":{
            "format":"int64",
            "type":"integer"
        }
    },
    "type":"object"
}

Nested Schema : DynamicQuotaNumberExpressionJXB

Type: object

Show Source

• number: number (double)

{
    "properties":{
        "number":{
            "format":"double",
            "type":"number"
        }
    },
    "type":"object"
}

Nested Schema : DynamicQuotaFieldToValueExpressionJXB

Type: object

Show Source

• fieldKind: string
  Allowed Values: [ "CUSTOMER_SPEC_FIELD", "EVENT_SPEC_FIELD", "PRODUCT_SPEC_FIELD", "PROFILE_SPEC_FIELD" ]
• fieldName: string
• fieldValue: string
• operator: string
  Allowed Values: [ "CONTAINS", "EQUAL_TO", "GREATER_THAN", "GREATER_THAN_EQUAL", "IN_LIST", "LESS_THAN", "LESS_THAN_EQUAL", "NOT_EQUAL_TO" ]
• separator: string

{
    "properties":{
        "separator":{
            "type":"string"
        },
        "operator":{
            "$ref":"#/components/schemas/DqsFiledToValueExpressionOperatorJXB"
        },
        "fieldName":{
            "type":"string"
        },
        "fieldKind":{
            "$ref":"#/components/schemas/DqsFieldKindJXB"
        },
        "fieldValue":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : RequestedUnitJXB

Type: object

Show Source

• dynamicQuotaBinaryExpression: object DynamicQuotaBinaryExpressionJXB
• dynamicQuotaNumberExpression: object DynamicQuotaNumberExpressionJXB
• fieldName: string
• unit: string
  Allowed Values: [ "BYTES", "DAYS", "GBYTES", "HOURS", "KBYTES", "MBYTES", "MINUTES", "NONE", "SECONDS" ]

{
    "properties":{
        "fieldName":{
            "type":"string"
        },
        "unit":{
            "$ref":"#/components/schemas/DqsUnitJXB"
        },
        "dynamicQuotaBinaryExpression":{
            "$ref":"#/components/schemas/DynamicQuotaBinaryExpressionJXB"
        },
        "dynamicQuotaNumberExpression":{
            "$ref":"#/components/schemas/DynamicQuotaNumberExpressionJXB"
        }
    },
    "type":"object"
}

Nested Schema : GeoZoneModelJXB

Type: object

Show Source

• description: string
• externalID: string
• geoLink: array geoLink
• internalId: string
• name: string
• newName: string
• obsolete: boolean
• priceListName: string
• zoneItem: array zoneItem

{
    "properties":{
        "name":{
            "type":"string"
        },
        "newName":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "internalId":{
            "type":"string"
        },
        "priceListName":{
            "type":"string"
        },
        "obsolete":{
            "type":"boolean"
        },
        "zoneItem":{
            "items":{
                "$ref":"#/components/schemas/GeoDistanceItemJXB"
            },
            "type":"array"
        },
        "geoLink":{
            "items":{
                "$ref":"#/components/schemas/GeoLinkItemJXB"
            },
            "type":"array"
        },
        "externalID":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : geoLink

Type: array

Show Source

• Array of: object GeoLinkItemJXB

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

Nested Schema : zoneItem

Type: array

Show Source

• Array of: object GeoDistanceItemJXB

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

Nested Schema : GeoLinkItemJXB

Type: object

Show Source

• latitude: number (double)
• longitude: number (double)
• prefix: string
• validFrom: string
• validTo: string

{
    "properties":{
        "latitude":{
            "format":"double",
            "type":"number"
        },
        "longitude":{
            "format":"double",
            "type":"number"
        },
        "prefix":{
            "type":"string"
        },
        "validFrom":{
            "type":"string"
        },
        "validTo":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : GeoDistanceItemJXB

Type: object

Show Source

• alternateZoneModel: object RoutingZoneResultJXB
• distance: number (double)
• productName: string
• validFrom: string
• validTo: string
• zoneResult: object ZoneResultJXB

{
    "properties":{
        "productName":{
            "type":"string"
        },
        "distance":{
            "format":"double",
            "type":"number"
        },
        "validFrom":{
            "type":"string"
        },
        "validTo":{
            "type":"string"
        },
        "zoneResult":{
            "$ref":"#/components/schemas/ZoneResultJXB"
        },
        "alternateZoneModel":{
            "$ref":"#/components/schemas/RoutingZoneResultJXB"
        }
    },
    "type":"object"
}

Nested Schema : RoutingZoneResultJXB

Type: object

Show Source

• zoneModelName: string

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

Nested Schema : ZoneResultJXB

Type: object

Show Source

• zoneName: string

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

Nested Schema : HolidayCalendarJXB

Type: object

Show Source

• description: string
• externalID: string
• holiday: array holiday
• internalId: string
• name: string
• newName: string
• obsolete: boolean
• priceListName: string

{
    "properties":{
        "name":{
            "type":"string"
        },
        "newName":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "internalId":{
            "type":"string"
        },
        "priceListName":{
            "type":"string"
        },
        "obsolete":{
            "type":"boolean"
        },
        "holiday":{
            "items":{
                "$ref":"#/components/schemas/MoyDomHolidayJXB"
            },
            "type":"array"
        },
        "externalID":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : holiday

Type: array

Show Source

• Array of: object MoyDomHolidayJXB

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

Nested Schema : MoyDomHolidayJXB

Type: object

Show Source

• day: integer (int32)
• month: string
  Allowed Values: [ "APR", "AUG", "DEC", "FEB", "JAN", "JUL", "JUN", "MAR", "MAY", "NOV", "OCT", "SEP" ]
• name: string
• year: integer (int32)

{
    "properties":{
        "name":{
            "type":"string"
        },
        "month":{
            "$ref":"#/components/schemas/MonthOfYearEnumJXB"
        },
        "day":{
            "format":"int32",
            "type":"integer"
        },
        "year":{
            "format":"int32",
            "type":"integer"
        }
    },
    "type":"object"
}

Nested Schema : ItemTypeSelectorJXB

Type: object

Show Source

• applicableToAllBalImpact: boolean
• applicableToAllChildEvents: boolean
• applicableToAllChildServices: boolean
• applicableToName: string
• description: string
• eventSpecName: string
• externalID: string
• internalId: string
• itemGroup: string
• itemSpec: array itemSpec
• name: string
• newName: string
• obsolete: boolean
• priceListName: string
• rule: array rule

{
    "properties":{
        "name":{
            "type":"string"
        },
        "newName":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "internalId":{
            "type":"string"
        },
        "priceListName":{
            "type":"string"
        },
        "obsolete":{
            "type":"boolean"
        },
        "applicableToName":{
            "type":"string"
        },
        "eventSpecName":{
            "type":"string"
        },
        "itemGroup":{
            "type":"string"
        },
        "applicableToAllChildServices":{
            "type":"boolean"
        },
        "applicableToAllChildEvents":{
            "type":"boolean"
        },
        "applicableToAllBalImpact":{
            "type":"boolean"
        },
        "rule":{
            "items":{
                "$ref":"#/components/schemas/ItemTypeSelectorRuleJXB"
            },
            "type":"array"
        },
        "itemSpec":{
            "items":{
                "$ref":"#/components/schemas/ItemSpecJXB"
            },
            "type":"array"
        },
        "externalID":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : itemSpec

Type: array

Show Source

• Array of: object ItemSpecJXB

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

Nested Schema : rule

Type: array

Show Source

• Array of: object ItemTypeSelectorRuleJXB

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

Nested Schema : ItemSpecJXB

Type: object

Show Source

• aggregationType: string
  Allowed Values: [ "CUMULATIVE_NONPRECREATE", "CUMULATIVE_PRECREATE", "INDIVIDUAL_NONPRECREATE" ]
• category: string
• default: boolean
• description: string
• externalID: string
• internalId: string
• name: string
• newName: string
• obsolete: boolean
• priceListName: string
• type: string

{
    "properties":{
        "name":{
            "type":"string"
        },
        "newName":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "internalId":{
            "type":"string"
        },
        "priceListName":{
            "type":"string"
        },
        "obsolete":{
            "type":"boolean"
        },
        "type":{
            "type":"string"
        },
        "default":{
            "type":"boolean"
        },
        "aggregationType":{
            "$ref":"#/components/schemas/ITSAggregationTypeJXB"
        },
        "category":{
            "type":"string"
        },
        "externalID":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : ItemTypeSelectorRuleJXB

Type: object

Show Source

• customExpression: array customExpression
• expression: array expression
• ruleName: string
• ruleOrder: integer
• specName: string

{
    "properties":{
        "ruleName":{
            "type":"string"
        },
        "ruleOrder":{
            "type":"integer"
        },
        "expression":{
            "items":{
                "$ref":"#/components/schemas/ItemTypeSelectorValueExpressionJXB"
            },
            "type":"array"
        },
        "customExpression":{
            "items":{
                "$ref":"#/components/schemas/ItemTypeSelectorCustomExpressionJXB"
            },
            "type":"array"
        },
        "specName":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : customExpression

Type: array

Show Source

• Array of: object ItemTypeSelectorCustomExpressionJXB

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

Nested Schema : expression

Type: array

Show Source

• Array of: object ItemTypeSelectorValueExpressionJXB

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

Nested Schema : ItemTypeSelectorCustomExpressionJXB

Type: object

Show Source

• expressionName: string

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

Nested Schema : ItemTypeSelectorValueExpressionJXB

Type: object

Show Source

• fieldKind: string
  Allowed Values: [ "CHARGING_RESULT_SPEC", "CUSTOMER_SPEC_FIELD", "EVENT_SPEC_FIELD", "PRODUCT_SPEC_FIELD", "PROFILE_SPEC_FIELD" ]
• fieldName: string
• fieldValue: string
• operation: string
  Allowed Values: [ "EQUAL_TO", "GREATER_THAN", "GREATER_THAN_EQUAL", "IN_LIST", "LESS_THAN", "LESS_THAN_EQUAL", "NOT_EQUAL_TO", "REGEX" ]
• separator: string

{
    "properties":{
        "separator":{
            "type":"string"
        },
        "operation":{
            "$ref":"#/components/schemas/ITSOperatorJXB"
        },
        "fieldName":{
            "type":"string"
        },
        "fieldKind":{
            "$ref":"#/components/schemas/ITSFieldKindJXB"
        },
        "fieldValue":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : PolicyLabelJXB

Type: object

Show Source

• description: string
• externalID: string
• internalId: string
• name: string
• newName: string
• obsolete: boolean
• priceListName: string
• subLabels: array subLabels

{
    "properties":{
        "name":{
            "type":"string"
        },
        "newName":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "internalId":{
            "type":"string"
        },
        "priceListName":{
            "type":"string"
        },
        "obsolete":{
            "type":"boolean"
        },
        "subLabels":{
            "items":{
                "$ref":"#/components/schemas/PolicySubLabelJXB"
            },
            "type":"array"
        },
        "externalID":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : subLabels

Type: array

Show Source

• Array of: object PolicySubLabelJXB

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

Nested Schema : PolicySubLabelJXB

Type: object

Show Source

• subLabel: string

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

Nested Schema : PolicySpecificationJXB

Type: object

Show Source

• counterPolicies: array counterPolicies
• description: string
• externalID: string
• internalId: string
• name: string
• newName: string
• obsolete: boolean
• priceListName: string

{
    "properties":{
        "name":{
            "type":"string"
        },
        "newName":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "internalId":{
            "type":"string"
        },
        "priceListName":{
            "type":"string"
        },
        "obsolete":{
            "type":"boolean"
        },
        "counterPolicies":{
            "items":{
                "$ref":"#/components/schemas/CounterPolicyJXB"
            },
            "type":"array"
        },
        "externalID":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : counterPolicies

Type: array

Show Source

• Array of: object CounterPolicyJXB

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

Nested Schema : CounterPolicyJXB

Type: object

Show Source

• balanceElementNumCode: string
• CounterRanges: array CounterRanges
• label: string
• unit: string
  Allowed Values: [ "BYTE", "DAY", "GIGABYTE", "HOUR", "KILOBYTE", "MEGABYTE", "MINUTE", "MONTH", "NONE", "SECOND" ]

  Measures the RUM quantity.

{
    "properties":{
        "label":{
            "type":"string"
        },
        "balanceElementNumCode":{
            "type":"string"
        },
        "unit":{
            "$ref":"#/components/schemas/RumQuantityUnitJXB"
        },
        "CounterRanges":{
            "items":{
                "$ref":"#/components/schemas/CounterRangeJXB"
            },
            "type":"array"
        }
    },
    "type":"object"
}

Nested Schema : CounterRanges

Type: array

Show Source

• Array of: object CounterRangeJXB

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

Nested Schema : CounterRangeJXB

Type: object

Show Source

• label: string
• lowerBound: string

{
    "properties":{
        "lowerBound":{
            "type":"string"
        },
        "label":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : PriceTagConfigJXB

Type: object

Show Source

• description: string
• externalID: string
• internalId: string
• name: string
• newName: string
• obsolete: boolean
• priceListName: string
• tags: array tags

{
    "properties":{
        "name":{
            "type":"string"
        },
        "newName":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "internalId":{
            "type":"string"
        },
        "priceListName":{
            "type":"string"
        },
        "obsolete":{
            "type":"boolean"
        },
        "tags":{
            "items":{
                "$ref":"#/components/schemas/TagJXB"
            },
            "type":"array"
        },
        "externalID":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : tags

Type: array

Show Source

• Array of: object TagJXB

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

Nested Schema : TagJXB

Type: object

Show Source

• permittedNames: array permittedNames
• resourceId: integer (int64)
• resourceUnitType: string
  Allowed Values: [ "BYTE", "KILOBYTE", "MEGABYTE", "GIGABYTE", "DAY", "HOUR", "MINUTE", "SECOND", "AMOUNT_USED", "FIXED_CHARGE", "ANY" ]
• ruleType: string
  Allowed Values: [ "ANY", "LIST", "RANGE" ]
• ruleValue: string

{
    "properties":{
        "ruleType":{
            "$ref":"#/components/schemas/RuleTypeJXB"
        },
        "ruleValue":{
            "type":"string"
        },
        "resourceId":{
            "format":"int64",
            "type":"integer"
        },
        "resourceUnitType":{
            "$ref":"#/components/schemas/ResourceUnitTypeJXB"
        },
        "permittedNames":{
            "items":{
                "$ref":"#/components/schemas/PermittedNameJXB"
            },
            "type":"array"
        }
    },
    "type":"object"
}

Nested Schema : permittedNames

Type: array

Show Source

• Array of: object PermittedNameJXB

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

Nested Schema : PermittedNameJXB

Type: object

Show Source

• applicableToAllChildServices: boolean
• name: string

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

Nested Schema : ProductSpecCharacteristicTemplateJXB

Type: object

Show Source

• description: string
• externalID: string
• internalId: string
• name: string
• newName: string
• obsolete: boolean
• priceListName: string
• pricingObjectType: string
  Allowed Values: [ "ALL", "ALTERATION_EXCLUSION", "ALTERATION_OFFERING", "ALTERATION_RATE_PLAN", "ALTERATION_RATE_PLAN_SELECTOR", "APN_MAP", "BEST_PRICING", "BUNDLED_PRODUCT_OFFERING", "BUNDLE_DEPENDENCY", "BUNDLE_TRANSITION", "CHARGE_OFFERING", "CHARGE_RATE_PLAN", "CHARGE_RATE_PLAN_SELECTOR", "CHARGE_SELECTOR_SPEC", "DISTRIBUTION_OFFERING", "DISTRIBUTION_RATE_PLAN", "GENERIC_SELECTOR", "HOLIDAY_CALENDAR", "NONE", "PACKAGE_EXCLUSION", "PACKAGE_LIST", "PACKAGE_OBJ", "PACKAGE_TRANSITION", "PRICE_MODEL", "PRICE_MODEL_SELECTOR", "REPLACEMENT_POP_MODEL", "ROLLOVER_RATE_PLAN", "SUBSCRIPTION_TERMS", "SUBSCRIPTION_TERMS_AUTO_RENEW", "TAX_EXEMPTION_SELECTOR", "TAX_SELECTOR", "TIME_MODEL", "TRIGGER_SPEC", "USC_MAP" ]
• productSpecCharacteristics: array productSpecCharacteristics

{
    "properties":{
        "name":{
            "type":"string"
        },
        "newName":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "internalId":{
            "type":"string"
        },
        "priceListName":{
            "type":"string"
        },
        "obsolete":{
            "type":"boolean"
        },
        "pricingObjectType":{
            "$ref":"#/components/schemas/PricingObjectTypeJXB"
        },
        "productSpecCharacteristics":{
            "items":{
                "$ref":"#/components/schemas/ProductSpecCharacteristicJXB"
            },
            "type":"array"
        },
        "externalID":{
            "type":"string"
        }
    }
}

Nested Schema : productSpecCharacteristics

Type: array

Show Source

• Array of: object ProductSpecCharacteristicJXB
  Key-value pair for defining special characteristics in a product.

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

Nested Schema : ProductSpecCharacteristicJXB

Type: object

Key-value pair for defining special characteristics in a product.

Show Source

• name(required): string
  Title: product spec char name

  Name of the special characteristic.
• value(required): array product spec char values
  Title: product spec char values

  List of special characteristics added for a given name.

{
    "required":[
        "name",
        "value"
    ],
    "properties":{
        "name":{
            "type":"string",
            "title":"product spec char name",
            "description":"Name of the special characteristic."
        },
        "value":{
            "items":{
                "type":"string"
            },
            "type":"array",
            "title":"product spec char values",
            "description":"List of special characteristics added for a given name."
        }
    },
    "type":"object",
    "description":"Key-value pair for defining special characteristics in a product."
}

Nested Schema : product spec char values

Type: array

Title: product spec char values

List of special characteristics added for a given name.

Show Source

• Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array",
    "title":"product spec char values",
    "description":"List of special characteristics added for a given name."
}

Nested Schema : RumConfigurationJXB

Type: object

Show Source

• description: string
• externalID: string
• internalId: string
• name: string
• newName: string
• obsolete: boolean
• priceListName: string
• rumCode: string
• rumRounding: string
  Allowed Values: [ "HALF_DOWN", "HALF_UP", "NONE", "ROUND_DOWN", "ROUND_UP" ]
• rumType: string
  Allowed Values: [ "CONDITIONAL", "PARTIAL", "WHOLE" ]
• unit: string
  Allowed Values: [ "BYTE", "DAY", "GIGABYTE", "HOUR", "KILOBYTE", "MEGABYTE", "MINUTE", "MONTH", "NONE", "SECOND" ]

  Measures the RUM quantity.

{
    "properties":{
        "name":{
            "type":"string"
        },
        "newName":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "internalId":{
            "type":"string"
        },
        "priceListName":{
            "type":"string"
        },
        "obsolete":{
            "type":"boolean"
        },
        "unit":{
            "$ref":"#/components/schemas/RumQuantityUnitJXB"
        },
        "rumType":{
            "$ref":"#/components/schemas/RumTypeJXB"
        },
        "rumRounding":{
            "$ref":"#/components/schemas/RUMRoundingJXB"
        },
        "rumCode":{
            "type":"string"
        },
        "externalID":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : StandardZoneModelJXB

Type: object

Show Source

• description: string
• externalID: string
• internalId: string
• name: string
• newName: string
• obsolete: boolean
• priceListName: string
• zoneItem: array zoneItem

{
    "properties":{
        "name":{
            "type":"string"
        },
        "newName":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "internalId":{
            "type":"string"
        },
        "priceListName":{
            "type":"string"
        },
        "obsolete":{
            "type":"boolean"
        },
        "zoneItem":{
            "items":{
                "$ref":"#/components/schemas/StandardZoneItemJXB"
            },
            "type":"array"
        },
        "externalID":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : zoneItem

Type: array

Show Source

• Array of: object StandardZoneItemJXB

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

Nested Schema : StandardZoneItemJXB

Type: object

Show Source

• alternateZoneModel: object RoutingZoneResultJXB
• destinationPrefix: string
• originPrefix: string
• productName: string
• validFrom: string
• validTo: string
• zoneResult: object ZoneResultJXB

{
    "properties":{
        "productName":{
            "type":"string"
        },
        "originPrefix":{
            "type":"string"
        },
        "destinationPrefix":{
            "type":"string"
        },
        "validFrom":{
            "type":"string"
        },
        "validTo":{
            "type":"string"
        },
        "zoneResult":{
            "$ref":"#/components/schemas/ZoneResultJXB"
        },
        "alternateZoneModel":{
            "$ref":"#/components/schemas/RoutingZoneResultJXB"
        }
    },
    "type":"object"
}

Nested Schema : TaxCodeJXB

Type: object

Show Source

• code: string
• description: string
• externalID: string
• glIdName: string
• internalId: string
• name: string
• newName: string
• obsolete: boolean
• priceListName: string
• taxCodeValidityPeriods: array taxCodeValidityPeriods
• taxPackageType: string
  Allowed Values: [ "CUSTOM", "VERTEX_COMMTAX_21", "VERTEX_QUANTUM" ]

{
    "properties":{
        "name":{
            "type":"string"
        },
        "newName":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "internalId":{
            "type":"string"
        },
        "priceListName":{
            "type":"string"
        },
        "obsolete":{
            "type":"boolean"
        },
        "code":{
            "type":"string"
        },
        "glIdName":{
            "type":"string"
        },
        "taxPackageType":{
            "$ref":"#/components/schemas/TaxCodePackageTypeJXB"
        },
        "taxCodeValidityPeriods":{
            "items":{
                "$ref":"#/components/schemas/TaxCodeValidityPeriodJXB"
            },
            "type":"array"
        },
        "externalID":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : taxCodeValidityPeriods

Type: array

Show Source

• Array of: object TaxCodeValidityPeriodJXB

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

Nested Schema : TaxCodeValidityPeriodJXB

Type: object

Show Source

• taxCodeMaps: array taxCodeMaps
• validFrom: string
• validTo: string

{
    "properties":{
        "validFrom":{
            "type":"string"
        },
        "validTo":{
            "type":"string"
        },
        "taxCodeMaps":{
            "items":{
                "$ref":"#/components/schemas/TaxCodeMapJXB"
            },
            "type":"array"
        }
    },
    "type":"object"
}

Nested Schema : taxCodeMaps

Type: array

Show Source

• Array of: object TaxCodeMapJXB

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

Nested Schema : TaxCodeMapJXB

Type: object

Show Source

• description: string
• percent: number (double)
• salesIndicator: string
  Allowed Values: [ "RESALE", "SALE" ]
• taxJurisdictionLevel: string
  Allowed Values: [ "CITY", "COUNTY", "FEDERAL", "LOCATION", "STATE" ]
• taxJurisdictions: array taxJurisdictions
• taxRuleType: string
  Allowed Values: [ "INCLUSIVE", "NCS", "NCT", "STANDARD", "TAX" ]
• transSubType_ServiceCode: integer
• transType_CategoryCode_Rate: integer

{
    "properties":{
        "description":{
            "type":"string"
        },
        "percent":{
            "format":"double",
            "type":"number"
        },
        "taxJurisdictionLevel":{
            "$ref":"#/components/schemas/TaxJurisdictionLevelTypeJXB"
        },
        "taxJurisdictions":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "taxRuleType":{
            "$ref":"#/components/schemas/TaxRuleTypeJXB"
        },
        "transType_CategoryCode_Rate":{
            "type":"integer"
        },
        "transSubType_ServiceCode":{
            "type":"integer"
        },
        "salesIndicator":{
            "$ref":"#/components/schemas/SalesIndicatorTypeJXB"
        }
    },
    "type":"object"
}

Nested Schema : taxJurisdictions

Type: array

Show Source

• Array of: string

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

Nested Schema : TaxExemptionCodeJXB

Type: object

Show Source

• code: string
• description: string
• externalID: string
• internalId: string
• name: string
• newName: string
• obsolete: boolean
• priceListName: string
• taxExemptionCodeMaps: array taxExemptionCodeMaps

{
    "properties":{
        "name":{
            "type":"string"
        },
        "newName":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "internalId":{
            "type":"string"
        },
        "priceListName":{
            "type":"string"
        },
        "obsolete":{
            "type":"boolean"
        },
        "code":{
            "type":"string"
        },
        "taxExemptionCodeMaps":{
            "items":{
                "$ref":"#/components/schemas/TaxExemptionCodeMapJXB"
            },
            "type":"array"
        },
        "externalID":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : taxExemptionCodeMaps

Type: array

Show Source

• Array of: object TaxExemptionCodeMapJXB

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

Nested Schema : TaxExemptionCodeMapJXB

Type: object

Show Source

• jurisdiction: string
  Allowed Values: [ "CITY", "COUNTY", "FEDERAL", "LOCATION", "STATE" ]
• percent: number (double)
• validFrom: string
• validTo: string

{
    "properties":{
        "validFrom":{
            "type":"string"
        },
        "validTo":{
            "type":"string"
        },
        "percent":{
            "format":"double",
            "type":"number"
        },
        "jurisdiction":{
            "$ref":"#/components/schemas/TaxJurisdictionLevelTypeJXB"
        }
    },
    "type":"object"
}

Nested Schema : ValueMapJXB

Type: object

Show Source

• description: string
• exactMatch: boolean
• externalID: string
• internalId: string
• name: string
• newName: string
• obsolete: boolean
• priceListName: string
• validityPeriod: array validityPeriod

{
    "properties":{
        "name":{
            "type":"string"
        },
        "newName":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "internalId":{
            "type":"string"
        },
        "priceListName":{
            "type":"string"
        },
        "obsolete":{
            "type":"boolean"
        },
        "exactMatch":{
            "type":"boolean"
        },
        "validityPeriod":{
            "items":{
                "$ref":"#/components/schemas/ValueMapValidityPeriodJXB"
            },
            "type":"array"
        },
        "externalID":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : validityPeriod

Type: array

Show Source

• Array of: object ValueMapValidityPeriodJXB

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

Nested Schema : ValueMapValidityPeriodJXB

Type: object

Show Source

• validFrom: string
• valueMapKey: array valueMapKey
• valueMapValue: array valueMapValue

{
    "properties":{
        "validFrom":{
            "type":"string"
        },
        "valueMapValue":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "valueMapKey":{
            "items":{
                "$ref":"#/components/schemas/ValueMapKeyJXB"
            },
            "type":"array"
        }
    },
    "type":"object"
}

Nested Schema : valueMapKey

Type: array

Show Source

• Array of: object ValueMapKeyJXB

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

Nested Schema : valueMapValue

Type: array

Show Source

• Array of: string

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

Nested Schema : ValueMapKeyJXB

Type: object

Show Source

• keyName: string
• valueMapKey: array valueMapKey
• valueMapValue: array valueMapValue

{
    "properties":{
        "keyName":{
            "type":"string"
        },
        "valueMapValue":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "valueMapKey":{
            "items":{
                "$ref":"#/components/schemas/ValueMapKeyJXB"
            },
            "type":"array"
        }
    },
    "type":"object"
}

Nested Schema : valueMapKey

Type: array

Show Source

• Array of: object ValueMapKeyJXB

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

Nested Schema : valueMapValue

Type: array

Show Source

• Array of: string

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

Nested Schema : ZoneResultConfigurationJXB

Type: object

Show Source

• description: string
• externalID: string
• internalId: string
• name: string
• newName: string
• obsolete: boolean
• priceListName: string
• result: string
• resultType: string
  Allowed Values: [ "BASE_RESULT", "DERIVED_RESULT" ]

{
    "properties":{
        "name":{
            "type":"string"
        },
        "newName":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "internalId":{
            "type":"string"
        },
        "priceListName":{
            "type":"string"
        },
        "obsolete":{
            "type":"boolean"
        },
        "result":{
            "type":"string"
        },
        "resultType":{
            "$ref":"#/components/schemas/ZoneResultConfigTypeJXB"
        },
        "externalID":{
            "type":"string"
        }
    },
    "type":"object"
}

Back to Top

Response

200 Response

The configuration objects were updated successfully.

400 Response

The request is invalid.

500 Response

The system encountered an error when processing the configuration objects.

Back to Top

Examples

This example shows how to partially update a RUM configuration by submitting a PATCH request on the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X PATCH 'http://hostname:port/pdc/config?type=RUM_CONFIGURATION'

where:

• hostname is the URL for the PDC REST server.

• port is the port for the PDC REST server.

Example of the Request Body

The following example shows the contents of the request body in JSON format.

{
   "rumConfigurations": [
      {
         "name": "OnetimeNew",
         "internalId": "9ff78162-df10-4f21-8971-588499a51d44",
         "priceListName": "Default",
         "obsolete": false,
         "unit": "NONE"
      }
   ]
}

If successful, the response code 200 is returned in the response body.

Note:

PDC PATCH API is based on and implemented as per JSON merge PATCH RFC 7396 specification. Any limitation to the standard, applies to PDC PATCH API. For example, if the PATCH payload is an array (or anything other than an object) the result will always be the PATCH.

PDC configuration objects, like balanceElements, have roundingRules, which is an array; attributeSpecMaps has the eventRUMSpec array that defines the association of events and RUMs with a service. When you include a new value in the array payload to PATCH an object from the External Product Catalog, it replaces any existing or enriched events already associated with that config object.

To retain an existing configuration, the External Product Catalog must first retrieve the object and include all required configurations, i.e., all roundingRules for balanceElements and all eventRUMSpecs for attributeSpecMaps (both existing and enriched), in the array when you republish the offer to PDC.

This behavior applies to all attributes modeled as arrays. For attributes that are not arrays, enriched values are preserved if they are not included in the payload sent from the External Product Catalog.

Back to Top