Create or update an array of policy rules
put
https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/policyRules
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
array
Minimum Number of Items:
1
Maximum Number of Items:
Show Source
50
-
Array of:
PolicyRuleOracle
Title:
PolicyRuleOracle
Nested Schema : PolicyRuleOracle
Title:
PolicyRuleOracle
Match All
Show Source
-
object
PolicyRule
Title:
PolicyRule
Discriminator:{ "propertyName":"@type", "mapping":{ "PolicyRule":"#/components/schemas/PolicyRule", "PolicyRuleOracle":"#/components/schemas/PolicyRuleOracle" } }
The policy resource represents a policy/rule applied to an entity or entity spec. -
object
type
Nested Schema : PolicyRule
Type:
object
Title:
PolicyRule
Discriminator: @type
Discriminator Values
The policy resource represents a policy/rule applied to an entity or entity spec.
Show Source
-
@baseType: string
Immediate base (class) type of the policy rule
-
@schemaLocation: string
A link to the schema describing this policy rule
-
@type: string
Class type of the policy rule
-
actionExecutionStrategy: string
Allowed Values:
[ "DO_SUCCESS", "DO_ALL", "DO_FAILURE", "DO_ALL_OR_NOTHING" ]
Used to indicate the current action execution strategy for policy rule -
description: string
Description of the policy rule
-
href: string
Hyperlink reference to the policy rule
-
id: string
Maximum Length:
30
Identifier to the policy rule -
lifecycleStatus: string
Used to indicate the current lifecycle status
-
name(required): string
Name given to the policy rule
-
policyActionRelationship: array
policyActionRelationship
-
priority: number
Indicatest the policy rule priority
-
sequencedActions: string
Allowed Values:
[ "MANDATORY", "RECOMMENDED", "BEST_EFFORT" ]
Indicates the ordering of policy action in the policy rule -
targetPolicyEffect: string
Allowed Values:
[ "PERMIT", "DENY" ]
Indicates the effect of targeted policy in the policy rule -
validFor: object
TimePeriod
Title:
TimePeriod
The period for which the productOffering is valid -
version: string
Policy rule version
Nested Schema : type
Type:
Show Source
object
-
applicationName: string
name of the external application
-
created: string
(date-time)
Date and time of creation
-
createdBy: string
name of the person who created
-
customerProfileSpecification: object
CustomerProfileSpecificationRef
Title:
CustomerProfileSpecificationRef
Customer Profile specification reference. -
customProfileSpecification: object
CustomProfileSpecRefOracle
Title:
CustomProfileSpecRefOracle
Custom Profile specification reference. -
externalId: string
id of the external application
-
lastUpdate: string
(date-time)
Date and time of the last update
-
lastUpdatedBy: string
name of the person who updated
-
plaSpecification: object
PlaSpecificationRef
Title:
PlaSpecificationRef
A pricing logic algorithm specification reference. A PricingLogicAlgorithmSpec is a detailed description of a tangible or intangible object made available externally in the form of a PricingLogicAlgorithm to customers or other parties playing a party role. -
productSpecification: object
ProductSpecificationRef
Title:
ProductSpecificationRef
Product specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role. -
project: object
ProjectRef
Title:
ProjectRef
Project Reference -
serviceSpecification:
ServiceSpecificationRefOracle
Title:
ServiceSpecificationRefOracle
-
specCharUse: array
specCharUse
-
standardZone: object
CustomProfileSpecRefOracle
Title:
CustomProfileSpecRefOracle
Custom Profile specification reference. -
usageSpecification:
UsageSpecificationRefOracle
Title:
UsageSpecificationRefOracle
-
valueMap: object
CustomProfileSpecRefOracle
Title:
CustomProfileSpecRefOracle
Custom Profile specification reference. -
versionState: number
Version state of the Price policy
Nested Schema : CustomerProfileSpecificationRef
Type:
object
Title:
CustomerProfileSpecificationRef
Customer Profile specification reference.
Show Source
-
@baseType: string
Indicates the base (class) type of this REST resource
-
@referredType(required): string
(Class) type of the referred Usage Specification.
-
@schemaLocation: string
This field provides a link to the schema describing this REST resource
-
@type(required): string
Indicates the (class) type of ServiceSpecificationRef.
-
href: string
Reference of the usage specification.
-
id(required): string
Unique identifier of the usage specification.
-
name: string
Name of the usage specification.
-
version: string
Version of the usage specification.
-
versionState: number
To hold the version state for the reference
Nested Schema : CustomProfileSpecRefOracle
Type:
object
Title:
CustomProfileSpecRefOracle
Custom Profile specification reference.
Show Source
-
@baseType: string
Indicates the base (class) type of this REST resource
-
@referredType(required): string
(Class) type of the referred custom Specification.
-
@schemaLocation: string
This field provides a link to the schema describing this REST resource
-
@type(required): string
Indicates the (class) type of customSpecificationRef.
-
href: string
Reference of the custom specification.
-
id(required): string
Unique identifier of the custom specification.
-
name: string
Name of the custom specification.
-
version: string
Version of the custom specification.
-
versionState: number
To hold the version state for the reference
Nested Schema : PlaSpecificationRef
Type:
object
Title:
PlaSpecificationRef
A pricing logic algorithm specification reference. A PricingLogicAlgorithmSpec is a detailed description of a tangible or intangible object made available externally in the form of a PricingLogicAlgorithm to customers or other parties playing a party role.
Show Source
-
@baseType: string
Indicates the base (class) type of this REST resource
-
@referredType(required): string
class type of referred pricing logic algorithm Specification.
-
@schemaLocation: string
This field provides a link to the schema describing this REST resource
-
@type(required): string
Indicates the (class) type of PLASpecification.
-
href: string
Reference of the pricing logic algorithm specification.
-
id(required): string
Unique identifier of the pricing logic algorithm specification.
-
name: string
Name of the pricing logic algorithm specification.
-
version: string
Version of the pricing logic algorithm specification.
-
versionState: number
To hold the version state for the reference
Nested Schema : ProductSpecificationRef
Type:
object
Title:
ProductSpecificationRef
Product specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.
Show Source
-
@baseType: string
Indicates the base (class) type of this REST resource
-
@referredType(required): string
class type of referred Product Specification
-
@schemaLocation: string
This field provides a link to the schema describing this REST resource
-
@type(required): string
Indicates the (class) type of ProductSpecificationRef.
-
href: string
Reference of the product specification
-
id(required): string
Unique identifier of the product specification
-
name: string
Name of the product specification
-
targetProductSchema: object
TargetProductSchema
Title:
TargetProductSchema
The reference object to the schema and type of target product which is described by product specification -
version: string
Version of the product specification
-
versionState: number
To hold the version state for the reference
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 : 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 : specCharUse
Type:
Show Source
array
-
Array of:
object SpecCharUseOracle
Title:
SpecCharUseOracle
Characteristic used to define Constraints
Nested Schema : UsageSpecificationRefOracle
Title:
UsageSpecificationRefOracle
Match All
Show Source
-
object
UsageSpecificationRef
Title:
UsageSpecificationRef
Discriminator:{ "propertyName":"@type", "mapping":{ "UsageSpecificationRef":"#/components/schemas/UsageSpecificationRef", "UsageSpecificationRefOracle":"#/components/schemas/UsageSpecificationRefOracle" } }
Usage specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role. -
object
UsageSpecificationRefOracle-allOf[1]
Nested Schema : TargetProductSchema
Type:
object
Title:
TargetProductSchema
The reference object to the schema and type of target product which is described by product specification
Show Source
-
@schemaLocation(required): string
This field provides a link to the schema describing the target product
-
@type(required): string
class type of the target product
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(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
Nested Schema : ServiceSpecificationRefOracle-allOf[1]
Type:
Show Source
object
-
isApplicableToChildServices: boolean
Indicates if applicable to child services.
-
role: string
Allowed Values:
[ "PRIMARY", "AUXILIARY" ]
Service specification role -
serviceCode: string
Code to service specification
Nested Schema : SpecCharUseOracle
Type:
object
Title:
SpecCharUseOracle
Characteristic used to define Constraints
Show Source
-
charSpecSeq : integer
Characteristic sequence
-
customerProfileSpecification: object
CustomerProfileSpecificationRef
Title:
CustomerProfileSpecificationRef
Customer Profile specification reference. -
customProfileSpecification: object
CustomProfileSpecRefOracle
Title:
CustomProfileSpecRefOracle
Custom Profile specification reference. -
displayName: string
Display name of characteristic
-
name(required): string
Name of characteristic
-
operator: string
Allowed Values:
[ "EQUALS", "GT", "LT", "GTE", "LTE", "NOT_EQUALS", "IS_NULL", "IS_NOT_NULL", "CONTAINS", "MAPS_TO", "NOT_MAPS_TO", "MATCHES", "NOT_MATCHES" ]
The logic expression operator. -
plaSpecification: object
PlaSpecificationRef
Title:
PlaSpecificationRef
A pricing logic algorithm specification reference. A PricingLogicAlgorithmSpec is a detailed description of a tangible or intangible object made available externally in the form of a PricingLogicAlgorithm to customers or other parties playing a party role. -
productSpecification: object
ProductSpecificationRef
Title:
ProductSpecificationRef
Product specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role. -
relationshipType(required): string
Allowed Values:
[ "AGGREGATION" ]
Relationship Type between characteristic Types -
serviceSpecification:
ServiceSpecificationRefOracle
Title:
ServiceSpecificationRefOracle
-
standardZone: object
CustomProfileSpecRefOracle
Title:
CustomProfileSpecRefOracle
Custom Profile specification reference. -
usageSpecification:
UsageSpecificationRefOracle
Title:
UsageSpecificationRefOracle
-
valueType: string
ValueType
Nested Schema : UsageSpecificationRef
Type:
object
Title:
UsageSpecificationRef
Discriminator: @type
Discriminator Values
Usage specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.
Show Source
-
@baseType: string
Indicates the base (class) type of this REST resource
-
@referredType(required): string
(Class) type of the referred Usage Specification.
-
@schemaLocation: string
This field provides a link to the schema describing this REST resource
-
@type(required): string
Indicates the (class) type of ServiceSpecificationRef.
-
href: string
Reference of the usage specification.
-
id(required): string
Unique identifier of the usage specification.
-
name: string
Name of the usage specification.
-
version: string
Version of the usage specification.
-
versionState: number
To hold the version state for the reference
Nested Schema : UsageSpecificationRefOracle-allOf[1]
Type:
Show Source
object
-
usageCode: string
Code to usage specification
Response
Supported Media Types
- application/json
200 Response
Your request is successful and the resources have been created or updated.
Nested Schema : PolicyRuleOracle
Title:
PolicyRuleOracle
Match All
Show Source
-
object
PolicyRule
Title:
PolicyRule
Discriminator:{ "propertyName":"@type", "mapping":{ "PolicyRule":"#/components/schemas/PolicyRule", "PolicyRuleOracle":"#/components/schemas/PolicyRuleOracle" } }
The policy resource represents a policy/rule applied to an entity or entity spec. -
object
type
Nested Schema : PolicyRule
Type:
object
Title:
PolicyRule
Discriminator: @type
Discriminator Values
The policy resource represents a policy/rule applied to an entity or entity spec.
Show Source
-
@baseType: string
Immediate base (class) type of the policy rule
-
@schemaLocation: string
A link to the schema describing this policy rule
-
@type: string
Class type of the policy rule
-
actionExecutionStrategy: string
Allowed Values:
[ "DO_SUCCESS", "DO_ALL", "DO_FAILURE", "DO_ALL_OR_NOTHING" ]
Used to indicate the current action execution strategy for policy rule -
description: string
Description of the policy rule
-
href: string
Hyperlink reference to the policy rule
-
id: string
Maximum Length:
30
Identifier to the policy rule -
lifecycleStatus: string
Used to indicate the current lifecycle status
-
name(required): string
Name given to the policy rule
-
policyActionRelationship: array
policyActionRelationship
-
priority: number
Indicatest the policy rule priority
-
sequencedActions: string
Allowed Values:
[ "MANDATORY", "RECOMMENDED", "BEST_EFFORT" ]
Indicates the ordering of policy action in the policy rule -
targetPolicyEffect: string
Allowed Values:
[ "PERMIT", "DENY" ]
Indicates the effect of targeted policy in the policy rule -
validFor: object
TimePeriod
Title:
TimePeriod
The period for which the productOffering is valid -
version: string
Policy rule version
Nested Schema : type
Type:
Show Source
object
-
applicationName: string
name of the external application
-
created: string
(date-time)
Date and time of creation
-
createdBy: string
name of the person who created
-
customerProfileSpecification: object
CustomerProfileSpecificationRef
Title:
CustomerProfileSpecificationRef
Customer Profile specification reference. -
customProfileSpecification: object
CustomProfileSpecRefOracle
Title:
CustomProfileSpecRefOracle
Custom Profile specification reference. -
externalId: string
id of the external application
-
lastUpdate: string
(date-time)
Date and time of the last update
-
lastUpdatedBy: string
name of the person who updated
-
plaSpecification: object
PlaSpecificationRef
Title:
PlaSpecificationRef
A pricing logic algorithm specification reference. A PricingLogicAlgorithmSpec is a detailed description of a tangible or intangible object made available externally in the form of a PricingLogicAlgorithm to customers or other parties playing a party role. -
productSpecification: object
ProductSpecificationRef
Title:
ProductSpecificationRef
Product specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role. -
project: object
ProjectRef
Title:
ProjectRef
Project Reference -
serviceSpecification:
ServiceSpecificationRefOracle
Title:
ServiceSpecificationRefOracle
-
specCharUse: array
specCharUse
-
standardZone: object
CustomProfileSpecRefOracle
Title:
CustomProfileSpecRefOracle
Custom Profile specification reference. -
usageSpecification:
UsageSpecificationRefOracle
Title:
UsageSpecificationRefOracle
-
valueMap: object
CustomProfileSpecRefOracle
Title:
CustomProfileSpecRefOracle
Custom Profile specification reference. -
versionState: number
Version state of the Price policy
Nested Schema : CustomerProfileSpecificationRef
Type:
object
Title:
CustomerProfileSpecificationRef
Customer Profile specification reference.
Show Source
-
@baseType: string
Indicates the base (class) type of this REST resource
-
@referredType(required): string
(Class) type of the referred Usage Specification.
-
@schemaLocation: string
This field provides a link to the schema describing this REST resource
-
@type(required): string
Indicates the (class) type of ServiceSpecificationRef.
-
href: string
Reference of the usage specification.
-
id(required): string
Unique identifier of the usage specification.
-
name: string
Name of the usage specification.
-
version: string
Version of the usage specification.
-
versionState: number
To hold the version state for the reference
Nested Schema : CustomProfileSpecRefOracle
Type:
object
Title:
CustomProfileSpecRefOracle
Custom Profile specification reference.
Show Source
-
@baseType: string
Indicates the base (class) type of this REST resource
-
@referredType(required): string
(Class) type of the referred custom Specification.
-
@schemaLocation: string
This field provides a link to the schema describing this REST resource
-
@type(required): string
Indicates the (class) type of customSpecificationRef.
-
href: string
Reference of the custom specification.
-
id(required): string
Unique identifier of the custom specification.
-
name: string
Name of the custom specification.
-
version: string
Version of the custom specification.
-
versionState: number
To hold the version state for the reference
Nested Schema : PlaSpecificationRef
Type:
object
Title:
PlaSpecificationRef
A pricing logic algorithm specification reference. A PricingLogicAlgorithmSpec is a detailed description of a tangible or intangible object made available externally in the form of a PricingLogicAlgorithm to customers or other parties playing a party role.
Show Source
-
@baseType: string
Indicates the base (class) type of this REST resource
-
@referredType(required): string
class type of referred pricing logic algorithm Specification.
-
@schemaLocation: string
This field provides a link to the schema describing this REST resource
-
@type(required): string
Indicates the (class) type of PLASpecification.
-
href: string
Reference of the pricing logic algorithm specification.
-
id(required): string
Unique identifier of the pricing logic algorithm specification.
-
name: string
Name of the pricing logic algorithm specification.
-
version: string
Version of the pricing logic algorithm specification.
-
versionState: number
To hold the version state for the reference
Nested Schema : ProductSpecificationRef
Type:
object
Title:
ProductSpecificationRef
Product specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.
Show Source
-
@baseType: string
Indicates the base (class) type of this REST resource
-
@referredType(required): string
class type of referred Product Specification
-
@schemaLocation: string
This field provides a link to the schema describing this REST resource
-
@type(required): string
Indicates the (class) type of ProductSpecificationRef.
-
href: string
Reference of the product specification
-
id(required): string
Unique identifier of the product specification
-
name: string
Name of the product specification
-
targetProductSchema: object
TargetProductSchema
Title:
TargetProductSchema
The reference object to the schema and type of target product which is described by product specification -
version: string
Version of the product specification
-
versionState: number
To hold the version state for the reference
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 : 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 : specCharUse
Type:
Show Source
array
-
Array of:
object SpecCharUseOracle
Title:
SpecCharUseOracle
Characteristic used to define Constraints
Nested Schema : UsageSpecificationRefOracle
Title:
UsageSpecificationRefOracle
Match All
Show Source
-
object
UsageSpecificationRef
Title:
UsageSpecificationRef
Discriminator:{ "propertyName":"@type", "mapping":{ "UsageSpecificationRef":"#/components/schemas/UsageSpecificationRef", "UsageSpecificationRefOracle":"#/components/schemas/UsageSpecificationRefOracle" } }
Usage specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role. -
object
UsageSpecificationRefOracle-allOf[1]
Nested Schema : TargetProductSchema
Type:
object
Title:
TargetProductSchema
The reference object to the schema and type of target product which is described by product specification
Show Source
-
@schemaLocation(required): string
This field provides a link to the schema describing the target product
-
@type(required): string
class type of the target product
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(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
Nested Schema : ServiceSpecificationRefOracle-allOf[1]
Type:
Show Source
object
-
isApplicableToChildServices: boolean
Indicates if applicable to child services.
-
role: string
Allowed Values:
[ "PRIMARY", "AUXILIARY" ]
Service specification role -
serviceCode: string
Code to service specification
Nested Schema : SpecCharUseOracle
Type:
object
Title:
SpecCharUseOracle
Characteristic used to define Constraints
Show Source
-
charSpecSeq : integer
Characteristic sequence
-
customerProfileSpecification: object
CustomerProfileSpecificationRef
Title:
CustomerProfileSpecificationRef
Customer Profile specification reference. -
customProfileSpecification: object
CustomProfileSpecRefOracle
Title:
CustomProfileSpecRefOracle
Custom Profile specification reference. -
displayName: string
Display name of characteristic
-
name(required): string
Name of characteristic
-
operator: string
Allowed Values:
[ "EQUALS", "GT", "LT", "GTE", "LTE", "NOT_EQUALS", "IS_NULL", "IS_NOT_NULL", "CONTAINS", "MAPS_TO", "NOT_MAPS_TO", "MATCHES", "NOT_MATCHES" ]
The logic expression operator. -
plaSpecification: object
PlaSpecificationRef
Title:
PlaSpecificationRef
A pricing logic algorithm specification reference. A PricingLogicAlgorithmSpec is a detailed description of a tangible or intangible object made available externally in the form of a PricingLogicAlgorithm to customers or other parties playing a party role. -
productSpecification: object
ProductSpecificationRef
Title:
ProductSpecificationRef
Product specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role. -
relationshipType(required): string
Allowed Values:
[ "AGGREGATION" ]
Relationship Type between characteristic Types -
serviceSpecification:
ServiceSpecificationRefOracle
Title:
ServiceSpecificationRefOracle
-
standardZone: object
CustomProfileSpecRefOracle
Title:
CustomProfileSpecRefOracle
Custom Profile specification reference. -
usageSpecification:
UsageSpecificationRefOracle
Title:
UsageSpecificationRefOracle
-
valueType: string
ValueType
Nested Schema : UsageSpecificationRef
Type:
object
Title:
UsageSpecificationRef
Discriminator: @type
Discriminator Values
Usage specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.
Show Source
-
@baseType: string
Indicates the base (class) type of this REST resource
-
@referredType(required): string
(Class) type of the referred Usage Specification.
-
@schemaLocation: string
This field provides a link to the schema describing this REST resource
-
@type(required): string
Indicates the (class) type of ServiceSpecificationRef.
-
href: string
Reference of the usage specification.
-
id(required): string
Unique identifier of the usage specification.
-
name: string
Name of the usage specification.
-
version: string
Version of the usage specification.
-
versionState: number
To hold the version state for the reference
Nested Schema : UsageSpecificationRefOracle-allOf[1]
Type:
Show Source
object
-
usageCode: string
Code to usage specification
400 Response
Your request couldn't be processed because it contains missing or invalid information, such as a validation error on an input field, a missing required value, and so forth.
Root Schema : schema
Type:
Show Source
array
-
Array of:
object Discriminator: @type
Discriminator:
{ "propertyName":"@type", "mapping":{ "Error":"#/components/schemas/Error", "BulkError":"#/components/schemas/BulkError" } }
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