Jump to

• Request
• Response
• Examples

Create or update an array of customer profile specifications

put

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

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 50

Show Source

• Array of: object CustomerProfileSpecificationOracle
  Title: CustomerProfileSpecificationOracle

  The Customer Profile Specification resource represents a set of customer profile characteristics and relationships.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CustomerProfileSpecificationOracle"
    },
    "minItems":"1",
    "maxItems":"50"
}

Nested Schema : CustomerProfileSpecificationOracle

Type: object

Title: CustomerProfileSpecificationOracle

The Customer Profile Specification resource represents a set of customer profile characteristics and relationships.

Show Source

• @baseType: string
  Immediate base (class) type of the Customer Profile Specification
• @schemaLocation: string
  A link to the schema describing this Customer Profle Specification
• @type(required): string
  Class type of the Customer Profile Specification
• applicationName: string
  name of the external application
• created: string (date-time)
  Date and time of the creation
• createdBy: string
  name of the person who created item
• custProfSpecCharacteristic: array custProfSpecCharacteristic
• custProfSpecificationRelationship: array custProfSpecificationRelationship
• description: string
  A string. A narrative that explains in detail what the customer profile specification is.
• externalId: string
  id of the external application
• href: string
  A string. Reference of the customer profile specification.
• id: string
  Maximum Length: 30

  A string. Unique identifier of the customer profile specification.
• lastUpdate: string (date-time)
  A date time (DateTime). Date and time of the last update of the Customer Profile specification.
• lastUpdatedBy: string
  name of the person who updated item
• lifecycleStatus: string
  A string. Used to indicate the current lifecycle status of the customer profile specification.
• name(required): string
  A string. Name of the customer profile specification.
• project: object ProjectRef
  Title: ProjectRef

  Project Reference
• relatedParty: array relatedParty
• validFor: object TimePeriod
  Title: TimePeriod

  The period for which the productOffering is valid
• version: string
  A string. customer profile specification version.
• versionState: number
  Version state of the Customer Profile Specification

{
    "title":"CustomerProfileSpecificationOracle",
    "type":"object",
    "description":"The Customer Profile Specification resource represents a set of customer profile characteristics and relationships.",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":"30",
            "description":"A string. Unique identifier of the customer profile specification."
        },
        "href":{
            "type":"string",
            "description":"A string. Reference of the customer profile specification."
        },
        "version":{
            "type":"string",
            "description":"A string. customer profile specification version."
        },
        "name":{
            "type":"string",
            "description":"A string. Name of the customer profile specification."
        },
        "description":{
            "type":"string",
            "description":"A string. A narrative that explains in detail what the customer profile specification is."
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"A string. Used to indicate the current lifecycle status of the customer profile specification."
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        },
        "@type":{
            "type":"string",
            "description":"Class type of the Customer Profile Specification"
        },
        "@baseType":{
            "type":"string",
            "description":"Immediate base (class) type of the Customer Profile Specification"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this Customer Profle Specification"
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"A date time (DateTime). Date and time of the last update of the Customer Profile specification."
        },
        "custProfSpecificationRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CustProfSpecRelationshipOracle"
            }
        },
        "custProfSpecCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CustProfSpecCharacteristicOracle"
            }
        },
        "relatedParty":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelatedPartyRefOrPartyRoleRef"
            }
        },
        "project":{
            "$ref":"#/components/schemas/ProjectRef"
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the creation"
        },
        "createdBy":{
            "type":"string",
            "description":"name of the person who created item"
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"name of the person who updated item"
        },
        "externalId":{
            "type":"string",
            "description":"id of the external application"
        },
        "applicationName":{
            "type":"string",
            "description":"name of the external application"
        },
        "versionState":{
            "type":"number",
            "description":"Version state of the Customer Profile Specification"
        }
    },
    "required":[
        "name",
        "@type"
    ]
}

Nested Schema : custProfSpecCharacteristic

Type: array

Show Source

• Array of: object CustProfSpecCharacteristicOracle
  Title: CustProfSpecCharacteristicOracle

  A list of customer profile spec characteristics (CustomerProfileSpecificationCharacteristic [*]). This class represents the key features of this customer profile specification.

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

Nested Schema : custProfSpecificationRelationship

Type: array

Show Source

• Array of: object CustProfSpecRelationshipOracle
  Title: CustProfSpecRelationshipOracle

  A list of usage spec relationships (CustomerProfileSpecificationRelationship [*]). A list of customer profile specifications related to this specification.

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

Nested Schema : ProjectRef

Type: object

Title: ProjectRef

Project Reference

Show Source

• href: string
  Unique reference of the project
• id(required): string
  Unique identifier of the project
• name: string
  Name of the project
• version: string
  Version of the project

{
    "title":"ProjectRef",
    "type":"object",
    "description":"Project Reference",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the project"
        },
        "href":{
            "type":"string",
            "description":"Unique reference of the project"
        },
        "name":{
            "type":"string",
            "description":"Name of the project"
        },
        "version":{
            "type":"string",
            "description":"Version of the project"
        }
    },
    "required":[
        "id"
    ]
}

Nested Schema : relatedParty

Type: array

Show Source

• Array of: object RelatedParty
  Title: RelatedParty

  RelatedParty reference. A related party defines party or party role linked to a specific entity.

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

Nested Schema : TimePeriod

Type: object

Title: TimePeriod

The period for which the productOffering is valid

Show Source

• endDateTime: string (date-time)
  An instant of time, ending at the TimePeriod.
• startDateTime: string (date-time)
  An instant of time, starting at the TimePeriod

{
    "title":"TimePeriod",
    "description":"The period for which the productOffering is valid",
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An instant of time, starting at the TimePeriod"
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An instant of time, ending at the TimePeriod."
        }
    }
}

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

• @baseType: string
  base class type (immediate parent) of the CustProfSpecCharacteristic
• @schemaLocation: string
  hyperlink reference to the schema describing this characteristic
• @type(required): string
  the class type of this characteristic
• @valueSchemaLocation: string
  A string. This (optional) field provides a link to the schema describing the value type.
• configurable: boolean
  A boolean. If true, the Boolean indicates that the CustProfSpecCharacteristic is configurable.
• custProfSpecCharacteristicValue: array custProfSpecCharacteristicValue
• custProfSpecCharRelationship: array custProfSpecCharRelationship
• description: string
  A string. A narrative that explains in detail what the SpecCharacteristic is.
• extensible: boolean
  A boolean. An indicator that specifies that the values for the characteristic can be extended by adding new values when instantiating a characteristic for an Entity.
• isUnique: boolean
  A boolean. An indicator that specifies if a value is unique for the specification. Possible values are; 'unique while value is in effect' and 'unique whether value is in effect or not'.
• maxCardinality: integer
  An integer. The maximum number of instances a CharacteristicValue can take on.
• minCardinality: integer
  An integer. The minimum number of instances a CharacteristicValue can take on.
• name(required): string
  A string. A word, term, or phrase by which this characteristic specification is known and distinguished from other characteristic specifications.
• regex: string
  A string. A rule or principle represented in regular expression used to derive the value of a characteristic value.
• validFor: object TimePeriodOracle
  Title: TimePeriodOracle

  Validity period of the related party
• valueType: string
  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.

{
    "title":"CustProfSpecCharacteristicOracle",
    "type":"object",
    "description":"A list of customer profile spec characteristics (CustomerProfileSpecificationCharacteristic [*]). This class represents the key features of this customer profile specification.",
    "properties":{
        "name":{
            "type":"string",
            "description":"A string. A word, term, or phrase by which this characteristic specification is known and distinguished from other characteristic specifications."
        },
        "description":{
            "type":"string",
            "description":"A string. A narrative that explains in detail what the SpecCharacteristic is."
        },
        "valueType":{
            "type":"string",
            "description":"A string. A kind of value that the characteristic can take on, such as numeric, text and so forth.",
            "enum":[
                "STRING",
                "NUMBER",
                "OBJECT",
                "ARRAY",
                "DECIMAL",
                "BOOLEAN",
                "DATE",
                "DATETIME"
            ]
        },
        "configurable":{
            "type":"boolean",
            "description":"A boolean. If true, the Boolean indicates that the CustProfSpecCharacteristic is configurable."
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriodOracle"
        },
        "@type":{
            "type":"string",
            "description":"the class type of this characteristic"
        },
        "@baseType":{
            "type":"string",
            "description":"base class type  (immediate parent) of the CustProfSpecCharacteristic"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"hyperlink reference to the schema describing this characteristic"
        },
        "@valueSchemaLocation":{
            "type":"string",
            "description":"A string. This (optional) field provides a link to the schema describing the value type."
        },
        "minCardinality":{
            "type":"integer",
            "description":"An integer. The minimum number of instances a CharacteristicValue can take on."
        },
        "maxCardinality":{
            "type":"integer",
            "description":"An integer. The maximum number of instances a CharacteristicValue can take on."
        },
        "isUnique":{
            "type":"boolean",
            "description":"A boolean. An indicator that specifies if a value is unique for the specification. Possible values are; 'unique while value is in effect' and 'unique whether value is in effect or not'."
        },
        "regex":{
            "type":"string",
            "description":"A string. A rule or principle represented in regular expression used to derive the value of a characteristic value."
        },
        "extensible":{
            "type":"boolean",
            "description":"A boolean. An indicator that specifies that the values for the characteristic can be extended by adding new values when instantiating a characteristic for an Entity."
        },
        "custProfSpecCharRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CustProfSpecCharRelationshipOracle"
            }
        },
        "custProfSpecCharacteristicValue":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CustProfSpecCharacteristicValueOracle"
            }
        }
    },
    "required":[
        "name",
        "@type"
    ]
}

Nested Schema : custProfSpecCharacteristicValue

Type: array

Show Source

• Array of: object 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.

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

Nested Schema : custProfSpecCharRelationship

Type: array

Show Source

• Array of: object CustProfSpecCharRelationshipOracle
  Title: CustProfSpecCharRelationshipOracle

  A list of customer profile spec char relationships. An aggregation, migration, substitution, dependency or exclusivity relationship between/among Specification Characteristics.

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

Nested Schema : TimePeriodOracle

Type: object

Title: TimePeriodOracle

Validity period of the related party

Show Source

• endDateTime: string (date-time)
  An instant of time, ending at the TimePeriod.
• startDateTime: string (date-time)
  An instant of time, starting at the TimePeriod

{
    "description":"Validity period of the related party",
    "title":"TimePeriodOracle",
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An instant of time, starting at the TimePeriod"
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An instant of time, ending at the TimePeriod."
        }
    }
}

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

• @baseType: string
  base class type (immediate parent) of the ServiceSpecCharacteristicValue
• @schemaLocation: string
  Hyperlink reference to schema describing this object
• @type(required): string
  The class type of the characteristic value
• isDefault: boolean
  A boolean. Indicates if the value is the default value for a characteristic.
• rangeInterval: string
  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'.
• regex: string
  A string. A regular expression constraint for given value.
• unitOfMeasure: string
  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.
• validFor: object TimePeriodOracle
  Title: TimePeriodOracle

  Validity period of the related party
• value(required): value
  An object (object). A discrete value that the characteristic can take on, or the actual value of the characteristic.
• valueFrom: string
  An integer. The low range value that a characteristic can take on.
• valueTo: string
  An integer. The upper range value that a characteristic can take on.
• valueType: string
  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.

{
    "title":"CustProfSpecCharacteristicValueOracle",
    "type":"object",
    "description":"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.",
    "properties":{
        "isDefault":{
            "type":"boolean",
            "description":"A boolean. Indicates if the value is the default value for a characteristic."
        },
        "unitOfMeasure":{
            "type":"string",
            "description":"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."
        },
        "validFor":{
            "description":"A time period. The period of time for which a value is applicable.",
            "$ref":"#/components/schemas/TimePeriodOracle"
        },
        "value":{
            "oneOf":[
                {
                    "type":"string"
                },
                {
                    "type":"object"
                },
                {
                    "type":"number"
                },
                {
                    "type":"boolean"
                },
                {
                    "type":"array"
                }
            ],
            "description":"An object (object). A discrete value that the characteristic can take on, or the actual value of the characteristic."
        },
        "valueFrom":{
            "type":"string",
            "description":"An integer. The low range value that a characteristic can take on."
        },
        "valueTo":{
            "type":"string",
            "description":"An integer. The upper range value that a characteristic can take on."
        },
        "valueType":{
            "type":"string",
            "description":"A string. A kind of value that the characteristic can take on, such as numeric, text, and so forth.",
            "enum":[
                "STRING",
                "NUMBER",
                "OBJECT",
                "ARRAY",
                "DECIMAL",
                "BOOLEAN",
                "DATE",
                "DATETIME"
            ]
        },
        "rangeInterval":{
            "type":"string",
            "description":"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'.",
            "enum":[
                "OPEN",
                "CLOSED",
                "CLOSED_BOTTOM",
                "CLOSED_TOP"
            ]
        },
        "regex":{
            "type":"string",
            "description":"A string. A regular expression constraint for given value."
        },
        "@type":{
            "type":"string",
            "description":"The class type of the characteristic value"
        },
        "@baseType":{
            "type":"string",
            "description":"base class type  (immediate parent) of the ServiceSpecCharacteristicValue"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"Hyperlink reference to schema describing this object"
        }
    },
    "required":[
        "value",
        "@type"
    ]
}

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

• string
• object value-oneOf[1]
• number
• boolean
• array value-oneOf[4]

{
    "oneOf":[
        {
            "type":"string"
        },
        {
            "type":"object"
        },
        {
            "type":"number"
        },
        {
            "type":"boolean"
        },
        {
            "type":"array"
        }
    ],
    "description":"An object (object). A discrete value that the characteristic can take on, or the actual value of the characteristic."
}

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

• @baseType: string
  base class type (immediate parent) of the CustomerProfileSpecCharacteristicRelationship
• @schemaLocation: string
  hyperlink reference to schema describing this object
• @type(required): string
  Class type of target customer profile specification Characteristic Relationship
• charSpecSeq: integer
  Characteristic sequence.
• href: string
  A string. Reference of the target customer profile.
• id(required): string
  A string. Unique identifier of the target customer profile Specification.
• name(required): string
  A string. Name of the target characteristic.
• relationshipType(required): string
  Allowed Values: [ "AGGREGATION", "MIGRATION", "SUBSTITUTION", "DEPENDENCY", "EXCLUSIVITY" ]

  A string. Type of relationship such as aggregation, migration, substitution, dependency, exclusivity.
• validFor: object TimePeriodOracle
  Title: TimePeriodOracle

  Validity period of the related party

{
    "title":"CustProfSpecCharRelationshipOracle",
    "type":"object",
    "description":"A list of customer profile spec char relationships. An aggregation, migration, substitution, dependency or exclusivity relationship between/among Specification Characteristics.",
    "properties":{
        "relationshipType":{
            "type":"string",
            "description":"A string. Type of relationship such as aggregation, migration, substitution, dependency, exclusivity.",
            "enum":[
                "AGGREGATION",
                "MIGRATION",
                "SUBSTITUTION",
                "DEPENDENCY",
                "EXCLUSIVITY"
            ]
        },
        "charSpecSeq":{
            "type":"integer",
            "description":"Characteristic sequence."
        },
        "validFor":{
            "description":"A time period. The period for which the customerProfileSpecCharRelationship is valid.",
            "$ref":"#/components/schemas/TimePeriodOracle"
        },
        "id":{
            "type":"string",
            "description":"A string. Unique identifier of the target customer profile Specification."
        },
        "name":{
            "type":"string",
            "description":"A string. Name of the target characteristic."
        },
        "href":{
            "type":"string",
            "description":"A string. Reference of the target customer profile."
        },
        "@type":{
            "type":"string",
            "description":"Class type of target customer profile specification Characteristic Relationship"
        },
        "@baseType":{
            "type":"string",
            "description":"base class type  (immediate parent) of the CustomerProfileSpecCharacteristicRelationship"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"hyperlink reference to schema describing this object"
        }
    },
    "required":[
        "id",
        "name",
        "relationshipType",
        "@type"
    ]
}

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

• @baseType: string
  The immediate base class type of the specification
• @schemaLocation: string
  A link to the schema describing this specification entity
• @type(required): string
  the class type of the specification
• href: string
  Reference of the specification
• id(required): string
  Unique identifier of the specification
• name: string
  name of the specification
• relationshipType(required): string
  Allowed Values: [ "AGGREGATION", "MIGRATION", "SUBSTITUTION", "DEPENDENCY", "EXCLUSIVITY" ]

  A string. Type of relationship such as migration, substitution, dependency, exclusivity.
• validFor: object TimePeriodOracle
  Title: TimePeriodOracle

  Validity period of the related party

{
    "type":"object",
    "title":"CustProfSpecRelationshipOracle",
    "description":"A list of usage spec relationships (CustomerProfileSpecificationRelationship [*]). A list of customer profile specifications related to this specification.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the specification"
        },
        "href":{
            "type":"string",
            "description":"Reference of the specification"
        },
        "name":{
            "type":"string",
            "description":"name of the specification"
        },
        "relationshipType":{
            "type":"string",
            "description":"A string. Type of relationship such as migration, substitution, dependency, exclusivity.",
            "enum":[
                "AGGREGATION",
                "MIGRATION",
                "SUBSTITUTION",
                "DEPENDENCY",
                "EXCLUSIVITY"
            ]
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriodOracle"
        },
        "@type":{
            "type":"string",
            "description":"the class type of the specification"
        },
        "@baseType":{
            "type":"string",
            "description":"The immediate base class type of the specification"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this specification entity"
        }
    },
    "required":[
        "id",
        "relationshipType",
        "@type"
    ]
}

Nested Schema : RelatedParty

Type: object

Title: RelatedParty

RelatedParty reference. A related party defines party or party role linked to a specific entity.

Show Source

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type(required): string
  When sub-classing, this defines the sub-class Extensible name.
• partyOrPartyRole(required): partyOrPartyRole
• role: string
  Role played by the related party or party role in the context of the specific entity it is linked to. Such as 'initiator', 'customer', 'salesAgent', 'user'.

{
    "title":"RelatedParty",
    "description":"RelatedParty reference. A related party defines party or party role linked to a specific entity.",
    "type":"object",
    "properties":{
        "role":{
            "type":"string",
            "description":"Role played by the related party or party role in the context of the specific entity it is linked to. Such as 'initiator', 'customer', 'salesAgent', 'user'."
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class Extensible name."
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships."
        },
        "partyOrPartyRole":{
            "items":{
                "anyOf":[
                    {
                        "$ref":"#/components/schemas/PartyRef"
                    },
                    {
                        "$ref":"#/components/schemas/PartyRoleRef"
                    }
                ]
            }
        }
    },
    "required":[
        "@type",
        "partyOrPartyRole"
    ]
}

Nested Schema : partyOrPartyRole

Type: array

Show Source

• Array of:

{
    "items":{
        "anyOf":[
            {
                "$ref":"#/components/schemas/PartyRef"
            },
            {
                "$ref":"#/components/schemas/PartyRoleRef"
            }
        ]
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Your request is successful and the resources have been created or updated.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object CustomerProfileSpecificationOracle
  Title: CustomerProfileSpecificationOracle

  The Customer Profile Specification resource represents a set of customer profile characteristics and relationships.

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

Nested Schema : CustomerProfileSpecificationOracle

Type: object

Title: CustomerProfileSpecificationOracle

The Customer Profile Specification resource represents a set of customer profile characteristics and relationships.

Show Source

• @baseType: string
  Immediate base (class) type of the Customer Profile Specification
• @schemaLocation: string
  A link to the schema describing this Customer Profle Specification
• @type(required): string
  Class type of the Customer Profile Specification
• applicationName: string
  name of the external application
• created: string (date-time)
  Date and time of the creation
• createdBy: string
  name of the person who created item
• custProfSpecCharacteristic: array custProfSpecCharacteristic
• custProfSpecificationRelationship: array custProfSpecificationRelationship
• description: string
  A string. A narrative that explains in detail what the customer profile specification is.
• externalId: string
  id of the external application
• href: string
  A string. Reference of the customer profile specification.
• id: string
  Maximum Length: 30

  A string. Unique identifier of the customer profile specification.
• lastUpdate: string (date-time)
  A date time (DateTime). Date and time of the last update of the Customer Profile specification.
• lastUpdatedBy: string
  name of the person who updated item
• lifecycleStatus: string
  A string. Used to indicate the current lifecycle status of the customer profile specification.
• name(required): string
  A string. Name of the customer profile specification.
• project: object ProjectRef
  Title: ProjectRef

  Project Reference
• relatedParty: array relatedParty
• validFor: object TimePeriod
  Title: TimePeriod

  The period for which the productOffering is valid
• version: string
  A string. customer profile specification version.
• versionState: number
  Version state of the Customer Profile Specification

{
    "title":"CustomerProfileSpecificationOracle",
    "type":"object",
    "description":"The Customer Profile Specification resource represents a set of customer profile characteristics and relationships.",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":"30",
            "description":"A string. Unique identifier of the customer profile specification."
        },
        "href":{
            "type":"string",
            "description":"A string. Reference of the customer profile specification."
        },
        "version":{
            "type":"string",
            "description":"A string. customer profile specification version."
        },
        "name":{
            "type":"string",
            "description":"A string. Name of the customer profile specification."
        },
        "description":{
            "type":"string",
            "description":"A string. A narrative that explains in detail what the customer profile specification is."
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"A string. Used to indicate the current lifecycle status of the customer profile specification."
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        },
        "@type":{
            "type":"string",
            "description":"Class type of the Customer Profile Specification"
        },
        "@baseType":{
            "type":"string",
            "description":"Immediate base (class) type of the Customer Profile Specification"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this Customer Profle Specification"
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"A date time (DateTime). Date and time of the last update of the Customer Profile specification."
        },
        "custProfSpecificationRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CustProfSpecRelationshipOracle"
            }
        },
        "custProfSpecCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CustProfSpecCharacteristicOracle"
            }
        },
        "relatedParty":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelatedPartyRefOrPartyRoleRef"
            }
        },
        "project":{
            "$ref":"#/components/schemas/ProjectRef"
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the creation"
        },
        "createdBy":{
            "type":"string",
            "description":"name of the person who created item"
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"name of the person who updated item"
        },
        "externalId":{
            "type":"string",
            "description":"id of the external application"
        },
        "applicationName":{
            "type":"string",
            "description":"name of the external application"
        },
        "versionState":{
            "type":"number",
            "description":"Version state of the Customer Profile Specification"
        }
    },
    "required":[
        "name",
        "@type"
    ]
}

Nested Schema : custProfSpecCharacteristic

Type: array

Show Source

• Array of: object CustProfSpecCharacteristicOracle
  Title: CustProfSpecCharacteristicOracle

  A list of customer profile spec characteristics (CustomerProfileSpecificationCharacteristic [*]). This class represents the key features of this customer profile specification.

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

Nested Schema : custProfSpecificationRelationship

Type: array

Show Source

• Array of: object CustProfSpecRelationshipOracle
  Title: CustProfSpecRelationshipOracle

  A list of usage spec relationships (CustomerProfileSpecificationRelationship [*]). A list of customer profile specifications related to this specification.

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

Nested Schema : ProjectRef

Type: object

Title: ProjectRef

Project Reference

Show Source

• href: string
  Unique reference of the project
• id(required): string
  Unique identifier of the project
• name: string
  Name of the project
• version: string
  Version of the project

{
    "title":"ProjectRef",
    "type":"object",
    "description":"Project Reference",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the project"
        },
        "href":{
            "type":"string",
            "description":"Unique reference of the project"
        },
        "name":{
            "type":"string",
            "description":"Name of the project"
        },
        "version":{
            "type":"string",
            "description":"Version of the project"
        }
    },
    "required":[
        "id"
    ]
}

Nested Schema : relatedParty

Type: array

Show Source

• Array of: object RelatedParty
  Title: RelatedParty

  RelatedParty reference. A related party defines party or party role linked to a specific entity.

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

Nested Schema : TimePeriod

Type: object

Title: TimePeriod

The period for which the productOffering is valid

Show Source

• endDateTime: string (date-time)
  An instant of time, ending at the TimePeriod.
• startDateTime: string (date-time)
  An instant of time, starting at the TimePeriod

{
    "title":"TimePeriod",
    "description":"The period for which the productOffering is valid",
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An instant of time, starting at the TimePeriod"
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An instant of time, ending at the TimePeriod."
        }
    }
}

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

• @baseType: string
  base class type (immediate parent) of the CustProfSpecCharacteristic
• @schemaLocation: string
  hyperlink reference to the schema describing this characteristic
• @type(required): string
  the class type of this characteristic
• @valueSchemaLocation: string
  A string. This (optional) field provides a link to the schema describing the value type.
• configurable: boolean
  A boolean. If true, the Boolean indicates that the CustProfSpecCharacteristic is configurable.
• custProfSpecCharacteristicValue: array custProfSpecCharacteristicValue
• custProfSpecCharRelationship: array custProfSpecCharRelationship
• description: string
  A string. A narrative that explains in detail what the SpecCharacteristic is.
• extensible: boolean
  A boolean. An indicator that specifies that the values for the characteristic can be extended by adding new values when instantiating a characteristic for an Entity.
• isUnique: boolean
  A boolean. An indicator that specifies if a value is unique for the specification. Possible values are; 'unique while value is in effect' and 'unique whether value is in effect or not'.
• maxCardinality: integer
  An integer. The maximum number of instances a CharacteristicValue can take on.
• minCardinality: integer
  An integer. The minimum number of instances a CharacteristicValue can take on.
• name(required): string
  A string. A word, term, or phrase by which this characteristic specification is known and distinguished from other characteristic specifications.
• regex: string
  A string. A rule or principle represented in regular expression used to derive the value of a characteristic value.
• validFor: object TimePeriodOracle
  Title: TimePeriodOracle

  Validity period of the related party
• valueType: string
  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.

{
    "title":"CustProfSpecCharacteristicOracle",
    "type":"object",
    "description":"A list of customer profile spec characteristics (CustomerProfileSpecificationCharacteristic [*]). This class represents the key features of this customer profile specification.",
    "properties":{
        "name":{
            "type":"string",
            "description":"A string. A word, term, or phrase by which this characteristic specification is known and distinguished from other characteristic specifications."
        },
        "description":{
            "type":"string",
            "description":"A string. A narrative that explains in detail what the SpecCharacteristic is."
        },
        "valueType":{
            "type":"string",
            "description":"A string. A kind of value that the characteristic can take on, such as numeric, text and so forth.",
            "enum":[
                "STRING",
                "NUMBER",
                "OBJECT",
                "ARRAY",
                "DECIMAL",
                "BOOLEAN",
                "DATE",
                "DATETIME"
            ]
        },
        "configurable":{
            "type":"boolean",
            "description":"A boolean. If true, the Boolean indicates that the CustProfSpecCharacteristic is configurable."
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriodOracle"
        },
        "@type":{
            "type":"string",
            "description":"the class type of this characteristic"
        },
        "@baseType":{
            "type":"string",
            "description":"base class type  (immediate parent) of the CustProfSpecCharacteristic"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"hyperlink reference to the schema describing this characteristic"
        },
        "@valueSchemaLocation":{
            "type":"string",
            "description":"A string. This (optional) field provides a link to the schema describing the value type."
        },
        "minCardinality":{
            "type":"integer",
            "description":"An integer. The minimum number of instances a CharacteristicValue can take on."
        },
        "maxCardinality":{
            "type":"integer",
            "description":"An integer. The maximum number of instances a CharacteristicValue can take on."
        },
        "isUnique":{
            "type":"boolean",
            "description":"A boolean. An indicator that specifies if a value is unique for the specification. Possible values are; 'unique while value is in effect' and 'unique whether value is in effect or not'."
        },
        "regex":{
            "type":"string",
            "description":"A string. A rule or principle represented in regular expression used to derive the value of a characteristic value."
        },
        "extensible":{
            "type":"boolean",
            "description":"A boolean. An indicator that specifies that the values for the characteristic can be extended by adding new values when instantiating a characteristic for an Entity."
        },
        "custProfSpecCharRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CustProfSpecCharRelationshipOracle"
            }
        },
        "custProfSpecCharacteristicValue":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CustProfSpecCharacteristicValueOracle"
            }
        }
    },
    "required":[
        "name",
        "@type"
    ]
}

Nested Schema : custProfSpecCharacteristicValue

Type: array

Show Source

• Array of: object 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.

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

Nested Schema : custProfSpecCharRelationship

Type: array

Show Source

• Array of: object CustProfSpecCharRelationshipOracle
  Title: CustProfSpecCharRelationshipOracle

  A list of customer profile spec char relationships. An aggregation, migration, substitution, dependency or exclusivity relationship between/among Specification Characteristics.

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

Nested Schema : TimePeriodOracle

Type: object

Title: TimePeriodOracle

Validity period of the related party

Show Source

• endDateTime: string (date-time)
  An instant of time, ending at the TimePeriod.
• startDateTime: string (date-time)
  An instant of time, starting at the TimePeriod

{
    "description":"Validity period of the related party",
    "title":"TimePeriodOracle",
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An instant of time, starting at the TimePeriod"
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An instant of time, ending at the TimePeriod."
        }
    }
}

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

• @baseType: string
  base class type (immediate parent) of the ServiceSpecCharacteristicValue
• @schemaLocation: string
  Hyperlink reference to schema describing this object
• @type(required): string
  The class type of the characteristic value
• isDefault: boolean
  A boolean. Indicates if the value is the default value for a characteristic.
• rangeInterval: string
  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'.
• regex: string
  A string. A regular expression constraint for given value.
• unitOfMeasure: string
  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.
• validFor: object TimePeriodOracle
  Title: TimePeriodOracle

  Validity period of the related party
• value(required): value
  An object (object). A discrete value that the characteristic can take on, or the actual value of the characteristic.
• valueFrom: string
  An integer. The low range value that a characteristic can take on.
• valueTo: string
  An integer. The upper range value that a characteristic can take on.
• valueType: string
  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.

{
    "title":"CustProfSpecCharacteristicValueOracle",
    "type":"object",
    "description":"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.",
    "properties":{
        "isDefault":{
            "type":"boolean",
            "description":"A boolean. Indicates if the value is the default value for a characteristic."
        },
        "unitOfMeasure":{
            "type":"string",
            "description":"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."
        },
        "validFor":{
            "description":"A time period. The period of time for which a value is applicable.",
            "$ref":"#/components/schemas/TimePeriodOracle"
        },
        "value":{
            "oneOf":[
                {
                    "type":"string"
                },
                {
                    "type":"object"
                },
                {
                    "type":"number"
                },
                {
                    "type":"boolean"
                },
                {
                    "type":"array"
                }
            ],
            "description":"An object (object). A discrete value that the characteristic can take on, or the actual value of the characteristic."
        },
        "valueFrom":{
            "type":"string",
            "description":"An integer. The low range value that a characteristic can take on."
        },
        "valueTo":{
            "type":"string",
            "description":"An integer. The upper range value that a characteristic can take on."
        },
        "valueType":{
            "type":"string",
            "description":"A string. A kind of value that the characteristic can take on, such as numeric, text, and so forth.",
            "enum":[
                "STRING",
                "NUMBER",
                "OBJECT",
                "ARRAY",
                "DECIMAL",
                "BOOLEAN",
                "DATE",
                "DATETIME"
            ]
        },
        "rangeInterval":{
            "type":"string",
            "description":"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'.",
            "enum":[
                "OPEN",
                "CLOSED",
                "CLOSED_BOTTOM",
                "CLOSED_TOP"
            ]
        },
        "regex":{
            "type":"string",
            "description":"A string. A regular expression constraint for given value."
        },
        "@type":{
            "type":"string",
            "description":"The class type of the characteristic value"
        },
        "@baseType":{
            "type":"string",
            "description":"base class type  (immediate parent) of the ServiceSpecCharacteristicValue"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"Hyperlink reference to schema describing this object"
        }
    },
    "required":[
        "value",
        "@type"
    ]
}

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

• string
• object value-oneOf[1]
• number
• boolean
• array value-oneOf[4]

{
    "oneOf":[
        {
            "type":"string"
        },
        {
            "type":"object"
        },
        {
            "type":"number"
        },
        {
            "type":"boolean"
        },
        {
            "type":"array"
        }
    ],
    "description":"An object (object). A discrete value that the characteristic can take on, or the actual value of the characteristic."
}

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

• @baseType: string
  base class type (immediate parent) of the CustomerProfileSpecCharacteristicRelationship
• @schemaLocation: string
  hyperlink reference to schema describing this object
• @type(required): string
  Class type of target customer profile specification Characteristic Relationship
• charSpecSeq: integer
  Characteristic sequence.
• href: string
  A string. Reference of the target customer profile.
• id(required): string
  A string. Unique identifier of the target customer profile Specification.
• name(required): string
  A string. Name of the target characteristic.
• relationshipType(required): string
  Allowed Values: [ "AGGREGATION", "MIGRATION", "SUBSTITUTION", "DEPENDENCY", "EXCLUSIVITY" ]

  A string. Type of relationship such as aggregation, migration, substitution, dependency, exclusivity.
• validFor: object TimePeriodOracle
  Title: TimePeriodOracle

  Validity period of the related party

{
    "title":"CustProfSpecCharRelationshipOracle",
    "type":"object",
    "description":"A list of customer profile spec char relationships. An aggregation, migration, substitution, dependency or exclusivity relationship between/among Specification Characteristics.",
    "properties":{
        "relationshipType":{
            "type":"string",
            "description":"A string. Type of relationship such as aggregation, migration, substitution, dependency, exclusivity.",
            "enum":[
                "AGGREGATION",
                "MIGRATION",
                "SUBSTITUTION",
                "DEPENDENCY",
                "EXCLUSIVITY"
            ]
        },
        "charSpecSeq":{
            "type":"integer",
            "description":"Characteristic sequence."
        },
        "validFor":{
            "description":"A time period. The period for which the customerProfileSpecCharRelationship is valid.",
            "$ref":"#/components/schemas/TimePeriodOracle"
        },
        "id":{
            "type":"string",
            "description":"A string. Unique identifier of the target customer profile Specification."
        },
        "name":{
            "type":"string",
            "description":"A string. Name of the target characteristic."
        },
        "href":{
            "type":"string",
            "description":"A string. Reference of the target customer profile."
        },
        "@type":{
            "type":"string",
            "description":"Class type of target customer profile specification Characteristic Relationship"
        },
        "@baseType":{
            "type":"string",
            "description":"base class type  (immediate parent) of the CustomerProfileSpecCharacteristicRelationship"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"hyperlink reference to schema describing this object"
        }
    },
    "required":[
        "id",
        "name",
        "relationshipType",
        "@type"
    ]
}

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

• @baseType: string
  The immediate base class type of the specification
• @schemaLocation: string
  A link to the schema describing this specification entity
• @type(required): string
  the class type of the specification
• href: string
  Reference of the specification
• id(required): string
  Unique identifier of the specification
• name: string
  name of the specification
• relationshipType(required): string
  Allowed Values: [ "AGGREGATION", "MIGRATION", "SUBSTITUTION", "DEPENDENCY", "EXCLUSIVITY" ]

  A string. Type of relationship such as migration, substitution, dependency, exclusivity.
• validFor: object TimePeriodOracle
  Title: TimePeriodOracle

  Validity period of the related party

{
    "type":"object",
    "title":"CustProfSpecRelationshipOracle",
    "description":"A list of usage spec relationships (CustomerProfileSpecificationRelationship [*]). A list of customer profile specifications related to this specification.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the specification"
        },
        "href":{
            "type":"string",
            "description":"Reference of the specification"
        },
        "name":{
            "type":"string",
            "description":"name of the specification"
        },
        "relationshipType":{
            "type":"string",
            "description":"A string. Type of relationship such as migration, substitution, dependency, exclusivity.",
            "enum":[
                "AGGREGATION",
                "MIGRATION",
                "SUBSTITUTION",
                "DEPENDENCY",
                "EXCLUSIVITY"
            ]
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriodOracle"
        },
        "@type":{
            "type":"string",
            "description":"the class type of the specification"
        },
        "@baseType":{
            "type":"string",
            "description":"The immediate base class type of the specification"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this specification entity"
        }
    },
    "required":[
        "id",
        "relationshipType",
        "@type"
    ]
}

Nested Schema : RelatedParty

Type: object

Title: RelatedParty

RelatedParty reference. A related party defines party or party role linked to a specific entity.

Show Source

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string
  A URI to a JSON-Schema file that defines additional attributes and relationships.
• @type(required): string
  When sub-classing, this defines the sub-class Extensible name.
• partyOrPartyRole(required): partyOrPartyRole
• role: string
  Role played by the related party or party role in the context of the specific entity it is linked to. Such as 'initiator', 'customer', 'salesAgent', 'user'.

{
    "title":"RelatedParty",
    "description":"RelatedParty reference. A related party defines party or party role linked to a specific entity.",
    "type":"object",
    "properties":{
        "role":{
            "type":"string",
            "description":"Role played by the related party or party role in the context of the specific entity it is linked to. Such as 'initiator', 'customer', 'salesAgent', 'user'."
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class Extensible name."
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships."
        },
        "partyOrPartyRole":{
            "items":{
                "anyOf":[
                    {
                        "$ref":"#/components/schemas/PartyRef"
                    },
                    {
                        "$ref":"#/components/schemas/PartyRoleRef"
                    }
                ]
            }
        }
    },
    "required":[
        "@type",
        "partyOrPartyRole"
    ]
}

Nested Schema : partyOrPartyRole

Type: array

Show Source

• Array of:

{
    "items":{
        "anyOf":[
            {
                "$ref":"#/components/schemas/PartyRef"
            },
            {
                "$ref":"#/components/schemas/PartyRoleRef"
            }
        ]
    }
}

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

• Array of: object Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "Error":"#/components/schemas/Error", "BulkError":"#/components/schemas/BulkError" } }

{
    "type":"array",
    "items":{
        "anyOf":[
            {
                "$ref":"#/components/schemas/Error"
            },
            {
                "$ref":"#/components/schemas/BulkError"
            }
        ],
        "discriminator":{
            "propertyName":"@type",
            "mapping":{
                "Error":"#/components/schemas/Error",
                "BulkError":"#/components/schemas/BulkError"
            }
        }
    }
}

Nested Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

• Error
• BulkError

{
    "anyOf":[
        {
            "$ref":"#/components/schemas/Error"
        },
        {
            "$ref":"#/components/schemas/BulkError"
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Error":"#/components/schemas/Error",
            "BulkError":"#/components/schemas/BulkError"
        }
    }
}

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

• @schemaLocation: string
  it provides a link to the schema describing a REST resource.
• @type: string
  The class type of a REST resource.
• code(required): string
  Application related code (as defined in the API or from a common list)
• message: string
  Text that provide more details and corrective actions related to the error. This can be shown to a client user.
• reason(required): string
  Text that explains the reason for error. This can be shown to a client user.
• referenceError: string
  url pointing to documentation describing the error
• status: string
  http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"it provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

404 Response

Your request includes a resource URI that doesn't exist.

Body ()

Root Schema : Error

Type: object

Title: Error

Show Source

• @schemaLocation: string
  it provides a link to the schema describing a REST resource.
• @type: string
  The class type of a REST resource.
• code(required): string
  Application related code (as defined in the API or from a common list)
• message: string
  Text that provide more details and corrective actions related to the error. This can be shown to a client user.
• reason(required): string
  Text that explains the reason for error. This can be shown to a client user.
• referenceError: string
  url pointing to documentation describing the error
• status: string
  http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"it provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

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

• @schemaLocation: string
  it provides a link to the schema describing a REST resource.
• @type: string
  The class type of a REST resource.
• code(required): string
  Application related code (as defined in the API or from a common list)
• message: string
  Text that provide more details and corrective actions related to the error. This can be shown to a client user.
• reason(required): string
  Text that explains the reason for error. This can be shown to a client user.
• referenceError: string
  url pointing to documentation describing the error
• status: string
  http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"it provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

500 Response

The server encountered something unexpected that prevented it from completing the request.

Body ()

Root Schema : Error

Type: object

Title: Error

Show Source

• @schemaLocation: string
  it provides a link to the schema describing a REST resource.
• @type: string
  The class type of a REST resource.
• code(required): string
  Application related code (as defined in the API or from a common list)
• message: string
  Text that provide more details and corrective actions related to the error. This can be shown to a client user.
• reason(required): string
  Text that explains the reason for error. This can be shown to a client user.
• referenceError: string
  url pointing to documentation describing the error
• status: string
  http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"it provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

Back to Top

Examples

The following example shows how to create or update an array of customer profile specification 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/customerProfileSpecifications -H 'Content-Type: application/json' -D @customprofilespecifications.json | json_pp

Example of Request Body

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

[
    {
        "id": "CustomerProfileSpec_Y2021_001",
        "name": "CustomerProfileSpec_Y2021_001",
        "description": "Description of CustomerProfileSpec_Y2021_001",
        "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": {
            "id": "BulkDocProject",
            "name": "Bulk Doc Project"
        },
        "custProfSpecCharacteristic": [
            {
                "name": "generalInformation",
                "description": "General Information",
                "valueType": "STRING",
                "extensible": false,
                "configurable": false,
                "isUnique": true,
                "minCardinality": 0,
                "maxCardinality": 1,
                "validFor": {
                    "startDateTime": "2020-01-18T00:00:00.000Z",
                    "endDateTime": "2021-02-20T16:42:23.000Z"
                }
            },
            {
                "name": "availableColor",
                "description": "Available Color",
                "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": [
                    {
                        "unitOfMeasure": "GIGABYTE",
                        "isDefault": false,
                        "validFor": {
                            "startDateTime": "2020-01-18T00:00:00.000Z",
                            "endDateTime": "2021-02-20T16:42:23.000Z"
                        },
                        "valueType": "STRING",
                        "value": "Maple Gold"
                    },
                    {
                        "unitOfMeasure": "GIGABYTE",
                        "isDefault": false,
                        "validFor": {
                            "startDateTime": "2020-01-18T00:00:00.000Z",
                            "endDateTime": "2021-02-20T16:42:23.000Z"
                        },
                        "valueType": "STRING",
                        "value": "Crown Silver"
                    },
                    {
                        "unitOfMeasure": "GIGABYTE",
                        "isDefault": true,
                        "validFor": {
                            "startDateTime": "2020-01-18T00:00:00.000Z",
                            "endDateTime": "2021-02-20T16:42:23.000Z"
                        },
                        "valueType": "STRING",
                        "value": "Majestic Black"
                    },
                    {
                        "unitOfMeasure": "GIGABYTE",
                        "isDefault": false,
                        "validFor": {
                            "startDateTime": "2020-01-18T00:00:00.000Z",
                            "endDateTime": "2021-02-20T16:42:23.000Z"
                        },
                        "valueType": "STRING",
                        "value": "Royal Gold"
                    }
                ]
            }
        ]
    },
    {
        "id": "CustomerProfileSpec_Y2021_002",
        "name": "CustomerProfileSpec_Y2021_002",
        "description": "description of CustomerProfileSpec_Y2021_002",
        "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": {
            "id": "BulkDocProject",
            "name": "Bulk Doc Project"
        },
        "custProfSpecCharacteristic": [
            {
                "name": "generalInformation_att",
                "description": "General Information att",
                "valueType": "STRING",
                "extensible": false,
                "configurable": false,
                "isUnique": true,
                "minCardinality": 0,
                "maxCardinality": 1,
                "validFor": {
                    "startDateTime": "2020-01-18T00:00:00.000Z",
                    "endDateTime": "2021-02-20T16:42:23.000Z"
                }
            },
            {
                "name": "availableColor",
                "description": "Available Color",
                "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": [
                    {
                        "unitOfMeasure": "GIGABYTE",
                        "isDefault": false,
                        "validFor": {
                            "startDateTime": "2020-01-18T00:00:00.000Z",
                            "endDateTime": "2021-02-20T16:42:23.000Z"
                        },
                        "valueType": "STRING",
                        "value": "Maple Gold"
                    },
                    {
                        "unitOfMeasure": "GIGABYTE",
                        "isDefault": false,
                        "validFor": {
                            "startDateTime": "2020-01-18T00:00:00.000Z",
                            "endDateTime": "2021-02-20T16:42:23.000Z"
                        },
                        "valueType": "STRING",
                        "value": "Crown Silver"
                    },
                    {
                        "unitOfMeasure": "GIGABYTE",
                        "isDefault": true,
                        "validFor": {
                            "startDateTime": "2020-01-18T00:00:00.000Z",
                            "endDateTime": "2021-02-20T16:42:23.000Z"
                        },
                        "valueType": "STRING",
                        "value": "Majestic Black"
                    },
                    {
                        "unitOfMeasure": "GIGABYTE",
                        "isDefault": false,
                        "validFor": {
                            "startDateTime": "2020-01-18T00:00:00.000Z",
                            "endDateTime": "2021-02-20T16:42:23.000Z"
                        },
                        "valueType": "STRING",
                        "value": "Royal Gold"
                    }
                ]
            }
        ]
    }
]

Example of Response Body

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

[
    {
        "id": "CustomerProfileSpec_Y2021_001",
        "name": "CustomerProfileSpec_Y2021_001",
        "description": "Description of CustomerProfileSpec_Y2021_001",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/customerProfileSpecifications/CustomerProfileSpec_Y2021_001",
        "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": {
            "id": "BulkDocProject",
            "name": "Bulk Doc Project",
            "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/BulkDocProject"
        },
        "custProfSpecCharacteristic": [
            {
                "name": "generalInformation",
                "description": "General Information",
                "valueType": "STRING",
                "extensible": false,
                "configurable": false,
                "isUnique": true,
                "minCardinality": 0,
                "maxCardinality": 1,
                "validFor": {
                    "startDateTime": "2020-01-18T00:00:00.000Z",
                    "endDateTime": "2021-02-20T16:42:23.000Z"
                }
            },
            {
                "name": "availableColor",
                "description": "Available Color",
                "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"
                        },
                        "unitOfMeasure": "GIGABYTE",
                        "valueType": "STRING",
                        "value": "Maple Gold"
                    },
                    {
                        "isDefault": false,
                        "validFor": {
                            "startDateTime": "2020-01-18T00:00:00.000Z",
                            "endDateTime": "2021-02-20T16:42:23.000Z"
                        },
                        "unitOfMeasure": "GIGABYTE",
                        "valueType": "STRING",
                        "value": "Crown Silver"
                    },
                    {
                        "isDefault": true,
                        "validFor": {
                            "startDateTime": "2020-01-18T00:00:00.000Z",
                            "endDateTime": "2021-02-20T16:42:23.000Z"
                        },
                        "unitOfMeasure": "GIGABYTE",
                        "valueType": "STRING",
                        "value": "Majestic Black"
                    },
                    {
                        "isDefault": false,
                        "validFor": {
                            "startDateTime": "2020-01-18T00:00:00.000Z",
                            "endDateTime": "2021-02-20T16:42:23.000Z"
                        },
                        "unitOfMeasure": "GIGABYTE",
                        "valueType": "STRING",
                        "value": "Royal Gold"
                    }
                ]
            }
        ]
    },
    {
        "id": "CustomerProfileSpec_Y2021_002",
        "name": "CustomerProfileSpec_Y2021_002",
        "description": "description of CustomerProfileSpec_Y2021_002",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/customerProfileSpecifications/CustomerProfileSpec_Y2021_002",
        "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": {
            "id": "BulkDocProject",
            "name": "Bulk Doc Project",
            "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/BulkDocProject"
        },
        "custProfSpecCharacteristic": [
            {
                "name": "generalInformation_att",
                "description": "General Information att",
                "valueType": "STRING",
                "extensible": false,
                "configurable": false,
                "isUnique": true,
                "minCardinality": 0,
                "maxCardinality": 1,
                "validFor": {
                    "startDateTime": "2020-01-18T00:00:00.000Z",
                    "endDateTime": "2021-02-20T16:42:23.000Z"
                }
            },
            {
                "name": "availableColor",
                "description": "Available Color",
                "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"
                        },
                        "unitOfMeasure": "GIGABYTE",
                        "valueType": "STRING",
                        "value": "Maple Gold"
                    },
                    {
                        "isDefault": false,
                        "validFor": {
                            "startDateTime": "2020-01-18T00:00:00.000Z",
                            "endDateTime": "2021-02-20T16:42:23.000Z"
                        },
                        "unitOfMeasure": "GIGABYTE",
                        "valueType": "STRING",
                        "value": "Crown Silver"
                    },
                    {
                        "isDefault": true,
                        "validFor": {
                            "startDateTime": "2020-01-18T00:00:00.000Z",
                            "endDateTime": "2021-02-20T16:42:23.000Z"
                        },
                        "unitOfMeasure": "GIGABYTE",
                        "valueType": "STRING",
                        "value": "Majestic Black"
                    },
                    {
                        "isDefault": false,
                        "validFor": {
                            "startDateTime": "2020-01-18T00:00:00.000Z",
                            "endDateTime": "2021-02-20T16:42:23.000Z"
                        },
                        "unitOfMeasure": "GIGABYTE",
                        "valueType": "STRING",
                        "value": "Royal Gold"
                    }
                ]
            }
        ]
    }
]

Back to Top