REST API Reference for Launch Cloud Service

Create an attribute

post

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

Request

There are no request parameters for this operation.

Supported Media Types

application/json

Root Schema : AttributeOracle

Type: object

Title: AttributeOracle

Show Source

@baseType: string

base class type (immediate parent) of the attribute
@schemaLocation: string

hyperlink reference to the schema describing this attribute
@type(required): string

the class type of this characteristic
@valueSchemaLocation: string

This (optional) field provides a link to the schema describing the value type
allowedUnits: array allowedUnits
applicationName: string

name of the external application
attributeRelationship: array attributeRelationship
attributeValue: array attributeValue
configurable: boolean

If true, the Boolean indicates that the attribute is configurable
created: string (date-time)

Date and time of the creation
createdBy: string

name of the person who created item
description: string

A narrative that explains in detail what the attribute is
displayName: string

Display Name of the Attribute reference
extensible: boolean

An indicator that specifies that the values for the attribute can be extended by adding new values when instantiating a attribute for a characteristic
externalId: string

id of the external application
fulfillmentUpdatable: boolean

Indicates runtime system to allow update coming from fulfillment system only for attributes that has this property set to true
href: string

Reference of the attribute
id: string

Maximum Length: 30

Unique identifier of the attribute
isUnique: boolean

An indicator that specifies if a value is unique for the attribute. Possible values are; "unique while value is in effect" and "unique whether value is in effect or not"
lastUpdate: string (date-time)

A date time (DateTime). Date and time of the last update of the attribute
lastUpdatedBy: string

name of the person who updated item
lifecycleStatus: string

Used to indicate the current lifecycle status
maxCardinality: integer

The maximum number of instances an attribute can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality
minCardinality: integer

The minimum number of instances an atribute can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality
name(required): string

Name of the required Attribute
project: object ProjectRef

Title: ProjectRef

Project Reference
regex: string

A rule or principle represented in regular expression used to derive the value of an attribute value
runtimeFilterable: boolean

Allows attribute to be exposed these attribute as filter criteria
sensitive: boolean

Indicates the sensitive information available
validFor: object TimePeriodOracle

Title: TimePeriodOracle

Validity period of the related party
valueType: string

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

A kind of value that the attribute can take on, such as numeric, text and so forth
version: string

attribute version
versionState: number

Version state of the attribute

{
    "title":"AttributeOracle",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"Unique identifier of the attribute"
        },
        "href":{
            "type":"string",
            "description":"Reference of the attribute"
        },
        "name":{
            "type":"string",
            "description":"Name of the required Attribute"
        },
        "displayName":{
            "type":"string",
            "description":"Display Name of the Attribute reference"
        },
        "version":{
            "type":"string",
            "description":"attribute version"
        },
        "description":{
            "type":"string",
            "description":"A narrative that explains in detail what the attribute is"
        },
        "project":{
            "$ref":"#/components/schemas/ProjectRef"
        },
        "valueType":{
            "type":"string",
            "description":"A kind of value that the attribute can take on, such as numeric, text and so forth",
            "enum":[
                "STRING",
                "NUMBER",
                "OBJECT",
                "ARRAY",
                "DECIMAL",
                "BOOLEAN",
                "DATE",
                "DATETIME",
                "URL"
            ]
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"Used to indicate the current lifecycle status"
        },
        "configurable":{
            "type":"boolean",
            "description":"If true, the Boolean indicates that the attribute 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 attribute"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"hyperlink reference to the schema describing this attribute"
        },
        "@valueSchemaLocation":{
            "type":"string",
            "description":"This (optional) field provides a link to the schema describing the value type"
        },
        "minCardinality":{
            "type":"integer",
            "description":"The minimum number of instances an atribute can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality"
        },
        "maxCardinality":{
            "type":"integer",
            "description":"The maximum number of instances an attribute can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality"
        },
        "isUnique":{
            "type":"boolean",
            "description":"An indicator that specifies if a value is unique for the attribute. 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 in regular expression used to derive the value of an attribute value"
        },
        "sensitive":{
            "type":"boolean",
            "description":"Indicates the sensitive information available"
        },
        "runtimeFilterable":{
            "type":"boolean",
            "description":"Allows attribute to be exposed these attribute as filter criteria"
        },
        "fulfillmentUpdatable":{
            "type":"boolean",
            "description":"Indicates runtime system to allow update coming from fulfillment system only for attributes that has this property set to true"
        },
        "extensible":{
            "type":"boolean",
            "description":"An indicator that specifies that the values for the attribute can be extended by adding new values when instantiating a attribute for a characteristic"
        },
        "allowedUnits":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "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"
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"A date time (DateTime). Date and time of the last update of the attribute"
        },
        "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 attribute"
        },
        "attributeRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AttributeRelationshipOracle"
            }
        },
        "attributeValue":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CharacteristicValueSpecification"
            }
        }
    },
    "required":[
        "name",
        "@type"
    ]
}

Nested Schema : allowedUnits

Type: array

Show Source

Array of: string

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

Nested Schema : attributeRelationship

Type: array

Show Source

Array of: object AttributeRelationshipOracle

Title: AttributeRelationshipOracle

An aggregation, migration, substitution, dependency or exclusivity relationship between/among attributes.

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

Nested Schema : attributeValue

Type: array

Show Source

Array of: object CharacteristicValueSpecification

Title: CharacteristicValueSpecification

Discriminator: { "propertyName":"@type", "mapping":{ "CharacteristicValueSpecification":"#/components/schemas/CharacteristicValueSpecification", "StringCharacteristicValueSpecification":"#/components/schemas/StringCharacteristicValueSpecification", "ObjectCharacteristicValueSpecification":"#/components/schemas/ObjectCharacteristicValueSpecification", "StringArrayCharacteristicValueSpecification":"#/components/schemas/StringArrayCharacteristicValueSpecification", "MapCharacteristicValueSpecification":"#/components/schemas/MapCharacteristicValueSpecification", "NumberCharacteristicValueSpecification":"#/components/schemas/NumberCharacteristicValueSpecification", "MapArrayCharacteristicValueSpecification":"#/components/schemas/MapArrayCharacteristicValueSpecification", "ObjectArrayCharacteristicValueSpecification":"#/components/schemas/ObjectArrayCharacteristicValueSpecification", "NumberArrayCharacteristicValueSpecification":"#/components/schemas/NumberArrayCharacteristicValueSpecification", "IntegerCharacteristicValueSpecification":"#/components/schemas/IntegerCharacteristicValueSpecification", "IntegerArrayCharacteristicValueSpecification":"#/components/schemas/IntegerArrayCharacteristicValueSpecification", "StringCharacteristicValueSpecificationOracle":"#/components/schemas/StringCharacteristicValueSpecificationOracle", "ObjectCharacteristicValueSpecificationOracle":"#/components/schemas/ObjectCharacteristicValueSpecificationOracle", "StringArrayCharacteristicValueSpecificationOracle":"#/components/schemas/StringArrayCharacteristicValueSpecificationOracle", "MapCharacteristicValueSpecificationOracle":"#/components/schemas/MapCharacteristicValueSpecificationOracle", "NumberCharacteristicValueSpecificationOracle":"#/components/schemas/NumberCharacteristicValueSpecificationOracle", "MapArrayCharacteristicValueSpecificationOracle":"#/components/schemas/MapArrayCharacteristicValueSpecificationOracle", "ObjectArrayCharacteristicValueSpecificationOracle":"#/components/schemas/ObjectArrayCharacteristicValueSpecificationOracle", "NumberArrayCharacteristicValueSpecificationOracle":"#/components/schemas/NumberArrayCharacteristicValueSpecificationOracle", "IntegerCharacteristicValueSpecificationOracle":"#/components/schemas/IntegerCharacteristicValueSpecificationOracle", "IntegerArrayCharacteristicValueSpecificationOracle":"#/components/schemas/IntegerArrayCharacteristicValueSpecificationOracle" } }

A number or text that can be assigned to a ProductSpecCharacteristic.

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

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

Type: object

Title: AttributeRelationshipOracle

An aggregation, migration, substitution, dependency or exclusivity relationship between/among attributes.

Show Source

@baseType: string

base class type (immediate parent) of the productSpecCharRelationship
@schemaLocation: string

hyperlink reference to schema describing this object
@type(required): string

Class type of target product specification
href: string

Hyperlink reference to the target product specification
id(required): string

the identifier of the associated product specification
name(required): string

Name of the target product specification characteristic
relationshipType(required): string

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

Type of relationship such as aggregation, migration, substitution, dependency, exclusivity
validFor: object TimePeriodOracle

Title: TimePeriodOracle

Validity period of the related party

{
    "title":"AttributeRelationshipOracle",
    "type":"object",
    "description":"An aggregation, migration, substitution, dependency or exclusivity relationship between/among attributes.",
    "properties":{
        "relationshipType":{
            "type":"string",
            "description":"Type of relationship such as aggregation, migration, substitution, dependency, exclusivity",
            "enum":[
                "AGGREGATION",
                "MIGRATION",
                "SUBSTITUTION",
                "DEPENDENCY",
                "EXCLUSIVITY"
            ]
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriodOracle"
        },
        "id":{
            "type":"string",
            "description":"the identifier of the associated product specification"
        },
        "name":{
            "type":"string",
            "description":"Name of the target product specification characteristic"
        },
        "href":{
            "type":"string",
            "description":"Hyperlink reference to the target product specification"
        },
        "@type":{
            "type":"string",
            "description":"Class type of target product specification"
        },
        "@baseType":{
            "type":"string",
            "description":"base class type  (immediate parent) of the productSpecCharRelationship"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"hyperlink reference to schema describing this object"
        }
    },
    "required":[
        "id",
        "name",
        "relationshipType",
        "@type"
    ]
}

Nested Schema : CharacteristicValueSpecification

Type: object

Title: CharacteristicValueSpecification

Discriminator: @type

Discriminator Values

CharacteristicValueSpecification
StringCharacteristicValueSpecification
ObjectCharacteristicValueSpecification
StringArrayCharacteristicValueSpecification
MapCharacteristicValueSpecification
NumberCharacteristicValueSpecification
MapArrayCharacteristicValueSpecification
ObjectArrayCharacteristicValueSpecification
NumberArrayCharacteristicValueSpecification
IntegerCharacteristicValueSpecification
IntegerArrayCharacteristicValueSpecification
StringCharacteristicValueSpecificationOracle
ObjectCharacteristicValueSpecificationOracle
StringArrayCharacteristicValueSpecificationOracle
MapCharacteristicValueSpecificationOracle
NumberCharacteristicValueSpecificationOracle
MapArrayCharacteristicValueSpecificationOracle
ObjectArrayCharacteristicValueSpecificationOracle
NumberArrayCharacteristicValueSpecificationOracle
IntegerCharacteristicValueSpecificationOracle
IntegerArrayCharacteristicValueSpecificationOracle

{
    "title":"CharacteristicValueSpecification",
    "type":"object",
    "description":"A number or text that can be assigned to a ProductSpecCharacteristic.",
    "properties":{
        "isDefault":{
            "type":"boolean",
            "description":"Indicates if the value is the default value for a characteristic"
        },
        "unitOfMeasure":{
            "type":"string",
            "description":"Could be minutes, GB...",
            "enum":[
                "NONE",
                "SECOND",
                "MINUTE",
                "HOUR",
                "DAY",
                "MONTH",
                "BYTE",
                "KILOBYTE",
                "MEGABYTE",
                "GIGABYTE",
                "PAGES",
                "MOVIES",
                "TIME_INTERVAL",
                "QUANTITY",
                "MBPS",
                "GBPS"
            ]
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriodOracle"
        },
        "valueFrom":{
            "type":"string",
            "description":"The low range value that a characteristic can take on"
        },
        "valueTo":{
            "type":"string",
            "description":"The upper range value that a characteristic can take on"
        },
        "valueType":{
            "type":"string",
            "description":"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",
                "URL"
            ]
        },
        "rangeInterval":{
            "type":"string",
            "description":"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":"Regular expression to define constraint on the allowed value"
        },
        "@type":{
            "type":"string",
            "description":"The class type of the characteristic value"
        },
        "@baseType":{
            "type":"string",
            "description":"base class type  (immediate parent) of the ProductSpecCharacteristic"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"Hyperlink reference to schema describing this object"
        }
    },
    "required":[
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "CharacteristicValueSpecification":"#/components/schemas/CharacteristicValueSpecification",
            "StringCharacteristicValueSpecification":"#/components/schemas/StringCharacteristicValueSpecification",
            "ObjectCharacteristicValueSpecification":"#/components/schemas/ObjectCharacteristicValueSpecification",
            "StringArrayCharacteristicValueSpecification":"#/components/schemas/StringArrayCharacteristicValueSpecification",
            "MapCharacteristicValueSpecification":"#/components/schemas/MapCharacteristicValueSpecification",
            "NumberCharacteristicValueSpecification":"#/components/schemas/NumberCharacteristicValueSpecification",
            "MapArrayCharacteristicValueSpecification":"#/components/schemas/MapArrayCharacteristicValueSpecification",
            "ObjectArrayCharacteristicValueSpecification":"#/components/schemas/ObjectArrayCharacteristicValueSpecification",
            "NumberArrayCharacteristicValueSpecification":"#/components/schemas/NumberArrayCharacteristicValueSpecification",
            "IntegerCharacteristicValueSpecification":"#/components/schemas/IntegerCharacteristicValueSpecification",
            "IntegerArrayCharacteristicValueSpecification":"#/components/schemas/IntegerArrayCharacteristicValueSpecification",
            "StringCharacteristicValueSpecificationOracle":"#/components/schemas/StringCharacteristicValueSpecificationOracle",
            "ObjectCharacteristicValueSpecificationOracle":"#/components/schemas/ObjectCharacteristicValueSpecificationOracle",
            "StringArrayCharacteristicValueSpecificationOracle":"#/components/schemas/StringArrayCharacteristicValueSpecificationOracle",
            "MapCharacteristicValueSpecificationOracle":"#/components/schemas/MapCharacteristicValueSpecificationOracle",
            "NumberCharacteristicValueSpecificationOracle":"#/components/schemas/NumberCharacteristicValueSpecificationOracle",
            "MapArrayCharacteristicValueSpecificationOracle":"#/components/schemas/MapArrayCharacteristicValueSpecificationOracle",
            "ObjectArrayCharacteristicValueSpecificationOracle":"#/components/schemas/ObjectArrayCharacteristicValueSpecificationOracle",
            "NumberArrayCharacteristicValueSpecificationOracle":"#/components/schemas/NumberArrayCharacteristicValueSpecificationOracle",
            "IntegerCharacteristicValueSpecificationOracle":"#/components/schemas/IntegerCharacteristicValueSpecificationOracle",
            "IntegerArrayCharacteristicValueSpecificationOracle":"#/components/schemas/IntegerArrayCharacteristicValueSpecificationOracle"
        }
    }
}

A number or text that can be assigned to a ProductSpecCharacteristic.

Show Source

@baseType: string

base class type (immediate parent) of the ProductSpecCharacteristic
@schemaLocation: string

Hyperlink reference to schema describing this object
@type(required): string

The class type of the characteristic value
isDefault: boolean

Indicates if the value is the default value for a characteristic
rangeInterval: string

Allowed Values: [ "OPEN", "CLOSED", "CLOSED_BOTTOM", "CLOSED_TOP" ]

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

Regular expression to define constraint on the allowed value
unitOfMeasure: string

Allowed Values: [ "NONE", "SECOND", "MINUTE", "HOUR", "DAY", "MONTH", "BYTE", "KILOBYTE", "MEGABYTE", "GIGABYTE", "PAGES", "MOVIES", "TIME_INTERVAL", "QUANTITY", "MBPS", "GBPS" ]

Could be minutes, GB...
validFor: object TimePeriodOracle

Title: TimePeriodOracle

Validity period of the related party
valueFrom: string

The low range value that a characteristic can take on
valueTo: string

The upper range value that a characteristic can take on
valueType: string

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

A kind of value that the characteristic can take on, such as numeric, text, and so forth

{
    "title":"CharacteristicValueSpecification",
    "type":"object",
    "description":"A number or text that can be assigned to a ProductSpecCharacteristic.",
    "properties":{
        "isDefault":{
            "type":"boolean",
            "description":"Indicates if the value is the default value for a characteristic"
        },
        "unitOfMeasure":{
            "type":"string",
            "description":"Could be minutes, GB...",
            "enum":[
                "NONE",
                "SECOND",
                "MINUTE",
                "HOUR",
                "DAY",
                "MONTH",
                "BYTE",
                "KILOBYTE",
                "MEGABYTE",
                "GIGABYTE",
                "PAGES",
                "MOVIES",
                "TIME_INTERVAL",
                "QUANTITY",
                "MBPS",
                "GBPS"
            ]
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriodOracle"
        },
        "valueFrom":{
            "type":"string",
            "description":"The low range value that a characteristic can take on"
        },
        "valueTo":{
            "type":"string",
            "description":"The upper range value that a characteristic can take on"
        },
        "valueType":{
            "type":"string",
            "description":"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",
                "URL"
            ]
        },
        "rangeInterval":{
            "type":"string",
            "description":"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":"Regular expression to define constraint on the allowed value"
        },
        "@type":{
            "type":"string",
            "description":"The class type of the characteristic value"
        },
        "@baseType":{
            "type":"string",
            "description":"base class type  (immediate parent) of the ProductSpecCharacteristic"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"Hyperlink reference to schema describing this object"
        }
    },
    "required":[
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "CharacteristicValueSpecification":"#/components/schemas/CharacteristicValueSpecification",
            "StringCharacteristicValueSpecification":"#/components/schemas/StringCharacteristicValueSpecification",
            "ObjectCharacteristicValueSpecification":"#/components/schemas/ObjectCharacteristicValueSpecification",
            "StringArrayCharacteristicValueSpecification":"#/components/schemas/StringArrayCharacteristicValueSpecification",
            "MapCharacteristicValueSpecification":"#/components/schemas/MapCharacteristicValueSpecification",
            "NumberCharacteristicValueSpecification":"#/components/schemas/NumberCharacteristicValueSpecification",
            "MapArrayCharacteristicValueSpecification":"#/components/schemas/MapArrayCharacteristicValueSpecification",
            "ObjectArrayCharacteristicValueSpecification":"#/components/schemas/ObjectArrayCharacteristicValueSpecification",
            "NumberArrayCharacteristicValueSpecification":"#/components/schemas/NumberArrayCharacteristicValueSpecification",
            "IntegerCharacteristicValueSpecification":"#/components/schemas/IntegerCharacteristicValueSpecification",
            "IntegerArrayCharacteristicValueSpecification":"#/components/schemas/IntegerArrayCharacteristicValueSpecification",
            "StringCharacteristicValueSpecificationOracle":"#/components/schemas/StringCharacteristicValueSpecificationOracle",
            "ObjectCharacteristicValueSpecificationOracle":"#/components/schemas/ObjectCharacteristicValueSpecificationOracle",
            "StringArrayCharacteristicValueSpecificationOracle":"#/components/schemas/StringArrayCharacteristicValueSpecificationOracle",
            "MapCharacteristicValueSpecificationOracle":"#/components/schemas/MapCharacteristicValueSpecificationOracle",
            "NumberCharacteristicValueSpecificationOracle":"#/components/schemas/NumberCharacteristicValueSpecificationOracle",
            "MapArrayCharacteristicValueSpecificationOracle":"#/components/schemas/MapArrayCharacteristicValueSpecificationOracle",
            "ObjectArrayCharacteristicValueSpecificationOracle":"#/components/schemas/ObjectArrayCharacteristicValueSpecificationOracle",
            "NumberArrayCharacteristicValueSpecificationOracle":"#/components/schemas/NumberArrayCharacteristicValueSpecificationOracle",
            "IntegerCharacteristicValueSpecificationOracle":"#/components/schemas/IntegerCharacteristicValueSpecificationOracle",
            "IntegerArrayCharacteristicValueSpecificationOracle":"#/components/schemas/IntegerArrayCharacteristicValueSpecificationOracle"
        }
    }
}

Response

Supported Media Types

application/json

201 Response

Your request is successful and a new resource has been created.

Root Schema : AttributeOracle

Type: object

Title: AttributeOracle

Show Source

@baseType: string

base class type (immediate parent) of the attribute
@schemaLocation: string

hyperlink reference to the schema describing this attribute
@type(required): string

the class type of this characteristic
@valueSchemaLocation: string

This (optional) field provides a link to the schema describing the value type
allowedUnits: array allowedUnits
applicationName: string

name of the external application
attributeRelationship: array attributeRelationship
attributeValue: array attributeValue
configurable: boolean

If true, the Boolean indicates that the attribute is configurable
created: string (date-time)

Date and time of the creation
createdBy: string

name of the person who created item
description: string

A narrative that explains in detail what the attribute is
displayName: string

Display Name of the Attribute reference
extensible: boolean

An indicator that specifies that the values for the attribute can be extended by adding new values when instantiating a attribute for a characteristic
externalId: string

id of the external application
fulfillmentUpdatable: boolean

Indicates runtime system to allow update coming from fulfillment system only for attributes that has this property set to true
href: string

Reference of the attribute
id: string

Maximum Length: 30

Unique identifier of the attribute
isUnique: boolean

An indicator that specifies if a value is unique for the attribute. Possible values are; "unique while value is in effect" and "unique whether value is in effect or not"
lastUpdate: string (date-time)

A date time (DateTime). Date and time of the last update of the attribute
lastUpdatedBy: string

name of the person who updated item
lifecycleStatus: string

Used to indicate the current lifecycle status
maxCardinality: integer

The maximum number of instances an attribute can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality
minCardinality: integer

The minimum number of instances an atribute can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality
name(required): string

Name of the required Attribute
project: object ProjectRef

Title: ProjectRef

Project Reference
regex: string

A rule or principle represented in regular expression used to derive the value of an attribute value
runtimeFilterable: boolean

Allows attribute to be exposed these attribute as filter criteria
sensitive: boolean

Indicates the sensitive information available
validFor: object TimePeriodOracle

Title: TimePeriodOracle

Validity period of the related party
valueType: string

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

A kind of value that the attribute can take on, such as numeric, text and so forth
version: string

attribute version
versionState: number

Version state of the attribute

{
    "title":"AttributeOracle",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"Unique identifier of the attribute"
        },
        "href":{
            "type":"string",
            "description":"Reference of the attribute"
        },
        "name":{
            "type":"string",
            "description":"Name of the required Attribute"
        },
        "displayName":{
            "type":"string",
            "description":"Display Name of the Attribute reference"
        },
        "version":{
            "type":"string",
            "description":"attribute version"
        },
        "description":{
            "type":"string",
            "description":"A narrative that explains in detail what the attribute is"
        },
        "project":{
            "$ref":"#/components/schemas/ProjectRef"
        },
        "valueType":{
            "type":"string",
            "description":"A kind of value that the attribute can take on, such as numeric, text and so forth",
            "enum":[
                "STRING",
                "NUMBER",
                "OBJECT",
                "ARRAY",
                "DECIMAL",
                "BOOLEAN",
                "DATE",
                "DATETIME",
                "URL"
            ]
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"Used to indicate the current lifecycle status"
        },
        "configurable":{
            "type":"boolean",
            "description":"If true, the Boolean indicates that the attribute 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 attribute"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"hyperlink reference to the schema describing this attribute"
        },
        "@valueSchemaLocation":{
            "type":"string",
            "description":"This (optional) field provides a link to the schema describing the value type"
        },
        "minCardinality":{
            "type":"integer",
            "description":"The minimum number of instances an atribute can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality"
        },
        "maxCardinality":{
            "type":"integer",
            "description":"The maximum number of instances an attribute can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality"
        },
        "isUnique":{
            "type":"boolean",
            "description":"An indicator that specifies if a value is unique for the attribute. 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 in regular expression used to derive the value of an attribute value"
        },
        "sensitive":{
            "type":"boolean",
            "description":"Indicates the sensitive information available"
        },
        "runtimeFilterable":{
            "type":"boolean",
            "description":"Allows attribute to be exposed these attribute as filter criteria"
        },
        "fulfillmentUpdatable":{
            "type":"boolean",
            "description":"Indicates runtime system to allow update coming from fulfillment system only for attributes that has this property set to true"
        },
        "extensible":{
            "type":"boolean",
            "description":"An indicator that specifies that the values for the attribute can be extended by adding new values when instantiating a attribute for a characteristic"
        },
        "allowedUnits":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "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"
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"A date time (DateTime). Date and time of the last update of the attribute"
        },
        "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 attribute"
        },
        "attributeRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AttributeRelationshipOracle"
            }
        },
        "attributeValue":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CharacteristicValueSpecification"
            }
        }
    },
    "required":[
        "name",
        "@type"
    ]
}

Nested Schema : allowedUnits

Type: array

Show Source

Array of: string

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

Nested Schema : attributeRelationship

Type: array

Show Source

Array of: object AttributeRelationshipOracle

Title: AttributeRelationshipOracle

An aggregation, migration, substitution, dependency or exclusivity relationship between/among attributes.

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

Nested Schema : attributeValue

Type: array

Show Source

Array of: object CharacteristicValueSpecification

Title: CharacteristicValueSpecification

Discriminator: { "propertyName":"@type", "mapping":{ "CharacteristicValueSpecification":"#/components/schemas/CharacteristicValueSpecification", "StringCharacteristicValueSpecification":"#/components/schemas/StringCharacteristicValueSpecification", "ObjectCharacteristicValueSpecification":"#/components/schemas/ObjectCharacteristicValueSpecification", "StringArrayCharacteristicValueSpecification":"#/components/schemas/StringArrayCharacteristicValueSpecification", "MapCharacteristicValueSpecification":"#/components/schemas/MapCharacteristicValueSpecification", "NumberCharacteristicValueSpecification":"#/components/schemas/NumberCharacteristicValueSpecification", "MapArrayCharacteristicValueSpecification":"#/components/schemas/MapArrayCharacteristicValueSpecification", "ObjectArrayCharacteristicValueSpecification":"#/components/schemas/ObjectArrayCharacteristicValueSpecification", "NumberArrayCharacteristicValueSpecification":"#/components/schemas/NumberArrayCharacteristicValueSpecification", "IntegerCharacteristicValueSpecification":"#/components/schemas/IntegerCharacteristicValueSpecification", "IntegerArrayCharacteristicValueSpecification":"#/components/schemas/IntegerArrayCharacteristicValueSpecification", "StringCharacteristicValueSpecificationOracle":"#/components/schemas/StringCharacteristicValueSpecificationOracle", "ObjectCharacteristicValueSpecificationOracle":"#/components/schemas/ObjectCharacteristicValueSpecificationOracle", "StringArrayCharacteristicValueSpecificationOracle":"#/components/schemas/StringArrayCharacteristicValueSpecificationOracle", "MapCharacteristicValueSpecificationOracle":"#/components/schemas/MapCharacteristicValueSpecificationOracle", "NumberCharacteristicValueSpecificationOracle":"#/components/schemas/NumberCharacteristicValueSpecificationOracle", "MapArrayCharacteristicValueSpecificationOracle":"#/components/schemas/MapArrayCharacteristicValueSpecificationOracle", "ObjectArrayCharacteristicValueSpecificationOracle":"#/components/schemas/ObjectArrayCharacteristicValueSpecificationOracle", "NumberArrayCharacteristicValueSpecificationOracle":"#/components/schemas/NumberArrayCharacteristicValueSpecificationOracle", "IntegerCharacteristicValueSpecificationOracle":"#/components/schemas/IntegerCharacteristicValueSpecificationOracle", "IntegerArrayCharacteristicValueSpecificationOracle":"#/components/schemas/IntegerArrayCharacteristicValueSpecificationOracle" } }

A number or text that can be assigned to a ProductSpecCharacteristic.

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

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

Type: object

Title: AttributeRelationshipOracle

An aggregation, migration, substitution, dependency or exclusivity relationship between/among attributes.

Show Source

@baseType: string

base class type (immediate parent) of the productSpecCharRelationship
@schemaLocation: string

hyperlink reference to schema describing this object
@type(required): string

Class type of target product specification
href: string

Hyperlink reference to the target product specification
id(required): string

the identifier of the associated product specification
name(required): string

Name of the target product specification characteristic
relationshipType(required): string

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

Type of relationship such as aggregation, migration, substitution, dependency, exclusivity
validFor: object TimePeriodOracle

Title: TimePeriodOracle

Validity period of the related party

{
    "title":"AttributeRelationshipOracle",
    "type":"object",
    "description":"An aggregation, migration, substitution, dependency or exclusivity relationship between/among attributes.",
    "properties":{
        "relationshipType":{
            "type":"string",
            "description":"Type of relationship such as aggregation, migration, substitution, dependency, exclusivity",
            "enum":[
                "AGGREGATION",
                "MIGRATION",
                "SUBSTITUTION",
                "DEPENDENCY",
                "EXCLUSIVITY"
            ]
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriodOracle"
        },
        "id":{
            "type":"string",
            "description":"the identifier of the associated product specification"
        },
        "name":{
            "type":"string",
            "description":"Name of the target product specification characteristic"
        },
        "href":{
            "type":"string",
            "description":"Hyperlink reference to the target product specification"
        },
        "@type":{
            "type":"string",
            "description":"Class type of target product specification"
        },
        "@baseType":{
            "type":"string",
            "description":"base class type  (immediate parent) of the productSpecCharRelationship"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"hyperlink reference to schema describing this object"
        }
    },
    "required":[
        "id",
        "name",
        "relationshipType",
        "@type"
    ]
}

Nested Schema : CharacteristicValueSpecification

Type: object

Title: CharacteristicValueSpecification

Discriminator: @type

Discriminator Values

CharacteristicValueSpecification
StringCharacteristicValueSpecification
ObjectCharacteristicValueSpecification
StringArrayCharacteristicValueSpecification
MapCharacteristicValueSpecification
NumberCharacteristicValueSpecification
MapArrayCharacteristicValueSpecification
ObjectArrayCharacteristicValueSpecification
NumberArrayCharacteristicValueSpecification
IntegerCharacteristicValueSpecification
IntegerArrayCharacteristicValueSpecification
StringCharacteristicValueSpecificationOracle
ObjectCharacteristicValueSpecificationOracle
StringArrayCharacteristicValueSpecificationOracle
MapCharacteristicValueSpecificationOracle
NumberCharacteristicValueSpecificationOracle
MapArrayCharacteristicValueSpecificationOracle
ObjectArrayCharacteristicValueSpecificationOracle
NumberArrayCharacteristicValueSpecificationOracle
IntegerCharacteristicValueSpecificationOracle
IntegerArrayCharacteristicValueSpecificationOracle

{
    "title":"CharacteristicValueSpecification",
    "type":"object",
    "description":"A number or text that can be assigned to a ProductSpecCharacteristic.",
    "properties":{
        "isDefault":{
            "type":"boolean",
            "description":"Indicates if the value is the default value for a characteristic"
        },
        "unitOfMeasure":{
            "type":"string",
            "description":"Could be minutes, GB...",
            "enum":[
                "NONE",
                "SECOND",
                "MINUTE",
                "HOUR",
                "DAY",
                "MONTH",
                "BYTE",
                "KILOBYTE",
                "MEGABYTE",
                "GIGABYTE",
                "PAGES",
                "MOVIES",
                "TIME_INTERVAL",
                "QUANTITY",
                "MBPS",
                "GBPS"
            ]
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriodOracle"
        },
        "valueFrom":{
            "type":"string",
            "description":"The low range value that a characteristic can take on"
        },
        "valueTo":{
            "type":"string",
            "description":"The upper range value that a characteristic can take on"
        },
        "valueType":{
            "type":"string",
            "description":"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",
                "URL"
            ]
        },
        "rangeInterval":{
            "type":"string",
            "description":"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":"Regular expression to define constraint on the allowed value"
        },
        "@type":{
            "type":"string",
            "description":"The class type of the characteristic value"
        },
        "@baseType":{
            "type":"string",
            "description":"base class type  (immediate parent) of the ProductSpecCharacteristic"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"Hyperlink reference to schema describing this object"
        }
    },
    "required":[
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "CharacteristicValueSpecification":"#/components/schemas/CharacteristicValueSpecification",
            "StringCharacteristicValueSpecification":"#/components/schemas/StringCharacteristicValueSpecification",
            "ObjectCharacteristicValueSpecification":"#/components/schemas/ObjectCharacteristicValueSpecification",
            "StringArrayCharacteristicValueSpecification":"#/components/schemas/StringArrayCharacteristicValueSpecification",
            "MapCharacteristicValueSpecification":"#/components/schemas/MapCharacteristicValueSpecification",
            "NumberCharacteristicValueSpecification":"#/components/schemas/NumberCharacteristicValueSpecification",
            "MapArrayCharacteristicValueSpecification":"#/components/schemas/MapArrayCharacteristicValueSpecification",
            "ObjectArrayCharacteristicValueSpecification":"#/components/schemas/ObjectArrayCharacteristicValueSpecification",
            "NumberArrayCharacteristicValueSpecification":"#/components/schemas/NumberArrayCharacteristicValueSpecification",
            "IntegerCharacteristicValueSpecification":"#/components/schemas/IntegerCharacteristicValueSpecification",
            "IntegerArrayCharacteristicValueSpecification":"#/components/schemas/IntegerArrayCharacteristicValueSpecification",
            "StringCharacteristicValueSpecificationOracle":"#/components/schemas/StringCharacteristicValueSpecificationOracle",
            "ObjectCharacteristicValueSpecificationOracle":"#/components/schemas/ObjectCharacteristicValueSpecificationOracle",
            "StringArrayCharacteristicValueSpecificationOracle":"#/components/schemas/StringArrayCharacteristicValueSpecificationOracle",
            "MapCharacteristicValueSpecificationOracle":"#/components/schemas/MapCharacteristicValueSpecificationOracle",
            "NumberCharacteristicValueSpecificationOracle":"#/components/schemas/NumberCharacteristicValueSpecificationOracle",
            "MapArrayCharacteristicValueSpecificationOracle":"#/components/schemas/MapArrayCharacteristicValueSpecificationOracle",
            "ObjectArrayCharacteristicValueSpecificationOracle":"#/components/schemas/ObjectArrayCharacteristicValueSpecificationOracle",
            "NumberArrayCharacteristicValueSpecificationOracle":"#/components/schemas/NumberArrayCharacteristicValueSpecificationOracle",
            "IntegerCharacteristicValueSpecificationOracle":"#/components/schemas/IntegerCharacteristicValueSpecificationOracle",
            "IntegerArrayCharacteristicValueSpecificationOracle":"#/components/schemas/IntegerArrayCharacteristicValueSpecificationOracle"
        }
    }
}

A number or text that can be assigned to a ProductSpecCharacteristic.

Show Source

@baseType: string

base class type (immediate parent) of the ProductSpecCharacteristic
@schemaLocation: string

Hyperlink reference to schema describing this object
@type(required): string

The class type of the characteristic value
isDefault: boolean

Indicates if the value is the default value for a characteristic
rangeInterval: string

Allowed Values: [ "OPEN", "CLOSED", "CLOSED_BOTTOM", "CLOSED_TOP" ]

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

Regular expression to define constraint on the allowed value
unitOfMeasure: string

Allowed Values: [ "NONE", "SECOND", "MINUTE", "HOUR", "DAY", "MONTH", "BYTE", "KILOBYTE", "MEGABYTE", "GIGABYTE", "PAGES", "MOVIES", "TIME_INTERVAL", "QUANTITY", "MBPS", "GBPS" ]

Could be minutes, GB...
validFor: object TimePeriodOracle

Title: TimePeriodOracle

Validity period of the related party
valueFrom: string

The low range value that a characteristic can take on
valueTo: string

The upper range value that a characteristic can take on
valueType: string

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

A kind of value that the characteristic can take on, such as numeric, text, and so forth

{
    "title":"CharacteristicValueSpecification",
    "type":"object",
    "description":"A number or text that can be assigned to a ProductSpecCharacteristic.",
    "properties":{
        "isDefault":{
            "type":"boolean",
            "description":"Indicates if the value is the default value for a characteristic"
        },
        "unitOfMeasure":{
            "type":"string",
            "description":"Could be minutes, GB...",
            "enum":[
                "NONE",
                "SECOND",
                "MINUTE",
                "HOUR",
                "DAY",
                "MONTH",
                "BYTE",
                "KILOBYTE",
                "MEGABYTE",
                "GIGABYTE",
                "PAGES",
                "MOVIES",
                "TIME_INTERVAL",
                "QUANTITY",
                "MBPS",
                "GBPS"
            ]
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriodOracle"
        },
        "valueFrom":{
            "type":"string",
            "description":"The low range value that a characteristic can take on"
        },
        "valueTo":{
            "type":"string",
            "description":"The upper range value that a characteristic can take on"
        },
        "valueType":{
            "type":"string",
            "description":"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",
                "URL"
            ]
        },
        "rangeInterval":{
            "type":"string",
            "description":"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":"Regular expression to define constraint on the allowed value"
        },
        "@type":{
            "type":"string",
            "description":"The class type of the characteristic value"
        },
        "@baseType":{
            "type":"string",
            "description":"base class type  (immediate parent) of the ProductSpecCharacteristic"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"Hyperlink reference to schema describing this object"
        }
    },
    "required":[
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "CharacteristicValueSpecification":"#/components/schemas/CharacteristicValueSpecification",
            "StringCharacteristicValueSpecification":"#/components/schemas/StringCharacteristicValueSpecification",
            "ObjectCharacteristicValueSpecification":"#/components/schemas/ObjectCharacteristicValueSpecification",
            "StringArrayCharacteristicValueSpecification":"#/components/schemas/StringArrayCharacteristicValueSpecification",
            "MapCharacteristicValueSpecification":"#/components/schemas/MapCharacteristicValueSpecification",
            "NumberCharacteristicValueSpecification":"#/components/schemas/NumberCharacteristicValueSpecification",
            "MapArrayCharacteristicValueSpecification":"#/components/schemas/MapArrayCharacteristicValueSpecification",
            "ObjectArrayCharacteristicValueSpecification":"#/components/schemas/ObjectArrayCharacteristicValueSpecification",
            "NumberArrayCharacteristicValueSpecification":"#/components/schemas/NumberArrayCharacteristicValueSpecification",
            "IntegerCharacteristicValueSpecification":"#/components/schemas/IntegerCharacteristicValueSpecification",
            "IntegerArrayCharacteristicValueSpecification":"#/components/schemas/IntegerArrayCharacteristicValueSpecification",
            "StringCharacteristicValueSpecificationOracle":"#/components/schemas/StringCharacteristicValueSpecificationOracle",
            "ObjectCharacteristicValueSpecificationOracle":"#/components/schemas/ObjectCharacteristicValueSpecificationOracle",
            "StringArrayCharacteristicValueSpecificationOracle":"#/components/schemas/StringArrayCharacteristicValueSpecificationOracle",
            "MapCharacteristicValueSpecificationOracle":"#/components/schemas/MapCharacteristicValueSpecificationOracle",
            "NumberCharacteristicValueSpecificationOracle":"#/components/schemas/NumberCharacteristicValueSpecificationOracle",
            "MapArrayCharacteristicValueSpecificationOracle":"#/components/schemas/MapArrayCharacteristicValueSpecificationOracle",
            "ObjectArrayCharacteristicValueSpecificationOracle":"#/components/schemas/ObjectArrayCharacteristicValueSpecificationOracle",
            "NumberArrayCharacteristicValueSpecificationOracle":"#/components/schemas/NumberArrayCharacteristicValueSpecificationOracle",
            "IntegerCharacteristicValueSpecificationOracle":"#/components/schemas/IntegerCharacteristicValueSpecificationOracle",
            "IntegerArrayCharacteristicValueSpecificationOracle":"#/components/schemas/IntegerArrayCharacteristicValueSpecificationOracle"
        }
    }
}

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

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

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

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.

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.

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.

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

Examples

The following example shows how to create an attribute by submitting a post request on the REST resource using cURL.

cURL Command

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

Example of Request Body

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

{
    "id": "ATT-3502851773-1723207031590",
    "name": "Storage",
    "version": "1.0",
    "lifecycleStatus": "In design",
    "valueType": "NUMBER",
    "@type": "AttributeOracle",
    "minCardinality": 0,
    "maxCardinality": 1,
    "validFor": {
        "startDateTime": "2024-08-09T00:00:00.000Z"
    },
    "versionState": 0,
    "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"
    }
}

Example of Response Body

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

{
    "id": "ATT-3502851773-1723207031590",
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/attribute/ATT-3502851773-1723207031590",
    "name": "Storage",
    "version": "1.0",
    "lifecycleStatus": "In design",
    "valueType": "NUMBER",
    "@type": "AttributeOracle",
    "minCardinality": 0,
    "maxCardinality": 1,
    "validFor": {
        "startDateTime": "2024-08-09T00:00:00.000Z"
    },
    "lastUpdate": "2025-02-17T18:09:21.052Z",
    "lastUpdatedBy": "booth",
    "created": "2025-02-17T18:09:21.000Z",
    "createdBy": "booth",
    "versionState": 0,
    "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"
    }
}