1. REST API Reference for Launch Cloud Service
  2. Tasks
  3. Constraint

Create or update an array of constraint

put

https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/constraints

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 50
Show Source
Nested Schema : PricingConstraintVariantOracle
Title: PricingConstraintVariantOracle
Match All
Show Source
  • Constraint
    Title: Constraint
    Discriminator: { "propertyName":"@type", "mapping":{ "Constraint":"#/components/schemas/Constraint", "PricingConstraintVariantOracle":"#/components/schemas/PricingConstraintVariantOracle", "PricelistConstraintOracle":"#/components/schemas/PricelistConstraintOracle" } }
    The Constraint resource represents a policy/rule applied to an entity or entity spec.
  • PricingConstraintVariantOracle-allOf[1]
Nested Schema : Constraint
Type: object
Title: Constraint
Discriminator: @type

Discriminator Values

The Constraint resource represents a policy/rule applied to an entity or entity spec.
Show Source
Nested Schema : PricingConstraintVariantOracle-allOf[1]
Type: object
Show Source
Nested Schema : constraintRule
Type: array
Show Source
Nested Schema : CustomerProfileSpecificationRef
Type: object
Title: CustomerProfileSpecificationRef
Customer Profile specification reference.
Show Source
Nested Schema : CustomProfileSpecRefOracle
Type: object
Title: CustomProfileSpecRefOracle
Custom Profile specification reference.
Show Source
Nested Schema : PlaSpecificationRef
Type: object
Title: PlaSpecificationRef
A pricing logic algorithm specification reference. A PricingLogicAlgorithmSpec is a detailed description of a tangible or intangible object made available externally in the form of a PricingLogicAlgorithm to customers or other parties playing a party role.
Show Source
Nested Schema : ProductSpecificationRef
Type: object
Title: ProductSpecificationRef
Product specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.
Show Source
Nested Schema : ProjectRef
Type: object
Title: ProjectRef
Project Reference
Show Source
Nested Schema : ServiceSpecificationRefOracle
Title: ServiceSpecificationRefOracle
Match All
Show Source
  • ServiceSpecificationRef
    Title: ServiceSpecificationRef
    Discriminator: { "propertyName":"@type", "mapping":{ "ServiceSpecificationRef":"#/components/schemas/ServiceSpecificationRef", "ServiceSpecificationRefOracle":"#/components/schemas/ServiceSpecificationRefOracle" } }
    Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.
  • ServiceSpecificationRefOracle-allOf[1]
Nested Schema : specCharUse
Type: array
Show Source
Nested Schema : UsageSpecificationRefOracle
Title: UsageSpecificationRefOracle
Match All
Show Source
  • UsageSpecificationRef
    Title: UsageSpecificationRef
    Discriminator: { "propertyName":"@type", "mapping":{ "UsageSpecificationRef":"#/components/schemas/UsageSpecificationRef", "UsageSpecificationRefOracle":"#/components/schemas/UsageSpecificationRefOracle" } }
    Usage specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.
  • UsageSpecificationRefOracle-allOf[1]
Nested Schema : ConstraintRuleOracle
Type: object
Title: ConstraintRuleOracle
Rules applied over a characteristic
Show Source
Nested Schema : productOfferingPrice
Type: array
Show Source
  • ProductOfferingPriceRef
    Title: ProductOfferingPriceRef
    ProductPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased
Nested Schema : TimePeriodOracle
Type: object
Title: TimePeriodOracle
Validity period of the related party
Show Source
Nested Schema : valueRelationship
Type: array
Show Source
Nested Schema : ProductOfferingPriceRef
Type: object
Title: ProductOfferingPriceRef
ProductPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased
Show Source
Nested Schema : ValueRelationshipOracle
Type: object
Title: ValueRelationshipOracle
Represent the value of a characteristic forming the constraint rule
Show Source
  • A length, surface, volume, dry measure, liquid measure, money, weight, time, and the like. In general, a determinate quantity or magnitude of the kind designated, taken as a standard of comparison for others of the same kind, in assigning to them numerical values, as 1 foot, 1 yard, 1 mile, 1 square foot.
  • value
    Value representing a Relationship attribute
Nested Schema : value
Value representing a Relationship attribute
Match One Schema
Show Source
Nested Schema : value-oneOf[1]
Type: object
Nested Schema : value-oneOf[4]
Type: array
Nested Schema : TargetProductSchema
Type: object
Title: TargetProductSchema
The reference object to the schema and type of target product which is described by product specification
Show Source
Nested Schema : ServiceSpecificationRef
Type: object
Title: ServiceSpecificationRef
Discriminator: @type

Discriminator Values

Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.
Show Source
Nested Schema : ServiceSpecificationRefOracle-allOf[1]
Type: object
Show Source
Nested Schema : SpecCharUseOracle
Type: object
Title: SpecCharUseOracle
Characteristic used to define Constraints
Show Source
Nested Schema : UsageSpecificationRef
Type: object
Title: UsageSpecificationRef
Discriminator: @type

Discriminator Values

Usage specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.
Show Source
Nested Schema : UsageSpecificationRefOracle-allOf[1]
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

Your request is successful and the resources have been created or updated.
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : PricingConstraintVariantOracle
Title: PricingConstraintVariantOracle
Match All
Show Source
  • Constraint
    Title: Constraint
    Discriminator: { "propertyName":"@type", "mapping":{ "Constraint":"#/components/schemas/Constraint", "PricingConstraintVariantOracle":"#/components/schemas/PricingConstraintVariantOracle", "PricelistConstraintOracle":"#/components/schemas/PricelistConstraintOracle" } }
    The Constraint resource represents a policy/rule applied to an entity or entity spec.
  • PricingConstraintVariantOracle-allOf[1]
Nested Schema : Constraint
Type: object
Title: Constraint
Discriminator: @type

Discriminator Values

The Constraint resource represents a policy/rule applied to an entity or entity spec.
Show Source
Nested Schema : PricingConstraintVariantOracle-allOf[1]
Type: object
Show Source
Nested Schema : constraintRule
Type: array
Show Source
Nested Schema : CustomerProfileSpecificationRef
Type: object
Title: CustomerProfileSpecificationRef
Customer Profile specification reference.
Show Source
Nested Schema : CustomProfileSpecRefOracle
Type: object
Title: CustomProfileSpecRefOracle
Custom Profile specification reference.
Show Source
Nested Schema : PlaSpecificationRef
Type: object
Title: PlaSpecificationRef
A pricing logic algorithm specification reference. A PricingLogicAlgorithmSpec is a detailed description of a tangible or intangible object made available externally in the form of a PricingLogicAlgorithm to customers or other parties playing a party role.
Show Source
Nested Schema : ProductSpecificationRef
Type: object
Title: ProductSpecificationRef
Product specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.
Show Source
Nested Schema : ProjectRef
Type: object
Title: ProjectRef
Project Reference
Show Source
Nested Schema : ServiceSpecificationRefOracle
Title: ServiceSpecificationRefOracle
Match All
Show Source
  • ServiceSpecificationRef
    Title: ServiceSpecificationRef
    Discriminator: { "propertyName":"@type", "mapping":{ "ServiceSpecificationRef":"#/components/schemas/ServiceSpecificationRef", "ServiceSpecificationRefOracle":"#/components/schemas/ServiceSpecificationRefOracle" } }
    Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.
  • ServiceSpecificationRefOracle-allOf[1]
Nested Schema : specCharUse
Type: array
Show Source
Nested Schema : UsageSpecificationRefOracle
Title: UsageSpecificationRefOracle
Match All
Show Source
  • UsageSpecificationRef
    Title: UsageSpecificationRef
    Discriminator: { "propertyName":"@type", "mapping":{ "UsageSpecificationRef":"#/components/schemas/UsageSpecificationRef", "UsageSpecificationRefOracle":"#/components/schemas/UsageSpecificationRefOracle" } }
    Usage specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.
  • UsageSpecificationRefOracle-allOf[1]
Nested Schema : ConstraintRuleOracle
Type: object
Title: ConstraintRuleOracle
Rules applied over a characteristic
Show Source
Nested Schema : productOfferingPrice
Type: array
Show Source
  • ProductOfferingPriceRef
    Title: ProductOfferingPriceRef
    ProductPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased
Nested Schema : TimePeriodOracle
Type: object
Title: TimePeriodOracle
Validity period of the related party
Show Source
Nested Schema : valueRelationship
Type: array
Show Source
Nested Schema : ProductOfferingPriceRef
Type: object
Title: ProductOfferingPriceRef
ProductPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased
Show Source
Nested Schema : ValueRelationshipOracle
Type: object
Title: ValueRelationshipOracle
Represent the value of a characteristic forming the constraint rule
Show Source
  • A length, surface, volume, dry measure, liquid measure, money, weight, time, and the like. In general, a determinate quantity or magnitude of the kind designated, taken as a standard of comparison for others of the same kind, in assigning to them numerical values, as 1 foot, 1 yard, 1 mile, 1 square foot.
  • value
    Value representing a Relationship attribute
Nested Schema : value
Value representing a Relationship attribute
Match One Schema
Show Source
Nested Schema : value-oneOf[1]
Type: object
Nested Schema : value-oneOf[4]
Type: array
Nested Schema : TargetProductSchema
Type: object
Title: TargetProductSchema
The reference object to the schema and type of target product which is described by product specification
Show Source
Nested Schema : ServiceSpecificationRef
Type: object
Title: ServiceSpecificationRef
Discriminator: @type

Discriminator Values

Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.
Show Source
Nested Schema : ServiceSpecificationRefOracle-allOf[1]
Type: object
Show Source
Nested Schema : SpecCharUseOracle
Type: object
Title: SpecCharUseOracle
Characteristic used to define Constraints
Show Source
Nested Schema : UsageSpecificationRef
Type: object
Title: UsageSpecificationRef
Discriminator: @type

Discriminator Values

Usage specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.
Show Source
Nested Schema : UsageSpecificationRefOracle-allOf[1]
Type: object
Show Source

400 Response

Your request couldn't be processed because it contains missing or invalid information, such as a validation error on an input field, a missing required value, and so forth.
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

401 Response

Your request isn't authorized. The authentication credentials included with this request are missing or invalid.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source

404 Response

Your request includes a resource URI that doesn't exist.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source

405 Response

HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source

500 Response

The server encountered something unexpected that prevented it from completing the request.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source
Back to Top

Examples

The following example shows how to create or update an array of constraint by submitting a put request on the REST resource using cURL.

cURL Command

curl -u username:password -X PUT https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/constraints -H 'Content-Type: application/json' -D @put_constraints.json | json_pp

Example of Request Body

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

[
    {
    "@type": "PricingConstraintVariantOracle",
    "@baseType": "Constraint",
    "id": "hxxxxx001",
    "name": "hxxxxx001",
    "constraintType": "PRICE",
    "description": "Description of CustTypeBasedConstraint001update",
    "version": "1.0",
    "productSpecification": {
        "@referredType": "ProductSpecificationOracle",
        "id": "ProductSpec2002",
        "name": "ProductSpec2002"
    },
     "project": {
              "id": "BulkDocProject",
        "name": "Bulk Doc Project"
    },
    "specCharUse": [
        {
            "relationshipType": "AGGREGATION",
            "name": "Colour",
            "charSpecSeq": 1,
            "productSpecification": {
                "id": "ProductSpec2002",
                "name": "ProductSpec2002",
                "href": "https://mycsp.com:8080/tmf-api/productCatalogManagement/v4/customerProfileSpecification/TestBRMCustomerProfile001",
                "version": "1.0"
            }
        }
    ],
    "constraintRule": [
        {
            "priority": 1,
            "priceTag": "PriceTag01",
            "validFor": {
                "startDateTime": "2017-04-19T16:42:23.0Z"
            },
            "valueRelationship": [
                {
                    "value": "Platinum"
                }
            ],
            "productOfferingPrice": [
                {
                    "id": "service112",
                    "name": "service112",
                    "version": "1.0"
                }
            ]
        }
    ]
},
{
    "@type": "PricingConstraintVariantOracle",
    "@baseType": "Constraint",
    "id": "hxxxxx002",
    "name": "hxxxxx002",
    "constraintType": "PRICE",
    "description": "Description of CustTypeBasedConstraint001update",
    "version": "1.0",
    "productSpecification": {
        "@referredType": "ProductSpecificationOracle",
        "id": "ProductSpec2002",
        "name": "ProductSpec2002"
    },
     "project": {
              "id": "BulkDocProject",
        "name": "Bulk Doc Project"
    },
    "specCharUse": [
        {
            "relationshipType": "AGGREGATION",
            "name": "Colour",
            "charSpecSeq": 1,
            "productSpecification": {
                "id": "ProductSpec2002",
                "name": "ProductSpec2002",
                "href": "https://mycsp.com:8080/tmf-api/productCatalogManagement/v4/customerProfileSpecification/TestBRMCustomerProfile001",
                "version": "1.0"
            }
        }
    ],
    "constraintRule": [
        {
            "priority": 1,
            "priceTag": "PriceTag01",
            "validFor": {
                "startDateTime": "2017-04-19T16:42:23.0Z"
            },
            "valueRelationship": [
                {
                    "value": "Platinum"
                }
            ],
            "productOfferingPrice": [
                {
                    "id": "service112",
                    "name": "service112",
                    "version": "1.0"
                }
            ]
        }
    ]
}
]

Example of Response Body

The following shows an example of the response body in JSON format.

[
    {
        "lastUpdate": "2021-09-15T07:14:37.394Z",
        "lastUpdatedBy": "booth",
        "created": "2021-05-07T07:44:22.000Z",
        "createdBy": "booth",
        "@type": "PricingConstraintVariantOracle",
        "@baseType": "Constraint",
        "constraintType": "PRICE",
        "specCharUse": [
            {
                "productSpecification": {
                    "id": "ProductSpec2002",
                    "name": "ProductSpec2002",
                    "version": "1.0",
                    "href": "https://mycsp.com:8080/tmf-api/productCatalogManagement/v4/customerProfileSpecification/TestBRMCustomerProfile001"
                },
                "charSpecSeq": 1,
                "relationshipType": "AGGREGATION",
                "name": "Colour"
            }
        ],
        "constraintRule": [
            {
                "productOfferingPrice": [
                    {
                        "id": "service112",
                        "name": "service112",
                        "version": "1.0",
                        "@referredType": "ProductOfferingPriceOracle"
                    }
                ],
                "priceTag": "PriceTag01",
                "valueRelationship": [
                    {
                        "value": "Platinum"
                    }
                ],
                "validFor": {
                    "startDateTime": "2017-04-19T16:42:23.0Z"
                },
                "priority": 1
            }
        ],
        "productSpecification": {
            "id": "ProductSpec2002",
            "name": "ProductSpec2002",
            "version": "1.0",
            "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productSpecification/ProductSpec2002",
            "@baseType": "ProductSpecificationOracle"
        },
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/constraints/hxxxxx001",
        "project": {
            "id": "BulkDocProject",
            "name": "Bulk Doc Project",
            "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/BulkDocProject"
        },
        "description": "Description of CustTypeBasedConstraint001update",
        "version": "1.0",
        "name": "hxxxxx001",
        "id": "hxxxxx001"
    },
    {
        "lastUpdate": "2021-09-15T07:14:37.853Z",
        "lastUpdatedBy": "booth",
        "created": "2021-05-30T08:53:51.892Z",
        "createdBy": "booth",
        "@type": "PricingConstraintVariantOracle",
        "@baseType": "Constraint",
        "constraintType": "PRICE",
        "specCharUse": [
            {
                "productSpecification": {
                    "id": "ProductSpec2002",
                    "name": "ProductSpec2002",
                    "version": "1.0",
                    "href": "https://mycsp.com:8080/tmf-api/productCatalogManagement/v4/customerProfileSpecification/TestBRMCustomerProfile001"
                },
                "charSpecSeq": 1,
                "relationshipType": "AGGREGATION",
                "name": "Colour"
            }
        ],
        "constraintRule": [
            {
                "productOfferingPrice": [
                    {
                        "id": "service112",
                        "name": "service112",
                        "version": "1.0",
                        "@referredType": "ProductOfferingPriceOracle"
                    }
                ],
                "priceTag": "PriceTag01",
                "valueRelationship": [
                    {
                        "value": "Platinum"
                    }
                ],
                "validFor": {
                    "startDateTime": "2017-04-19T16:42:23.0Z"
                },
                "priority": 1
            }
        ],
        "productSpecification": {
            "id": "ProductSpec2002",
            "name": "ProductSpec2002",
            "version": "1.0",
            "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productSpecification/ProductSpec2002",
            "@baseType": "ProductSpecificationOracle"
        },
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/constraints/hxxxxx002",
        "project": {
            "id": "BulkDocProject",
            "name": "Bulk Doc Project",
            "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/BulkDocProject"
        },
        "description": "Description of CustTypeBasedConstraint001update",
        "version": "1.0",
        "name": "hxxxxx002",
        "id": "hxxxxx002"
    }
]
Back to Top