Jump to

• Request
• Response
• Examples

Get all pricing logic algorithm specifications

get

https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/pricingLogicAlgorithmSpecification

Request

Query Parameters

• description: string
  The description of the resource.
• eligibleForProject: string
  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 identifier of the resource item.
• 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.
• version: string
  The current version of the resource.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object PricingLogicAlgorithmSpecification_Schemas
  Title: PricingLogicAlgorithmSpecification_Schemas

  Discriminator: { "propertyName":"@type", "mapping":{ "PricingLogicAlgorithmSpecificationOracle":"#/components/schemas/PricingLogicAlgorithmSpecificationOracle", "OneTimePLASpecOracle":"#/components/schemas/OneTimePLASpecOracle", "UsagePLASpecOracle":"#/components/schemas/UsagePLASpecOracle", "RecurringPLASpecOracle":"#/components/schemas/RecurringPLASpecOracle" } }

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

Nested Schema : PricingLogicAlgorithmSpecification_Schemas

Type: object

Title: PricingLogicAlgorithmSpecification_Schemas

Discriminator: @type

Discriminator Values

• PricingLogicAlgorithmSpecificationOracle
• OneTimePLASpecOracle
• UsagePLASpecOracle
• RecurringPLASpecOracle

{
    "title":"PricingLogicAlgorithmSpecification_Schemas",
    "oneOf":[
        {
            "$ref":"#/components/schemas/PricingLogicAlgorithmSpecificationOracle"
        },
        {
            "$ref":"#/components/schemas/OneTimePLASpecOracle"
        },
        {
            "$ref":"#/components/schemas/UsagePLASpecOracle"
        },
        {
            "$ref":"#/components/schemas/RecurringPLASpecOracle"
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "PricingLogicAlgorithmSpecificationOracle":"#/components/schemas/PricingLogicAlgorithmSpecificationOracle",
            "OneTimePLASpecOracle":"#/components/schemas/OneTimePLASpecOracle",
            "UsagePLASpecOracle":"#/components/schemas/UsagePLASpecOracle",
            "RecurringPLASpecOracle":"#/components/schemas/RecurringPLASpecOracle"
        }
    }
}

Match One Schema

Show Source

• PricingLogicAlgorithmSpecificationsOracle
  Title: PricingLogicAlgorithmSpecificationsOracle

  It is designed to model flexible interface definition in order to provide maximal reuse for existing rating algorithms.
• OneTimePLASpecOracle
  Title: OneTimePLASpecOracle

  It is designed to model flexible interface definition in order to provide maximal reuse for existing rating algorithms.
• UsagePLASpecOracle
  Title: UsagePLASpecOracle

  It is designed to model flexible interface definition in order to provide maximal reuse for existing rating algorithms.
• RecurringPLASpecOracle
  Title: RecurringPLASpecOracle

  It is designed to model flexible interface definition in order to provide maximal reuse for existing rating algorithms.

{
    "title":"PricingLogicAlgorithmSpecification_Schemas",
    "oneOf":[
        {
            "$ref":"#/components/schemas/PricingLogicAlgorithmSpecificationOracle"
        },
        {
            "$ref":"#/components/schemas/OneTimePLASpecOracle"
        },
        {
            "$ref":"#/components/schemas/UsagePLASpecOracle"
        },
        {
            "$ref":"#/components/schemas/RecurringPLASpecOracle"
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "PricingLogicAlgorithmSpecificationOracle":"#/components/schemas/PricingLogicAlgorithmSpecificationOracle",
            "OneTimePLASpecOracle":"#/components/schemas/OneTimePLASpecOracle",
            "UsagePLASpecOracle":"#/components/schemas/UsagePLASpecOracle",
            "RecurringPLASpecOracle":"#/components/schemas/RecurringPLASpecOracle"
        }
    }
}

Nested Schema : PricingLogicAlgorithmSpecificationsOracle

Title: PricingLogicAlgorithmSpecificationsOracle

It is designed to model flexible interface definition in order to provide maximal reuse for existing rating algorithms.

Match All

It is designed to model flexible interface definition in order to provide maximal reuse for existing rating algorithms.

It is designed to model flexible interface definition in order to provide maximal reuse for existing rating algorithms.

Show Source

• object PricingLogicAlgorithmSpecification
  Title: PricingLogicAlgorithmSpecification

  Discriminator: { "propertyName":"@type", "mapping":{ "PricingLogicAlgorithmSpec":"#/components/schemas/PricingLogicAlgorithmSpecification", "PricingLogicAlgorithmSpecOracle":"#/components/schemas/PricingLogicAlgorithmSpecificationOracle" } }

  It is designed to model flexible interface definition in order to provide maximal reuse for existing rating algorithms.
• object Discriminator: @type
  Discriminator: { "propertyName":"@type", "mapping":{ "OneTimePLASpecOracle":"#/components/schemas/OneTimePLASpecOracle", "UsagePLASpecOracle":"#/components/schemas/UsagePLASpecOracle", "RecurringPLASpecOracle":"#/components/schemas/RecurringPLASpecOracle", "PricingLogicAlgorithmSpecOracle":"#/components/schemas/PricingLogicAlgorithmSpecificationOracle" } }

{
    "title":"PricingLogicAlgorithmSpecificationsOracle",
    "description":"It is designed to model flexible interface definition in order to provide maximal reuse for existing rating algorithms.",
    "allOf":[
        {
            "$ref":"#/components/schemas/PricingLogicAlgorithmSpecification"
        },
        {
            "type":"object",
            "properties":{
                "project":{
                    "$ref":"#/components/schemas/ProjectRef"
                },
                "created":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Date and time of the creation"
                },
                "createdBy":{
                    "type":"string",
                    "description":"name of the person who created item"
                },
                "lastUpdatedBy":{
                    "type":"string",
                    "description":"name of the person who updated item"
                },
                "plaSpecificationRelationship":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/PLASpecificationRelationship"
                    }
                },
                "externalId":{
                    "type":"string",
                    "description":"id of the external application"
                },
                "applicationName":{
                    "type":"string",
                    "description":"name of the external application"
                },
                "versionState":{
                    "type":"number",
                    "description":"Version state of the Pricing Logic Algorithm Specification"
                }
            },
            "discriminator":{
                "propertyName":"@type",
                "mapping":{
                    "OneTimePLASpecOracle":"#/components/schemas/OneTimePLASpecOracle",
                    "UsagePLASpecOracle":"#/components/schemas/UsagePLASpecOracle",
                    "RecurringPLASpecOracle":"#/components/schemas/RecurringPLASpecOracle",
                    "PricingLogicAlgorithmSpecOracle":"#/components/schemas/PricingLogicAlgorithmSpecificationOracle"
                }
            }
        }
    ]
}

Nested Schema : OneTimePLASpecOracle

Title: OneTimePLASpecOracle

It is designed to model flexible interface definition in order to provide maximal reuse for existing rating algorithms.

Match All

It is designed to model flexible interface definition in order to provide maximal reuse for existing rating algorithms.

It is designed to model flexible interface definition in order to provide maximal reuse for existing rating algorithms.

Show Source

• allOf PricingLogicAlgorithmSpecificationsOracle
  Title: PricingLogicAlgorithmSpecificationsOracle

  It is designed to model flexible interface definition in order to provide maximal reuse for existing rating algorithms.
• object OneTimePLASpecOracle-allOf[1]

{
    "title":"OneTimePLASpecOracle",
    "description":"It is designed to model flexible interface definition in order to provide maximal reuse for existing rating algorithms.",
    "allOf":[
        {
            "$ref":"#/components/schemas/PricingLogicAlgorithmSpecificationOracle"
        },
        {
            "type":"object"
        }
    ]
}

Nested Schema : UsagePLASpecOracle

Title: UsagePLASpecOracle

It is designed to model flexible interface definition in order to provide maximal reuse for existing rating algorithms.

Match All

It is designed to model flexible interface definition in order to provide maximal reuse for existing rating algorithms.

It is designed to model flexible interface definition in order to provide maximal reuse for existing rating algorithms.

Show Source

• allOf PricingLogicAlgorithmSpecificationsOracle
  Title: PricingLogicAlgorithmSpecificationsOracle

  It is designed to model flexible interface definition in order to provide maximal reuse for existing rating algorithms.
• object UsagePLASpecOracle-allOf[1]

{
    "title":"UsagePLASpecOracle",
    "description":"It is designed to model flexible interface definition in order to provide maximal reuse for existing rating algorithms.",
    "allOf":[
        {
            "$ref":"#/components/schemas/PricingLogicAlgorithmSpecificationOracle"
        },
        {
            "type":"object",
            "properties":{
                "usageSpecification":{
                    "$ref":"#/components/schemas/UsageSpecificationRefOracle"
                }
            }
        }
    ]
}

Nested Schema : RecurringPLASpecOracle

Title: RecurringPLASpecOracle

It is designed to model flexible interface definition in order to provide maximal reuse for existing rating algorithms.

Match All

It is designed to model flexible interface definition in order to provide maximal reuse for existing rating algorithms.

It is designed to model flexible interface definition in order to provide maximal reuse for existing rating algorithms.

Show Source

• allOf PricingLogicAlgorithmSpecificationsOracle
  Title: PricingLogicAlgorithmSpecificationsOracle

  It is designed to model flexible interface definition in order to provide maximal reuse for existing rating algorithms.
• object RecurringPLASpecOracle-allOf[1]

{
    "title":"RecurringPLASpecOracle",
    "description":"It is designed to model flexible interface definition in order to provide maximal reuse for existing rating algorithms.",
    "allOf":[
        {
            "$ref":"#/components/schemas/PricingLogicAlgorithmSpecificationOracle"
        },
        {
            "type":"object"
        }
    ]
}

Nested Schema : PricingLogicAlgorithmSpecification

Type: object

Title: PricingLogicAlgorithmSpecification

Discriminator: @type

Discriminator Values

• PricingLogicAlgorithmSpec
• PricingLogicAlgorithmSpecOracle

{
    "title":"PricingLogicAlgorithmSpecification",
    "type":"object",
    "description":"It is designed to model flexible interface definition in order to provide maximal reuse for existing rating algorithms.",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"Unique identifier of the pricing logic algorithm specification."
        },
        "href":{
            "type":"string",
            "description":"Reference of the pricing logic algorithm specification."
        },
        "name":{
            "type":"string",
            "description":"Name of the pricing logic algorithm specification."
        },
        "description":{
            "type":"string",
            "description":"A narrative that explains in detail what the pricing logic algorithm specification is."
        },
        "version":{
            "type":"string",
            "description":"Pricing logic algorithm specification version."
        },
        "@type":{
            "type":"string",
            "description":"class type of the pricing logic algorithm specification."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"hyperlink reference to schema describing this object."
        },
        "@baseType":{
            "type":"string",
            "description":"base class type (immediate parent) of the pricing logic algorithm specification."
        },
        "targetProductSchema":{
            "$ref":"#/components/schemas/TargetProductSchema"
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"Used to indicate the current lifecycle status"
        },
        "plaSpecCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PLASpecCharacteristic"
            }
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the last update"
        }
    },
    "required":[
        "name",
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "PricingLogicAlgorithmSpec":"#/components/schemas/PricingLogicAlgorithmSpecification",
            "PricingLogicAlgorithmSpecOracle":"#/components/schemas/PricingLogicAlgorithmSpecificationOracle"
        }
    }
}

It is designed to model flexible interface definition in order to provide maximal reuse for existing rating algorithms.

Show Source

• @baseType: string
  base class type (immediate parent) of the pricing logic algorithm specification.
• @schemaLocation: string
  hyperlink reference to schema describing this object.
• @type(required): string
  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
  Reference of the pricing logic algorithm specification.
• id: string
  Maximum Length: 30

  Unique identifier of the pricing logic algorithm specification.
• lastUpdate: string (date-time)
  Date and time of the last update
• lifecycleStatus: string
  Used to indicate the current lifecycle status
• name(required): string
  Name of the pricing logic algorithm specification.
• plaSpecCharacteristic: array plaSpecCharacteristic
• targetProductSchema: object TargetProductSchema
  Title: TargetProductSchema

  The reference object to the schema and type of target product which is described by product specification
• validFor: object TimePeriod
  Title: TimePeriod

  The period for which the productOffering is valid
• version: string
  Pricing logic algorithm specification version.

{
    "title":"PricingLogicAlgorithmSpecification",
    "type":"object",
    "description":"It is designed to model flexible interface definition in order to provide maximal reuse for existing rating algorithms.",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"Unique identifier of the pricing logic algorithm specification."
        },
        "href":{
            "type":"string",
            "description":"Reference of the pricing logic algorithm specification."
        },
        "name":{
            "type":"string",
            "description":"Name of the pricing logic algorithm specification."
        },
        "description":{
            "type":"string",
            "description":"A narrative that explains in detail what the pricing logic algorithm specification is."
        },
        "version":{
            "type":"string",
            "description":"Pricing logic algorithm specification version."
        },
        "@type":{
            "type":"string",
            "description":"class type of the pricing logic algorithm specification."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"hyperlink reference to schema describing this object."
        },
        "@baseType":{
            "type":"string",
            "description":"base class type (immediate parent) of the pricing logic algorithm specification."
        },
        "targetProductSchema":{
            "$ref":"#/components/schemas/TargetProductSchema"
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"Used to indicate the current lifecycle status"
        },
        "plaSpecCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PLASpecCharacteristic"
            }
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the last update"
        }
    },
    "required":[
        "name",
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "PricingLogicAlgorithmSpec":"#/components/schemas/PricingLogicAlgorithmSpecification",
            "PricingLogicAlgorithmSpecOracle":"#/components/schemas/PricingLogicAlgorithmSpecificationOracle"
        }
    }
}

Nested Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

• OneTimePLASpecOracle
• UsagePLASpecOracle
• RecurringPLASpecOracle
• PricingLogicAlgorithmSpecOracle

{
    "type":"object",
    "properties":{
        "project":{
            "$ref":"#/components/schemas/ProjectRef"
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the creation"
        },
        "createdBy":{
            "type":"string",
            "description":"name of the person who created item"
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"name of the person who updated item"
        },
        "plaSpecificationRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PLASpecificationRelationship"
            }
        },
        "externalId":{
            "type":"string",
            "description":"id of the external application"
        },
        "applicationName":{
            "type":"string",
            "description":"name of the external application"
        },
        "versionState":{
            "type":"number",
            "description":"Version state of the Pricing Logic Algorithm Specification"
        }
    },
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "OneTimePLASpecOracle":"#/components/schemas/OneTimePLASpecOracle",
            "UsagePLASpecOracle":"#/components/schemas/UsagePLASpecOracle",
            "RecurringPLASpecOracle":"#/components/schemas/RecurringPLASpecOracle",
            "PricingLogicAlgorithmSpecOracle":"#/components/schemas/PricingLogicAlgorithmSpecificationOracle"
        }
    }
}

Show Source

• applicationName: string
  name of the external application
• created: string (date-time)
  Date and time of the creation
• createdBy: string
  name of the person who created item
• externalId: string
  id of the external application
• lastUpdatedBy: string
  name of the person who updated item
• plaSpecificationRelationship: array plaSpecificationRelationship
• project: object ProjectRef
  Title: ProjectRef

  Project Reference
• versionState: number
  Version state of the Pricing Logic Algorithm Specification

{
    "type":"object",
    "properties":{
        "project":{
            "$ref":"#/components/schemas/ProjectRef"
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the creation"
        },
        "createdBy":{
            "type":"string",
            "description":"name of the person who created item"
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"name of the person who updated item"
        },
        "plaSpecificationRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PLASpecificationRelationship"
            }
        },
        "externalId":{
            "type":"string",
            "description":"id of the external application"
        },
        "applicationName":{
            "type":"string",
            "description":"name of the external application"
        },
        "versionState":{
            "type":"number",
            "description":"Version state of the Pricing Logic Algorithm Specification"
        }
    },
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "OneTimePLASpecOracle":"#/components/schemas/OneTimePLASpecOracle",
            "UsagePLASpecOracle":"#/components/schemas/UsagePLASpecOracle",
            "RecurringPLASpecOracle":"#/components/schemas/RecurringPLASpecOracle",
            "PricingLogicAlgorithmSpecOracle":"#/components/schemas/PricingLogicAlgorithmSpecificationOracle"
        }
    }
}

Nested Schema : OneTimePLASpecOracle-allOf[1]

Type: object

Nested Schema : UsagePLASpecOracle-allOf[1]

Type: object

Show Source

• usageSpecification: UsageSpecificationRefOracle
  Title: UsageSpecificationRefOracle

{
    "type":"object",
    "properties":{
        "usageSpecification":{
            "$ref":"#/components/schemas/UsageSpecificationRefOracle"
        }
    }
}

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]

{
    "title":"UsageSpecificationRefOracle",
    "allOf":[
        {
            "$ref":"#/components/schemas/UsageSpecificationRef"
        },
        {
            "type":"object",
            "properties":{
                "usageCode":{
                    "type":"string",
                    "description":"Code to usage specification"
                }
            }
        }
    ]
}

Nested Schema : UsageSpecificationRef

Type: object

Title: UsageSpecificationRef

Discriminator: @type

Discriminator Values

• UsageSpecificationRef
• UsageSpecificationRefOracle

{
    "title":"UsageSpecificationRef",
    "type":"object",
    "description":"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.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the usage specification."
        },
        "href":{
            "type":"string",
            "description":"Reference of the usage specification."
        },
        "name":{
            "type":"string",
            "description":"Name of the usage specification."
        },
        "version":{
            "type":"string",
            "description":"Version of the usage specification."
        },
        "@referredType":{
            "type":"string",
            "description":"(Class) type of the referred Usage Specification."
        },
        "@type":{
            "type":"string",
            "description":"Indicates the (class) type of ServiceSpecificationRef."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"This field provides a link to the schema describing this REST resource"
        },
        "@baseType":{
            "type":"string",
            "description":"Indicates<b> </b>the base (class) type of this REST resource"
        },
        "versionState":{
            "type":"number",
            "description":"To hold the version state for the reference"
        }
    },
    "required":[
        "id",
        "@type",
        "@referredType"
    ],
    "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.

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

{
    "title":"UsageSpecificationRef",
    "type":"object",
    "description":"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.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the usage specification."
        },
        "href":{
            "type":"string",
            "description":"Reference of the usage specification."
        },
        "name":{
            "type":"string",
            "description":"Name of the usage specification."
        },
        "version":{
            "type":"string",
            "description":"Version of the usage specification."
        },
        "@referredType":{
            "type":"string",
            "description":"(Class) type of the referred Usage Specification."
        },
        "@type":{
            "type":"string",
            "description":"Indicates the (class) type of ServiceSpecificationRef."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"This field provides a link to the schema describing this REST resource"
        },
        "@baseType":{
            "type":"string",
            "description":"Indicates<b> </b>the base (class) type of this REST resource"
        },
        "versionState":{
            "type":"number",
            "description":"To hold the version state for the reference"
        }
    },
    "required":[
        "id",
        "@type",
        "@referredType"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "UsageSpecificationRef":"#/components/schemas/UsageSpecificationRef",
            "UsageSpecificationRefOracle":"#/components/schemas/UsageSpecificationRefOracle"
        }
    }
}

Nested Schema : UsageSpecificationRefOracle-allOf[1]

Type: object

Show Source

• usageCode: string
  Code to usage specification

{
    "type":"object",
    "properties":{
        "usageCode":{
            "type":"string",
            "description":"Code to usage specification"
        }
    }
}

Nested Schema : RecurringPLASpecOracle-allOf[1]

Type: object

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.

Body ()

Root Schema : Error

Type: object

Title: Error

Show Source

• @schemaLocation: string
  it provides a link to the schema describing a REST resource.
• @type: string
  The class type of a REST resource.
• code(required): string
  Application related code (as defined in the API or from a common list)
• message: string
  Text that provide more details and corrective actions related to the error. This can be shown to a client user.
• reason(required): string
  Text that explains the reason for error. This can be shown to a client user.
• referenceError: string
  url pointing to documentation describing the error
• status: string
  http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"it provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

401 Response

Your request isn't authorized. The authentication credentials included with this request are missing or invalid.

Body ()

Root Schema : Error

Type: object

Title: Error

Show Source

• @schemaLocation: string
  it provides a link to the schema describing a REST resource.
• @type: string
  The class type of a REST resource.
• code(required): string
  Application related code (as defined in the API or from a common list)
• message: string
  Text that provide more details and corrective actions related to the error. This can be shown to a client user.
• reason(required): string
  Text that explains the reason for error. This can be shown to a client user.
• referenceError: string
  url pointing to documentation describing the error
• status: string
  http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"it provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

404 Response

Your request includes a resource URI that does not exist.

Body ()

Root Schema : Error

Type: object

Title: Error

Show Source

• @schemaLocation: string
  it provides a link to the schema describing a REST resource.
• @type: string
  The class type of a REST resource.
• code(required): string
  Application related code (as defined in the API or from a common list)
• message: string
  Text that provide more details and corrective actions related to the error. This can be shown to a client user.
• reason(required): string
  Text that explains the reason for error. This can be shown to a client user.
• referenceError: string
  url pointing to documentation describing the error
• status: string
  http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"it provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

405 Response

HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.

Body ()

Root Schema : Error

Type: object

Title: Error

Show Source

• @schemaLocation: string
  it provides a link to the schema describing a REST resource.
• @type: string
  The class type of a REST resource.
• code(required): string
  Application related code (as defined in the API or from a common list)
• message: string
  Text that provide more details and corrective actions related to the error. This can be shown to a client user.
• reason(required): string
  Text that explains the reason for error. This can be shown to a client user.
• referenceError: string
  url pointing to documentation describing the error
• status: string
  http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"it provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

500 Response

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

Body ()

Root Schema : Error

Type: object

Title: Error

Show Source

• @schemaLocation: string
  it provides a link to the schema describing a REST resource.
• @type: string
  The class type of a REST resource.
• code(required): string
  Application related code (as defined in the API or from a common list)
• message: string
  Text that provide more details and corrective actions related to the error. This can be shown to a client user.
• reason(required): string
  Text that explains the reason for error. This can be shown to a client user.
• referenceError: string
  url pointing to documentation describing the error
• status: string
  http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"it provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

Back to Top

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

Back to Top