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

Get all product lines

get

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

Request

Query Parameters
  • The description of the resource.
  • Project Id
  • The comma-separated field names that are returned in the response. The field names are the names that you specify when you create or retrieve a resource.
  • The unique identifier of the resource item.
  • The current lifecycle status of the resource.
  • The number of resources to be returned in the response. The minimum value that can be specified is 1, and the maximum value that can be specified is 100,000. If the specified value is greater than 100,000, then it defaults to 100,000.
  • The name of the resource.
  • The record number from which the retrieval starts. The default value is zero. If no value is specified, then it defaults to zero. The value zero indicates that the retrieval will start from the beginning of the collection.
  • The current version of the resource.
  • enrich objects with usedBy information

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : schema
Type: array
Show Source
Nested 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
  • ProductLineOracle-allOf[1]
Nested Schema : ProductLine
Type: object
Title: ProductLine
Discriminator: @type

Discriminator Values

Represents entities that groups product offerings
Show Source
Nested Schema : ProductLineOracle-allOf[1]
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 get all product lines by submitting a GET request on the REST resource using cURL.

cURL Command

curl -u username:password -X GET https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productLine\ -H 'Content-Type: application/json'

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/PRODUCTLINE-3621804581-1594152825043",
        "id": "PRODUCTLINE-3621804581-1594152825043",
        "created": "2020-07-07T20:13:45.001Z",
        "lastUpdate": "2020-07-07T20:13:45.549Z",
        "version": "1.0",
        "name": "Automation Product Line Name-8-7-2020-1-41-53",
        "description": "Automation Product Line Description",
        "@type": "ProductLineOracle",
        "@schemaLocation": "https://{FusionAppsHost}/CatalogManagement/schema/oracle/ProductLineOracle.yml",
        "lifecycleStatus": "In design"
    },
    {
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productLine/ServicePlanPL6790",
        "id": "ServicePlanPL6790",
        "created": "2020-07-09T10:35:21.459Z",
        "lastUpdate": "2020-07-23T08:18:11.001Z",
        "version": "1.0",
        "project": {
            "id": "28527",
            "name": "ImportJob_28527",
            "version": "1.0"
        },
        "name": "Service Plan PL6790",
        "description": "Description of Product Lines",
        "@type": "ProductLineOracle",
        "@baseType": "ProductLine",
        "@schemaLocation": "https://{FusionAppsHost}/CatalogManagement/schema/oracle/ProductLineOracle.yml",
        "lifecycleStatus": "Ready to publish",
        "productOffering": [
            {
                "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productLine/HomeUltimateMonitoringPlan6790",
                "id": "HomeUltimateMonitoringPlan6790",
                "version": "1.0",
                "isBundle": false,
                "lifecycleStatus": "Ready to publish",
                "name": "Home Ultimate Monitoring Plan6790",
                "@referredType": "ProductOfferingOracle"
            },
            {
                "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productLine/HomeProtectionMonitoringPlan6790",
                "id": "HomeProtectionMonitoringPlan6790",
                "version": "1.0",
                "isBundle": false,
                "lifecycleStatus": "Ready to publish",
                "name": "Home Protection Monitoring Plan6790",
                "@referredType": "ProductOfferingOracle"
            },
            {
                "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productLine/HomeInteractiveMonitoringPlan6790",
                "id": "HomeInteractiveMonitoringPlan6790",
                "version": "1.0",
                "isBundle": false,
                "lifecycleStatus": "Ready to publish",
                "name": "Home Interactive Monitoring Plan6790",
                "@referredType": "ProductOfferingOracle"
            }
        ]
    },
    {
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productLine/PL-449443605-1595511813939",
        "id": "PL-449443605-1595511813939",
        "created": "2020-07-23T13:43:34.001Z",
        "lastUpdate": "2020-07-23T13:43:34.579Z",
        "version": "1.0",
        "name": "Product Line Name_23_7_2020_19_11_43",
        "description": "Product Line Description",
        "@type": "ProductLineOracle",
        "@schemaLocation": "https://{FusionAppsHost}/CatalogManagement/schema/oracle/ProductLineOracle.yml",
        "lifecycleStatus": "In design"
    },
	....
]
Back to Top