Get all pricing logic algorithm specifications
get
https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/pricingLogicAlgorithmSpecification
Returns a list of pricing logic algorithm specifications that match the search criteria.
Request
Query Parameters
-
description: string
The description of the resource.
-
eligibleForProject: string
The project ID.
-
fields: string
The comma-separated field names that are returned in the response. The field names are the names that you specify when you create or retrieve a resource.
-
id: string
The unique ID of the resource item.
-
lastUpdate: string
Filters resources by their last update date and time.
-
lifecycleStatus: string
The current lifecycle status of the resource.
-
limit: integer
The number of resources to be returned in the response. The minimum value that can be specified is 1, and the maximum value that can be specified is 100,000. If the specified value is greater than 100,000, then it defaults to 100,000.
-
name: string
The name of the resource.
-
offset: string
The record number from which the retrieval starts. The default value is zero. If no value is specified, then it defaults to zero. The value zero indicates that the retrieval will start from the beginning of the collection.
-
project.id: string
The ID of the project for filtering resource results.
-
project.version: string
The project version for filtering entities.
-
validFor.endDateTime: string
The valid for end date time for filtering entities.
-
validFor.startDateTime: string
The valid for start date time for filtering entities.
-
version: string
The current version of the resource.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
The list of pricing logic algorithm specifications was returned successfully.
Root Schema : schema
Type:
Show Source
array-
Array of:
object PricingLogicAlgorithmSpecification_Schemas
Title:
PricingLogicAlgorithmSpecification_SchemasDiscriminator:{ "propertyName":"@type", "mapping":{ "PricingLogicAlgorithmSpecificationOracle":"#/components/schemas/PricingLogicAlgorithmSpecificationOracle", "OneTimePLASpecOracle":"#/components/schemas/OneTimePLASpecOracle", "UsagePLASpecOracle":"#/components/schemas/UsagePLASpecOracle", "RecurringPLASpecOracle":"#/components/schemas/RecurringPLASpecOracle" } }The pricing logic algorithm specification resource.
Nested Schema : PricingLogicAlgorithmSpecification_Schemas
Type:
objectTitle:
PricingLogicAlgorithmSpecification_SchemasDiscriminator: @type
Discriminator Values
- PricingLogicAlgorithmSpecificationOracle
- OneTimePLASpecOracle
- UsagePLASpecOracle
- RecurringPLASpecOracle
The pricing logic algorithm specification resource.
Match One Schema
Show Source
-
PricingLogicAlgorithmSpecificationsOracle
Title:
PricingLogicAlgorithmSpecificationsOracle -
OneTimePLASpecOracle
Title:
OneTimePLASpecOracle -
UsagePLASpecOracle
Title:
UsagePLASpecOracle -
RecurringPLASpecOracle
Title:
RecurringPLASpecOracle
Nested Schema : PricingLogicAlgorithmSpecificationsOracle
Title:
PricingLogicAlgorithmSpecificationsOracleMatch All
Show Source
-
object
PricingLogicAlgorithmSpecification
Title:
PricingLogicAlgorithmSpecificationDiscriminator:{ "propertyName":"@type", "mapping":{ "PricingLogicAlgorithmSpecification":"#/components/schemas/PricingLogicAlgorithmSpecification", "PricingLogicAlgorithmSpecificationOracle":"#/components/schemas/PricingLogicAlgorithmSpecificationOracle" } }The specification models flexible interface definitions to support reuse by existing rating algorithms. -
object
Discriminator: @type
Discriminator:
{ "propertyName":"@type", "mapping":{ "OneTimePLASpecOracle":"#/components/schemas/OneTimePLASpecOracle", "UsagePLASpecOracle":"#/components/schemas/UsagePLASpecOracle", "RecurringPLASpecOracle":"#/components/schemas/RecurringPLASpecOracle", "PricingLogicAlgorithmSpecificationOracle":"#/components/schemas/PricingLogicAlgorithmSpecificationOracle" } }
Nested Schema : OneTimePLASpecOracle
Title:
OneTimePLASpecOracleMatch All
Show Source
-
allOf
PricingLogicAlgorithmSpecificationsOracle
Title:
PricingLogicAlgorithmSpecificationsOracle -
object
OneTimePLASpecOracle-allOf[1]
Nested Schema : UsagePLASpecOracle
Title:
UsagePLASpecOracleMatch All
Show Source
-
allOf
PricingLogicAlgorithmSpecificationsOracle
Title:
PricingLogicAlgorithmSpecificationsOracle -
object
UsagePLASpecOracle-allOf[1]
Nested Schema : RecurringPLASpecOracle
Title:
RecurringPLASpecOracleMatch All
Show Source
-
allOf
PricingLogicAlgorithmSpecificationsOracle
Title:
PricingLogicAlgorithmSpecificationsOracle -
object
RecurringPLASpecOracle-allOf[1]
Nested Schema : PricingLogicAlgorithmSpecification
Type:
objectTitle:
PricingLogicAlgorithmSpecificationDiscriminator: @type
Discriminator Values
The specification models flexible interface definitions to support reuse by existing rating algorithms.
Show Source
-
@baseType: string
The base type of the pricing logic algorithm specification.
-
@schemaLocation: string
The URI of the schema that defines the pricing logic algorithm specification.
-
@type(required): string
The class type of the pricing logic algorithm specification.
-
description: string
A narrative that explains in detail what the pricing logic algorithm specification is.
-
href: string
The hyperlink reference to the pricing logic algorithm specification.
-
id: string
Maximum Length:
30The ID of the pricing logic algorithm specification. -
lastUpdate: string
(date-time)
The date and time when the pricing logic algorithm specification was last updated.
-
lifecycleStatus: string
The status of the pricing logic algorithm specification.
-
name(required): string
The name of the pricing logic algorithm specification.
-
plaSpecCharacteristic: array
plaSpecCharacteristic
A list of pla specification characteristics associated with the pricing logic algorithm specification.
-
targetProductSchema: object
TargetProductSchema
Title:
TargetProductSchemaThe reference object to the schema and type of target product which is described by product specification. -
validFor: object
TimePeriod
Title:
TimePeriodThe period for which the productOffering is valid. -
version: string
The pricing logic algorithm specification version.
Nested Schema : Discriminator: @type
Type:
objectDiscriminator: @type
Discriminator Values
- OneTimePLASpecOracle
- UsagePLASpecOracle
- RecurringPLASpecOracle
- PricingLogicAlgorithmSpecificationOracle
-
applicationName: string
The name of the application associated with the pricing logic algorithm specification.
-
created: string
(date-time)
The date and time of the creation.
-
createdBy: string
The name of the person who created item.
-
externalId: string
The ID of the external associated with the pricing logic algorithm specification.
-
lastUpdatedBy: string
The name of the person who updated item.
-
plaSpecificationRelationship: array
plaSpecificationRelationship
A list of pla specification relationships associated with the pricing logic algorithm specification.
-
project: object
ProjectRef
Title:
ProjectRefThe project reference resource. -
versionState: number
The version state of the Pricing Logic Algorithm Specification.
Nested Schema : OneTimePLASpecOracle-allOf[1]
Type:
objectNested Schema : UsagePLASpecOracle-allOf[1]
Type:
Show Source
object-
usageSpecification:
UsageSpecificationRefOracle
Title:
UsageSpecificationRefOracle
Nested Schema : UsageSpecificationRefOracle
Title:
UsageSpecificationRefOracleMatch All
Show Source
-
object
UsageSpecificationRef
Title:
UsageSpecificationRefDiscriminator:{ "propertyName":"@type", "mapping":{ "UsageSpecificationRef":"#/components/schemas/UsageSpecificationRef", "UsageSpecificationRefOracle":"#/components/schemas/UsageSpecificationRefOracle" } }The 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 : UsageSpecificationRef
Type:
objectTitle:
UsageSpecificationRefDiscriminator: @type
Discriminator Values
The 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
The base type of the usage specification reference.
-
@referredType(required): string
The type of the referred usage specification reference.
-
@schemaLocation: string
The URI of the schema that defines the usage specification reference.
-
@type(required): string
The class type of the usage specification reference.
-
href: string
The hyperlink reference to the usage specification reference.
-
id(required): string
The ID of the usage specification reference.
-
name: string
The name of the usage specification reference.
-
version: string
The version of the usage specification.
-
versionState: number
The version state of the reference.
Nested Schema : UsageSpecificationRefOracle-allOf[1]
Type:
Show Source
object-
usageCode: string
The usage code associated with the usage specification reference.
Nested Schema : RecurringPLASpecOracle-allOf[1]
Type:
object400 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:
objectTitle:
ErrorThe 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.
401 Response
Your request isn't authorized. The authentication credentials included with this request are missing or invalid.
Root Schema : Error
Type:
objectTitle:
ErrorThe 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.
404 Response
The resource with the specified URI couldn't be found.
Root Schema : Error
Type:
objectTitle:
ErrorThe 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.
405 Response
HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.
Root Schema : Error
Type:
objectTitle:
ErrorThe 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.
500 Response
The server encountered something unexpected that prevented it from completing the request.
Root Schema : Error
Type:
objectTitle:
ErrorThe 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.
Examples
The following example shows how to get all pricing logic algorithm specifications by submitting a GET request on the REST resource using cURL.
cURL Command
curl -u username:password -X GET
https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/pricingLogicAlgorithmSpecification
\ -H 'Content-Type: application/json'
Example of Response Body
The following example shows the contents of the response body in JSON format.
[
{
"id": "PLAspec1",
"name": "PLA Spec",
"description": "Description of PLAspec",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/pricingLogicAlgorithmSpecification/PLAspec1",
"version": "1.0",
"lifecycleStatus": "In design",
"created": "2025-02-17T12:53:28.000Z",
"createdBy": "booth",
"lastUpdate": "2025-02-17T12:53:28.047Z",
"lastUpdatedBy": "booth",
"@type": "PricingLogicAlgorithmSpecificationOracle",
"@baseType": "PricingLogicAlgorithmSpecification",
"@schemaLocation": "https://{FusionAppsHost}/CatalogManagement/schema/oracle/PricingLogicAlgorithmSpecificationOracle.yml",
"versionState": 0,
"plaSpecCharacteristic": [
{
"name": "Colour",
"description": "Phone Colour",
"valueType": "STRING",
"@type": "PLASpecCharacteristic",
"extensible": false,
"configurable": true,
"isUnique": true,
"minCardinality": 1,
"maxCardinality": 1
}
]
},
{
"id": "PLAspec2",
"name": "PLA Spec 2",
"description": "Description of PLAspec 2",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/pricingLogicAlgorithmSpecification/PLAspec2",
"version": "1.0",
"lifecycleStatus": "In design",
"created": "2025-02-17T12:53:28.000Z",
"createdBy": "booth",
"lastUpdate": "2025-02-17T12:53:28.047Z",
"lastUpdatedBy": "booth",
"@type": "PricingLogicAlgorithmSpecificationOracle",
"@baseType": "PricingLogicAlgorithmSpecification",
"@schemaLocation": "https://{FusionAppsHost}/CatalogManagement/schema/oracle/PricingLogicAlgorithmSpecificationOracle.yml",
"versionState": 0,
"plaSpecCharacteristic": [
{
"name": "Colour",
"description": "Phone Colour",
"valueType": "STRING",
"@type": "PLASpecCharacteristic",
"extensible": false,
"configurable": true,
"isUnique": true,
"minCardinality": 1,
"maxCardinality": 1
}
]
}
]