Create or update an array of attribute
put
https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/Attributes
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
array
Minimum Number of Items:
1
Maximum Number of Items:
Show Source
50
-
Array of:
object AttributeOracle
Title:
AttributeOracle
Nested Schema : AttributeOracle
Type:
object
Title:
Show Source
AttributeOracle
-
@baseType: string
base class type (immediate parent) of the attribute
-
@schemaLocation: string
hyperlink reference to the schema describing this attribute
-
@type: 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
Nested Schema : attributeRelationship
Type:
Show Source
array
-
Array of:
object ProductSpecCharRelationship
Title:
ProductSpecCharRelationship
Discriminator:{ "propertyName":"@type", "mapping":{ "ProductSpecCharRelationship":"#/components/schemas/ProductSpecCharRelationship", "ProductSpecCharRelationshipOracle":"#/components/schemas/ProductSpecCharRelationshipOracle" } }
An aggregation, migration, substitution, dependency or exclusivity relationship between/among productSpecCharacteristics.
Nested Schema : attributeValue
Type:
Show Source
array
-
Array of:
ProductSpecCharacteristicValueOracle
Title:
ProductSpecCharacteristicValueOracle
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
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
Nested Schema : ProductSpecCharRelationship
Type:
object
Title:
ProductSpecCharRelationship
Discriminator: @type
Discriminator Values
An aggregation, migration, substitution, dependency or exclusivity relationship between/among productSpecCharacteristics.
Show Source
-
@baseType: string
base class type (immediate parent) of the productSpecCharRelationship
-
@schemaLocation: string
hyperlink reference to schema describing this object
-
@type: string
Class type of target product specification
-
charSpecSeq: integer
The order in which a CharacteristicSpecification appears within another CharacteristicSpecification that defines a grouping of CharacteristicSpecifications. For example, a grouping may represent the name of an individual. The given name is first, the middle name is second, and the last name is third.
-
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
Nested Schema : ProductSpecCharacteristicValueOracle
Title:
ProductSpecCharacteristicValueOracle
Match All
Show Source
-
object
ProductSpecCharacteristicValue
Title:
ProductSpecCharacteristicValue
Discriminator:{ "propertyName":"@type", "mapping":{ "ProductSpecCharacteristicValue":"#/components/schemas/ProductSpecCharacteristicValue", "ProductSpecCharacteristicValueOracle":"#/components/schemas/ProductSpecCharacteristicValueOracle" } }
A number or text that can be assigned to a ProductSpecCharacteristic. -
object
ProductSpecCharacteristicValueOracle-allOf[1]
Nested Schema : ProductSpecCharacteristicValue
Type:
object
Title:
ProductSpecCharacteristicValue
Discriminator: @type
Discriminator Values
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: 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 -
value(required):
value
A discrete value that the characteristic can take on. the value type is defined by 'valueType' characteristic
-
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
Nested Schema : ProductSpecCharacteristicValueOracle-allOf[1]
Type:
Show Source
object
-
attachment: array
attachment
-
sequence: integer
Indicates the sequence where attribute values appear during runtime
-
valueCode: string
A optional code for the value where applicable, like RGB for color code.
-
valueRelationship: array
valueRelationship
Nested Schema : attachment
Type:
Show Source
array
-
Array of:
object AttachmentRefOrValue
Title:
AttachmentRefOrValue
Complements the description of an element (for instance a product) through video, pictures...
Nested Schema : valueRelationship
Type:
Show Source
array
-
Array of:
object ValueRelationshipOracle
Title:
ValueRelationshipOracle
Represent the value of a characteristic forming the constraint rule
Nested Schema : AttachmentRefOrValue
Type:
object
Title:
AttachmentRefOrValue
Complements the description of an element (for instance a product) through video, pictures...
Show Source
-
@baseType: string
The immediate base class type of the attachment
-
@referredType: string
The actual type of the target instance when needed for disambiguation
-
@schemaLocation: string
A link to the schema describing this attachment entity
-
@type: string
the class type of the Attachment
-
attachmentType: string
Attachment type such as video, picture
-
description: string
A narrative text describing the content of the attachment
-
href: string
Reference of the attachment
-
id: string
Unique identifier of the attachment
-
mimeType: string
Attachment mime type such as extension file for video, picture and document
-
name: string
name of the attachment
-
size: object
Quantity
Title:
Quantity
A number and unit representing how many of an ProductOffering is available at the offered price. -
url: string
Uniform Resource Locator, is a web page address (a subset of URI)
-
validFor: object
TimePeriodOracle
Title:
TimePeriodOracle
Validity period of the related party
Nested Schema : Quantity
Type:
object
Title:
Quantity
A number and unit representing how many of an ProductOffering is available at the offered price.
Show Source
-
amount(required): number
A quantity of something, typically the total of a thing or things in number, size, value, extent, or money.
-
units(required): string
Allowed Values:
[ "NONE", "SECOND", "MINUTE", "HOUR", "DAY", "MONTH", "BYTE", "KILOBYTE", "MEGABYTE", "GIGABYTE", "PAGES", "MOVIES", "TIME_INTERVAL", "QUANTITY", "MBPS", "GBPS" ]
The unit of measure for the quantity, such as meters, cubic yards, kilograms [ISO 80000], and the currency referring to [ISO 4217].
Nested Schema : ValueRelationshipOracle
Type:
object
Title:
ValueRelationshipOracle
Represent the value of a characteristic forming the constraint rule
Show Source
-
unitOfMeasure: string
A length, surface, volume, dry measure, liquid measure, money, weight, time, and the like. In general, a determinate quantity or magnitude of the kind designated, taken as a standard of comparison for others of the same kind, in assigning to them numerical values, as 1 foot, 1 yard, 1 mile, 1 square foot.
-
value(required):
value
Value representing a Relationship attribute
Nested Schema : value-oneOf[1]
Type:
object
Nested Schema : value-oneOf[4]
Type:
array
Response
Supported Media Types
- application/json
200 Response
Your request is successful and the resources have been created or updated.
Root Schema : schema
Type:
Show Source
array
-
Array of:
object AttributeOracle
Title:
AttributeOracle
Nested Schema : AttributeOracle
Type:
object
Title:
Show Source
AttributeOracle
-
@baseType: string
base class type (immediate parent) of the attribute
-
@schemaLocation: string
hyperlink reference to the schema describing this attribute
-
@type: 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
Nested Schema : attributeRelationship
Type:
Show Source
array
-
Array of:
object ProductSpecCharRelationship
Title:
ProductSpecCharRelationship
Discriminator:{ "propertyName":"@type", "mapping":{ "ProductSpecCharRelationship":"#/components/schemas/ProductSpecCharRelationship", "ProductSpecCharRelationshipOracle":"#/components/schemas/ProductSpecCharRelationshipOracle" } }
An aggregation, migration, substitution, dependency or exclusivity relationship between/among productSpecCharacteristics.
Nested Schema : attributeValue
Type:
Show Source
array
-
Array of:
ProductSpecCharacteristicValueOracle
Title:
ProductSpecCharacteristicValueOracle
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
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
Nested Schema : ProductSpecCharRelationship
Type:
object
Title:
ProductSpecCharRelationship
Discriminator: @type
Discriminator Values
An aggregation, migration, substitution, dependency or exclusivity relationship between/among productSpecCharacteristics.
Show Source
-
@baseType: string
base class type (immediate parent) of the productSpecCharRelationship
-
@schemaLocation: string
hyperlink reference to schema describing this object
-
@type: string
Class type of target product specification
-
charSpecSeq: integer
The order in which a CharacteristicSpecification appears within another CharacteristicSpecification that defines a grouping of CharacteristicSpecifications. For example, a grouping may represent the name of an individual. The given name is first, the middle name is second, and the last name is third.
-
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
Nested Schema : ProductSpecCharacteristicValueOracle
Title:
ProductSpecCharacteristicValueOracle
Match All
Show Source
-
object
ProductSpecCharacteristicValue
Title:
ProductSpecCharacteristicValue
Discriminator:{ "propertyName":"@type", "mapping":{ "ProductSpecCharacteristicValue":"#/components/schemas/ProductSpecCharacteristicValue", "ProductSpecCharacteristicValueOracle":"#/components/schemas/ProductSpecCharacteristicValueOracle" } }
A number or text that can be assigned to a ProductSpecCharacteristic. -
object
ProductSpecCharacteristicValueOracle-allOf[1]
Nested Schema : ProductSpecCharacteristicValue
Type:
object
Title:
ProductSpecCharacteristicValue
Discriminator: @type
Discriminator Values
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: 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 -
value(required):
value
A discrete value that the characteristic can take on. the value type is defined by 'valueType' characteristic
-
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
Nested Schema : ProductSpecCharacteristicValueOracle-allOf[1]
Type:
Show Source
object
-
attachment: array
attachment
-
sequence: integer
Indicates the sequence where attribute values appear during runtime
-
valueCode: string
A optional code for the value where applicable, like RGB for color code.
-
valueRelationship: array
valueRelationship
Nested Schema : attachment
Type:
Show Source
array
-
Array of:
object AttachmentRefOrValue
Title:
AttachmentRefOrValue
Complements the description of an element (for instance a product) through video, pictures...
Nested Schema : valueRelationship
Type:
Show Source
array
-
Array of:
object ValueRelationshipOracle
Title:
ValueRelationshipOracle
Represent the value of a characteristic forming the constraint rule
Nested Schema : AttachmentRefOrValue
Type:
object
Title:
AttachmentRefOrValue
Complements the description of an element (for instance a product) through video, pictures...
Show Source
-
@baseType: string
The immediate base class type of the attachment
-
@referredType: string
The actual type of the target instance when needed for disambiguation
-
@schemaLocation: string
A link to the schema describing this attachment entity
-
@type: string
the class type of the Attachment
-
attachmentType: string
Attachment type such as video, picture
-
description: string
A narrative text describing the content of the attachment
-
href: string
Reference of the attachment
-
id: string
Unique identifier of the attachment
-
mimeType: string
Attachment mime type such as extension file for video, picture and document
-
name: string
name of the attachment
-
size: object
Quantity
Title:
Quantity
A number and unit representing how many of an ProductOffering is available at the offered price. -
url: string
Uniform Resource Locator, is a web page address (a subset of URI)
-
validFor: object
TimePeriodOracle
Title:
TimePeriodOracle
Validity period of the related party
Nested Schema : Quantity
Type:
object
Title:
Quantity
A number and unit representing how many of an ProductOffering is available at the offered price.
Show Source
-
amount(required): number
A quantity of something, typically the total of a thing or things in number, size, value, extent, or money.
-
units(required): string
Allowed Values:
[ "NONE", "SECOND", "MINUTE", "HOUR", "DAY", "MONTH", "BYTE", "KILOBYTE", "MEGABYTE", "GIGABYTE", "PAGES", "MOVIES", "TIME_INTERVAL", "QUANTITY", "MBPS", "GBPS" ]
The unit of measure for the quantity, such as meters, cubic yards, kilograms [ISO 80000], and the currency referring to [ISO 4217].
Nested Schema : ValueRelationshipOracle
Type:
object
Title:
ValueRelationshipOracle
Represent the value of a characteristic forming the constraint rule
Show Source
-
unitOfMeasure: string
A length, surface, volume, dry measure, liquid measure, money, weight, time, and the like. In general, a determinate quantity or magnitude of the kind designated, taken as a standard of comparison for others of the same kind, in assigning to them numerical values, as 1 foot, 1 yard, 1 mile, 1 square foot.
-
value(required):
value
Value representing a Relationship attribute
Nested Schema : value-oneOf[1]
Type:
object
Nested Schema : value-oneOf[4]
Type:
array
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 : schema
Type:
Show Source
array
-
Array of:
object Discriminator: @type
Discriminator:
{ "propertyName":"@type", "mapping":{ "Error":"#/components/schemas/Error", "BulkError":"#/components/schemas/BulkError" } }
401 Response
Your request isn't authorized. The authentication credentials included with this request are missing or invalid.
Root Schema : Error
Type:
object
Title:
Show Source
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
Your request includes a resource URI that doesn't exist.
Root Schema : Error
Type:
object
Title:
Show Source
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
HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.
Root Schema : Error
Type:
object
Title:
Show Source
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
The server encountered something unexpected that prevented it from completing the request.
Root Schema : Error
Type:
object
Title:
Show Source
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