1. REST API Reference for Launch Cloud Service
  2. Tasks
  3. Attributes

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
Request Body - application/json ()
Root Schema : AttributeOracle
Type: object
Title: AttributeOracle
Show Source
Nested Schema : allowedUnits
Type: array
Show Source
Nested Schema : attributeRelationship
Type: array
Show Source
  • 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: array
Show Source
Nested Schema : ProjectRef
Type: object
Title: ProjectRef
Project Reference
Show Source
Nested Schema : TimePeriodOracle
Type: object
Title: TimePeriodOracle
Validity period of the related party
Show Source
Nested Schema : ProductSpecCharRelationship
Type: object
Title: ProductSpecCharRelationship
Discriminator: @type

Discriminator Values

An aggregation, migration, substitution, dependency or exclusivity relationship between/among productSpecCharacteristics.
Show Source
  • base class type (immediate parent) of the productSpecCharRelationship
  • hyperlink reference to schema describing this object
  • Class type of target product specification
  • 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.
  • Hyperlink reference to the target product specification
  • the identifier of the associated product specification
  • Name of the target product specification characteristic
  • Allowed Values: [ "AGGREGATION", "MIGRATION", "SUBSTITUTION", "DEPENDENCY", "EXCLUSIVITY" ]
    Type of relationship such as aggregation, migration, substitution, dependency, exclusivity
  • TimePeriodOracle
    Title: TimePeriodOracle
    Validity period of the related party
Nested Schema : ProductSpecCharacteristicValueOracle
Title: ProductSpecCharacteristicValueOracle
Match All
Show Source
Nested Schema : ProductSpecCharacteristicValue
Type: object
Title: ProductSpecCharacteristicValue
Discriminator: @type

Discriminator Values

A number or text that can be assigned to a ProductSpecCharacteristic.
Show Source
  • base class type (immediate parent) of the ProductSpecCharacteristic
  • Hyperlink reference to schema describing this object
  • The class type of the characteristic value
  • Indicates if the value is the default value for a characteristic
  • 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".
  • Regular expression to define constraint on the allowed value
  • Allowed Values: [ "NONE", "SECOND", "MINUTE", "HOUR", "DAY", "MONTH", "BYTE", "KILOBYTE", "MEGABYTE", "GIGABYTE", "PAGES", "MOVIES", "TIME_INTERVAL", "QUANTITY", "MBPS", "GBPS" ]
    Could be minutes, GB...
  • TimePeriodOracle
    Title: TimePeriodOracle
    Validity period of the related party
  • value
    A discrete value that the characteristic can take on. the value type is defined by 'valueType' characteristic
  • The low range value that a characteristic can take on
  • The upper range value that a characteristic can take on
  • 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: object
Show Source
Nested Schema : attachment
Type: array
Show Source
Nested Schema : valueRelationship
Type: array
Show Source
Nested Schema : AttachmentRefOrValue
Type: object
Title: AttachmentRefOrValue
Complements the description of an element (for instance a product) through video, pictures...
Show Source
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
  • A quantity of something, typically the total of a thing or things in number, size, value, extent, or money.
  • 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
  • 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
    Value representing a Relationship attribute
Nested Schema : value
Value representing a Relationship attribute
Match One Schema
Show Source
Nested Schema : value-oneOf[1]
Type: object
Nested Schema : value-oneOf[4]
Type: array
Back to Top

Response

Supported Media Types

201 Response

Your request is successful and a new resource has been created.
Body ()
Root Schema : AttributeOracle
Type: object
Title: AttributeOracle
Show Source
Nested Schema : allowedUnits
Type: array
Show Source
Nested Schema : attributeRelationship
Type: array
Show Source
  • 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: array
Show Source
Nested Schema : ProjectRef
Type: object
Title: ProjectRef
Project Reference
Show Source
Nested Schema : TimePeriodOracle
Type: object
Title: TimePeriodOracle
Validity period of the related party
Show Source
Nested Schema : ProductSpecCharRelationship
Type: object
Title: ProductSpecCharRelationship
Discriminator: @type

Discriminator Values

An aggregation, migration, substitution, dependency or exclusivity relationship between/among productSpecCharacteristics.
Show Source
  • base class type (immediate parent) of the productSpecCharRelationship
  • hyperlink reference to schema describing this object
  • Class type of target product specification
  • 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.
  • Hyperlink reference to the target product specification
  • the identifier of the associated product specification
  • Name of the target product specification characteristic
  • Allowed Values: [ "AGGREGATION", "MIGRATION", "SUBSTITUTION", "DEPENDENCY", "EXCLUSIVITY" ]
    Type of relationship such as aggregation, migration, substitution, dependency, exclusivity
  • TimePeriodOracle
    Title: TimePeriodOracle
    Validity period of the related party
Nested Schema : ProductSpecCharacteristicValueOracle
Title: ProductSpecCharacteristicValueOracle
Match All
Show Source
Nested Schema : ProductSpecCharacteristicValue
Type: object
Title: ProductSpecCharacteristicValue
Discriminator: @type

Discriminator Values

A number or text that can be assigned to a ProductSpecCharacteristic.
Show Source
  • base class type (immediate parent) of the ProductSpecCharacteristic
  • Hyperlink reference to schema describing this object
  • The class type of the characteristic value
  • Indicates if the value is the default value for a characteristic
  • 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".
  • Regular expression to define constraint on the allowed value
  • Allowed Values: [ "NONE", "SECOND", "MINUTE", "HOUR", "DAY", "MONTH", "BYTE", "KILOBYTE", "MEGABYTE", "GIGABYTE", "PAGES", "MOVIES", "TIME_INTERVAL", "QUANTITY", "MBPS", "GBPS" ]
    Could be minutes, GB...
  • TimePeriodOracle
    Title: TimePeriodOracle
    Validity period of the related party
  • value
    A discrete value that the characteristic can take on. the value type is defined by 'valueType' characteristic
  • The low range value that a characteristic can take on
  • The upper range value that a characteristic can take on
  • 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: object
Show Source
Nested Schema : attachment
Type: array
Show Source
Nested Schema : valueRelationship
Type: array
Show Source
Nested Schema : AttachmentRefOrValue
Type: object
Title: AttachmentRefOrValue
Complements the description of an element (for instance a product) through video, pictures...
Show Source
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
  • A quantity of something, typically the total of a thing or things in number, size, value, extent, or money.
  • 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
  • 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
    Value representing a Relationship attribute
Nested Schema : value
Value representing a Relationship attribute
Match One Schema
Show Source
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.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source

401 Response

Your request isn't authorized. The authentication credentials included with this request are missing or invalid.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source

404 Response

Your request includes a resource URI that doesn't exist.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source

405 Response

HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source

500 Response

The server encountered something unexpected that prevented it from completing the request.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source
Back to Top

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",
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/attribute/ATT-3502851773-1723207031590",
    "name": "storageSimple test",
    "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": "P-1898728235-1723206732151",
        "name": "testInit22",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/P-1898728235-1723206732151",
        "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": "storageSimple test",
    "version": "1.0",
    "lifecycleStatus": "In design",
    "valueType": "NUMBER",
    "@type": "AttributeOracle",
    "minCardinality": 0,
    "maxCardinality": 1,
    "validFor": {
        "startDateTime": "2024-08-09T00:00:00.000Z"
    },
    "lastUpdate": "2024-09-26T07:15:04.760Z",
    "lastUpdatedBy": "booth",
    "created": "2024-09-26T07:15:04.000Z",
    "createdBy": "booth",
    "versionState": 0,
    "project": {
        "id": "P-1898728235-1723206732151",
        "name": "testInit22",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/P-1898728235-1723206732151",
        "version": "1.0"
    }
}
Back to Top