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

Create or update a product specification

put

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

Request

Path Parameters
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

200 Response

OK
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 or update a product specification by submitting a PUT request on the REST resource using cURL.

cURL Command

curl -u username:password -X PUT \ https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productSpecification/SpecHomebaseModel00614 \ -H 'Content-Type: application/json' -D @put_prodspec.json | json_pp

Example of Request Body

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

{
    "@type": "ProductSpecificationOracle",
    "@baseType": "ProductSpecification",
    "id": "SpecHomebaseModel00614",
    "name": "Spec Home base Model 00614",
    "description": "SpecHomebaseMode 00614",
    "version": "1.0",
    "lifecycleStatus": "In study",
    "isBundle": false,
    "validFor": {
        "startDateTime": "2020-05-02T16:42:23.0Z",
        "endDateTime": "2021-07-14T00:00:00.0Z"
    },
     "project": {
        "id": "SpringProject",
        "name": "SpringProject"
    },
    "targetProductSchema": {
        "@type": "ProductOracle",
        "@schemaLocation": "https://{FusionAppsHost}/CatalogManagement/schema/oracle/ProductOracle.yml"
    }
}

Example of Response Body

The following example shows the contents of the response body in JSON format.
{
    "@type": "ProductSpecificationOracle",
    "@baseType": "ProductSpecification",
    "id": "SpecHomebaseModel00614",
    "name": "Spec Home base Model 00614",
    "description": "SpecHomebaseMode 00614",
    "version": "1.0",
    "lifecycleStatus": "In study",
    "isBundle": false,
    "validFor": {
        "startDateTime": "2020-05-02T16:42:23.0Z",
        "endDateTime": "2021-07-14T00:00:00.0Z"
    },
    "project": {
        "id": "SpringProject",
        "name": "SpringProject"
    },
    "targetProductSchema": {
        "@type": "ProductOracle",
        "@schemaLocation": "https://{FusionAppsHost}/CatalogManagement/schema/oracle/ProductOracle.yml"
    },
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productSpecification/SpecHomebaseModel00614",
    "createdBy": "anonymous",
    "created": "2020-08-20T14:13:32.000Z",
    "lastUpdatedBy": "anonymous",
    "lastUpdate": "2020-08-20T14:13:34.000Z"
}
Back to Top