REST API Reference for Launch Cloud Service

Create a price tag

post

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

Creates a new price tag using the supplied request payload and returns the created resource.

Request

There are no request parameters for this operation.

Supported Media Types

application/json

Root Schema : PriceTagOracle

Type: object

Title: PriceTagOracle

The price tag resource.

Show Source

@baseType: string

The base type of the price tag.
@schemaLocation: string

The URI of the schema that defines the price tag.
@type(required): string

The class type of the price tag.
created: string (date-time)

The date and time of the priceTag creation.
createdBy: string

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

The description of priceTag.
href: string

The hyperlink reference to the price tag.
id: string

Maximum Length: 30

The ID of the price tag.
lastUpdate: string (date-time)

The date and time when the price tag was last updated.
lastUpdatedBy: string

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

The status of the price tag.
name(required): string

The name of the price tag.
priceTagRules: array priceTagRules

A list of price tag rules associated with the price tag.
project: object ProjectRef

Title: ProjectRef

The project reference resource.
validFor: object TimePeriod

Title: TimePeriod

The period for which the productOffering is valid.
version: string

The price tag version.
versionState: number

The version state of the priceTag.

{
    "title":"PriceTagOracle",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"The ID of the price tag."
        },
        "name":{
            "type":"string",
            "description":"The name of the price tag."
        },
        "description":{
            "type":"string",
            "description":"The description of priceTag."
        },
        "href":{
            "type":"string",
            "description":"The hyperlink reference to the price tag."
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the price tag was last updated."
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"The status of the price tag."
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod",
            "description":"The period for which the price tag is valid."
        },
        "@type":{
            "type":"string",
            "description":"The class type of the price tag."
        },
        "@baseType":{
            "type":"string",
            "description":"The base type of the price tag."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the price tag."
        },
        "project":{
            "$ref":"#/components/schemas/ProjectRef",
            "description":"The price tag."
        },
        "version":{
            "type":"string",
            "description":"The price tag version."
        },
        "priceTagRules":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PriceTagRuleOracle"
            },
            "description":"A list of price tag rules associated with the price tag."
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time of the priceTag creation."
        },
        "createdBy":{
            "type":"string",
            "description":"The name of the person who created the priceTag."
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"The name of the person who updated the priceTag."
        },
        "versionState":{
            "type":"number",
            "description":"The version state of the priceTag."
        }
    },
    "required":[
        "name",
        "@type"
    ],
    "description":"The price tag resource."
}

Nested Schema : priceTagRules

Type: array

A list of price tag rules associated with the price tag.

Show Source

Array of: object PriceTagRuleOracle

Title: PriceTagRuleOracle

The price tag rule resource.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/PriceTagRuleOracle"
    },
    "description":"A list of price tag rules associated with the price tag."
}

Nested Schema : ProjectRef

Type: object

Title: ProjectRef

The project reference resource.

Show Source

href: string

The hyperlink reference to the project reference.
id(required): string

The ID of the project reference.
name: string

The name of the project reference.
version: string

The version of the project.

{
    "title":"ProjectRef",
    "type":"object",
    "description":"The project reference resource.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the project reference."
        },
        "href":{
            "type":"string",
            "description":"The hyperlink reference to the project reference."
        },
        "name":{
            "type":"string",
            "description":"The name of the project reference."
        },
        "version":{
            "type":"string",
            "description":"The 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)

The end date and time of the time period.
startDateTime: string (date-time)

The start date and time of the time period.

{
    "title":"TimePeriod",
    "description":"The period for which the productOffering is valid.",
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The start date and time of the time period."
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The end date and time of the time period."
        }
    }
}

Nested Schema : PriceTagRuleOracle

Type: object

Title: PriceTagRuleOracle

The price tag rule resource.

Show Source

balanceElement: object BalanceElementRef

Title: BalanceElementRef

The 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

The ID of the price tag rule.
productType: string

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

The type or classification of the price tag rule. Valid values are ALL, ACCOUNT, and SERVICE.
serviceSpecification: array serviceSpecification

A list of service specifications associated with the price tag rule.
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" ]

The type or classification of the price tag rule. Valid values are ALL, LIST, and RANGE.

{
    "title":"PriceTagRuleOracle",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"The ID of the price tag rule."
        },
        "balanceElement":{
            "$ref":"#/components/schemas/BalanceElementRef",
            "description":"The price tag rule."
        },
        "productType":{
            "type":"string",
            "description":"The type or classification of the price tag rule. Valid values are ALL, ACCOUNT, and SERVICE.",
            "enum":[
                "ALL",
                "ACCOUNT",
                "SERVICE"
            ]
        },
        "valueType":{
            "type":"string",
            "description":"The type or classification of the price tag rule. Valid values are ALL, LIST, and RANGE.",
            "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"
            },
            "description":"A list of service specifications associated with the price tag rule."
        }
    },
    "required":[
        "id"
    ],
    "description":"The price tag rule resource."
}

Nested Schema : BalanceElementRef

Type: object

Title: BalanceElementRef

The balance element ref in price.

Show Source

@baseType: string

The base type of the balance element reference.
@referredType(required): string

The type of the referred balance element reference.
@schemaLocation: string

The URI of the schema that defines the balance element reference.
@type(required): string

The class type of the balance element reference.
href: string

The hyperlink reference to the balance element reference.
id(required): string

The ID of the balance element reference.
name: string

The name of the balance element reference.
version: string

The version of the balance element.
versionState: number

The version state of the reference.

{
    "title":"BalanceElementRef",
    "type":"object",
    "description":"The balance element ref in price.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the balance element reference."
        },
        "href":{
            "type":"string",
            "description":"The hyperlink reference to the balance element reference."
        },
        "version":{
            "type":"string",
            "description":"The version of the balance element."
        },
        "name":{
            "type":"string",
            "description":"The name of the balance element reference."
        },
        "@type":{
            "type":"string",
            "description":"The class type of the balance element reference."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the balance element reference."
        },
        "@baseType":{
            "type":"string",
            "description":"The base type of the balance element reference."
        },
        "@referredType":{
            "type":"string",
            "description":"The type of the referred balance element reference."
        },
        "versionState":{
            "type":"number",
            "description":"The version state of the reference."
        }
    },
    "required":[
        "id",
        "@type",
        "@referredType"
    ]
}

Nested Schema : serviceSpecification

Type: array

A list of service specifications associated with the price tag rule.

Show Source

Array of: ServiceSpecificationRefOracle

Title: ServiceSpecificationRefOracle

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ServiceSpecificationRefOracle"
    },
    "description":"A list of service specifications associated with the price tag rule."
}

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" } }

The 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":"The service code associated with the service specification reference."
                },
                "role":{
                    "type":"string",
                    "description":"The service specification role. Valid values are PRIMARY, and AUXILIARY.",
                    "enum":[
                        "PRIMARY",
                        "AUXILIARY"
                    ]
                },
                "isApplicableToChildServices":{
                    "type":"boolean",
                    "description":"Whether the service specification reference is applicable to child services."
                }
            }
        }
    ]
}

Nested Schema : ServiceSpecificationRef

Type: object

Title: ServiceSpecificationRef

Discriminator: @type

{
    "title":"ServiceSpecificationRef",
    "type":"object",
    "description":"The service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the service specification reference."
        },
        "href":{
            "type":"string",
            "description":"The hyperlink reference to the service specification reference."
        },
        "name":{
            "type":"string",
            "description":"The name of the service specification reference."
        },
        "version":{
            "type":"string",
            "description":"The service specification version."
        },
        "@referredType":{
            "type":"string",
            "description":"The type of the referred service specification reference."
        },
        "@type":{
            "type":"string",
            "description":"The class type of the service specification reference."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the service specification reference."
        },
        "@baseType":{
            "type":"string",
            "description":"The base type of the service specification reference."
        },
        "targetServiceSchema":{
            "$ref":"#/components/schemas/TargetServiceSchema",
            "description":"The service specification reference."
        },
        "versionState":{
            "type":"number",
            "description":"The version state of the reference."
        }
    },
    "required":[
        "id",
        "@type",
        "@referredType"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ServiceSpecificationRef":"#/components/schemas/ServiceSpecificationRef",
            "ServiceSpecificationRefOracle":"#/components/schemas/ServiceSpecificationRefOracle"
        }
    }
}

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

Show Source

@baseType: string

The base type of the service specification reference.
@referredType(required): string

The type of the referred service specification reference.
@schemaLocation: string

The URI of the schema that defines the service specification reference.
@type(required): string

The class type of the service specification reference.
href: string

The hyperlink reference to the service specification reference.
id(required): string

The ID of the service specification reference.
name: string

The name of the service specification reference.
targetServiceSchema: object TargetServiceSchema

Title: TargetServiceSchema

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

The service specification version.
versionState: number

The version state of the reference.

{
    "title":"ServiceSpecificationRef",
    "type":"object",
    "description":"The service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the service specification reference."
        },
        "href":{
            "type":"string",
            "description":"The hyperlink reference to the service specification reference."
        },
        "name":{
            "type":"string",
            "description":"The name of the service specification reference."
        },
        "version":{
            "type":"string",
            "description":"The service specification version."
        },
        "@referredType":{
            "type":"string",
            "description":"The type of the referred service specification reference."
        },
        "@type":{
            "type":"string",
            "description":"The class type of the service specification reference."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the service specification reference."
        },
        "@baseType":{
            "type":"string",
            "description":"The base type of the service specification reference."
        },
        "targetServiceSchema":{
            "$ref":"#/components/schemas/TargetServiceSchema",
            "description":"The service specification reference."
        },
        "versionState":{
            "type":"number",
            "description":"The version state of 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

Whether the service specification reference is applicable to child services.
role: string

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

The service specification role. Valid values are PRIMARY, and AUXILIARY.
serviceCode: string

The service code associated with the service specification reference.

{
    "type":"object",
    "properties":{
        "serviceCode":{
            "type":"string",
            "description":"The service code associated with the service specification reference."
        },
        "role":{
            "type":"string",
            "description":"The service specification role. Valid values are PRIMARY, and AUXILIARY.",
            "enum":[
                "PRIMARY",
                "AUXILIARY"
            ]
        },
        "isApplicableToChildServices":{
            "type":"boolean",
            "description":"Whether the service specification reference is applicable to child services."
        }
    }
}

Response

Supported Media Types

application/json

201 Response

The price tag was created successfully.

Root Schema : PriceTagOracle

Type: object

Title: PriceTagOracle

The price tag resource.

Show Source

@baseType: string

The base type of the price tag.
@schemaLocation: string

The URI of the schema that defines the price tag.
@type(required): string

The class type of the price tag.
created: string (date-time)

The date and time of the priceTag creation.
createdBy: string

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

The description of priceTag.
href: string

The hyperlink reference to the price tag.
id: string

Maximum Length: 30

The ID of the price tag.
lastUpdate: string (date-time)

The date and time when the price tag was last updated.
lastUpdatedBy: string

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

The status of the price tag.
name(required): string

The name of the price tag.
priceTagRules: array priceTagRules

A list of price tag rules associated with the price tag.
project: object ProjectRef

Title: ProjectRef

The project reference resource.
validFor: object TimePeriod

Title: TimePeriod

The period for which the productOffering is valid.
version: string

The price tag version.
versionState: number

The version state of the priceTag.

{
    "title":"PriceTagOracle",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"The ID of the price tag."
        },
        "name":{
            "type":"string",
            "description":"The name of the price tag."
        },
        "description":{
            "type":"string",
            "description":"The description of priceTag."
        },
        "href":{
            "type":"string",
            "description":"The hyperlink reference to the price tag."
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the price tag was last updated."
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"The status of the price tag."
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod",
            "description":"The period for which the price tag is valid."
        },
        "@type":{
            "type":"string",
            "description":"The class type of the price tag."
        },
        "@baseType":{
            "type":"string",
            "description":"The base type of the price tag."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the price tag."
        },
        "project":{
            "$ref":"#/components/schemas/ProjectRef",
            "description":"The price tag."
        },
        "version":{
            "type":"string",
            "description":"The price tag version."
        },
        "priceTagRules":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PriceTagRuleOracle"
            },
            "description":"A list of price tag rules associated with the price tag."
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time of the priceTag creation."
        },
        "createdBy":{
            "type":"string",
            "description":"The name of the person who created the priceTag."
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"The name of the person who updated the priceTag."
        },
        "versionState":{
            "type":"number",
            "description":"The version state of the priceTag."
        }
    },
    "required":[
        "name",
        "@type"
    ],
    "description":"The price tag resource."
}

Nested Schema : priceTagRules

Type: array

A list of price tag rules associated with the price tag.

Show Source

Array of: object PriceTagRuleOracle

Title: PriceTagRuleOracle

The price tag rule resource.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/PriceTagRuleOracle"
    },
    "description":"A list of price tag rules associated with the price tag."
}

Nested Schema : ProjectRef

Type: object

Title: ProjectRef

The project reference resource.

Show Source

href: string

The hyperlink reference to the project reference.
id(required): string

The ID of the project reference.
name: string

The name of the project reference.
version: string

The version of the project.

{
    "title":"ProjectRef",
    "type":"object",
    "description":"The project reference resource.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the project reference."
        },
        "href":{
            "type":"string",
            "description":"The hyperlink reference to the project reference."
        },
        "name":{
            "type":"string",
            "description":"The name of the project reference."
        },
        "version":{
            "type":"string",
            "description":"The 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)

The end date and time of the time period.
startDateTime: string (date-time)

The start date and time of the time period.

{
    "title":"TimePeriod",
    "description":"The period for which the productOffering is valid.",
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The start date and time of the time period."
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The end date and time of the time period."
        }
    }
}

Nested Schema : PriceTagRuleOracle

Type: object

Title: PriceTagRuleOracle

The price tag rule resource.

Show Source

balanceElement: object BalanceElementRef

Title: BalanceElementRef

The 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

The ID of the price tag rule.
productType: string

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

The type or classification of the price tag rule. Valid values are ALL, ACCOUNT, and SERVICE.
serviceSpecification: array serviceSpecification

A list of service specifications associated with the price tag rule.
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" ]

The type or classification of the price tag rule. Valid values are ALL, LIST, and RANGE.

{
    "title":"PriceTagRuleOracle",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"The ID of the price tag rule."
        },
        "balanceElement":{
            "$ref":"#/components/schemas/BalanceElementRef",
            "description":"The price tag rule."
        },
        "productType":{
            "type":"string",
            "description":"The type or classification of the price tag rule. Valid values are ALL, ACCOUNT, and SERVICE.",
            "enum":[
                "ALL",
                "ACCOUNT",
                "SERVICE"
            ]
        },
        "valueType":{
            "type":"string",
            "description":"The type or classification of the price tag rule. Valid values are ALL, LIST, and RANGE.",
            "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"
            },
            "description":"A list of service specifications associated with the price tag rule."
        }
    },
    "required":[
        "id"
    ],
    "description":"The price tag rule resource."
}

Nested Schema : BalanceElementRef

Type: object

Title: BalanceElementRef

The balance element ref in price.

Show Source

@baseType: string

The base type of the balance element reference.
@referredType(required): string

The type of the referred balance element reference.
@schemaLocation: string

The URI of the schema that defines the balance element reference.
@type(required): string

The class type of the balance element reference.
href: string

The hyperlink reference to the balance element reference.
id(required): string

The ID of the balance element reference.
name: string

The name of the balance element reference.
version: string

The version of the balance element.
versionState: number

The version state of the reference.

{
    "title":"BalanceElementRef",
    "type":"object",
    "description":"The balance element ref in price.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the balance element reference."
        },
        "href":{
            "type":"string",
            "description":"The hyperlink reference to the balance element reference."
        },
        "version":{
            "type":"string",
            "description":"The version of the balance element."
        },
        "name":{
            "type":"string",
            "description":"The name of the balance element reference."
        },
        "@type":{
            "type":"string",
            "description":"The class type of the balance element reference."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the balance element reference."
        },
        "@baseType":{
            "type":"string",
            "description":"The base type of the balance element reference."
        },
        "@referredType":{
            "type":"string",
            "description":"The type of the referred balance element reference."
        },
        "versionState":{
            "type":"number",
            "description":"The version state of the reference."
        }
    },
    "required":[
        "id",
        "@type",
        "@referredType"
    ]
}

Nested Schema : serviceSpecification

Type: array

A list of service specifications associated with the price tag rule.

Show Source

Array of: ServiceSpecificationRefOracle

Title: ServiceSpecificationRefOracle

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ServiceSpecificationRefOracle"
    },
    "description":"A list of service specifications associated with the price tag rule."
}

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" } }

The 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":"The service code associated with the service specification reference."
                },
                "role":{
                    "type":"string",
                    "description":"The service specification role. Valid values are PRIMARY, and AUXILIARY.",
                    "enum":[
                        "PRIMARY",
                        "AUXILIARY"
                    ]
                },
                "isApplicableToChildServices":{
                    "type":"boolean",
                    "description":"Whether the service specification reference is applicable to child services."
                }
            }
        }
    ]
}

Nested Schema : ServiceSpecificationRef

Type: object

Title: ServiceSpecificationRef

Discriminator: @type

Discriminator Values

ServiceSpecificationRef
ServiceSpecificationRefOracle

{
    "title":"ServiceSpecificationRef",
    "type":"object",
    "description":"The service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the service specification reference."
        },
        "href":{
            "type":"string",
            "description":"The hyperlink reference to the service specification reference."
        },
        "name":{
            "type":"string",
            "description":"The name of the service specification reference."
        },
        "version":{
            "type":"string",
            "description":"The service specification version."
        },
        "@referredType":{
            "type":"string",
            "description":"The type of the referred service specification reference."
        },
        "@type":{
            "type":"string",
            "description":"The class type of the service specification reference."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the service specification reference."
        },
        "@baseType":{
            "type":"string",
            "description":"The base type of the service specification reference."
        },
        "targetServiceSchema":{
            "$ref":"#/components/schemas/TargetServiceSchema",
            "description":"The service specification reference."
        },
        "versionState":{
            "type":"number",
            "description":"The version state of the reference."
        }
    },
    "required":[
        "id",
        "@type",
        "@referredType"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ServiceSpecificationRef":"#/components/schemas/ServiceSpecificationRef",
            "ServiceSpecificationRefOracle":"#/components/schemas/ServiceSpecificationRefOracle"
        }
    }
}

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

Show Source

@baseType: string

The base type of the service specification reference.
@referredType(required): string

The type of the referred service specification reference.
@schemaLocation: string

The URI of the schema that defines the service specification reference.
@type(required): string

The class type of the service specification reference.
href: string

The hyperlink reference to the service specification reference.
id(required): string

The ID of the service specification reference.
name: string

The name of the service specification reference.
targetServiceSchema: object TargetServiceSchema

Title: TargetServiceSchema

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

The service specification version.
versionState: number

The version state of the reference.

{
    "title":"ServiceSpecificationRef",
    "type":"object",
    "description":"The service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the service specification reference."
        },
        "href":{
            "type":"string",
            "description":"The hyperlink reference to the service specification reference."
        },
        "name":{
            "type":"string",
            "description":"The name of the service specification reference."
        },
        "version":{
            "type":"string",
            "description":"The service specification version."
        },
        "@referredType":{
            "type":"string",
            "description":"The type of the referred service specification reference."
        },
        "@type":{
            "type":"string",
            "description":"The class type of the service specification reference."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the service specification reference."
        },
        "@baseType":{
            "type":"string",
            "description":"The base type of the service specification reference."
        },
        "targetServiceSchema":{
            "$ref":"#/components/schemas/TargetServiceSchema",
            "description":"The service specification reference."
        },
        "versionState":{
            "type":"number",
            "description":"The version state of 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

Whether the service specification reference is applicable to child services.
role: string

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

The service specification role. Valid values are PRIMARY, and AUXILIARY.
serviceCode: string

The service code associated with the service specification reference.

{
    "type":"object",
    "properties":{
        "serviceCode":{
            "type":"string",
            "description":"The service code associated with the service specification reference."
        },
        "role":{
            "type":"string",
            "description":"The service specification role. Valid values are PRIMARY, and AUXILIARY.",
            "enum":[
                "PRIMARY",
                "AUXILIARY"
            ]
        },
        "isApplicableToChildServices":{
            "type":"boolean",
            "description":"Whether the service specification reference is 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

The error resource.

Show Source

@schemaLocation: string

The URI of the schema that defines the error.
@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

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

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

The URL pointing to documentation describing the error.
status: string

The status of the error.

{
    "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":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

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

The error resource.

Show Source

@schemaLocation: string

The URI of the schema that defines the error.
@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

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

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

The URL pointing to documentation describing the error.
status: string

The status of the error.

{
    "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":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

404 Response

The resource with the specified URI couldn't be found.

Root Schema : Error

Type: object

Title: Error

The error resource.

Show Source

@schemaLocation: string

The URI of the schema that defines the error.
@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

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

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

The URL pointing to documentation describing the error.
status: string

The status of the error.

{
    "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":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

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

The error resource.

Show Source

@schemaLocation: string

The URI of the schema that defines the error.
@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

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

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

The URL pointing to documentation describing the error.
status: string

The status of the error.

{
    "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":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

500 Response

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

Root Schema : Error

Type: object

Title: Error

The error resource.

Show Source

@schemaLocation: string

The URI of the schema that defines the error.
@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

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

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

The URL pointing to documentation describing the error.
status: string

The status of the error.

{
    "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":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

Examples

The following example shows how to create a price tag by submitting a post request on the REST resource using cURL.

cURL Command

curl -u username:password -X POST https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/priceTag -H 'Content-Type: application/json' -D @create_pricetag.json | json_pp

Example of Request Body

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

{
    "id": "PT_0091",
    "name": "Price Tag1",
    "lifecycleStatus": "In design",
    "version": "1.0",
    "@type": "PriceTagOracle",
    "project": {
        "id": "I0601",
        "name": "I0601",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/I0601",
        "version": "1.0",
        "@referredType": "ProjectOracle"
    },
    "priceTagRules": [
        {
            "id": "pt-rule-1",
            "unitOfMeasure": "ALL",
            "productType": "ALL",
            "valueType": "LIST",
            "balanceElementCode": "ALL",
            "value": "10;20"
        }
    ]
}

Example of Response Body

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

{
    "id": "PT_0091",
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/priceTag/PT_0091",
    "name": "Price Tag1",
    "lastUpdate": "2025-02-17T13:09:27.124Z",
    "lifecycleStatus": "In design",
    "version": "1.0",
    "@type": "PriceTagOracle",
    "project": {
        "id": "I0601",
        "name": "I0601",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/I0601",
        "version": "1.0",
        "@referredType": "ProjectOracle"
    },
    "priceTagRules": [
        {
            "id": "pt-rule-1",
            "unitOfMeasure": "ALL",
            "productType": "ALL",
            "valueType": "LIST",
            "balanceElementCode": "ALL",
            "value": "10;20"
        }
    ],
    "lastUpdatedBy": "booth",
    "created": "2025-02-17T13:09:27.000Z",
    "createdBy": "booth",
    "versionState": 0
}