REST API Reference for Launch Cloud Service

Get a product specification

get

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

Request

Path Parameters

id(required): string

The unique identifier of the resource item.

Query Parameters

eligibleVersionForProject: string

Project Id
fields: string

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.

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Root Schema : ProductSpecificationOracle

Title: ProductSpecificationOracle

Match All

Show Source

object ProductSpecification

Title: ProductSpecification

Discriminator: { "propertyName":"@type", "mapping":{ "ProductSpecification":"#/components/schemas/ProductSpecification", "ProductSpecificationOracle":"#/components/schemas/ProductSpecificationOracle" } }
object type

{
    "title":"ProductSpecificationOracle",
    "allOf":[
        {
            "$ref":"#/components/schemas/ProductSpecification"
        },
        {
            "type":"object",
            "properties":{
                "category":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/CategoryRef"
                    }
                },
                "project":{
                    "$ref":"#/components/schemas/ProjectRef"
                },
                "created":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Date and time of the creation"
                },
                "createdBy":{
                    "type":"string",
                    "description":"name of the person who created item"
                },
                "lastUpdatedBy":{
                    "type":"string",
                    "description":"name of the person who updated item"
                },
                "usageSpecification":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/UsageSpecificationRefOracle"
                    }
                },
                "customerProfileSpecification":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/CustomerProfileSpecificationRef"
                    }
                },
                "usedBy":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/UsedByRef"
                    }
                },
                "customProfileSpec":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/CustomProfileSpecRefOracle"
                    }
                },
                "externalId":{
                    "type":"string",
                    "description":"id of the external application"
                },
                "applicationName":{
                    "type":"string",
                    "description":"name of the external application"
                },
                "versionState":{
                    "type":"number",
                    "description":"Version state of the Product Specification"
                }
            }
        }
    ]
}

Nested Schema : ProductSpecification

Type: object

Title: ProductSpecification

Discriminator: @type

{
    "title":"ProductSpecification",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":"30",
            "description":"Unique identifier of the product specification"
        },
        "href":{
            "type":"string",
            "description":"Reference of the product specification"
        },
        "name":{
            "type":"string",
            "description":"Name of the product specification"
        },
        "description":{
            "type":"string",
            "description":"A narrative that explains in detail what the product specification is"
        },
        "brand":{
            "type":"string",
            "description":"The manufacturer or trademark of the specification"
        },
        "isBundle":{
            "type":"boolean",
            "description":"isBundle determines whether a productSpecification represents a single productSpecification (false), or a bundle of productSpecification (true)."
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the last update"
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"Used to indicate the current lifecycle status"
        },
        "productNumber":{
            "type":"string",
            "description":"An identification number assigned to uniquely identity the specification"
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        },
        "version":{
            "type":"string",
            "description":"Product specification version"
        },
        "@type":{
            "type":"string",
            "description":"class type of the product specification"
        },
        "@baseType":{
            "type":"string",
            "description":"base class type  (immediate parent) of the product specification"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"hyperlink reference to schema describing this object"
        },
        "relatedParty":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelatedPartyRefOrPartyRoleRef"
            }
        },
        "productSpecCharacteristic":{
            "type":"array",
            "items":{
                "anyOf":[
                    {
                        "$ref":"#/components/schemas/CharacteristicSpecificationOracle"
                    },
                    {
                        "$ref":"#/components/schemas/AttributeRefOracle"
                    }
                ]
            }
        },
        "serviceSpecification":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ServiceSpecificationRefOracle"
            }
        },
        "targetProductSchema":{
            "$ref":"#/components/schemas/TargetProductSchema"
        },
        "productSpecificationRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductSpecificationRelationship"
            }
        },
        "resourceSpecification":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceSpecificationRef"
            }
        },
        "attachment":{
            "type":"array",
            "items":{
                "anyOf":[
                    {
                        "$ref":"#/components/schemas/Attachment"
                    },
                    {
                        "$ref":"#/components/schemas/AttachmentOracle"
                    },
                    {
                        "$ref":"#/components/schemas/AttachmentRef"
                    }
                ],
                "discriminator":{
                    "propertyName":"@type",
                    "mapping":{
                        "Attachment":"#/components/schemas/Attachment",
                        "AttachmentOracle":"#/components/schemas/AttachmentOracle",
                        "AttachmentRef":"#/components/schemas/AttachmentRef"
                    }
                }
            }
        },
        "bundledProductSpecification":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BundledProductSpecification"
            }
        }
    },
    "required":[
        "name",
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ProductSpecification":"#/components/schemas/ProductSpecification",
            "ProductSpecificationOracle":"#/components/schemas/ProductSpecificationOracle"
        }
    }
}

Show Source

@baseType: string

base class type (immediate parent) of the product specification
@schemaLocation: string

hyperlink reference to schema describing this object
@type(required): string

class type of the product specification
attachment: array attachment
brand: string

The manufacturer or trademark of the specification
bundledProductSpecification: array bundledProductSpecification
description: string

A narrative that explains in detail what the product specification is
href: string

Reference of the product specification
id: string

Maximum Length: 30

Unique identifier of the product specification
isBundle: boolean

isBundle determines whether a productSpecification represents a single productSpecification (false), or a bundle of productSpecification (true).
lastUpdate: string (date-time)

Date and time of the last update
lifecycleStatus: string

Used to indicate the current lifecycle status
name(required): string

Name of the product specification
productNumber: string

An identification number assigned to uniquely identity the specification
productSpecCharacteristic: array productSpecCharacteristic
productSpecificationRelationship: array productSpecificationRelationship
relatedParty: array relatedParty
resourceSpecification: array resourceSpecification
serviceSpecification: array serviceSpecification
targetProductSchema: object TargetProductSchema

Title: TargetProductSchema

The reference object to the schema and type of target product which is described by product specification
validFor: object TimePeriod

Title: TimePeriod

The period for which the productOffering is valid
version: string

Product specification version

{
    "title":"ProductSpecification",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":"30",
            "description":"Unique identifier of the product specification"
        },
        "href":{
            "type":"string",
            "description":"Reference of the product specification"
        },
        "name":{
            "type":"string",
            "description":"Name of the product specification"
        },
        "description":{
            "type":"string",
            "description":"A narrative that explains in detail what the product specification is"
        },
        "brand":{
            "type":"string",
            "description":"The manufacturer or trademark of the specification"
        },
        "isBundle":{
            "type":"boolean",
            "description":"isBundle determines whether a productSpecification represents a single productSpecification (false), or a bundle of productSpecification (true)."
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the last update"
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"Used to indicate the current lifecycle status"
        },
        "productNumber":{
            "type":"string",
            "description":"An identification number assigned to uniquely identity the specification"
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        },
        "version":{
            "type":"string",
            "description":"Product specification version"
        },
        "@type":{
            "type":"string",
            "description":"class type of the product specification"
        },
        "@baseType":{
            "type":"string",
            "description":"base class type  (immediate parent) of the product specification"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"hyperlink reference to schema describing this object"
        },
        "relatedParty":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelatedPartyRefOrPartyRoleRef"
            }
        },
        "productSpecCharacteristic":{
            "type":"array",
            "items":{
                "anyOf":[
                    {
                        "$ref":"#/components/schemas/CharacteristicSpecificationOracle"
                    },
                    {
                        "$ref":"#/components/schemas/AttributeRefOracle"
                    }
                ]
            }
        },
        "serviceSpecification":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ServiceSpecificationRefOracle"
            }
        },
        "targetProductSchema":{
            "$ref":"#/components/schemas/TargetProductSchema"
        },
        "productSpecificationRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductSpecificationRelationship"
            }
        },
        "resourceSpecification":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceSpecificationRef"
            }
        },
        "attachment":{
            "type":"array",
            "items":{
                "anyOf":[
                    {
                        "$ref":"#/components/schemas/Attachment"
                    },
                    {
                        "$ref":"#/components/schemas/AttachmentOracle"
                    },
                    {
                        "$ref":"#/components/schemas/AttachmentRef"
                    }
                ],
                "discriminator":{
                    "propertyName":"@type",
                    "mapping":{
                        "Attachment":"#/components/schemas/Attachment",
                        "AttachmentOracle":"#/components/schemas/AttachmentOracle",
                        "AttachmentRef":"#/components/schemas/AttachmentRef"
                    }
                }
            }
        },
        "bundledProductSpecification":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BundledProductSpecification"
            }
        }
    },
    "required":[
        "name",
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ProductSpecification":"#/components/schemas/ProductSpecification",
            "ProductSpecificationOracle":"#/components/schemas/ProductSpecificationOracle"
        }
    }
}

Nested Schema : type

Type: object

Show Source

applicationName: string

name of the external application
category: array category
created: string (date-time)

Date and time of the creation
createdBy: string

name of the person who created item
customerProfileSpecification: array customerProfileSpecification
customProfileSpec: array customProfileSpec
externalId: string

id of the external application
lastUpdatedBy: string

name of the person who updated item
project: object ProjectRef

Title: ProjectRef

Project Reference
usageSpecification: array usageSpecification
usedBy: array usedBy
versionState: number

Version state of the Product Specification

{
    "type":"object",
    "properties":{
        "category":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CategoryRef"
            }
        },
        "project":{
            "$ref":"#/components/schemas/ProjectRef"
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the creation"
        },
        "createdBy":{
            "type":"string",
            "description":"name of the person who created item"
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"name of the person who updated item"
        },
        "usageSpecification":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/UsageSpecificationRefOracle"
            }
        },
        "customerProfileSpecification":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CustomerProfileSpecificationRef"
            }
        },
        "usedBy":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/UsedByRef"
            }
        },
        "customProfileSpec":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CustomProfileSpecRefOracle"
            }
        },
        "externalId":{
            "type":"string",
            "description":"id of the external application"
        },
        "applicationName":{
            "type":"string",
            "description":"name of the external application"
        },
        "versionState":{
            "type":"number",
            "description":"Version state of the Product Specification"
        }
    }
}

Nested Schema : category

Type: array

Show Source

Array of: object 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.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CategoryRef"
    }
}

Nested Schema : customerProfileSpecification

Type: array

Show Source

Array of: object CustomerProfileSpecificationRef

Title: CustomerProfileSpecificationRef

Customer Profile specification reference.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CustomerProfileSpecificationRef"
    }
}

Nested Schema : customProfileSpec

Type: array

Show Source

Array of: object CustomProfileSpecRefOracle

Title: CustomProfileSpecRefOracle

Custom Profile specification reference.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CustomProfileSpecRefOracle"
    }
}

Nested Schema : ProjectRef

Type: object

Title: ProjectRef

Project Reference

Show Source

href: string

Unique reference of the project
id(required): string

Unique identifier of the project
name: string

Name of the project
version: string

Version of the project

{
    "title":"ProjectRef",
    "type":"object",
    "description":"Project Reference",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the project"
        },
        "href":{
            "type":"string",
            "description":"Unique reference of the project"
        },
        "name":{
            "type":"string",
            "description":"Name of the project"
        },
        "version":{
            "type":"string",
            "description":"Version of the project"
        }
    },
    "required":[
        "id"
    ]
}

Nested Schema : usageSpecification

Type: array

Show Source

Array of: UsageSpecificationRefOracle

Title: UsageSpecificationRefOracle

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/UsageSpecificationRefOracle"
    }
}

Nested Schema : usedBy

Type: array

Show Source

Array of: object UsedByRef

Title: UsedByRef

A reference to a resource that is aggregating another top-level resource.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/UsedByRef"
    }
}

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

@baseType: string

base class type of CategoryRef
@referredType(required): string

the class type of the referred Category
@schemaLocation: string

Hyperlink reference to schema describing this object
@type(required): string

The class type of the CategoyRef
href: string

Unique reference of the category
id(required): string

Unique reference of the category
name: string

Name of the category
version: string

Category version
versionState: number

To hold the version state for the reference

{
    "title":"CategoryRef",
    "type":"object",
    "description":"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.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique reference of the category"
        },
        "href":{
            "type":"string",
            "description":"Unique reference of the category"
        },
        "version":{
            "type":"string",
            "description":"Category version"
        },
        "name":{
            "type":"string",
            "description":"Name of the category"
        },
        "@type":{
            "type":"string",
            "description":"The class type of the CategoyRef"
        },
        "@baseType":{
            "type":"string",
            "description":"base class type  of CategoryRef"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"Hyperlink reference to schema describing this object"
        },
        "@referredType":{
            "type":"string",
            "description":"the class type of the referred Category"
        },
        "versionState":{
            "type":"number",
            "description":"To hold the version state for the reference"
        }
    },
    "required":[
        "id",
        "@type",
        "@referredType"
    ]
}

Nested Schema : CustomerProfileSpecificationRef

Type: object

Title: CustomerProfileSpecificationRef

Customer Profile specification reference.

Show Source

@baseType: string

Indicates the base (class) type of this REST resource
@referredType(required): string

(Class) type of the referred Usage Specification.
@schemaLocation: string

This field provides a link to the schema describing this REST resource
@type(required): string

Indicates the (class) type of ServiceSpecificationRef.
href: string

Reference of the usage specification.
id(required): string

Unique identifier of the usage specification.
name: string

Name of the usage specification.
version: string

Version of the usage specification.
versionState: number

To hold the version state for the reference

{
    "title":"CustomerProfileSpecificationRef",
    "type":"object",
    "description":"Customer Profile specification reference.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the usage specification."
        },
        "href":{
            "type":"string",
            "description":"Reference of the usage specification."
        },
        "name":{
            "type":"string",
            "description":"Name of the usage specification."
        },
        "version":{
            "type":"string",
            "description":"Version of the usage specification."
        },
        "@referredType":{
            "type":"string",
            "description":"(Class) type of the referred Usage Specification."
        },
        "@type":{
            "type":"string",
            "description":"Indicates the (class) type of ServiceSpecificationRef."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"This field provides a link to the schema describing this REST resource"
        },
        "@baseType":{
            "type":"string",
            "description":"Indicates<b> </b>the base (class) type of this REST resource"
        },
        "versionState":{
            "type":"number",
            "description":"To hold the version state for the reference"
        }
    },
    "required":[
        "id",
        "@type",
        "@referredType"
    ]
}

Nested Schema : CustomProfileSpecRefOracle

Type: object

Title: CustomProfileSpecRefOracle

Custom Profile specification reference.

Show Source

@baseType: string

Indicates the base (class) type of this REST resource
@referredType(required): string

(Class) type of the referred custom Specification.
@schemaLocation: string

This field provides a link to the schema describing this REST resource
@type(required): string

Indicates the (class) type of customSpecificationRef.
href: string

Reference of the custom specification.
id(required): string

Unique identifier of the custom specification.
name: string

Name of the custom specification.
version: string

Version of the custom specification.
versionState: number

To hold the version state for the reference

{
    "title":"CustomProfileSpecRefOracle",
    "type":"object",
    "description":"Custom Profile specification reference.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the custom specification."
        },
        "href":{
            "type":"string",
            "description":"Reference of the custom specification."
        },
        "name":{
            "type":"string",
            "description":"Name of the custom specification."
        },
        "version":{
            "type":"string",
            "description":"Version of the custom specification."
        },
        "@referredType":{
            "type":"string",
            "description":"(Class) type of the referred custom Specification."
        },
        "@type":{
            "type":"string",
            "description":"Indicates the (class) type of customSpecificationRef."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"This field provides a link to the schema describing this REST resource"
        },
        "@baseType":{
            "type":"string",
            "description":"Indicates<b> </b>the base (class) type of this REST resource"
        },
        "versionState":{
            "type":"number",
            "description":"To hold the version state for the reference"
        }
    },
    "required":[
        "id",
        "@type",
        "@referredType"
    ]
}

Nested Schema : UsageSpecificationRefOracle

Title: UsageSpecificationRefOracle

Match All

Show Source

object 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.
object UsageSpecificationRefOracle-allOf[1]

{
    "title":"UsageSpecificationRefOracle",
    "allOf":[
        {
            "$ref":"#/components/schemas/UsageSpecificationRef"
        },
        {
            "type":"object",
            "properties":{
                "usageCode":{
                    "type":"string",
                    "description":"Code to usage specification"
                }
            }
        }
    ]
}

Nested Schema : UsageSpecificationRef

Type: object

Title: UsageSpecificationRef

Discriminator: @type

Discriminator Values

UsageSpecificationRef
UsageSpecificationRefOracle

{
    "title":"UsageSpecificationRef",
    "type":"object",
    "description":"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.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the usage specification."
        },
        "href":{
            "type":"string",
            "description":"Reference of the usage specification."
        },
        "name":{
            "type":"string",
            "description":"Name of the usage specification."
        },
        "version":{
            "type":"string",
            "description":"Version of the usage specification."
        },
        "@referredType":{
            "type":"string",
            "description":"(Class) type of the referred Usage Specification."
        },
        "@type":{
            "type":"string",
            "description":"Indicates the (class) type of ServiceSpecificationRef."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"This field provides a link to the schema describing this REST resource"
        },
        "@baseType":{
            "type":"string",
            "description":"Indicates<b> </b>the base (class) type of this REST resource"
        },
        "versionState":{
            "type":"number",
            "description":"To hold the version state for the reference"
        }
    },
    "required":[
        "id",
        "@type",
        "@referredType"
    ],
    "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.

Show Source

@baseType: string

Indicates the base (class) type of this REST resource
@referredType(required): string

(Class) type of the referred Usage Specification.
@schemaLocation: string

This field provides a link to the schema describing this REST resource
@type(required): string

Indicates the (class) type of ServiceSpecificationRef.
href: string

Reference of the usage specification.
id(required): string

Unique identifier of the usage specification.
name: string

Name of the usage specification.
version: string

Version of the usage specification.
versionState: number

To hold the version state for the reference

{
    "title":"UsageSpecificationRef",
    "type":"object",
    "description":"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.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the usage specification."
        },
        "href":{
            "type":"string",
            "description":"Reference of the usage specification."
        },
        "name":{
            "type":"string",
            "description":"Name of the usage specification."
        },
        "version":{
            "type":"string",
            "description":"Version of the usage specification."
        },
        "@referredType":{
            "type":"string",
            "description":"(Class) type of the referred Usage Specification."
        },
        "@type":{
            "type":"string",
            "description":"Indicates the (class) type of ServiceSpecificationRef."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"This field provides a link to the schema describing this REST resource"
        },
        "@baseType":{
            "type":"string",
            "description":"Indicates<b> </b>the base (class) type of this REST resource"
        },
        "versionState":{
            "type":"number",
            "description":"To hold the version state for the reference"
        }
    },
    "required":[
        "id",
        "@type",
        "@referredType"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "UsageSpecificationRef":"#/components/schemas/UsageSpecificationRef",
            "UsageSpecificationRefOracle":"#/components/schemas/UsageSpecificationRefOracle"
        }
    }
}

Nested Schema : UsageSpecificationRefOracle-allOf[1]

Type: object

Show Source

usageCode: string

Code to usage specification

{
    "type":"object",
    "properties":{
        "usageCode":{
            "type":"string",
            "description":"Code to usage specification"
        }
    }
}

Nested Schema : UsedByRef

Type: object

Title: UsedByRef

A reference to a resource that is aggregating another top-level resource.

Show Source

@baseType: string

Indicates the base (class) type of this REST resource
@referredType: string

The Class type of using item
href: string

hyperlink reference of the using item
id: string

Unique identifier of the using item
name: string

Name of the using item
referenceType: string

Allowed Values: [ "PACKAGE", "COMMERCIAL_BUNDLE", "SERVICE_BUNDLE", "SERVICE", "DEVICE", "ACCESSORY", "CHOICE", "AGGREGATION", "AWARD", "DISCOUNT", "TRADE_IN", "COMPATIBILITY", "ELIGIBILITY", "MIGRATION", "RECOMMENDATION", "POLICY", "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: string

Version of the using item

{
    "title":"UsedByRef",
    "type":"object",
    "description":"A reference to a resource that is aggregating another top-level resource.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the using item"
        },
        "href":{
            "type":"string",
            "description":"hyperlink reference of the using item"
        },
        "name":{
            "type":"string",
            "description":"Name of the using item"
        },
        "version":{
            "type":"string",
            "description":"Version of the using item"
        },
        "@referredType":{
            "type":"string",
            "description":"The Class type of using item"
        },
        "@baseType":{
            "type":"string",
            "description":"Indicates<b> the base (class) type of this REST resource"
        },
        "referenceType":{
            "type":"string",
            "description":"The entity type of using item",
            "enum":[
                "PACKAGE",
                "COMMERCIAL_BUNDLE",
                "SERVICE_BUNDLE",
                "SERVICE",
                "DEVICE",
                "ACCESSORY",
                "CHOICE",
                "AGGREGATION",
                "AWARD",
                "DISCOUNT",
                "TRADE_IN",
                "COMPATIBILITY",
                "ELIGIBILITY",
                "MIGRATION",
                "RECOMMENDATION",
                "POLICY",
                "DEVICE_SPEC",
                "CHARGING_TERM",
                "SUSPENSION_TERM",
                "RETURN_CHECKLIST",
                "ENTITY_PROFILE",
                "PRODUCT_LINE",
                "PRODUCT_OFFERING_PRICE",
                "CATALOG",
                "CATEGORY",
                "PRODUCT_SPECIFICATION",
                "USAGE_SPECIFICATION",
                "SERVICE_SPECIFICATION"
            ]
        }
    }
}

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.

Root Schema : Error

Type: object

Title: Error

Show Source

@schemaLocation: string

it provides a link to the schema describing a REST resource.
@type: string

The class type of a REST resource.
code(required): string

Application related code (as defined in the API or from a common list)
message: string

Text that provide more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

Text that explains the reason for error. This can be shown to a client user.
referenceError: string

url pointing to documentation describing the error
status: string

http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"it provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

401 Response

Your request isn't authorized. The authentication credentials included with this request are missing or invalid.

Root Schema : Error

Type: object

Title: Error

Show Source

@schemaLocation: string

it provides a link to the schema describing a REST resource.
@type: string

The class type of a REST resource.
code(required): string

Application related code (as defined in the API or from a common list)
message: string

Text that provide more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

Text that explains the reason for error. This can be shown to a client user.
referenceError: string

url pointing to documentation describing the error
status: string

http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"it provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

404 Response

Your request includes a resource URI that doesn't exist.

Root Schema : Error

Type: object

Title: Error

Show Source

@schemaLocation: string

it provides a link to the schema describing a REST resource.
@type: string

The class type of a REST resource.
code(required): string

Application related code (as defined in the API or from a common list)
message: string

Text that provide more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

Text that explains the reason for error. This can be shown to a client user.
referenceError: string

url pointing to documentation describing the error
status: string

http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"it provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

405 Response

HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.

Root Schema : Error

Type: object

Title: Error

Show Source

@schemaLocation: string

it provides a link to the schema describing a REST resource.
@type: string

The class type of a REST resource.
code(required): string

Application related code (as defined in the API or from a common list)
message: string

Text that provide more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

Text that explains the reason for error. This can be shown to a client user.
referenceError: string

url pointing to documentation describing the error
status: string

http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"it provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

500 Response

The server encountered something unexpected that prevented it from completing the request.

Root Schema : Error

Type: object

Title: Error

Show Source

@schemaLocation: string

it provides a link to the schema describing a REST resource.
@type: string

The class type of a REST resource.
code(required): string

Application related code (as defined in the API or from a common list)
message: string

Text that provide more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

Text that explains the reason for error. This can be shown to a client user.
referenceError: string

url pointing to documentation describing the error
status: string

http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"it provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

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/v5/productSpecification/{id} \ -H 'Content-Type: application/json'

Example of Response Body

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

{
    "id": "PS-DataRoaming",
    "name": "Data Roaming PS",
    "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/productSpecification/PS-DataRoaming",
    "version": "1.0",
    "lifecycleStatus": "In design",
    "created": "2025-01-20T13:31:42.000Z",
    "createdBy": "booth",
    "lastUpdate": "2025-02-17T11:48:08.292Z",
    "lastUpdatedBy": "booth",
    "isBundle": false,
    "@type": "ProductSpecificationOracle",
    "validFor": {
        "startDateTime": "2024-09-03T00:00:00.000Z"
    },
    "project": {
        "id": "DBE_RI_Mob_ProdModel_PSP",
        "name": "DBE RI Mobile Product Model",
        "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/DBE_RI_Mob_ProdModel_PSP",
        "version": "1.0",
        "@referredType": "ProjectOracle"
    },
    "serviceSpecification": [
        {
            "id": "SS-WRLSS-BANDWIDTH",
            "name": "Wireless Data Bandwidth SS",
            "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/serviceCatalogManagement/v3/serviceSpecification/SS-WRLSS-BANDWIDTH",
            "version": "1.0",
            "@referredType": "ServiceSpecificationOracle",
            "versionState": -1,
            "@type": "ServiceSpecificationRefOracle",
            "role": "PRIMARY",
            "serviceCode": "/service/telco/gsm/data"
        }
    ],
    "productSpecCharacteristic": [
        {
            "id": "ATT-MAX-SPEED",
            "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/productSpecification/PS-DataRoaming/ATT-MAX-SPEED",
            "name": "Max Speed",
            "version": "1.0",
            "lifecycleStatus": "Ready to publish",
            "valueType": "STRING",
            "@type": "AttributeOracle",
            "extensible": true,
            "configurable": true,
            "minCardinality": 0,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2024-09-03T00:00:00.000Z"
            },
            "lastUpdate": "2025-02-17T11:46:03.885Z",
            "lastUpdatedBy": "booth",
            "created": "2025-01-20T13:31:18.383Z",
            "createdBy": "booth",
            "project": {
                "id": "DBE_RI_Mob_ProdModel_PSP",
                "name": "DBE RI Mobile Product Model",
                "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/DBE_RI_Mob_ProdModel_PSP",
                "version": "1.0",
                "@referredType": "ProjectOracle"
            },
            "displayName": "Max Speed",
            "fulfillmentUpdatable": true,
            "characteristicValueSpecification": [
                {
                    "value": "3G",
                    "valueType": "STRING",
                    "unitOfMeasure": "NONE",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2024-09-03T00:00:00.000Z"
                    },
                    "@type": "CharacteristicValueSpecification",
                    "sequence": 1
                },
                {
                    "value": "4G",
                    "valueType": "STRING",
                    "unitOfMeasure": "NONE",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2024-09-03T00:00:00.000Z"
                    },
                    "@type": "CharacteristicValueSpecification",
                    "sequence": 2
                },
                {
                    "value": "5G",
                    "valueType": "STRING",
                    "unitOfMeasure": "NONE",
                    "isDefault": true,
                    "validFor": {
                        "startDateTime": "2024-09-03T00:00:00.000Z"
                    },
                    "@type": "CharacteristicValueSpecification",
                    "sequence": 3
                }
            ]
        },
        {
            "id": "ATT-Quota",
            "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/productSpecification/PS-DataRoaming/ATT-Quota",
            "name": "Quota",
            "version": "1.0",
            "lifecycleStatus": "Ready to publish",
            "valueType": "NUMBER",
            "@type": "AttributeOracle",
            "extensible": true,
            "configurable": true,
            "minCardinality": 1,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2024-09-03T00:00:00.000Z"
            },
            "lastUpdate": "2025-02-17T11:46:03.945Z",
            "lastUpdatedBy": "booth",
            "created": "2025-01-20T13:31:18.000Z",
            "createdBy": "booth",
            "project": {
                "id": "DBE_RI_Mob_ProdModel_PSP",
                "name": "DBE RI Mobile Product Model",
                "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/DBE_RI_Mob_ProdModel_PSP",
                "version": "1.0",
                "@referredType": "ProjectOracle"
            },
            "displayName": "Quota",
            "characteristicValueSpecification": [
                {
                    "value": 1,
                    "valueType": "NUMBER",
                    "unitOfMeasure": "GIGABYTE",
                    "isDefault": true,
                    "validFor": {
                        "startDateTime": "2024-09-03T00:00:00.000Z"
                    },
                    "@type": "CharacteristicValueSpecification",
                    "sequence": 1
                },
                {
                    "value": 5,
                    "valueType": "NUMBER",
                    "unitOfMeasure": "GIGABYTE",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2024-09-03T00:00:00.000Z"
                    },
                    "@type": "CharacteristicValueSpecification",
                    "sequence": 2
                },
                {
                    "value": 10,
                    "valueType": "NUMBER",
                    "unitOfMeasure": "GIGABYTE",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2024-09-03T00:00:00.000Z"
                    },
                    "@type": "CharacteristicValueSpecification",
                    "sequence": 3
                }
            ]
        },
        {
            "id": "ATT-ROAM-AREA",
            "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/productSpecification/PS-DataRoaming/ATT-ROAM-AREA",
            "name": "Roaming Area",
            "version": "1.0",
            "lifecycleStatus": "Ready to publish",
            "valueType": "STRING",
            "@type": "AttributeOracle",
            "extensible": true,
            "configurable": true,
            "minCardinality": 1,
            "maxCardinality": 1,
            "validFor": {
                "startDateTime": "2024-09-03T00:00:00.000Z"
            },
            "lastUpdate": "2025-02-17T11:46:03.948Z",
            "lastUpdatedBy": "booth",
            "created": "2025-01-20T13:31:18.705Z",
            "createdBy": "booth",
            "project": {
                "id": "DBE_RI_Mob_ProdModel_PSP",
                "name": "DBE RI Mobile Product Model",
                "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/DBE_RI_Mob_ProdModel_PSP",
                "version": "1.0",
                "@referredType": "ProjectOracle"
            },
            "displayName": "Roaming Area",
            "characteristicValueSpecification": [
                {
                    "value": "All",
                    "valueType": "STRING",
                    "unitOfMeasure": "NONE",
                    "isDefault": true,
                    "validFor": {
                        "startDateTime": "2024-09-03T00:00:00.000Z"
                    },
                    "@type": "CharacteristicValueSpecification",
                    "sequence": 1
                },
                {
                    "value": "US & Canada",
                    "valueType": "STRING",
                    "unitOfMeasure": "NONE",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2024-09-03T00:00:00.000Z"
                    },
                    "@type": "CharacteristicValueSpecification",
                    "sequence": 2
                },
                {
                    "value": "Europe",
                    "valueType": "STRING",
                    "unitOfMeasure": "NONE",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2024-09-03T00:00:00.000Z"
                    },
                    "@type": "CharacteristicValueSpecification",
                    "sequence": 3
                },
                {
                    "value": "Schengen Area",
                    "valueType": "STRING",
                    "unitOfMeasure": "NONE",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2024-09-03T00:00:00.000Z"
                    },
                    "@type": "CharacteristicValueSpecification",
                    "sequence": 4
                },
                {
                    "value": "Middle East",
                    "valueType": "STRING",
                    "unitOfMeasure": "NONE",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2024-09-03T00:00:00.000Z"
                    },
                    "@type": "CharacteristicValueSpecification",
                    "sequence": 5
                },
                {
                    "value": "Asia",
                    "valueType": "STRING",
                    "unitOfMeasure": "NONE",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2024-09-03T00:00:00.000Z"
                    },
                    "@type": "CharacteristicValueSpecification",
                    "sequence": 6
                },
                {
                    "value": "Australia & New Zealand",
                    "valueType": "STRING",
                    "unitOfMeasure": "NONE",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2024-09-03T00:00:00.000Z"
                    },
                    "@type": "CharacteristicValueSpecification",
                    "sequence": 7
                },
                {
                    "value": "National",
                    "valueType": "STRING",
                    "unitOfMeasure": "NONE",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2024-09-03T00:00:00.000Z"
                    },
                    "@type": "CharacteristicValueSpecification",
                    "sequence": 8
                },
                {
                    "value": "International",
                    "valueType": "STRING",
                    "unitOfMeasure": "NONE",
                    "isDefault": false,
                    "validFor": {
                        "startDateTime": "2024-09-03T00:00:00.000Z"
                    },
                    "@type": "CharacteristicValueSpecification",
                    "sequence": 9
                }
            ]
        }
    ],
    "productSpecificationRelationship": [
        {
            "id": "PS-VOP-OFFR-CHRG-FIC",
            "href": "https://cptapcbqy.fusionapps.ocs.oc-test.com/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productSpecification/PS-VOP-OFFR-CHRG-FIC",
            "relationshipType": "PARENT",
            "name": "VoIP Offer Charge Class",
            "version": "1.0",
            "@referredType": "ProductSpecificationOracle",
            "@type": "productSpecificationRelationship"
        }
    ],
    "usageSpecification": [
        {
            "versionState": -1,
            "id": "DBE_UsageSpec_GPRS",
            "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/usageManagement/v2/usageSpecification/DBE_UsageSpec_GPRS",
            "name": "EventDelayedSessionTelcoGprs",
            "@referredType": "UsageSpecificationOracle",
            "@type": "UsageSpecificationRefOracle",
            "@baseType": "UsageSpecificationRef",
            "version": "1.0"
        }
    ]
}