REST API Reference for Launch Cloud Service

Get all customer profile specifications

get

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

Returns a list of customer profile specifications that match the search criteria.

Request

Query Parameters

description: string

The description of the resource.
eligibleForProject: string

The project ID.
fields: string

The comma-separated field names that are returned in the response. The field names are the names that you specify when you create or retrieve a resource.
id: string

The unique ID of the resource item.
lastUpdate: string

Filters resources by their last update date and time.
lifecycleStatus: string

The current lifecycle status of the resource.
limit: integer

The number of resources to be returned in the response. The minimum value that can be specified is 1, and the maximum value that can be specified is 100,000. If the specified value is greater than 100,000, then it defaults to 100,000.
name: string

The name of the resource.
offset: string

The record number from which the retrieval starts. The default value is zero. If no value is specified, then it defaults to zero. The value zero indicates that the retrieval will start from the beginning of the collection.
profileType: string

The type or classification of the resource.
project.id: string

The ID of the project for filtering resource results.
project.version: string

The project version for filtering entities.
validFor.endDateTime: string

The valid for end date time for filtering entities.
validFor.startDateTime: string

The valid for start date time for filtering entities.
version: string

The current version of the resource.

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

The list of customer profile specifications was returned successfully.

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

The base type of the customer profile specification.
@schemaLocation: string

The URI of the schema that defines the customer profile specification.
@type(required): string

The class type of the customer profile specification.
applicationName: string

The name of the application associated with the customer profile specification.
created: string (date-time)

The date and time of the creation.
createdBy: string

The name of the person who created item.
custProfSpecCharacteristic: array custProfSpecCharacteristic

A list of cust prof specification characteristics associated with the customer profile specification.
custProfSpecificationRelationship: array custProfSpecificationRelationship

A list of cust prof specification relationships associated with the customer profile specification.
description: string

A string. A narrative that explains in detail what the customer profile specification is.
externalId: string

The ID of the external associated with the customer profile specification.
href: string

A string. Reference of the customer profile specification.
id: string

Maximum Length: 30

The ID 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

The name of the person who updated item.
lifecycleStatus: string

Indicates 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

The project reference resource.
relatedParty: array relatedParty

A list of related parties associated with the customer profile specification.
validFor: object TimePeriod

Title: TimePeriod

The period for which the productOffering is valid.
version: string

The customer profile specification version.
versionState: number

The 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":"The ID of the customer profile specification."
        },
        "href":{
            "type":"string",
            "description":"A string. Reference of the customer profile specification."
        },
        "version":{
            "type":"string",
            "description":"The 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":"Indicates the current lifecycle status of the customer profile specification."
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod",
            "description":"The period for which the customer profile specification is valid."
        },
        "@type":{
            "type":"string",
            "description":"The class type of the customer profile specification."
        },
        "@baseType":{
            "type":"string",
            "description":"The base type of the customer profile specification."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the customer profile 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"
            },
            "description":"A list of cust prof specification relationships associated with the customer profile specification."
        },
        "custProfSpecCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CustProfSpecCharacteristicOracle"
            },
            "description":"A list of cust prof specification characteristics associated with the customer profile specification."
        },
        "relatedParty":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelatedPartyRefOrPartyRoleRef"
            },
            "description":"A list of related parties associated with the customer profile specification."
        },
        "project":{
            "$ref":"#/components/schemas/ProjectRef",
            "description":"The customer profile specification."
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time of the creation."
        },
        "createdBy":{
            "type":"string",
            "description":"The name of the person who created item."
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"The name of the person who updated item."
        },
        "externalId":{
            "type":"string",
            "description":"The ID of the external associated with the customer profile specification."
        },
        "applicationName":{
            "type":"string",
            "description":"The name of the application associated with the customer profile specification."
        },
        "versionState":{
            "type":"number",
            "description":"The version state of the Customer Profile Specification."
        }
    },
    "required":[
        "name",
        "@type"
    ]
}

Nested Schema : custProfSpecCharacteristic

Type: array

A list of cust prof specification characteristics associated with the customer profile specification.

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"
    },
    "description":"A list of cust prof specification characteristics associated with the customer profile specification."
}

Nested Schema : custProfSpecificationRelationship

Type: array

A list of cust prof specification relationships associated with the customer profile specification.

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"
    },
    "description":"A list of cust prof specification relationships associated with the customer profile specification."
}

Nested Schema : ProjectRef

Type: object

Title: ProjectRef

The project reference resource.

Show Source

href: string

The hyperlink reference to the project reference.
id(required): string

The ID of the project reference.
name: string

The name of the project reference.
version: string

The version of the project.

{
    "title":"ProjectRef",
    "type":"object",
    "description":"The project reference resource.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the project reference."
        },
        "href":{
            "type":"string",
            "description":"The hyperlink reference to the project reference."
        },
        "name":{
            "type":"string",
            "description":"The name of the project reference."
        },
        "version":{
            "type":"string",
            "description":"The version of the project."
        }
    },
    "required":[
        "id"
    ]
}

Nested Schema : relatedParty

Type: array

A list of related parties associated with the customer profile specification.

Show Source

Array of: object RelatedParty

Title: RelatedParty

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

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RelatedPartyRefOrPartyRoleRef"
    },
    "description":"A list of related parties associated with the customer profile specification."
}

Nested Schema : TimePeriod

Type: object

Title: TimePeriod

The period for which the productOffering is valid.

Show Source

endDateTime: string (date-time)

The end date and time of the time period.
startDateTime: string (date-time)

The start date and time of the time period.

{
    "title":"TimePeriod",
    "description":"The period for which the productOffering is valid.",
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The start date and time of the time period."
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The end date and time of the time period."
        }
    }
}

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

The base type of the cust prof specification characteristic.
@schemaLocation: string

The URI of the schema that defines the cust prof specification characteristic.
@type(required): string

The class type of the cust prof specification characteristic.
@valueSchemaLocation: string

A string. This (optional) field provides a link to the schema describing the value type.
configurable: boolean

Whether the cust prof specification characteristic is configurable.
custProfSpecCharacteristicValue: array custProfSpecCharacteristicValue

A list of cust prof specification characteristic values associated with the cust prof specification characteristic.
custProfSpecCharRelationship: array custProfSpecCharRelationship

A list of cust prof specification characteristic relationships associated with the cust prof specification characteristic.
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 rule or principle represented as a regular expression for deriving the value of a characteristic value.
validFor: object TimePeriodOracle

Title: TimePeriodOracle

The validity period of the related party.
valueType: string

Allowed Values: [ "STRING", "NUMBER", "OBJECT", "ARRAY", "DECIMAL", "BOOLEAN", "DATE", "DATETIME" ]

The type or classification of the cust prof specification characteristic. Valid values are STRING, NUMBER, OBJECT, ARRAY, DECIMAL, BOOLEAN, DATE, and DATETIME.

{
    "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":"The type or classification of the cust prof specification characteristic. Valid values are STRING, NUMBER, OBJECT, ARRAY, DECIMAL, BOOLEAN, DATE, and DATETIME.",
            "enum":[
                "STRING",
                "NUMBER",
                "OBJECT",
                "ARRAY",
                "DECIMAL",
                "BOOLEAN",
                "DATE",
                "DATETIME"
            ]
        },
        "configurable":{
            "type":"boolean",
            "description":"Whether the cust prof specification characteristic is configurable."
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriodOracle",
            "description":"The period for which the cust prof specification characteristic is valid."
        },
        "@type":{
            "type":"string",
            "description":"The class type of the cust prof specification characteristic."
        },
        "@baseType":{
            "type":"string",
            "description":"The base type of the cust prof specification characteristic."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the cust prof specification 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 rule or principle represented as a regular expression for deriving 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"
            },
            "description":"A list of cust prof specification characteristic relationships associated with the cust prof specification characteristic."
        },
        "custProfSpecCharacteristicValue":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CustProfSpecCharacteristicValueOracle"
            },
            "description":"A list of cust prof specification characteristic values associated with the cust prof specification characteristic."
        }
    },
    "required":[
        "name",
        "@type"
    ]
}

Nested Schema : custProfSpecCharacteristicValue

Type: array

A list of cust prof specification characteristic values associated with the cust prof specification characteristic.

Show Source

Array of: object CustProfSpecCharacteristicValueOracle

Title: CustProfSpecCharacteristicValueOracle

A list of customer profile spec characteristic values A CustomerProfileSpecificationCharacteristicValue object defines 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"
    },
    "description":"A list of cust prof specification characteristic values associated with the cust prof specification characteristic."
}

Nested Schema : custProfSpecCharRelationship

Type: array

A list of cust prof specification characteristic relationships associated with the cust prof specification characteristic.

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"
    },
    "description":"A list of cust prof specification characteristic relationships associated with the cust prof specification characteristic."
}

Nested Schema : TimePeriodOracle

Type: object

Title: TimePeriodOracle

The validity period of the related party.

Show Source

endDateTime: string (date-time)

The end date and time of the time period.
startDateTime: string (date-time)

The start date and time of the time period.

{
    "description":"The validity period of the related party.",
    "title":"TimePeriodOracle",
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The start date and time of the time period."
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The end date and time of the time period."
        }
    }
}

Nested Schema : CustProfSpecCharacteristicValueOracle

Type: object

Title: CustProfSpecCharacteristicValueOracle

A list of customer profile spec characteristic values A CustomerProfileSpecificationCharacteristicValue object defines 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

The base type of the cust prof specification characteristic value.
@schemaLocation: string

The URI of the schema that defines the cust prof specification characteristic value.
@type(required): string

The class type of the cust prof specification characteristic value.
isDefault: boolean

Whether the cust prof specification characteristic value is default.
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'. Valid values are OPEN, CLOSED, CLOSED_BOTTOM, and CLOSED_TOP.
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

The validity period of the related party.
value(required): value

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" ]

The type or classification of the cust prof specification characteristic value. Valid values are STRING, NUMBER, OBJECT, ARRAY, DECIMAL, BOOLEAN, DATE, and DATETIME.

{
    "title":"CustProfSpecCharacteristicValueOracle",
    "type":"object",
    "description":"A list of customer profile spec characteristic values A CustomerProfileSpecificationCharacteristicValue object defines 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":"Whether the cust prof specification characteristic value is default."
        },
        "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":"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":"The type or classification of the cust prof specification characteristic value. Valid values are STRING, NUMBER, OBJECT, ARRAY, DECIMAL, BOOLEAN, DATE, and DATETIME.",
            "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'. Valid values are OPEN, CLOSED, CLOSED_BOTTOM, and CLOSED_TOP.",
            "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 cust prof specification characteristic value."
        },
        "@baseType":{
            "type":"string",
            "description":"The base type of the cust prof specification characteristic value."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the cust prof specification characteristic value."
        }
    },
    "required":[
        "value",
        "@type"
    ]
}

Nested Schema : value

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":"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

The base type of the cust prof specification characteristic relationship.
@schemaLocation: string

The URI of the schema that defines the cust prof specification characteristic relationship.
@type(required): string

The class type of the cust prof specification characteristic relationship.
charSpecSeq: integer

The characteristic sequence.
href: string

A string. Reference of the target customer profile.
id(required): string

The ID of the cust prof specification characteristic relationship.
name(required): string

A string. Name of the target characteristic.
relationshipType(required): string

Allowed Values: [ "AGGREGATION", "MIGRATION", "SUBSTITUTION", "DEPENDENCY", "EXCLUSIVITY" ]

The type or classification of the cust prof specification characteristic relationship. Valid values are AGGREGATION, MIGRATION, SUBSTITUTION, DEPENDENCY, and EXCLUSIVITY.
validFor: object TimePeriodOracle

Title: TimePeriodOracle

The 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":"The type or classification of the cust prof specification characteristic relationship. Valid values are AGGREGATION, MIGRATION, SUBSTITUTION, DEPENDENCY, and EXCLUSIVITY.",
            "enum":[
                "AGGREGATION",
                "MIGRATION",
                "SUBSTITUTION",
                "DEPENDENCY",
                "EXCLUSIVITY"
            ]
        },
        "charSpecSeq":{
            "type":"integer",
            "description":"The characteristic sequence."
        },
        "validFor":{
            "description":"A time period. The period for which the customerProfileSpecCharRelationship is valid.",
            "$ref":"#/components/schemas/TimePeriodOracle"
        },
        "id":{
            "type":"string",
            "description":"The ID of the cust prof specification characteristic relationship."
        },
        "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":"The class type of the cust prof specification characteristic relationship."
        },
        "@baseType":{
            "type":"string",
            "description":"The base type of the cust prof specification characteristic relationship."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the cust prof specification characteristic relationship."
        }
    },
    "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 base type of the cust prof specification relationship.
@schemaLocation: string

The URI of the schema that defines the cust prof specification relationship.
@type(required): string

The class type of the cust prof specification relationship.
href: string

The hyperlink reference to the cust prof specification relationship.
id(required): string

The ID of the cust prof specification relationship.
name: string

The name of the cust prof specification relationship.
relationshipType(required): string

Allowed Values: [ "AGGREGATION", "MIGRATION", "SUBSTITUTION", "DEPENDENCY", "EXCLUSIVITY" ]

The type or classification of the cust prof specification relationship. Valid values are AGGREGATION, MIGRATION, SUBSTITUTION, DEPENDENCY, and EXCLUSIVITY.
validFor: object TimePeriodOracle

Title: TimePeriodOracle

The 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":"The ID of the cust prof specification relationship."
        },
        "href":{
            "type":"string",
            "description":"The hyperlink reference to the cust prof specification relationship."
        },
        "name":{
            "type":"string",
            "description":"The name of the cust prof specification relationship."
        },
        "relationshipType":{
            "type":"string",
            "description":"The type or classification of the cust prof specification relationship. Valid values are AGGREGATION, MIGRATION, SUBSTITUTION, DEPENDENCY, and EXCLUSIVITY.",
            "enum":[
                "AGGREGATION",
                "MIGRATION",
                "SUBSTITUTION",
                "DEPENDENCY",
                "EXCLUSIVITY"
            ]
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriodOracle",
            "description":"The period for which the cust prof specification relationship is valid."
        },
        "@type":{
            "type":"string",
            "description":"The class type of the cust prof specification relationship."
        },
        "@baseType":{
            "type":"string",
            "description":"The base type of the cust prof specification relationship."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the cust prof specification relationship."
        }
    },
    "required":[
        "id",
        "relationshipType",
        "@type"
    ]
}

Nested Schema : RelatedParty

Type: object

Title: RelatedParty

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

Show Source

@baseType: string

The base type of the related party reference or party role reference.
@schemaLocation: string

A URI to a JSON-Schema file that defines additional attributes and relationships.
@type(required): string

The class type of the related party reference or party role reference.
partyOrPartyRole(required): partyOrPartyRole

A list of party or party roles associated with the related party reference or party role reference.
role: string

The 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":"The relatedParty reference. A related party defines party or party role linked to a specific entity.",
    "type":"object",
    "properties":{
        "role":{
            "type":"string",
            "description":"The 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":"The class type of the related party reference or party role reference."
        },
        "@baseType":{
            "type":"string",
            "description":"The base type of the related party reference or party role reference."
        },
        "@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"
                    }
                ]
            },
            "description":"A list of party or party roles associated with the related party reference or party role reference."
        }
    },
    "required":[
        "@type",
        "partyOrPartyRole"
    ]
}

Nested Schema : partyOrPartyRole

Type: array

A list of party or party roles associated with the related party reference or party role reference.

Show Source

Array of:

{
    "items":{
        "anyOf":[
            {
                "$ref":"#/components/schemas/PartyRef"
            },
            {
                "$ref":"#/components/schemas/PartyRoleRef"
            }
        ]
    },
    "description":"A list of party or party roles associated with the related party reference or party role reference."
}

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.

Root Schema : Error

Type: object

Title: Error

The error resource.

Show Source

@schemaLocation: string

The URI of the schema that defines the error.
@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

The text that provides more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

The text that explains the reason for error. This can be shown to a client user.
referenceError: string

The URL pointing to documentation describing the error.
status: string

The status of the error.

{
    "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":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

401 Response

Your request isn't authorized. The authentication credentials included with this request are missing or invalid.

Root Schema : Error

Type: object

Title: Error

The error resource.

Show Source

@schemaLocation: string

The URI of the schema that defines the error.
@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

The text that provides more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

The text that explains the reason for error. This can be shown to a client user.
referenceError: string

The URL pointing to documentation describing the error.
status: string

The status of the error.

{
    "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":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

404 Response

The resource with the specified URI couldn't be found.

Root Schema : Error

Type: object

Title: Error

The error resource.

Show Source

@schemaLocation: string

The URI of the schema that defines the error.
@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

The text that provides more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

The text that explains the reason for error. This can be shown to a client user.
referenceError: string

The URL pointing to documentation describing the error.
status: string

The status of the error.

{
    "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":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

405 Response

HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.

Root Schema : Error

Type: object

Title: Error

The error resource.

Show Source

@schemaLocation: string

The URI of the schema that defines the error.
@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

The text that provides more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

The text that explains the reason for error. This can be shown to a client user.
referenceError: string

The URL pointing to documentation describing the error.
status: string

The status of the error.

{
    "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":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

500 Response

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

Root Schema : Error

Type: object

Title: Error

The error resource.

Show Source

@schemaLocation: string

The URI of the schema that defines the error.
@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

The text that provides more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

The text that explains the reason for error. This can be shown to a client user.
referenceError: string

The URL pointing to documentation describing the error.
status: string

The status of the error.

{
    "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":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

Examples

The following example shows how to get all customer profile specifications by submitting a GET request on the REST resource using cURL.

cURL Command

curl -u username:password -X GET https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customerProfileSpecification

Example of Response Body

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

[
    {
        "id": "CustomerDetailsSpec",
        "name": "Customer Details Specification",
        "description": "Linear Scanner Category",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customerProfileSpecification/CustomerDetailsSpec",
        "version": "1.0",
        "lifecycleStatus": "In design",
        "created": "2025-02-19T13:30:45.000Z",
        "createdBy": "booth",
        "lastUpdate": "2025-03-10T09:48:49.138Z",
        "lastUpdatedBy": "booth",
        "@type": "CustomerProfileSpecificationOracle",
        "validFor": {
            "startDateTime": "2012-08-09T00:00:00.000Z",
            "endDateTime": "2028-08-09T00:00:00.000Z"
        },
        "project": {
            "id": "DBE_RI_ProdModel_PreSeed_PSP",
            "name": "DBE RI Product Model Preseed",
            "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/DBE_RI_ProdModel_PreSeed_PSP",
            "version": "1.0",
            "@referredType": "ProjectOracle"
        },
        "modificationNumber": 2,
        "versionState": 0,
        "custProfSpecCharacteristic": [
            {
                "name": "Credit Rating",
                "description": "Credit Rating of Customer",
                "valueType": "STRING",
                "@type": "CharacteristicSpecificationOracle",
                "configurable": false,
                "minCardinality": 0,
                "maxCardinality": 1,
                "validFor": {
                    "startDateTime": "2020-01-18T00:00:00.000Z",
                    "endDateTime": "2021-02-20T16:42:23.000Z"
                },
                "custProfSpecCharacteristicValue": [
                    {
                        "value": "",
                        "rangeInterval": "CLOSED",
                        "valueTo": "719",
                        "valueFrom": "650",
                        "valueType": "STRING",
                        "isDefault": true,
                        "validFor": {
                            "startDateTime": "2020-01-18T00:00:00.000Z",
                            "endDateTime": "2021-02-20T16:42:23.000Z"
                        },
                        "@type": "StringCharacteristicValueSpecificationOracle"
                    },
                    {
                        "value": "",
                        "rangeInterval": "CLOSED",
                        "valueTo": "850",
                        "valueFrom": "720",
                        "valueType": "STRING",
                        "isDefault": false,
                        "validFor": {
                            "startDateTime": "2020-01-18T00:00:00.000Z",
                            "endDateTime": "2021-02-20T16:42:23.000Z"
                        },
                        "@type": "StringCharacteristicValueSpecificationOracle"
                    }
                ]
            },
            {
                "name": "Loyalty Tier",
                "description": "Loyalty Tier of Customer",
                "valueType": "STRING",
                "@type": "CharacteristicSpecificationOracle",
                "configurable": false,
                "minCardinality": 0,
                "maxCardinality": 1,
                "validFor": {
                    "startDateTime": "2020-01-18T00:00:00.000Z",
                    "endDateTime": "2021-02-20T16:42:23.000Z"
                },
                "custProfSpecCharacteristicValue": [
                    {
                        "value": "Platinum",
                        "valueType": "STRING",
                        "isDefault": false,
                        "validFor": {
                            "startDateTime": "2020-01-18T00:00:00.000Z",
                            "endDateTime": "2021-02-20T16:42:23.000Z"
                        },
                        "@type": "StringCharacteristicValueSpecificationOracle"
                    },
                    {
                        "value": "Gold",
                        "valueType": "STRING",
                        "isDefault": true,
                        "validFor": {
                            "startDateTime": "2020-01-18T00:00:00.000Z",
                            "endDateTime": "2021-02-20T16:42:23.000Z"
                        },
                        "@type": "StringCharacteristicValueSpecificationOracle"
                    }
                ]
            }
        ]
    },
    {
        "id": "CustomerProfileSpecJ6",
        "name": "Customer Profile SpecJ6",
        "description": "Desc for customer profile Spec",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customerProfileSpecification/CustomerProfileSpecJ6",
        "version": "1.0",
        "lifecycleStatus": "In design",
        "created": "2025-01-06T14:41:47.000Z",
        "createdBy": "booth",
        "lastUpdate": "2025-01-06T14:41:47.285Z",
        "lastUpdatedBy": "booth",
        "@type": "CustomerProfileSpecificationOracle",
        "validFor": {
            "startDateTime": "2010-06-19T16:42:23.000Z"
        },
        "project": {
            "id": "P-1608753254-1735976772005",
            "name": "init4Jan",
            "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/P-1608753254-1735976772005",
            "version": "1.0",
            "@referredType": "ProjectOracle"
        },
        "modificationNumber": 1,
        "versionState": 0,
        "custProfSpecCharacteristic": [
            {
                "name": "customerType",
                "description": "customerType",
                "valueType": "STRING",
                "@type": "CharacteristicSpecificationOracle",
                "extensible": true,
                "configurable": true,
                "isUnique": true,
                "minCardinality": 0,
                "maxCardinality": 1,
                "validFor": {
                    "startDateTime": "2010-06-19T16:42:23.000Z"
                },
                "custProfSpecCharacteristicValue": [
                    {
                        "value": "Silver",
                        "valueType": "STRING",
                        "isDefault": false,
                        "validFor": {
                            "startDateTime": "2010-06-19T16:42:23.000Z"
                        },
                        "@type": "StringCharacteristicValueSpecificationOracle"
                    },
                    {
                        "value": "*",
                        "valueType": "STRING",
                        "isDefault": false,
                        "validFor": {
                            "startDateTime": "2010-06-19T16:42:23.000Z"
                        },
                        "@type": "StringCharacteristicValueSpecificationOracle"
                    },
                    {
                        "value": "Gold",
                        "valueType": "STRING",
                        "isDefault": false,
                        "validFor": {
                            "startDateTime": "2010-06-19T16:42:23.000Z"
                        },
                        "@type": "StringCharacteristicValueSpecificationOracle"
                    }
                ]
            }
        ]
    }
]