Jump to

• Request
• Response
• Examples

Create or update a product line

put

https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/productLine/{id}

Request

Path Parameters

• id(required): string
  The unique identifier of the resource item.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ProductLineOracle

Title: ProductLineOracle

Represents entities that groups product offerings

Match All

Represents entities that groups product offerings

Represents entities that groups product offerings

Show Source

• object ProductLine
  Title: ProductLine

  Discriminator: { "propertyName":"@type", "mapping":{ "ProductLine":"#/components/schemas/ProductLine", "ProductLineOracle":"#/components/schemas/ProductLineOracle" } }

  Represents entities that groups product offerings
• object type

{
    "title":"ProductLineOracle",
    "description":"Represents entities that groups product offerings",
    "allOf":[
        {
            "$ref":"#/components/schemas/ProductLine"
        },
        {
            "type":"object",
            "properties":{
                "created":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Date and time of creation"
                },
                "createdBy":{
                    "type":"string",
                    "description":"name of the person who created item"
                },
                "lastUpdatedBy":{
                    "type":"string",
                    "description":"name of the person who updated item"
                },
                "productOffering":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/ProductOfferingRefOracle"
                    }
                },
                "project":{
                    "$ref":"#/components/schemas/ProjectRef"
                },
                "compatibilityRules":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/CompatibilityRulesOracle"
                    }
                },
                "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 product line"
                }
            }
        }
    ]
}

Nested Schema : ProductLine

Type: object

Title: ProductLine

Discriminator: @type

Discriminator Values

• ProductLine
• ProductLineOracle

{
    "title":"ProductLine",
    "type":"object",
    "description":"Represents entities that groups product offerings",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"Unique identifier of the product line"
        },
        "href":{
            "type":"string",
            "description":"Reference of the Product line"
        },
        "name":{
            "type":"string",
            "description":"Name of the product line"
        },
        "description":{
            "type":"string",
            "description":"Description of the product line"
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the last update"
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"Used to indicate the current lifecycle status"
        },
        "version":{
            "type":"string",
            "description":"ProductOffering version"
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriodOracle"
        },
        "@type":{
            "type":"string",
            "description":"Class type of the product offering"
        },
        "@baseType":{
            "type":"string",
            "description":"Immediate base (class) type of the product offering"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this product offering"
        }
    },
    "required":[
        "name",
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ProductLine":"#/components/schemas/ProductLine",
            "ProductLineOracle":"#/components/schemas/ProductLineOracle"
        }
    }
}

Represents entities that groups product offerings

Show Source

• @baseType: string
  Immediate base (class) type of the product offering
• @schemaLocation: string
  A link to the schema describing this product offering
• @type(required): string
  Class type of the product offering
• description: string
  Description of the product line
• href: string
  Reference of the Product line
• id: string
  Maximum Length: 30

  Unique identifier of the product line
• 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 product line
• validFor: object TimePeriodOracle
  Title: TimePeriodOracle

  Validity period of the related party
• version: string
  ProductOffering version

{
    "title":"ProductLine",
    "type":"object",
    "description":"Represents entities that groups product offerings",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"Unique identifier of the product line"
        },
        "href":{
            "type":"string",
            "description":"Reference of the Product line"
        },
        "name":{
            "type":"string",
            "description":"Name of the product line"
        },
        "description":{
            "type":"string",
            "description":"Description of the product line"
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the last update"
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"Used to indicate the current lifecycle status"
        },
        "version":{
            "type":"string",
            "description":"ProductOffering version"
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriodOracle"
        },
        "@type":{
            "type":"string",
            "description":"Class type of the product offering"
        },
        "@baseType":{
            "type":"string",
            "description":"Immediate base (class) type of the product offering"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this product offering"
        }
    },
    "required":[
        "name",
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ProductLine":"#/components/schemas/ProductLine",
            "ProductLineOracle":"#/components/schemas/ProductLineOracle"
        }
    }
}

Nested Schema : type

Type: object

Show Source

• applicationName: string
  name of the external application
• compatibilityRules: array compatibilityRules
• created: string (date-time)
  Date and time of 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
• productOffering: array productOffering
• project: object ProjectRef
  Title: ProjectRef

  Project Reference
• versionState: number
  Version state of the product line

{
    "type":"object",
    "properties":{
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of creation"
        },
        "createdBy":{
            "type":"string",
            "description":"name of the person who created item"
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"name of the person who updated item"
        },
        "productOffering":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductOfferingRefOracle"
            }
        },
        "project":{
            "$ref":"#/components/schemas/ProjectRef"
        },
        "compatibilityRules":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CompatibilityRulesOracle"
            }
        },
        "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 product line"
        }
    }
}

Nested Schema : compatibilityRules

Type: array

Show Source

• Array of: object CompatibilityRulesOracle
  Title: CompatibilityRulesOracle

  specifies the compatibilty rule for the offer

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

Nested Schema : productOffering

Type: array

Show Source

• Array of: ProductOfferingRefOracle
  Title: ProductOfferingRefOracle

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

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

{
    "title":"ProjectRef",
    "type":"object",
    "description":"Project Reference",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the project"
        },
        "href":{
            "type":"string",
            "description":"Unique reference of the project"
        },
        "name":{
            "type":"string",
            "description":"Name of the project"
        },
        "version":{
            "type":"string",
            "description":"Version of the project"
        }
    },
    "required":[
        "id"
    ]
}

Nested Schema : CompatibilityRulesOracle

Type: object

Title: CompatibilityRulesOracle

specifies the compatibilty rule for the offer

Show Source

• active: boolean
  A flag indicating if the rule is active or not
• compatibilityRuleType: string
  Allowed Values: [ "REQUIRES", "EXCLUDES" ]

  Specifies the type of compatability rule
• name(required): string
  Unique name of the Compatibility Rule
• objectProduct: string
  object offer component of the compatability rule
• objectProductLine: string
  Object Product Line component of the compatability rule
• subjectProduct: string
  Subject offer component of the compatability rule
• subjectProductLine: string
  Subject Product Line component of the compatability rule
• validFor: object TimePeriodOracle
  Title: TimePeriodOracle

  Validity period of the related party

{
    "title":"CompatibilityRulesOracle",
    "type":"object",
    "description":"specifies the compatibilty rule for the offer",
    "properties":{
        "name":{
            "type":"string",
            "description":"Unique name of the Compatibility Rule"
        },
        "subjectProduct":{
            "type":"string",
            "description":"Subject offer component of the compatability rule"
        },
        "objectProduct":{
            "type":"string",
            "description":"object offer component of the compatability rule"
        },
        "subjectProductLine":{
            "type":"string",
            "description":"Subject Product Line component of the compatability rule"
        },
        "objectProductLine":{
            "type":"string",
            "description":"Object Product Line component of the compatability rule"
        },
        "active":{
            "type":"boolean",
            "description":"A flag indicating if the rule is active or not"
        },
        "compatibilityRuleType":{
            "type":"string",
            "description":"Specifies the type of compatability rule",
            "enum":[
                "REQUIRES",
                "EXCLUDES"
            ]
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriodOracle"
        }
    },
    "required":[
        "name"
    ]
}

Nested Schema : TimePeriodOracle

Type: object

Title: TimePeriodOracle

Validity period of the related party

Show Source

• endDateTime: string (date-time)
  An instant of time, ending at the TimePeriod.
• startDateTime: string (date-time)
  An instant of time, starting at the TimePeriod

{
    "description":"Validity period of the related party",
    "title":"TimePeriodOracle",
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An instant of time, starting at the TimePeriod"
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An instant of time, ending at the TimePeriod."
        }
    }
}

Nested Schema : ProductOfferingRefOracle

Title: ProductOfferingRefOracle

Match All

Show Source

• object ProductOfferingRef
  Title: ProductOfferingRef

  Discriminator: { "propertyName":"@type", "mapping":{ "ProductOfferingRef":"#/components/schemas/ProductOfferingRef", "BundledProductOffering":"#/components/schemas/BundledProductOffering", "BundledProductOfferingChoiceOracle":"#/components/schemas/BundledProductOfferingChoiceOracle", "BundledProductOfferingOracle":"#/components/schemas/BundledProductOfferingOracle" } }

  ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.
• object ProductOfferingRefOracle-allOf[1]

{
    "title":"ProductOfferingRefOracle",
    "allOf":[
        {
            "$ref":"#/components/schemas/ProductOfferingRef"
        },
        {
            "type":"object",
            "properties":{
                "version":{
                    "type":"string",
                    "description":"Version of the product offering"
                },
                "lifecycleStatus":{
                    "type":"string",
                    "description":"lifecycleStatus of the product offering"
                },
                "isBundle":{
                    "type":"boolean",
                    "description":"Indicates if the offer is simple or composite"
                }
            }
        }
    ]
}

Nested Schema : ProductOfferingRef

Type: object

Title: ProductOfferingRef

Discriminator: @type

Discriminator Values

• ProductOfferingRef
• BundledProductOffering
• BundledProductOfferingChoiceOracle
• BundledProductOfferingOracle

{
    "title":"ProductOfferingRef",
    "type":"object",
    "description":"ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the product offering"
        },
        "href":{
            "type":"string",
            "description":"Reference of the product offering"
        },
        "name":{
            "type":"string",
            "description":"Name of the product offering"
        },
        "@type":{
            "type":"string",
            "description":"The class type of this ProductOfferingRef"
        },
        "@baseType":{
            "type":"string",
            "description":"base class type  (immediate parent) of the ProductOfferingRef"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"Hyperlink reference to schema describing this object"
        },
        "@referredType":{
            "type":"string",
            "description":"the class type of the referred product offering"
        },
        "versionState":{
            "type":"number",
            "description":"To hold the version state for the reference"
        },
        "version":{
            "type":"string",
            "description":"Version of the product offering"
        }
    },
    "required":[
        "id",
        "@type",
        "@referredType"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ProductOfferingRef":"#/components/schemas/ProductOfferingRef",
            "BundledProductOffering":"#/components/schemas/BundledProductOffering",
            "BundledProductOfferingChoiceOracle":"#/components/schemas/BundledProductOfferingChoiceOracle",
            "BundledProductOfferingOracle":"#/components/schemas/BundledProductOfferingOracle"
        }
    }
}

ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.

Show Source

• @baseType: string
  base class type (immediate parent) of the ProductOfferingRef
• @referredType(required): string
  the class type of the referred product offering
• @schemaLocation: string
  Hyperlink reference to schema describing this object
• @type(required): string
  The class type of this ProductOfferingRef
• href: string
  Reference of the product offering
• id(required): string
  Unique identifier of the product offering
• name: string
  Name of the product offering
• version: string
  Version of the product offering
• versionState: number
  To hold the version state for the reference

{
    "title":"ProductOfferingRef",
    "type":"object",
    "description":"ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the product offering"
        },
        "href":{
            "type":"string",
            "description":"Reference of the product offering"
        },
        "name":{
            "type":"string",
            "description":"Name of the product offering"
        },
        "@type":{
            "type":"string",
            "description":"The class type of this ProductOfferingRef"
        },
        "@baseType":{
            "type":"string",
            "description":"base class type  (immediate parent) of the ProductOfferingRef"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"Hyperlink reference to schema describing this object"
        },
        "@referredType":{
            "type":"string",
            "description":"the class type of the referred product offering"
        },
        "versionState":{
            "type":"number",
            "description":"To hold the version state for the reference"
        },
        "version":{
            "type":"string",
            "description":"Version of the product offering"
        }
    },
    "required":[
        "id",
        "@type",
        "@referredType"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ProductOfferingRef":"#/components/schemas/ProductOfferingRef",
            "BundledProductOffering":"#/components/schemas/BundledProductOffering",
            "BundledProductOfferingChoiceOracle":"#/components/schemas/BundledProductOfferingChoiceOracle",
            "BundledProductOfferingOracle":"#/components/schemas/BundledProductOfferingOracle"
        }
    }
}

Nested Schema : ProductOfferingRefOracle-allOf[1]

Type: object

Show Source

• isBundle: boolean
  Indicates if the offer is simple or composite
• lifecycleStatus: string
  lifecycleStatus of the product offering
• version: string
  Version of the product offering

{
    "type":"object",
    "properties":{
        "version":{
            "type":"string",
            "description":"Version of the product offering"
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"lifecycleStatus of the product offering"
        },
        "isBundle":{
            "type":"boolean",
            "description":"Indicates if the offer is simple or composite"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : ProductLineOracle

Title: ProductLineOracle

Represents entities that groups product offerings

Match All

Represents entities that groups product offerings

Represents entities that groups product offerings

Show Source

• object ProductLine
  Title: ProductLine

  Discriminator: { "propertyName":"@type", "mapping":{ "ProductLine":"#/components/schemas/ProductLine", "ProductLineOracle":"#/components/schemas/ProductLineOracle" } }

  Represents entities that groups product offerings
• object type

{
    "title":"ProductLineOracle",
    "description":"Represents entities that groups product offerings",
    "allOf":[
        {
            "$ref":"#/components/schemas/ProductLine"
        },
        {
            "type":"object",
            "properties":{
                "created":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Date and time of creation"
                },
                "createdBy":{
                    "type":"string",
                    "description":"name of the person who created item"
                },
                "lastUpdatedBy":{
                    "type":"string",
                    "description":"name of the person who updated item"
                },
                "productOffering":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/ProductOfferingRefOracle"
                    }
                },
                "project":{
                    "$ref":"#/components/schemas/ProjectRef"
                },
                "compatibilityRules":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/CompatibilityRulesOracle"
                    }
                },
                "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 product line"
                }
            }
        }
    ]
}

Nested Schema : ProductLine

Type: object

Title: ProductLine

Discriminator: @type

Discriminator Values

• ProductLine
• ProductLineOracle

{
    "title":"ProductLine",
    "type":"object",
    "description":"Represents entities that groups product offerings",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"Unique identifier of the product line"
        },
        "href":{
            "type":"string",
            "description":"Reference of the Product line"
        },
        "name":{
            "type":"string",
            "description":"Name of the product line"
        },
        "description":{
            "type":"string",
            "description":"Description of the product line"
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the last update"
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"Used to indicate the current lifecycle status"
        },
        "version":{
            "type":"string",
            "description":"ProductOffering version"
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriodOracle"
        },
        "@type":{
            "type":"string",
            "description":"Class type of the product offering"
        },
        "@baseType":{
            "type":"string",
            "description":"Immediate base (class) type of the product offering"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this product offering"
        }
    },
    "required":[
        "name",
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ProductLine":"#/components/schemas/ProductLine",
            "ProductLineOracle":"#/components/schemas/ProductLineOracle"
        }
    }
}

Represents entities that groups product offerings

Show Source

• @baseType: string
  Immediate base (class) type of the product offering
• @schemaLocation: string
  A link to the schema describing this product offering
• @type(required): string
  Class type of the product offering
• description: string
  Description of the product line
• href: string
  Reference of the Product line
• id: string
  Maximum Length: 30

  Unique identifier of the product line
• 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 product line
• validFor: object TimePeriodOracle
  Title: TimePeriodOracle

  Validity period of the related party
• version: string
  ProductOffering version

{
    "title":"ProductLine",
    "type":"object",
    "description":"Represents entities that groups product offerings",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"Unique identifier of the product line"
        },
        "href":{
            "type":"string",
            "description":"Reference of the Product line"
        },
        "name":{
            "type":"string",
            "description":"Name of the product line"
        },
        "description":{
            "type":"string",
            "description":"Description of the product line"
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the last update"
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"Used to indicate the current lifecycle status"
        },
        "version":{
            "type":"string",
            "description":"ProductOffering version"
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriodOracle"
        },
        "@type":{
            "type":"string",
            "description":"Class type of the product offering"
        },
        "@baseType":{
            "type":"string",
            "description":"Immediate base (class) type of the product offering"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this product offering"
        }
    },
    "required":[
        "name",
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ProductLine":"#/components/schemas/ProductLine",
            "ProductLineOracle":"#/components/schemas/ProductLineOracle"
        }
    }
}

Nested Schema : type

Type: object

Show Source

• applicationName: string
  name of the external application
• compatibilityRules: array compatibilityRules
• created: string (date-time)
  Date and time of 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
• productOffering: array productOffering
• project: object ProjectRef
  Title: ProjectRef

  Project Reference
• versionState: number
  Version state of the product line

{
    "type":"object",
    "properties":{
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of creation"
        },
        "createdBy":{
            "type":"string",
            "description":"name of the person who created item"
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"name of the person who updated item"
        },
        "productOffering":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductOfferingRefOracle"
            }
        },
        "project":{
            "$ref":"#/components/schemas/ProjectRef"
        },
        "compatibilityRules":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CompatibilityRulesOracle"
            }
        },
        "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 product line"
        }
    }
}

Nested Schema : compatibilityRules

Type: array

Show Source

• Array of: object CompatibilityRulesOracle
  Title: CompatibilityRulesOracle

  specifies the compatibilty rule for the offer

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

Nested Schema : productOffering

Type: array

Show Source

• Array of: ProductOfferingRefOracle
  Title: ProductOfferingRefOracle

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

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

{
    "title":"ProjectRef",
    "type":"object",
    "description":"Project Reference",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the project"
        },
        "href":{
            "type":"string",
            "description":"Unique reference of the project"
        },
        "name":{
            "type":"string",
            "description":"Name of the project"
        },
        "version":{
            "type":"string",
            "description":"Version of the project"
        }
    },
    "required":[
        "id"
    ]
}

Nested Schema : CompatibilityRulesOracle

Type: object

Title: CompatibilityRulesOracle

specifies the compatibilty rule for the offer

Show Source

• active: boolean
  A flag indicating if the rule is active or not
• compatibilityRuleType: string
  Allowed Values: [ "REQUIRES", "EXCLUDES" ]

  Specifies the type of compatability rule
• name(required): string
  Unique name of the Compatibility Rule
• objectProduct: string
  object offer component of the compatability rule
• objectProductLine: string
  Object Product Line component of the compatability rule
• subjectProduct: string
  Subject offer component of the compatability rule
• subjectProductLine: string
  Subject Product Line component of the compatability rule
• validFor: object TimePeriodOracle
  Title: TimePeriodOracle

  Validity period of the related party

{
    "title":"CompatibilityRulesOracle",
    "type":"object",
    "description":"specifies the compatibilty rule for the offer",
    "properties":{
        "name":{
            "type":"string",
            "description":"Unique name of the Compatibility Rule"
        },
        "subjectProduct":{
            "type":"string",
            "description":"Subject offer component of the compatability rule"
        },
        "objectProduct":{
            "type":"string",
            "description":"object offer component of the compatability rule"
        },
        "subjectProductLine":{
            "type":"string",
            "description":"Subject Product Line component of the compatability rule"
        },
        "objectProductLine":{
            "type":"string",
            "description":"Object Product Line component of the compatability rule"
        },
        "active":{
            "type":"boolean",
            "description":"A flag indicating if the rule is active or not"
        },
        "compatibilityRuleType":{
            "type":"string",
            "description":"Specifies the type of compatability rule",
            "enum":[
                "REQUIRES",
                "EXCLUDES"
            ]
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriodOracle"
        }
    },
    "required":[
        "name"
    ]
}

Nested Schema : TimePeriodOracle

Type: object

Title: TimePeriodOracle

Validity period of the related party

Show Source

• endDateTime: string (date-time)
  An instant of time, ending at the TimePeriod.
• startDateTime: string (date-time)
  An instant of time, starting at the TimePeriod

{
    "description":"Validity period of the related party",
    "title":"TimePeriodOracle",
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An instant of time, starting at the TimePeriod"
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An instant of time, ending at the TimePeriod."
        }
    }
}

Nested Schema : ProductOfferingRefOracle

Title: ProductOfferingRefOracle

Match All

Show Source

• object ProductOfferingRef
  Title: ProductOfferingRef

  Discriminator: { "propertyName":"@type", "mapping":{ "ProductOfferingRef":"#/components/schemas/ProductOfferingRef", "BundledProductOffering":"#/components/schemas/BundledProductOffering", "BundledProductOfferingChoiceOracle":"#/components/schemas/BundledProductOfferingChoiceOracle", "BundledProductOfferingOracle":"#/components/schemas/BundledProductOfferingOracle" } }

  ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.
• object ProductOfferingRefOracle-allOf[1]

{
    "title":"ProductOfferingRefOracle",
    "allOf":[
        {
            "$ref":"#/components/schemas/ProductOfferingRef"
        },
        {
            "type":"object",
            "properties":{
                "version":{
                    "type":"string",
                    "description":"Version of the product offering"
                },
                "lifecycleStatus":{
                    "type":"string",
                    "description":"lifecycleStatus of the product offering"
                },
                "isBundle":{
                    "type":"boolean",
                    "description":"Indicates if the offer is simple or composite"
                }
            }
        }
    ]
}

Nested Schema : ProductOfferingRef

Type: object

Title: ProductOfferingRef

Discriminator: @type

Discriminator Values

• ProductOfferingRef
• BundledProductOffering
• BundledProductOfferingChoiceOracle
• BundledProductOfferingOracle

{
    "title":"ProductOfferingRef",
    "type":"object",
    "description":"ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the product offering"
        },
        "href":{
            "type":"string",
            "description":"Reference of the product offering"
        },
        "name":{
            "type":"string",
            "description":"Name of the product offering"
        },
        "@type":{
            "type":"string",
            "description":"The class type of this ProductOfferingRef"
        },
        "@baseType":{
            "type":"string",
            "description":"base class type  (immediate parent) of the ProductOfferingRef"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"Hyperlink reference to schema describing this object"
        },
        "@referredType":{
            "type":"string",
            "description":"the class type of the referred product offering"
        },
        "versionState":{
            "type":"number",
            "description":"To hold the version state for the reference"
        },
        "version":{
            "type":"string",
            "description":"Version of the product offering"
        }
    },
    "required":[
        "id",
        "@type",
        "@referredType"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ProductOfferingRef":"#/components/schemas/ProductOfferingRef",
            "BundledProductOffering":"#/components/schemas/BundledProductOffering",
            "BundledProductOfferingChoiceOracle":"#/components/schemas/BundledProductOfferingChoiceOracle",
            "BundledProductOfferingOracle":"#/components/schemas/BundledProductOfferingOracle"
        }
    }
}

ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.

Show Source

• @baseType: string
  base class type (immediate parent) of the ProductOfferingRef
• @referredType(required): string
  the class type of the referred product offering
• @schemaLocation: string
  Hyperlink reference to schema describing this object
• @type(required): string
  The class type of this ProductOfferingRef
• href: string
  Reference of the product offering
• id(required): string
  Unique identifier of the product offering
• name: string
  Name of the product offering
• version: string
  Version of the product offering
• versionState: number
  To hold the version state for the reference

{
    "title":"ProductOfferingRef",
    "type":"object",
    "description":"ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the product offering"
        },
        "href":{
            "type":"string",
            "description":"Reference of the product offering"
        },
        "name":{
            "type":"string",
            "description":"Name of the product offering"
        },
        "@type":{
            "type":"string",
            "description":"The class type of this ProductOfferingRef"
        },
        "@baseType":{
            "type":"string",
            "description":"base class type  (immediate parent) of the ProductOfferingRef"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"Hyperlink reference to schema describing this object"
        },
        "@referredType":{
            "type":"string",
            "description":"the class type of the referred product offering"
        },
        "versionState":{
            "type":"number",
            "description":"To hold the version state for the reference"
        },
        "version":{
            "type":"string",
            "description":"Version of the product offering"
        }
    },
    "required":[
        "id",
        "@type",
        "@referredType"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ProductOfferingRef":"#/components/schemas/ProductOfferingRef",
            "BundledProductOffering":"#/components/schemas/BundledProductOffering",
            "BundledProductOfferingChoiceOracle":"#/components/schemas/BundledProductOfferingChoiceOracle",
            "BundledProductOfferingOracle":"#/components/schemas/BundledProductOfferingOracle"
        }
    }
}

Nested Schema : ProductOfferingRefOracle-allOf[1]

Type: object

Show Source

• isBundle: boolean
  Indicates if the offer is simple or composite
• lifecycleStatus: string
  lifecycleStatus of the product offering
• version: string
  Version of the product offering

{
    "type":"object",
    "properties":{
        "version":{
            "type":"string",
            "description":"Version of the product offering"
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"lifecycleStatus of the product offering"
        },
        "isBundle":{
            "type":"boolean",
            "description":"Indicates if the offer is simple or composite"
        }
    }
}

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 create or update a product line by submitting a PUT request on the REST resource using cURL.

cURL Command

curl -u username:password -X PUT https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/productLine/InternetOffersPL2020 -H 'Content-Type: application/json' -D @put_productline.json | json_pp

Example of Request Body

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

{
    "id": "InternetOffersPL2020",
    "name": "Internet Offers PL2020",
    "@type": "ProductLineOracle",
    "@baseType": "ProductLine",
    "version": "1.0",
    "description": "Product line 12 for IPTV TV and Movie offers",
    "lifecycleStatus": "In design",
    "project": {
        "id": "SpringProject",
        "name": "SpringProject"
    },
}

Example of Response Body

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

{
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productLine/IPTVProductLine2/InternetOffersPL2020",
    "id": "InternetOffersPL2020",
    "createdBy": "anonymous",
    "created": "2020-08-19T16:02:10.004Z",
    "lastUpdate": "2020-08-19T16:02:11.427Z",
    "lastUpdatedBy": "anonymous",
    "version": "1.0",
    "name": "Internet Offers PL2020",
    "description": "Product line 12 for IPTV TV and Movie offers",
    "@type": "ProductLineOracle",
    "@baseType": "ProductLine",
    "@schemaLocation": "https://{FusionAppsHost}/CatalogManagement/schema/oracle/ProductLineOracle.yml",
    "lifecycleStatus": "In design",
    "project": {
        "id": "SpringProject",
        "name": "SpringProject"
    }
}

Back to Top