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

Create a product specification

post

https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productSpecification

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json ()
Root Schema : ProductSpecificationOracle
Title: ProductSpecificationOracle
Match All
Show Source
  • ProductSpecification
    Title: ProductSpecification
    Discriminator: { "propertyName":"@type", "mapping":{ "ProductSpecification":"#/components/schemas/ProductSpecification", "ProductSpecificationOracle":"#/components/schemas/ProductSpecificationOracle" } }
  • type
Nested Schema : ProductSpecification
Type: object
Title: ProductSpecification
Discriminator: @type

Discriminator Values

Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : category
Type: array
Show Source
  • CategoryRef
    Title: CategoryRef
    Category reference. The category resource is used to group product offerings, service and resource candidates in logical containers. Categories can contain other categories and/or product offerings, resource or service candidates.
Nested Schema : customerProfileSpecification
Type: array
Show Source
Nested Schema : customProfileSpec
Type: array
Show Source
Nested Schema : ProjectRef
Type: object
Title: ProjectRef
Project Reference
Show Source
Nested Schema : usageSpecification
Type: array
Show Source
Nested Schema : usedBy
Type: array
Show Source
Nested Schema : CategoryRef
Type: object
Title: CategoryRef
Category reference. The category resource is used to group product offerings, service and resource candidates in logical containers. Categories can contain other categories and/or product offerings, resource or service candidates.
Show Source
Nested Schema : CustomerProfileSpecificationRef
Type: object
Title: CustomerProfileSpecificationRef
Customer Profile specification reference.
Show Source
Nested Schema : CustomProfileSpecRefOracle
Type: object
Title: CustomProfileSpecRefOracle
Custom Profile specification reference.
Show Source
Nested Schema : UsageSpecificationRefOracle
Title: UsageSpecificationRefOracle
Match All
Show Source
  • UsageSpecificationRef
    Title: UsageSpecificationRef
    Discriminator: { "propertyName":"@type", "mapping":{ "UsageSpecificationRef":"#/components/schemas/UsageSpecificationRef", "UsageSpecificationRefOracle":"#/components/schemas/UsageSpecificationRefOracle" } }
    Usage specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.
  • UsageSpecificationRefOracle-allOf[1]
Nested Schema : UsageSpecificationRef
Type: object
Title: UsageSpecificationRef
Discriminator: @type

Discriminator Values

Usage specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.
Show Source
Nested Schema : UsageSpecificationRefOracle-allOf[1]
Type: object
Show Source
Nested Schema : UsedByRef
Type: object
Title: UsedByRef
A reference to a resource that is aggregating another top-level resource.
Show Source
  • Indicates the base (class) type of this REST resource
  • The Class type of using item
  • hyperlink reference of the using item
  • Unique identifier of the using item
  • Name of the using item
  • Allowed Values: [ "PACKAGE", "COMMERCIAL_BUNDLE", "SERVICE_BUNDLE", "SERVICE", "DEVICE", "ACCESSORY", "CHOICE", "AGGREGATION", "AWARD", "DISCOUNT", "TRADE_IN", "COMPATIBILITY", "ELIGIBILITY", "MIGRATION", "RECOMMENDATION", "CONSTRAINT", "DEVICE_SPEC", "CHARGING_TERM", "SUSPENSION_TERM", "RETURN_CHECKLIST", "ENTITY_PROFILE", "PRODUCT_LINE", "PRODUCT_OFFERING_PRICE", "CATALOG", "CATEGORY", "PRODUCT_SPECIFICATION", "USAGE_SPECIFICATION", "SERVICE_SPECIFICATION" ]
    The entity type of using item
  • Version of the using item
Back to Top

Response

Supported Media Types

201 Response

Your request is successful and a new resource has been created.
Body ()
Root Schema : ProductSpecificationOracle
Title: ProductSpecificationOracle
Match All
Show Source
  • ProductSpecification
    Title: ProductSpecification
    Discriminator: { "propertyName":"@type", "mapping":{ "ProductSpecification":"#/components/schemas/ProductSpecification", "ProductSpecificationOracle":"#/components/schemas/ProductSpecificationOracle" } }
  • type
Nested Schema : ProductSpecification
Type: object
Title: ProductSpecification
Discriminator: @type

Discriminator Values

Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : category
Type: array
Show Source
  • CategoryRef
    Title: CategoryRef
    Category reference. The category resource is used to group product offerings, service and resource candidates in logical containers. Categories can contain other categories and/or product offerings, resource or service candidates.
Nested Schema : customerProfileSpecification
Type: array
Show Source
Nested Schema : customProfileSpec
Type: array
Show Source
Nested Schema : ProjectRef
Type: object
Title: ProjectRef
Project Reference
Show Source
Nested Schema : usageSpecification
Type: array
Show Source
Nested Schema : usedBy
Type: array
Show Source
Nested Schema : CategoryRef
Type: object
Title: CategoryRef
Category reference. The category resource is used to group product offerings, service and resource candidates in logical containers. Categories can contain other categories and/or product offerings, resource or service candidates.
Show Source
Nested Schema : CustomerProfileSpecificationRef
Type: object
Title: CustomerProfileSpecificationRef
Customer Profile specification reference.
Show Source
Nested Schema : CustomProfileSpecRefOracle
Type: object
Title: CustomProfileSpecRefOracle
Custom Profile specification reference.
Show Source
Nested Schema : UsageSpecificationRefOracle
Title: UsageSpecificationRefOracle
Match All
Show Source
  • UsageSpecificationRef
    Title: UsageSpecificationRef
    Discriminator: { "propertyName":"@type", "mapping":{ "UsageSpecificationRef":"#/components/schemas/UsageSpecificationRef", "UsageSpecificationRefOracle":"#/components/schemas/UsageSpecificationRefOracle" } }
    Usage specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.
  • UsageSpecificationRefOracle-allOf[1]
Nested Schema : UsageSpecificationRef
Type: object
Title: UsageSpecificationRef
Discriminator: @type

Discriminator Values

Usage specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.
Show Source
Nested Schema : UsageSpecificationRefOracle-allOf[1]
Type: object
Show Source
Nested Schema : UsedByRef
Type: object
Title: UsedByRef
A reference to a resource that is aggregating another top-level resource.
Show Source
  • Indicates the base (class) type of this REST resource
  • The Class type of using item
  • hyperlink reference of the using item
  • Unique identifier of the using item
  • Name of the using item
  • Allowed Values: [ "PACKAGE", "COMMERCIAL_BUNDLE", "SERVICE_BUNDLE", "SERVICE", "DEVICE", "ACCESSORY", "CHOICE", "AGGREGATION", "AWARD", "DISCOUNT", "TRADE_IN", "COMPATIBILITY", "ELIGIBILITY", "MIGRATION", "RECOMMENDATION", "CONSTRAINT", "DEVICE_SPEC", "CHARGING_TERM", "SUSPENSION_TERM", "RETURN_CHECKLIST", "ENTITY_PROFILE", "PRODUCT_LINE", "PRODUCT_OFFERING_PRICE", "CATALOG", "CATEGORY", "PRODUCT_SPECIFICATION", "USAGE_SPECIFICATION", "SERVICE_SPECIFICATION" ]
    The entity type of using item
  • Version of the using item

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 a product specification 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/tmf-api/productCatalogManagement/v4/productSpecification -H "Content-Type: application/json" -D @create_prodspec.json| json_pp

Example of Request Body

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

{
    "id": "TestProductSpec0526022605",
    "name": "TestProductSpec05262022605",
    "description": "TestProductSpec05262022605",
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productSpecification/TestProductSpec14032022605/TestProductSpec14032022605",
    "version": "1.0",
    "lifecycleStatus": "In design",
    "created": "2022-03-14T12:35:45.000Z",
    "createdBy": "booth",
    "lastUpdate": "2022-03-15T07:07:53.188Z",
    "lastUpdatedBy": "booth",
    "isBundle": false,
    "@type": "ProductSpecificationOracle",
    "@baseType": "ProductSpecification",
    "validFor": {
        "startDateTime": "2020-01-18T00:00:00.000Z",
        "endDateTime": "2022-02-20T16:42:23.000Z"
    },
    "project": {
        "id": "AutomationProject",
        "name": "AutomationProject",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/AutomationProject"
    },
    "productSpecCharacteristic": [
        {
            "name": "Colour",
            "description": "Phone Colour",
            "valueType": "STRING",
            "extensible": false,
            "configurable": true,
            "isUnique": true,
            "minCardinality": 1,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2020-01-18T00:00:00.000Z",
                "endDateTime": "2022-02-20T16:42:23.000Z"
            },
            "productSpecCharacteristicValue": [
                {
                    "value": "Black",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2020-01-18T00:00:00.000Z",
                        "endDateTime": "2022-02-20T16:42:23.000Z"
                    },
                    "sequence": 1
                },
                {
                    "value": "Grey",
                    "valueType": "STRING",
                    "isDefault": true,
                    "validFor": {
                        "startDateTime": "2020-01-18T00:00:00.000Z",
                        "endDateTime": "2022-02-20T16:42:23.000Z"
                    },
                    "sequence": 2
                }
            ],
            "displayName": "ColorType",
            "sensitive": false,
            "runtimeFilterable": false
        },
        {
            "name": "Allocated IPv6 Address",
            "description": "Allocated IPv6 Address",
            "valueType": "STRING",
            "extensible": false,
            "configurable": false,
            "isUnique": true,
            "regex": "([0-9A-Fa-f]{1,4}:){7}[0-9A-Fa-f]{1,4})",
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2020-01-18T00:00:00.000Z",
                "endDateTime": "2022-02-20T16:42:23.000Z"
            },
            "displayName": "IPv6 AddressType",
            "sensitive": false,
            "runtimeFilterable": false
        },
        {
            "name": "ProductLink",
            "description": "ProductLink",
            "valueType": "URL",
            "extensible": false,
            "configurable": false,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2020-01-18T00:00:00.000Z",
                "endDateTime": "2022-02-20T16:42:23.000Z"
            },
            "displayName": "ProductLinkType",
            "sensitive": false,
            "runtimeFilterable": false
        },
        {
            "name": "PurchaseDay",
            "description": "PurchaseDay",
            "valueType": "DATETIME",
            "extensible": false,
            "configurable": false,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2020-01-18T00:00:00.000Z",
                "endDateTime": "2022-02-20T16:42:23.000Z"
            },
            "displayName": "PurchaseDayType",
            "sensitive": false,
            "runtimeFilterable": false
        },
        {
            "name": "PriceVal",
            "description": "PriceVal",
            "valueType": "DECIMAL",
            "extensible": false,
            "configurable": false,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2020-01-18T00:00:00.000Z",
                "endDateTime": "2022-02-20T16:42:23.000Z"
            },
            "productSpecCharacteristicValue": [
                {
                    "value": "5.2",
                    "rangeInterval": "OPEN",
                    "valueTo": "10",
                    "valueFrom": "0",
                    "valueType": "STRING",
                    "isDefault": true
                }
            ],
            "displayName": "PriceValType",
            "sensitive": false,
            "runtimeFilterable": false
        }
    ],
    "attachment": [
        {
            "id": "Attach1",
            "@type": "AttachmentOracle",
            "url": "https://oceintegration-oce0004.cec.ocp.oraclecloud.com/",
            "mimeType": "image/jpeg"
        },
        {
            "id": "Attach2",
            "@type": "AttachmentOracle",
            "url": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1/attachment/Attach2",
            "mimeType": "application/pdf"
        }
    ],
    "externalId": "eid",
    "applicationName": "LaunchX"
}

Example of Response Body

The following example shows the contents of the response body in JSON format.
{
    "id": "TestProductSpec0526022605",
    "name": "TestProductSpec05262022605",
    "description": "TestProductSpec05262022605",
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productSpecification/TestProductSpec0526022605",
    "version": "1.0",
    "lifecycleStatus": "In design",
    "created": "2022-05-26T06:33:33.000Z",
    "createdBy": "booth",
    "lastUpdate": "2022-05-26T06:33:33.351Z",
    "lastUpdatedBy": "booth",
    "isBundle": false,
    "@type": "ProductSpecificationOracle",
    "@baseType": "ProductSpecification",
    "validFor": {
        "startDateTime": "2020-01-18T00:00:00.000Z",
        "endDateTime": "2022-02-20T16:42:23.000Z"
    },
    "project": {
        "id": "AutomationProject",
        "name": "AutomationProject",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/AutomationProject"
    },
    "productSpecCharacteristic": [
        {
            "name": "Colour",
            "description": "Phone Colour",
            "valueType": "STRING",
            "extensible": false,
            "configurable": true,
            "isUnique": true,
            "minCardinality": 1,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2020-01-18T00:00:00.000Z",
                "endDateTime": "2022-02-20T16:42:23.000Z"
            },
            "productSpecCharacteristicValue": [
                {
                    "value": "Black",
                    "valueType": "STRING",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2020-01-18T00:00:00.000Z",
                        "endDateTime": "2022-02-20T16:42:23.000Z"
                    },
                    "sequence": 1
                },
                {
                    "value": "Grey",
                    "valueType": "STRING",
                    "isDefault": true,
                    "validFor": {
                        "startDateTime": "2020-01-18T00:00:00.000Z",
                        "endDateTime": "2022-02-20T16:42:23.000Z"
                    },
                    "sequence": 2
                }
            ],
            "displayName": "ColorType",
            "sensitive": false,
            "runtimeFilterable": false
        },
        {
            "name": "Allocated IPv6 Address",
            "description": "Allocated IPv6 Address",
            "valueType": "STRING",
            "extensible": false,
            "configurable": false,
            "isUnique": true,
            "regex": "([0-9A-Fa-f]{1,4}:){7}[0-9A-Fa-f]{1,4})",
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2020-01-18T00:00:00.000Z",
                "endDateTime": "2022-02-20T16:42:23.000Z"
            },
            "displayName": "IPv6 AddressType",
            "sensitive": false,
            "runtimeFilterable": false
        },
        {
            "name": "ProductLink",
            "description": "ProductLink",
            "valueType": "URL",
            "extensible": false,
            "configurable": false,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2020-01-18T00:00:00.000Z",
                "endDateTime": "2022-02-20T16:42:23.000Z"
            },
            "displayName": "ProductLinkType",
            "sensitive": false,
            "runtimeFilterable": false
        },
        {
            "name": "PurchaseDay",
            "description": "PurchaseDay",
            "valueType": "DATETIME",
            "extensible": false,
            "configurable": false,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2020-01-18T00:00:00.000Z",
                "endDateTime": "2022-02-20T16:42:23.000Z"
            },
            "displayName": "PurchaseDayType",
            "sensitive": false,
            "runtimeFilterable": false
        },
        {
            "name": "PriceVal",
            "description": "PriceVal",
            "valueType": "DECIMAL",
            "extensible": false,
            "configurable": false,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2020-01-18T00:00:00.000Z",
                "endDateTime": "2022-02-20T16:42:23.000Z"
            },
            "productSpecCharacteristicValue": [
                {
                    "value": "5.2",
                    "rangeInterval": "OPEN",
                    "valueTo": "10",
                    "valueFrom": "0",
                    "valueType": "STRING",
                    "isDefault": true
                }
            ],
            "displayName": "PriceValType",
            "sensitive": false,
            "runtimeFilterable": false
        }
    ],
    "attachment": [
        {
            "id": "Attach1",
            "@type": "AttachmentOracle",
            "url": "https://oceintegration-oce0004.cec.ocp.oraclecloud.com/",
            "mimeType": "image/jpeg"
        },
        {
            "id": "Attach2",
            "@type": "AttachmentOracle",
            "url": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1/attachment/Attach2",
            "mimeType": "application/pdf"
        }
    ],
    "externalId": "eid",
    "applicationName": "LaunchX"
}
Back to Top