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

Get all product specifications

get

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

Request

Query Parameters
  • The base class type of the resource.
  • The link to the location where the scheme of the resource is defined.
  • The class type of the resource.
  • The manufacturer or trademark of the specification.
  • 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.
  • Contains one of the values, True or False. If False, then a single product offering is included. If True, then a bundle of product offerings is included.
  • 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 unique identifier of the specification.
  • 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 : ProductSpecificationOracle
Title: ProductSpecificationOracle
Match All
Show Source
Nested Schema : ProductSpecification
Type: object
Title: ProductSpecification
Discriminator: @type

Discriminator Values

Show Source
Nested Schema : ProductSpecificationOracle-allOf[1]
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 get a category 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/pricingLogicAlgorithmSpecification \ -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/pricingLogicAlgorithmSpecification/TestPLASpec",
        "id": "TestPLASpec",
        "lastUpdate": "2020-07-09T08:41:47.652Z",
        "version": "1.0",
        "@type": "PricingLogicAlgorithmSpecOracle",
        "@schemaLocation": "https://{FusionAppsHost}/CatalogManagement/schema/oracle/PricingLogicAlgorithmSpecOracle.yml",
        "@baseType": "PricingLogicAlgorithmSpec",
        "lifecycleStatus": "Ready to publish",
        "name": "Test PLA Spec",
        "description": "description of Test PLA Spec"
    },
    {
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/pricingLogicAlgorithmSpecification/PLA001",
        "id": "PLA001",
        "lastUpdate": "2020-07-08T12:50:12.876Z",
        "version": "1.0",
        "@type": "PricingLogicAlgorithmSpecOracle",
        "@schemaLocation": "https://{FusionAppsHost}/CatalogManagement/schema/oracle/PricingLogicAlgorithmSpecOracle.yml",
        "@baseType": "PricingLogicAlgorithmSpec",
        "lifecycleStatus": "Ready to publish",
        "name": "PLA_001",
        "description": "description of Validity PLA Spec"
    },
    {
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/pricingLogicAlgorithmSpecification/Oracle_20C37O1S",
        "id": "Oracle_20C37O1S",
        "lastUpdate": "2020-07-23T07:41:42.276Z",
        "version": "1.0",
        "project": {
            "id": "PublishProject06",
            "name": "Publish Project06"
        },
        "productSpecCharacteristic": [
            {
                "name": "Colour",
                "description": "Phone Colour",
                "valueType": "STRING",
                "configurable": true,
                "minCardinality": 1,
                "maxCardinality": 1,
                "isUnique": true,
                "extensible": false
            }
        ],
        "@type": "UsagePLASpecOracle",
        "@schemaLocation": "https://{FusionAppsHost}/CatalogManagement/schema/oracle/UsagePLASpecOracle.yml",
        "@baseType": "UsagePLASpec",
        "lifecycleStatus": "In design",
        "name": "Names_OXEOI5UEH",
        "description": "updated by automation description"
    }
	....
]
Back to Top