1. REST API Reference for Launch Cloud Service
  2. Tasks
  3. Customer Profile Specification

Update a customer profile specification

patch

https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customerProfileSpecification/{id}

Request

Path Parameters
Supported Media Types
Request Body - application/json ()
Root Schema : CustomerProfileSpecificationOracle
Type: object
Title: CustomerProfileSpecificationOracle
The Customer Profile Specification resource represents a set of customer profile characteristics and relationships.
Show Source
Nested Schema : custProfSpecCharacteristic
Type: array
Show Source
  • CustProfSpecCharacteristicOracle
    Title: CustProfSpecCharacteristicOracle
    A list of customer profile spec characteristics (CustomerProfileSpecificationCharacteristic [*]). This class represents the key features of this customer profile specification.
Nested Schema : custProfSpecificationRelationship
Type: array
Show Source
  • CustProfSpecRelationshipOracle
    Title: CustProfSpecRelationshipOracle
    A list of usage spec relationships (CustomerProfileSpecificationRelationship [*]). A list of customer profile specifications related to this specification.
Nested Schema : ProjectRef
Type: object
Title: ProjectRef
Project Reference
Show Source
Nested Schema : relatedParty
Type: array
Show Source
Nested Schema : TimePeriod
Type: object
Title: TimePeriod
The period for which the productOffering is valid
Show Source
Nested Schema : CustProfSpecCharacteristicOracle
Type: object
Title: CustProfSpecCharacteristicOracle
A list of customer profile spec characteristics (CustomerProfileSpecificationCharacteristic [*]). This class represents the key features of this customer profile specification.
Show Source
Nested Schema : custProfSpecCharacteristicValue
Type: array
Show Source
  • CustProfSpecCharacteristicValueOracle
    Title: CustProfSpecCharacteristicValueOracle
    A list of customer profile spec characteristic values A CustomerProfileSpecificationCharacteristicValue object is used to define a set of attributes, each of which can be assigned to a corresponding set of attributes in a SpecCharacteristic object. The values of the attributes in the SpecCharacteristicValue object describe the values of the attributes that a corresponding SpecCharacteristic object can take on.
Nested Schema : custProfSpecCharRelationship
Type: array
Show Source
  • CustProfSpecCharRelationshipOracle
    Title: CustProfSpecCharRelationshipOracle
    A list of customer profile spec char relationships. An aggregation, migration, substitution, dependency or exclusivity relationship between/among Specification Characteristics.
Nested Schema : TimePeriodOracle
Type: object
Title: TimePeriodOracle
Validity period of the related party
Show Source
Nested Schema : CustProfSpecCharacteristicValueOracle
Type: object
Title: CustProfSpecCharacteristicValueOracle
A list of customer profile spec characteristic values A CustomerProfileSpecificationCharacteristicValue object is used to define a set of attributes, each of which can be assigned to a corresponding set of attributes in a SpecCharacteristic object. The values of the attributes in the SpecCharacteristicValue object describe the values of the attributes that a corresponding SpecCharacteristic object can take on.
Show Source
  • base class type (immediate parent) of the ServiceSpecCharacteristicValue
  • Hyperlink reference to schema describing this object
  • The class type of the characteristic value
  • A boolean. Indicates if the value is the default value for a characteristic.
  • Allowed Values: [ "OPEN", "CLOSED", "CLOSED_BOTTOM", "CLOSED_TOP" ]
    A string. An indicator that specifies the inclusion or exclusion of the valueFrom and valueTo attributes. If applicable, possible values are 'open', 'closed', 'closedBottom' and 'closedTop'.
  • A string. A regular expression constraint for given value.
  • A string. 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.
  • TimePeriodOracle
    Title: TimePeriodOracle
    Validity period of the related party
  • value
    An object (object). A discrete value that the characteristic can take on, or the actual value of the characteristic.
  • An integer. The low range value that a characteristic can take on.
  • An integer. The upper range value that a characteristic can take on.
  • Allowed Values: [ "STRING", "NUMBER", "OBJECT", "ARRAY", "DECIMAL", "BOOLEAN", "DATE", "DATETIME" ]
    A string. A kind of value that the characteristic can take on, such as numeric, text, and so forth.
Nested Schema : value
An object (object). A discrete value that the characteristic can take on, or the actual value of the characteristic.
Match One Schema
Show Source
Nested Schema : value-oneOf[1]
Type: object
Nested Schema : value-oneOf[4]
Type: array
Nested Schema : CustProfSpecCharRelationshipOracle
Type: object
Title: CustProfSpecCharRelationshipOracle
A list of customer profile spec char relationships. An aggregation, migration, substitution, dependency or exclusivity relationship between/among Specification Characteristics.
Show Source
Nested Schema : CustProfSpecRelationshipOracle
Type: object
Title: CustProfSpecRelationshipOracle
A list of usage spec relationships (CustomerProfileSpecificationRelationship [*]). A list of customer profile specifications related to this specification.
Show Source
Nested Schema : RelatedParty
Type: object
Title: RelatedParty
RelatedParty reference. A related party defines party or party role linked to a specific entity.
Show Source
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : CustomerProfileSpecificationOracle
Type: object
Title: CustomerProfileSpecificationOracle
The Customer Profile Specification resource represents a set of customer profile characteristics and relationships.
Show Source
Nested Schema : custProfSpecCharacteristic
Type: array
Show Source
  • CustProfSpecCharacteristicOracle
    Title: CustProfSpecCharacteristicOracle
    A list of customer profile spec characteristics (CustomerProfileSpecificationCharacteristic [*]). This class represents the key features of this customer profile specification.
Nested Schema : custProfSpecificationRelationship
Type: array
Show Source
  • CustProfSpecRelationshipOracle
    Title: CustProfSpecRelationshipOracle
    A list of usage spec relationships (CustomerProfileSpecificationRelationship [*]). A list of customer profile specifications related to this specification.
Nested Schema : ProjectRef
Type: object
Title: ProjectRef
Project Reference
Show Source
Nested Schema : relatedParty
Type: array
Show Source
Nested Schema : TimePeriod
Type: object
Title: TimePeriod
The period for which the productOffering is valid
Show Source
Nested Schema : CustProfSpecCharacteristicOracle
Type: object
Title: CustProfSpecCharacteristicOracle
A list of customer profile spec characteristics (CustomerProfileSpecificationCharacteristic [*]). This class represents the key features of this customer profile specification.
Show Source
Nested Schema : custProfSpecCharacteristicValue
Type: array
Show Source
  • CustProfSpecCharacteristicValueOracle
    Title: CustProfSpecCharacteristicValueOracle
    A list of customer profile spec characteristic values A CustomerProfileSpecificationCharacteristicValue object is used to define a set of attributes, each of which can be assigned to a corresponding set of attributes in a SpecCharacteristic object. The values of the attributes in the SpecCharacteristicValue object describe the values of the attributes that a corresponding SpecCharacteristic object can take on.
Nested Schema : custProfSpecCharRelationship
Type: array
Show Source
  • CustProfSpecCharRelationshipOracle
    Title: CustProfSpecCharRelationshipOracle
    A list of customer profile spec char relationships. An aggregation, migration, substitution, dependency or exclusivity relationship between/among Specification Characteristics.
Nested Schema : TimePeriodOracle
Type: object
Title: TimePeriodOracle
Validity period of the related party
Show Source
Nested Schema : CustProfSpecCharacteristicValueOracle
Type: object
Title: CustProfSpecCharacteristicValueOracle
A list of customer profile spec characteristic values A CustomerProfileSpecificationCharacteristicValue object is used to define a set of attributes, each of which can be assigned to a corresponding set of attributes in a SpecCharacteristic object. The values of the attributes in the SpecCharacteristicValue object describe the values of the attributes that a corresponding SpecCharacteristic object can take on.
Show Source
  • base class type (immediate parent) of the ServiceSpecCharacteristicValue
  • Hyperlink reference to schema describing this object
  • The class type of the characteristic value
  • A boolean. Indicates if the value is the default value for a characteristic.
  • Allowed Values: [ "OPEN", "CLOSED", "CLOSED_BOTTOM", "CLOSED_TOP" ]
    A string. An indicator that specifies the inclusion or exclusion of the valueFrom and valueTo attributes. If applicable, possible values are 'open', 'closed', 'closedBottom' and 'closedTop'.
  • A string. A regular expression constraint for given value.
  • A string. 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.
  • TimePeriodOracle
    Title: TimePeriodOracle
    Validity period of the related party
  • value
    An object (object). A discrete value that the characteristic can take on, or the actual value of the characteristic.
  • An integer. The low range value that a characteristic can take on.
  • An integer. The upper range value that a characteristic can take on.
  • Allowed Values: [ "STRING", "NUMBER", "OBJECT", "ARRAY", "DECIMAL", "BOOLEAN", "DATE", "DATETIME" ]
    A string. A kind of value that the characteristic can take on, such as numeric, text, and so forth.
Nested Schema : value
An object (object). A discrete value that the characteristic can take on, or the actual value of the characteristic.
Match One Schema
Show Source
Nested Schema : value-oneOf[1]
Type: object
Nested Schema : value-oneOf[4]
Type: array
Nested Schema : CustProfSpecCharRelationshipOracle
Type: object
Title: CustProfSpecCharRelationshipOracle
A list of customer profile spec char relationships. An aggregation, migration, substitution, dependency or exclusivity relationship between/among Specification Characteristics.
Show Source
Nested Schema : CustProfSpecRelationshipOracle
Type: object
Title: CustProfSpecRelationshipOracle
A list of usage spec relationships (CustomerProfileSpecificationRelationship [*]). A list of customer profile specifications related to this specification.
Show Source
Nested Schema : RelatedParty
Type: object
Title: RelatedParty
RelatedParty reference. A related party defines party or party role linked to a specific entity.
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 : Error
Type: object
Title: Error
Show Source

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 update a customer profile specification by submitting a patch request on the REST resource using cURL.

curl  -H 'Authorization: Bearer <accessToken> -H PATCH https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customerProfileSpecification -H "Content-Type: application/json" -D @update_customerprofilespec.json | json_pp

Example of Request Header

The following shows an example of the request header.

{
    "id": "CP3001005418450",
    "name": "profile to setup color",
    "description": "updated description",
    "version": "1.0",
    "lifecycleStatus": "In design",
    "@type": "CustomerProfileSpecificationOracle",
    "@baseType": "CustomerProfileSpecificationOracle",
    "validFor": {
        "startDateTime": "2020-01-18T00:00:00.000Z",
        "endDateTime": "2021-02-20T16:42:23.000Z"
    },
   "project": {
        "name": "MyProject3000",
        "id": "MyProject3000"
    },
    "custProfSpecCharacteristic": [
        {
            "name": "customerType",
            "description": "customerType",
            "valueType": "STRING",
            "extensible": true,
            "configurable": true,
            "isUnique": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2020-01-18T00:00:00.000Z",
                "endDateTime": "2021-02-20T16:42:23.000Z"
            },
            "custProfSpecCharacteristicValue": [
                {
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2020-01-18T00:00:00.000Z",
                        "endDateTime": "2021-02-20T16:42:23.000Z"
                    },
                    "valueType": "STRING",
                    "value": "Gold"
                },
                {
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2020-01-18T00:00:00.000Z",
                        "endDateTime": "2021-02-20T16:42:23.000Z"
                    },
                    "valueType": "STRING",
                    "value": "Silver"
                },
                
            ]
        }
    ],
            "custProfSpecificationRelationship": [
        {
            "id": "Oracle_IVPVJCH3",
            "relationshipType": "AGGREGATION",
            "validFor": {
                "startDateTime": "2020-08-28T23:47:27.040Z",
                "endDateTime": "2020-08-28T23:47:27.040Z"
            },
            "name": "Names_ZTX4ZSI0W"
        }
    ]
}

Example of Response Body

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

{
    "id": "CP3001005418450",
    "name": "profile to setup color",
    "description": "updated description",
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customerProfileSpecification/CP3001005418450/CP3001005418450",
    "version": "1.0",
    "lifecycleStatus": "In design",
    "created": "2021-04-01T12:17:48.000Z",
    "createdBy": "booth",
    "lastUpdate": "2021-04-01T12:23:31.000Z",
    "lastUpdatedBy": "booth",
    "@type": "CustomerProfileSpecificationOracle",
    "@baseType": "CustomerProfileSpecificationOracle",
    "validFor": {
        "startDateTime": "2020-01-18T00:00:00.000Z",
        "endDateTime": "2021-02-20T16:42:23.000Z"
    },
    "project": {
        "id": "MyProject3000",
        "name": "MyProject3000"
    },
    "custProfSpecCharacteristic": [
        {
            "name": "customerType",
            "description": "customerType",
            "valueType": "STRING",
            "extensible": true,
            "configurable": true,
            "isUnique": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2020-01-18T00:00:00.000Z",
                "endDateTime": "2021-02-20T16:42:23.000Z"
            },
            "custProfSpecCharacteristicValue": [
                {
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2020-01-18T00:00:00.000Z",
                        "endDateTime": "2021-02-20T16:42:23.000Z"
                    },
                    "valueType": "STRING",
                    "value": "Gold"
                },
                {
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2020-01-18T00:00:00.000Z",
                        "endDateTime": "2021-02-20T16:42:23.000Z"
                    },
                    "valueType": "STRING",
                    "value": "Silver"
                }
            ]
        }
    ],
    "custProfSpecificationRelationship": [
        {
            "id": "Oracle_IVPVJCH3",
            "relationshipType": "AGGREGATION",
            "validFor": {
                "startDateTime": "2020-08-28T23:47:27.040Z",
                "endDateTime": "2020-08-28T23:47:27.040Z"
            },
            "name": "Names_ZTX4ZSI0W"
        }
    ]
}
Back to Top