REST API Reference for Launch Cloud Service

Create or update a price tag

put

https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/priceTag/{id}

Request

Path Parameters

id(required): string

The unique identifier of the resource item.

Supported Media Types

application/json

Root Schema : PriceTagOracle

Type: object

Title: PriceTagOracle

Show Source

@baseType: string

Immediate base (class) type of the object
@schemaLocation: string

A link to the schema describing this object
@type(required): string

Indicates the type of resource.
created: string (date-time)

Date and time of the priceTag creation.
createdBy: string

name of the person who created the priceTag.
description: string

Description of priceTag.
href: string

Hypertext Reference of the priceTag.
id: string

Maximum Length: 30

Unique identifier of the priceTag.
lastUpdate: string (date-time)

Latest update date of priceTag.
lastUpdatedBy: string

name of the person who updated the priceTag.
lifecycleStatus: string

Status of priceTag
name(required): string

Name of priceTag.
priceTagRules: array priceTagRules
project: object ProjectRef

Title: ProjectRef

Project Reference
validFor: object TimePeriod

Title: TimePeriod

The period for which the productOffering is valid
version: string

PriceTag version
versionState: number

Version state of the priceTag.

{
    "title":"PriceTagOracle",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"Unique identifier of the priceTag."
        },
        "name":{
            "type":"string",
            "description":"Name of priceTag."
        },
        "description":{
            "type":"string",
            "description":"Description of priceTag."
        },
        "href":{
            "type":"string",
            "description":"Hypertext Reference of the priceTag."
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"Latest update date of priceTag."
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"Status of priceTag"
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        },
        "@type":{
            "type":"string",
            "description":"Indicates the type of resource."
        },
        "@baseType":{
            "type":"string",
            "description":"Immediate base (class) type of the object"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this object"
        },
        "project":{
            "$ref":"#/components/schemas/ProjectRef"
        },
        "version":{
            "type":"string",
            "description":"PriceTag version"
        },
        "priceTagRules":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PriceTagRuleOracle"
            }
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the priceTag creation."
        },
        "createdBy":{
            "type":"string",
            "description":"name of the person who created the priceTag."
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"name of the person who updated the priceTag."
        },
        "versionState":{
            "type":"number",
            "description":"Version state of the priceTag."
        }
    },
    "required":[
        "name",
        "@type"
    ]
}

Nested Schema : priceTagRules

Type: array

Show Source

Array of: object PriceTagRuleOracle

Title: PriceTagRuleOracle

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

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 : TimePeriod

Type: object

Title: TimePeriod

The period for which the productOffering is valid

Show Source

endDateTime: string (date-time)

An instant of time, ending at the TimePeriod.
startDateTime: string (date-time)

An instant of time, starting at the TimePeriod

{
    "title":"TimePeriod",
    "description":"The period for which the productOffering is valid",
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An instant of time, starting at the TimePeriod"
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An instant of time, ending at the TimePeriod."
        }
    }
}

Nested Schema : PriceTagRuleOracle

Type: object

Title: PriceTagRuleOracle

Show Source

balanceElement: object BalanceElementRef

Title: BalanceElementRef

Balance element ref in price
balanceElementCode: string

Currency (ISO4217 norm uses 3 letters to define the currency and user defined code for non currency
id(required): string

Maximum Length: 30

Unique identifier of the priceTag.
productType: string

Allowed Values: [ "ALL", "ACCOUNT", "SERVICE" ]

Type of offer to which the priceTag rule applies to.
serviceSpecification: array serviceSpecification
unitOfMeasure: string

The unit of measure for which the priceTag rule applies to.
value: string

Value corresponding to the selected valueType in semicolon selected format.
valueType: string

Allowed Values: [ "ALL", "LIST", "RANGE" ]

Type of value.

{
    "title":"PriceTagRuleOracle",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"Unique identifier of the priceTag."
        },
        "balanceElement":{
            "$ref":"#/components/schemas/BalanceElementRef"
        },
        "productType":{
            "type":"string",
            "description":"Type of offer to which the priceTag rule applies to.",
            "enum":[
                "ALL",
                "ACCOUNT",
                "SERVICE"
            ]
        },
        "valueType":{
            "type":"string",
            "description":"Type of value.",
            "enum":[
                "ALL",
                "LIST",
                "RANGE"
            ]
        },
        "value":{
            "type":"string",
            "description":"Value corresponding to the selected valueType in semicolon selected format."
        },
        "unitOfMeasure":{
            "type":"string",
            "description":"The unit of measure for which the priceTag rule applies to."
        },
        "balanceElementCode":{
            "type":"string",
            "description":"Currency (ISO4217 norm uses 3 letters to define the currency and user defined code for non currency"
        },
        "serviceSpecification":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ServiceSpecificationRefOracle"
            }
        }
    },
    "required":[
        "id"
    ]
}

Nested Schema : BalanceElementRef

Type: object

Title: BalanceElementRef

Balance element ref in price

Show Source

@baseType: string

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

The Class type of referred balance element
@schemaLocation: string

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

Indicates the (class) type of balance element.
href: string

Unique reference of the balance element
id(required): string

Unique identifier of the balance element
name: string

Name of the balance element
version: string

Version of the balance element
versionState: number

To hold the version state of reference

{
    "title":"BalanceElementRef",
    "type":"object",
    "description":"Balance element ref in price",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the balance element"
        },
        "href":{
            "type":"string",
            "description":"Unique reference of the balance element"
        },
        "version":{
            "type":"string",
            "description":"Version of the balance element"
        },
        "name":{
            "type":"string",
            "description":"Name of the balance element"
        },
        "@type":{
            "type":"string",
            "description":"Indicates the (class) type of balance element."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"This field provides a link to the schema describing this REST resource"
        },
        "@baseType":{
            "type":"string",
            "description":"Indicates<b> the base (class) type of this REST resource"
        },
        "@referredType":{
            "type":"string",
            "description":"The Class type of  referred balance element"
        },
        "versionState":{
            "type":"number",
            "description":"To hold the version state of reference"
        }
    },
    "required":[
        "id",
        "@type",
        "@referredType"
    ]
}

Nested Schema : serviceSpecification

Type: array

Show Source

Array of: ServiceSpecificationRefOracle

Title: ServiceSpecificationRefOracle

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

Nested Schema : ServiceSpecificationRefOracle

Title: ServiceSpecificationRefOracle

Match All

Show Source

object ServiceSpecificationRef

Title: ServiceSpecificationRef

Discriminator: { "propertyName":"@type", "mapping":{ "ServiceSpecificationRef":"#/components/schemas/ServiceSpecificationRef", "ServiceSpecificationRefOracle":"#/components/schemas/ServiceSpecificationRefOracle" } }

Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.
object ServiceSpecificationRefOracle-allOf[1]

{
    "title":"ServiceSpecificationRefOracle",
    "allOf":[
        {
            "$ref":"#/components/schemas/ServiceSpecificationRef"
        },
        {
            "type":"object",
            "properties":{
                "serviceCode":{
                    "type":"string",
                    "description":"Code to service specification"
                },
                "role":{
                    "type":"string",
                    "description":"Service specification role",
                    "enum":[
                        "PRIMARY",
                        "AUXILIARY"
                    ]
                },
                "isApplicableToChildServices":{
                    "type":"boolean",
                    "description":"Indicates if applicable to child services."
                }
            }
        }
    ]
}

Nested Schema : ServiceSpecificationRef

Type: object

Title: ServiceSpecificationRef

Discriminator: @type

{
    "title":"ServiceSpecificationRef",
    "type":"object",
    "description":"Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the service specification"
        },
        "href":{
            "type":"string",
            "description":"Reference of the serviceSpecification"
        },
        "name":{
            "type":"string",
            "description":"Name of the requiredServiceSpecification"
        },
        "version":{
            "type":"string",
            "description":"Service specification version"
        },
        "@referredType":{
            "type":"string",
            "description":"the class type of associated service 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"
        },
        "targetServiceSchema":{
            "$ref":"#/components/schemas/TargetServiceSchema"
        },
        "versionState":{
            "type":"number",
            "description":"To hold the version state for the reference"
        }
    },
    "required":[
        "id",
        "@type",
        "@referredType"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ServiceSpecificationRef":"#/components/schemas/ServiceSpecificationRef",
            "ServiceSpecificationRefOracle":"#/components/schemas/ServiceSpecificationRefOracle"
        }
    }
}

Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.

Show Source

@baseType: string

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

the class type of associated service 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 serviceSpecification
id(required): string

Unique identifier of the service specification
name: string

Name of the requiredServiceSpecification
targetServiceSchema: object TargetServiceSchema

Title: TargetServiceSchema

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

Service specification version
versionState: number

To hold the version state for the reference

{
    "title":"ServiceSpecificationRef",
    "type":"object",
    "description":"Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the service specification"
        },
        "href":{
            "type":"string",
            "description":"Reference of the serviceSpecification"
        },
        "name":{
            "type":"string",
            "description":"Name of the requiredServiceSpecification"
        },
        "version":{
            "type":"string",
            "description":"Service specification version"
        },
        "@referredType":{
            "type":"string",
            "description":"the class type of associated service 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"
        },
        "targetServiceSchema":{
            "$ref":"#/components/schemas/TargetServiceSchema"
        },
        "versionState":{
            "type":"number",
            "description":"To hold the version state for the reference"
        }
    },
    "required":[
        "id",
        "@type",
        "@referredType"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ServiceSpecificationRef":"#/components/schemas/ServiceSpecificationRef",
            "ServiceSpecificationRefOracle":"#/components/schemas/ServiceSpecificationRefOracle"
        }
    }
}

Nested Schema : ServiceSpecificationRefOracle-allOf[1]

Type: object

Show Source

isApplicableToChildServices: boolean

Indicates if applicable to child services.
role: string

Allowed Values: [ "PRIMARY", "AUXILIARY" ]

Service specification role
serviceCode: string

Code to service specification

{
    "type":"object",
    "properties":{
        "serviceCode":{
            "type":"string",
            "description":"Code to service specification"
        },
        "role":{
            "type":"string",
            "description":"Service specification role",
            "enum":[
                "PRIMARY",
                "AUXILIARY"
            ]
        },
        "isApplicableToChildServices":{
            "type":"boolean",
            "description":"Indicates if applicable to child services."
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Root Schema : PriceTagOracle

Type: object

Title: PriceTagOracle

Show Source

@baseType: string

Immediate base (class) type of the object
@schemaLocation: string

A link to the schema describing this object
@type(required): string

Indicates the type of resource.
created: string (date-time)

Date and time of the priceTag creation.
createdBy: string

name of the person who created the priceTag.
description: string

Description of priceTag.
href: string

Hypertext Reference of the priceTag.
id: string

Maximum Length: 30

Unique identifier of the priceTag.
lastUpdate: string (date-time)

Latest update date of priceTag.
lastUpdatedBy: string

name of the person who updated the priceTag.
lifecycleStatus: string

Status of priceTag
name(required): string

Name of priceTag.
priceTagRules: array priceTagRules
project: object ProjectRef

Title: ProjectRef

Project Reference
validFor: object TimePeriod

Title: TimePeriod

The period for which the productOffering is valid
version: string

PriceTag version
versionState: number

Version state of the priceTag.

{
    "title":"PriceTagOracle",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"Unique identifier of the priceTag."
        },
        "name":{
            "type":"string",
            "description":"Name of priceTag."
        },
        "description":{
            "type":"string",
            "description":"Description of priceTag."
        },
        "href":{
            "type":"string",
            "description":"Hypertext Reference of the priceTag."
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"Latest update date of priceTag."
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"Status of priceTag"
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        },
        "@type":{
            "type":"string",
            "description":"Indicates the type of resource."
        },
        "@baseType":{
            "type":"string",
            "description":"Immediate base (class) type of the object"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this object"
        },
        "project":{
            "$ref":"#/components/schemas/ProjectRef"
        },
        "version":{
            "type":"string",
            "description":"PriceTag version"
        },
        "priceTagRules":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PriceTagRuleOracle"
            }
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the priceTag creation."
        },
        "createdBy":{
            "type":"string",
            "description":"name of the person who created the priceTag."
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"name of the person who updated the priceTag."
        },
        "versionState":{
            "type":"number",
            "description":"Version state of the priceTag."
        }
    },
    "required":[
        "name",
        "@type"
    ]
}

Nested Schema : priceTagRules

Type: array

Show Source

Array of: object PriceTagRuleOracle

Title: PriceTagRuleOracle

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

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 : TimePeriod

Type: object

Title: TimePeriod

The period for which the productOffering is valid

Show Source

endDateTime: string (date-time)

An instant of time, ending at the TimePeriod.
startDateTime: string (date-time)

An instant of time, starting at the TimePeriod

{
    "title":"TimePeriod",
    "description":"The period for which the productOffering is valid",
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An instant of time, starting at the TimePeriod"
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An instant of time, ending at the TimePeriod."
        }
    }
}

Nested Schema : PriceTagRuleOracle

Type: object

Title: PriceTagRuleOracle

Show Source

balanceElement: object BalanceElementRef

Title: BalanceElementRef

Balance element ref in price
balanceElementCode: string

Currency (ISO4217 norm uses 3 letters to define the currency and user defined code for non currency
id(required): string

Maximum Length: 30

Unique identifier of the priceTag.
productType: string

Allowed Values: [ "ALL", "ACCOUNT", "SERVICE" ]

Type of offer to which the priceTag rule applies to.
serviceSpecification: array serviceSpecification
unitOfMeasure: string

The unit of measure for which the priceTag rule applies to.
value: string

Value corresponding to the selected valueType in semicolon selected format.
valueType: string

Allowed Values: [ "ALL", "LIST", "RANGE" ]

Type of value.

{
    "title":"PriceTagRuleOracle",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"Unique identifier of the priceTag."
        },
        "balanceElement":{
            "$ref":"#/components/schemas/BalanceElementRef"
        },
        "productType":{
            "type":"string",
            "description":"Type of offer to which the priceTag rule applies to.",
            "enum":[
                "ALL",
                "ACCOUNT",
                "SERVICE"
            ]
        },
        "valueType":{
            "type":"string",
            "description":"Type of value.",
            "enum":[
                "ALL",
                "LIST",
                "RANGE"
            ]
        },
        "value":{
            "type":"string",
            "description":"Value corresponding to the selected valueType in semicolon selected format."
        },
        "unitOfMeasure":{
            "type":"string",
            "description":"The unit of measure for which the priceTag rule applies to."
        },
        "balanceElementCode":{
            "type":"string",
            "description":"Currency (ISO4217 norm uses 3 letters to define the currency and user defined code for non currency"
        },
        "serviceSpecification":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ServiceSpecificationRefOracle"
            }
        }
    },
    "required":[
        "id"
    ]
}

Nested Schema : BalanceElementRef

Type: object

Title: BalanceElementRef

Balance element ref in price

Show Source

@baseType: string

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

The Class type of referred balance element
@schemaLocation: string

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

Indicates the (class) type of balance element.
href: string

Unique reference of the balance element
id(required): string

Unique identifier of the balance element
name: string

Name of the balance element
version: string

Version of the balance element
versionState: number

To hold the version state of reference

{
    "title":"BalanceElementRef",
    "type":"object",
    "description":"Balance element ref in price",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the balance element"
        },
        "href":{
            "type":"string",
            "description":"Unique reference of the balance element"
        },
        "version":{
            "type":"string",
            "description":"Version of the balance element"
        },
        "name":{
            "type":"string",
            "description":"Name of the balance element"
        },
        "@type":{
            "type":"string",
            "description":"Indicates the (class) type of balance element."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"This field provides a link to the schema describing this REST resource"
        },
        "@baseType":{
            "type":"string",
            "description":"Indicates<b> the base (class) type of this REST resource"
        },
        "@referredType":{
            "type":"string",
            "description":"The Class type of  referred balance element"
        },
        "versionState":{
            "type":"number",
            "description":"To hold the version state of reference"
        }
    },
    "required":[
        "id",
        "@type",
        "@referredType"
    ]
}

Nested Schema : serviceSpecification

Type: array

Show Source

Array of: ServiceSpecificationRefOracle

Title: ServiceSpecificationRefOracle

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

Nested Schema : ServiceSpecificationRefOracle

Title: ServiceSpecificationRefOracle

Match All

Show Source

object ServiceSpecificationRef

Title: ServiceSpecificationRef

Discriminator: { "propertyName":"@type", "mapping":{ "ServiceSpecificationRef":"#/components/schemas/ServiceSpecificationRef", "ServiceSpecificationRefOracle":"#/components/schemas/ServiceSpecificationRefOracle" } }

Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.
object ServiceSpecificationRefOracle-allOf[1]

{
    "title":"ServiceSpecificationRefOracle",
    "allOf":[
        {
            "$ref":"#/components/schemas/ServiceSpecificationRef"
        },
        {
            "type":"object",
            "properties":{
                "serviceCode":{
                    "type":"string",
                    "description":"Code to service specification"
                },
                "role":{
                    "type":"string",
                    "description":"Service specification role",
                    "enum":[
                        "PRIMARY",
                        "AUXILIARY"
                    ]
                },
                "isApplicableToChildServices":{
                    "type":"boolean",
                    "description":"Indicates if applicable to child services."
                }
            }
        }
    ]
}

Nested Schema : ServiceSpecificationRef

Type: object

Title: ServiceSpecificationRef

Discriminator: @type

Discriminator Values

ServiceSpecificationRef
ServiceSpecificationRefOracle

{
    "title":"ServiceSpecificationRef",
    "type":"object",
    "description":"Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the service specification"
        },
        "href":{
            "type":"string",
            "description":"Reference of the serviceSpecification"
        },
        "name":{
            "type":"string",
            "description":"Name of the requiredServiceSpecification"
        },
        "version":{
            "type":"string",
            "description":"Service specification version"
        },
        "@referredType":{
            "type":"string",
            "description":"the class type of associated service 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"
        },
        "targetServiceSchema":{
            "$ref":"#/components/schemas/TargetServiceSchema"
        },
        "versionState":{
            "type":"number",
            "description":"To hold the version state for the reference"
        }
    },
    "required":[
        "id",
        "@type",
        "@referredType"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ServiceSpecificationRef":"#/components/schemas/ServiceSpecificationRef",
            "ServiceSpecificationRefOracle":"#/components/schemas/ServiceSpecificationRefOracle"
        }
    }
}

Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.

Show Source

@baseType: string

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

the class type of associated service 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 serviceSpecification
id(required): string

Unique identifier of the service specification
name: string

Name of the requiredServiceSpecification
targetServiceSchema: object TargetServiceSchema

Title: TargetServiceSchema

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

Service specification version
versionState: number

To hold the version state for the reference

{
    "title":"ServiceSpecificationRef",
    "type":"object",
    "description":"Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the service specification"
        },
        "href":{
            "type":"string",
            "description":"Reference of the serviceSpecification"
        },
        "name":{
            "type":"string",
            "description":"Name of the requiredServiceSpecification"
        },
        "version":{
            "type":"string",
            "description":"Service specification version"
        },
        "@referredType":{
            "type":"string",
            "description":"the class type of associated service 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"
        },
        "targetServiceSchema":{
            "$ref":"#/components/schemas/TargetServiceSchema"
        },
        "versionState":{
            "type":"number",
            "description":"To hold the version state for the reference"
        }
    },
    "required":[
        "id",
        "@type",
        "@referredType"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ServiceSpecificationRef":"#/components/schemas/ServiceSpecificationRef",
            "ServiceSpecificationRefOracle":"#/components/schemas/ServiceSpecificationRefOracle"
        }
    }
}

Nested Schema : ServiceSpecificationRefOracle-allOf[1]

Type: object

Show Source

isApplicableToChildServices: boolean

Indicates if applicable to child services.
role: string

Allowed Values: [ "PRIMARY", "AUXILIARY" ]

Service specification role
serviceCode: string

Code to service specification

{
    "type":"object",
    "properties":{
        "serviceCode":{
            "type":"string",
            "description":"Code to service specification"
        },
        "role":{
            "type":"string",
            "description":"Service specification role",
            "enum":[
                "PRIMARY",
                "AUXILIARY"
            ]
        },
        "isApplicableToChildServices":{
            "type":"boolean",
            "description":"Indicates if applicable to child services."
        }
    }
}

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 create or update a price tag 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/productCatalogReferenceManagement/v1/priceTag/{id}

Example of Request Body

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

{
    "id": "PDC-PRICETAG",
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/priceTag/PDC-PRICETAG",
    "name": "PDC-PRICETAG",
    "lifecycleStatus": "In design",
    "version": "1.0",
    "@type": "PriceTagOracle",
    "project": {
        "id": "P-3454289648-1759125844206",
        "name": "PDC-INITIATIVE",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/P-3454289648-1759125844206",
        "version": "1.0",
        "@referredType": "ProjectOracle"
    },
    "priceTagRules": [
        {
            "id": "PT-RULE-01",
            "unitOfMeasure": "MINUTE",
            "productType": "SERVICE",
            "serviceSpecification": [
                {
                    "id": "SS-1193122351-1759125892052",
                    "name": "PDC-SERVICE-SPEC",
                    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/serviceCatalogManagement/v3/serviceSpecification/SS-1193122351-1759125892052",
                    "version": "1.0",
                    "@referredType": "ServiceSpecificationOracle",
                    "@type": "ServiceSpecificationRef"
                }
            ],
            "valueType": "LIST",
            "balanceElementCode": "USD",
            "value": "10;20",
            "balanceElement": {
                "id": "USDCurrency",
                "name": "USD Currency",
                "@referredType": "BalanceElementOracle",
                "@type": "BalanceElementRef",
                "version": "1.0"
            }
        },
        {
            "id": "PT-RULE-02",
            "unitOfMeasure": "ALL",
            "productType": "ALL",
            "valueType": "LIST",
            "balanceElementCode": "ALL"
        }
    ]
}

Example of Response Body

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

{
    "id": "PDC-PRICETAG",
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/priceTag/PDC-PRICETAG",
    "name": "PDC-PRICETAG",
    "lastUpdate": "2025-10-24T08:01:10.009Z",
    "lifecycleStatus": "In design",
    "version": "1.0",
    "@type": "PriceTagOracle",
    "project": {
        "id": "P-3454289648-1759125844206",
        "name": "PDC-INITIATIVE",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/P-3454289648-1759125844206",
        "version": "1.0",
        "@referredType": "ProjectOracle"
    },
    "priceTagRules": [
        {
            "id": "PT-RULE-01",
            "unitOfMeasure": "MINUTE",
            "productType": "SERVICE",
            "serviceSpecification": [
                {
                    "id": "SS-1193122351-1759125892052",
                    "name": "PDC-SERVICE-SPEC",
                    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/serviceCatalogManagement/v3/serviceSpecification/SS-1193122351-1759125892052",
                    "version": "1.0",
                    "@referredType": "ServiceSpecificationOracle",
                    "@type": "ServiceSpecificationRef"
                }
            ],
            "valueType": "LIST",
            "balanceElementCode": "USD",
            "value": "10;20"
        },
        {
            "id": "PT-RULE-02",
            "unitOfMeasure": "ALL",
            "productType": "ALL",
            "valueType": "LIST",
            "balanceElementCode": "ALL"
        }
    ],
    "lastUpdatedBy": "booth",
    "created": "2025-10-09T08:22:39.000Z",
    "createdBy": "booth"
}