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

Create a product line

post

https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/productLine

Creates a new product line using the supplied request payload and returns the created resource.

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json ()
Root Schema : ProductLineOracle
Title: ProductLineOracle
Match All
Show Source
  • ProductLine
    Title: ProductLine
    Discriminator: { "propertyName":"@type", "mapping":{ "ProductLine":"#/components/schemas/ProductLine", "ProductLineOracle":"#/components/schemas/ProductLineOracle" } }
    The entity that groups product offerings.
  • type
Nested Schema : ProductLine
Type: object
Title: ProductLine
Discriminator: @type

Discriminator Values

The entity that groups product offerings.
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : compatibilityRules
Type: array
A list of compatibility rules associated with the product line.
Show Source
Nested Schema : productOffering
Type: array
A list of product offerings associated with the product line.
Show Source
Nested Schema : ProjectRef
Type: object
Title: ProjectRef
The project reference resource.
Show Source
Nested Schema : CompatibilityRulesOracle
Type: object
Title: CompatibilityRulesOracle
Specifies the compatibility rule for the offer.
Show Source
Nested Schema : TimePeriodOracle
Type: object
Title: TimePeriodOracle
The validity period of the related party.
Show Source
Nested Schema : ProductOfferingRefOracle
Title: ProductOfferingRefOracle
Match All
Show Source
  • ProductOfferingRef
    Title: ProductOfferingRef
    Discriminator: { "propertyName":"@type", "mapping":{ "ProductOfferingRef":"#/components/schemas/ProductOfferingRef", "BundledProductOffering":"#/components/schemas/BundledProductOffering", "BundledProductOfferingChoiceOracle":"#/components/schemas/BundledProductOfferingChoiceOracle", "BundledProductOfferingOracle":"#/components/schemas/BundledProductOfferingOracle" } }
    The productOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.
  • ProductOfferingRefOracle-allOf[1]
Nested Schema : ProductOfferingRef
Type: object
Title: ProductOfferingRef
Discriminator: @type

Discriminator Values

The productOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.
Show Source
Nested Schema : ProductOfferingRefOracle-allOf[1]
Type: object
Show Source
Back to Top

Response

Supported Media Types

201 Response

The product line was created successfully.
Body ()
Root Schema : ProductLineOracle
Title: ProductLineOracle
Match All
Show Source
  • ProductLine
    Title: ProductLine
    Discriminator: { "propertyName":"@type", "mapping":{ "ProductLine":"#/components/schemas/ProductLine", "ProductLineOracle":"#/components/schemas/ProductLineOracle" } }
    The entity that groups product offerings.
  • type
Nested Schema : ProductLine
Type: object
Title: ProductLine
Discriminator: @type

Discriminator Values

The entity that groups product offerings.
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : compatibilityRules
Type: array
A list of compatibility rules associated with the product line.
Show Source
Nested Schema : productOffering
Type: array
A list of product offerings associated with the product line.
Show Source
Nested Schema : ProjectRef
Type: object
Title: ProjectRef
The project reference resource.
Show Source
Nested Schema : CompatibilityRulesOracle
Type: object
Title: CompatibilityRulesOracle
Specifies the compatibility rule for the offer.
Show Source
Nested Schema : TimePeriodOracle
Type: object
Title: TimePeriodOracle
The validity period of the related party.
Show Source
Nested Schema : ProductOfferingRefOracle
Title: ProductOfferingRefOracle
Match All
Show Source
  • ProductOfferingRef
    Title: ProductOfferingRef
    Discriminator: { "propertyName":"@type", "mapping":{ "ProductOfferingRef":"#/components/schemas/ProductOfferingRef", "BundledProductOffering":"#/components/schemas/BundledProductOffering", "BundledProductOfferingChoiceOracle":"#/components/schemas/BundledProductOfferingChoiceOracle", "BundledProductOfferingOracle":"#/components/schemas/BundledProductOfferingOracle" } }
    The productOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.
  • ProductOfferingRefOracle-allOf[1]
Nested Schema : ProductOfferingRef
Type: object
Title: ProductOfferingRef
Discriminator: @type

Discriminator Values

The productOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.
Show Source
Nested Schema : ProductOfferingRefOracle-allOf[1]
Type: object
Show Source

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
The error resource.
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
The error resource.
Show Source

404 Response

The resource with the specified URI couldn't be found.
Body ()
Root Schema : Error
Type: object
Title: Error
The error resource.
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
The error resource.
Show Source

500 Response

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

Examples

The following example shows how to create a product line 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/productLine/ \ -H 'Content-Type: application/json' -D @create_productline.json | json_pp

Example of Request Body

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

{
    "id": "InternetOffersPL",
    "name": "Internet Offers PL",
    "@type": "ProductLineOracle",
    "@baseType": "ProductLine",
    "version": "1.0",
    "description": "Product line for IPTV TV and Movie offers",
    "lifecycleStatus": "In design",
    "project": {
        "id": "SpringProject",
        "name": "SpringProject"
    }
}

Example of Response Body

The following example shows the contents of the response body in JSON format.
{
    "id": "InternetOffersPL",
    "name": "Internet Offers PL",
    "@type": "ProductLineOracle",
    "@baseType": "ProductLine",
    "version": "1.0",
    "description": "Product line for IPTV TV and Movie offers",
    "lifecycleStatus": "In design",
    "project": {
        "id": "SpringProject",
        "name": "SpringProject"
    },
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productLine/InternetOffersPL",
    "createdBy": "anonymous",
    "created": "2020-08-19T15:52:49.000Z",
    "lastUpdatedBy": "anonymous",
    "lastUpdate": "2020-08-19T15:52:49.000Z"
}
Back to Top