Create an attribute
https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/attribute
Request
There are no request parameters for this operation.
- application/json
object
AttributeOracle
-
@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
array
-
Array of:
object AttributeRelationshipOracle
Title:
AttributeRelationshipOracle
An aggregation, migration, substitution, dependency or exclusivity relationship between/among attributes.
array
-
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.
object
ProjectRef
-
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
object
TimePeriodOracle
-
endDateTime: string
(date-time)
An instant of time, ending at the TimePeriod.
-
startDateTime: string
(date-time)
An instant of time, starting at the TimePeriod
object
AttributeRelationshipOracle
-
@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
object
CharacteristicValueSpecification
Discriminator Values
- CharacteristicValueSpecification
- StringCharacteristicValueSpecification
- ObjectCharacteristicValueSpecification
- StringArrayCharacteristicValueSpecification
- MapCharacteristicValueSpecification
- NumberCharacteristicValueSpecification
- MapArrayCharacteristicValueSpecification
- ObjectArrayCharacteristicValueSpecification
- NumberArrayCharacteristicValueSpecification
- IntegerCharacteristicValueSpecification
- IntegerArrayCharacteristicValueSpecification
- StringCharacteristicValueSpecificationOracle
- ObjectCharacteristicValueSpecificationOracle
- StringArrayCharacteristicValueSpecificationOracle
- MapCharacteristicValueSpecificationOracle
- NumberCharacteristicValueSpecificationOracle
- MapArrayCharacteristicValueSpecificationOracle
- ObjectArrayCharacteristicValueSpecificationOracle
- NumberArrayCharacteristicValueSpecificationOracle
- IntegerCharacteristicValueSpecificationOracle
- IntegerArrayCharacteristicValueSpecificationOracle
-
@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
Response
- application/json
201 Response
object
AttributeOracle
-
@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
array
-
Array of:
object AttributeRelationshipOracle
Title:
AttributeRelationshipOracle
An aggregation, migration, substitution, dependency or exclusivity relationship between/among attributes.
array
-
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.
object
ProjectRef
-
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
object
TimePeriodOracle
-
endDateTime: string
(date-time)
An instant of time, ending at the TimePeriod.
-
startDateTime: string
(date-time)
An instant of time, starting at the TimePeriod
object
AttributeRelationshipOracle
-
@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
object
CharacteristicValueSpecification
Discriminator Values
- CharacteristicValueSpecification
- StringCharacteristicValueSpecification
- ObjectCharacteristicValueSpecification
- StringArrayCharacteristicValueSpecification
- MapCharacteristicValueSpecification
- NumberCharacteristicValueSpecification
- MapArrayCharacteristicValueSpecification
- ObjectArrayCharacteristicValueSpecification
- NumberArrayCharacteristicValueSpecification
- IntegerCharacteristicValueSpecification
- IntegerArrayCharacteristicValueSpecification
- StringCharacteristicValueSpecificationOracle
- ObjectCharacteristicValueSpecificationOracle
- StringArrayCharacteristicValueSpecificationOracle
- MapCharacteristicValueSpecificationOracle
- NumberCharacteristicValueSpecificationOracle
- MapArrayCharacteristicValueSpecificationOracle
- ObjectArrayCharacteristicValueSpecificationOracle
- NumberArrayCharacteristicValueSpecificationOracle
- IntegerCharacteristicValueSpecificationOracle
- IntegerArrayCharacteristicValueSpecificationOracle
-
@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
400 Response
object
Error
-
@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
401 Response
object
Error
-
@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
404 Response
object
Error
-
@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
405 Response
object
Error
-
@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
500 Response
object
Error
-
@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
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" } }