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:
Show Source
PriceTagOracle
-
@baseType: string
Immediate base (class) type of the object
-
@schemaLocation: string
A link to the schema describing this object
-
@type: 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.
Nested Schema : priceTagRules
Type:
Show Source
array
-
Array of:
object PriceTagRuleOracle
Title:
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
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(required): string
(date-time)
An instant of time, starting at the TimePeriod
Nested Schema : PriceTagRuleOracle
Type:
object
Title:
Show Source
PriceTagRuleOracle
-
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.
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: string
The Class type of referred balance element
-
@schemaLocation: string
This field provides a link to the schema describing this REST resource
-
@type: 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
Nested Schema : serviceSpecification
Type:
Show Source
array
-
Array of:
ServiceSpecificationReferenceOracle
Title:
ServiceSpecificationReferenceOracle
Nested Schema : ServiceSpecificationReferenceOracle
Title:
ServiceSpecificationReferenceOracle
Match All
Show Source
-
allOf
ServiceSpecificationRefOracle
Title:
ServiceSpecificationRefOracle
-
object
ServiceSpecificationReferenceOracle-allOf[1]
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]
Nested Schema : ServiceSpecificationRef
Type:
object
Title:
ServiceSpecificationRef
Discriminator: @type
Discriminator Values
Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.
Show Source
-
@baseType: string
Indicates the base (class) type of this REST resource
-
@referredType: string
the class type of associated service specification
-
@schemaLocation: string
This field provides a link to the schema describing this REST resource
-
@type: 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
Nested Schema : ServiceSpecificationRefOracle-allOf[1]
Type:
Show Source
object
-
role: string
Allowed Values:
[ "PRIMARY", "AUXILIARY" ]
Service specification role -
serviceCode: string
Code to service specification
Nested Schema : ServiceSpecificationReferenceOracle-allOf[1]
Type:
Show Source
object
-
isApplicableToChildServices: boolean
Indicates if applicable to child services.
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : PriceTagOracle
Type:
object
Title:
Show Source
PriceTagOracle
-
@baseType: string
Immediate base (class) type of the object
-
@schemaLocation: string
A link to the schema describing this object
-
@type: 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.
Nested Schema : priceTagRules
Type:
Show Source
array
-
Array of:
object PriceTagRuleOracle
Title:
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
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(required): string
(date-time)
An instant of time, starting at the TimePeriod
Nested Schema : PriceTagRuleOracle
Type:
object
Title:
Show Source
PriceTagRuleOracle
-
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.
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: string
The Class type of referred balance element
-
@schemaLocation: string
This field provides a link to the schema describing this REST resource
-
@type: 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
Nested Schema : serviceSpecification
Type:
Show Source
array
-
Array of:
ServiceSpecificationReferenceOracle
Title:
ServiceSpecificationReferenceOracle
Nested Schema : ServiceSpecificationReferenceOracle
Title:
ServiceSpecificationReferenceOracle
Match All
Show Source
-
allOf
ServiceSpecificationRefOracle
Title:
ServiceSpecificationRefOracle
-
object
ServiceSpecificationReferenceOracle-allOf[1]
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]
Nested Schema : ServiceSpecificationRef
Type:
object
Title:
ServiceSpecificationRef
Discriminator: @type
Discriminator Values
Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.
Show Source
-
@baseType: string
Indicates the base (class) type of this REST resource
-
@referredType: string
the class type of associated service specification
-
@schemaLocation: string
This field provides a link to the schema describing this REST resource
-
@type: 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
Nested Schema : ServiceSpecificationRefOracle-allOf[1]
Type:
Show Source
object
-
role: string
Allowed Values:
[ "PRIMARY", "AUXILIARY" ]
Service specification role -
serviceCode: string
Code to service specification
Nested Schema : ServiceSpecificationReferenceOracle-allOf[1]
Type:
Show Source
object
-
isApplicableToChildServices: boolean
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:
Show Source
Error
-
@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
401 Response
Your request isn't authorized. The authentication credentials included with this request are missing or invalid.
Root Schema : Error
Type:
object
Title:
Show Source
Error
-
@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
404 Response
Your request includes a resource URI that doesn't exist.
Root Schema : Error
Type:
object
Title:
Show Source
Error
-
@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
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:
Show Source
Error
-
@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
500 Response
The server encountered something unexpected that prevented it from completing the request.
Root Schema : Error
Type:
object
Title:
Show Source
Error
-
@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