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

Create or update a product line

put

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

Request

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

Discriminator Values

Represents entities that groups product offerings
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : compatibilityRules
Type: array
Show Source
Nested Schema : productOffering
Type: array
Show Source
  • ProductLineOfferingRef
    Title: ProductLineOfferingRef
    ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.
Nested Schema : ProjectRef
Type: object
Title: ProjectRef
Project Reference
Show Source
Nested Schema : CompatibilityRulesOracle
Type: object
Title: CompatibilityRulesOracle
specifies the compatibilty rule for the offer
Show Source
Nested Schema : TimePeriodOracle
Type: object
Title: TimePeriodOracle
Validity period of the related party
Show Source
Nested Schema : ProductLineOfferingRef
Type: object
Title: ProductLineOfferingRef
ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.
Show Source
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : ProductLineOracle
Title: ProductLineOracle
Represents entities that groups product offerings
Match All
Represents entities that groups product offerings
Represents entities that groups product offerings
Show Source
  • ProductLine
    Title: ProductLine
    Discriminator: { "propertyName":"@type", "mapping":{ "ProductLine":"#/components/schemas/ProductLine", "ProductLineOracle":"#/components/schemas/ProductLineOracle" } }
    Represents entities that groups product offerings
  • type
Nested Schema : ProductLine
Type: object
Title: ProductLine
Discriminator: @type

Discriminator Values

Represents entities that groups product offerings
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : compatibilityRules
Type: array
Show Source
Nested Schema : productOffering
Type: array
Show Source
  • ProductLineOfferingRef
    Title: ProductLineOfferingRef
    ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.
Nested Schema : ProjectRef
Type: object
Title: ProjectRef
Project Reference
Show Source
Nested Schema : CompatibilityRulesOracle
Type: object
Title: CompatibilityRulesOracle
specifies the compatibilty rule for the offer
Show Source
Nested Schema : TimePeriodOracle
Type: object
Title: TimePeriodOracle
Validity period of the related party
Show Source
Nested Schema : ProductLineOfferingRef
Type: object
Title: ProductLineOfferingRef
ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.
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
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 line 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/productLine/InternetOffersPL2020 -H 'Content-Type: application/json' -D @put_productline.json | json_pp

Example of Request Body

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

{
    "id": "InternetOffersPL2020",
    "name": "Internet Offers PL2020",
    "@type": "ProductLineOracle",
    "@baseType": "ProductLine",
    "version": "1.0",
    "description": "Product line 12 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.
{
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productLine/IPTVProductLine2/InternetOffersPL2020",
    "id": "InternetOffersPL2020",
    "createdBy": "anonymous",
    "created": "2020-08-19T16:02:10.004Z",
    "lastUpdate": "2020-08-19T16:02:11.427Z",
    "lastUpdatedBy": "anonymous",
    "version": "1.0",
    "name": "Internet Offers PL2020",
    "description": "Product line 12 for IPTV TV and Movie offers",
    "@type": "ProductLineOracle",
    "@baseType": "ProductLine",
    "@schemaLocation": "https://{FusionAppsHost}/CatalogManagement/schema/oracle/ProductLineOracle.yml",
    "lifecycleStatus": "In design",
    "project": {
        "id": "SpringProject",
        "name": "SpringProject"
    }
}
Back to Top