Create or update an array of product lines
https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/productLines
Request
There are no request parameters for this operation.
- application/json
array150-
Array of:
ProductLineOracle
Title:
ProductLineOracle
ProductLineOracle-
object
ProductLine
Title:
ProductLineDiscriminator:{ "propertyName":"@type", "mapping":{ "ProductLine":"#/components/schemas/ProductLine", "ProductLineOracle":"#/components/schemas/ProductLineOracle" } }The entity that groups product offerings. -
object
type
objectProductLineDiscriminator Values
-
@baseType: string
The base type of the product line.
-
@schemaLocation: string
The URI of the schema that defines the product line.
-
@type(required): string
The class type of the product line.
-
description: string
The description of the product line.
-
href: string
The hyperlink reference to the product line.
-
id: string
Maximum Length:
30The ID of the product line. -
lastUpdate: string
(date-time)
The date and time when the product line was last updated.
-
lifecycleStatus: string
The status of the product line.
-
name(required): string
The name of the product line.
-
validFor: object
TimePeriodOracle
Title:
TimePeriodOracleThe validity period of the related party. -
version: string
The product line version.
object-
applicationName: string
The name of the application associated with the product line.
-
compatibilityRules: array
compatibilityRules
A list of compatibility rules associated with the product line.
-
created: string
(date-time)
The date and time of creation.
-
createdBy: string
The name of the person who created item.
-
externalId: string
The ID of the external associated with the product line.
-
lastUpdatedBy: string
The name of the person who updated item.
-
productOffering: array
productOffering
A list of product offerings associated with the product line.
-
project: object
ProjectRef
Title:
ProjectRefThe project reference resource. -
versionState: number
The version state of the product line.
array-
Array of:
object CompatibilityRulesOracle
Title:
CompatibilityRulesOracleSpecifies the compatibility rule for the offer.
array-
Array of:
ProductOfferingRefOracle
Title:
ProductOfferingRefOracle
objectProjectRef-
href: string
The hyperlink reference to the project reference.
-
id(required): string
The ID of the project reference.
-
name: string
The name of the project reference.
-
version: string
The version of the project.
objectCompatibilityRulesOracle-
active: boolean
Whether the compatibility rule has active.
-
compatibilityRuleType: string
Allowed Values:
[ "REQUIRES", "EXCLUDES" ]The type or classification of the compatibility rule. Valid values are REQUIRES, and EXCLUDES. -
name(required): string
The name of the compatibility rule.
-
objectProduct: string
The object offer component of the compatability rule.
-
objectProductLine: string
The object Product Line component of the compatability rule.
-
subjectProduct: string
The subject offer component of the compatability rule.
-
subjectProductLine: string
The subject Product Line component of the compatability rule.
-
validFor: object
TimePeriodOracle
Title:
TimePeriodOracleThe validity period of the related party.
objectTimePeriodOracle-
endDateTime: string
(date-time)
The end date and time of the time period.
-
startDateTime: string
(date-time)
The start date and time of the time period.
ProductOfferingRefOracle-
object
ProductOfferingRef
Title:
ProductOfferingRefDiscriminator:{ "propertyName":"@type", "mapping":{ "ProductOfferingRef":"#/components/schemas/ProductOfferingRef", "BundledProductOffering":"#/components/schemas/BundledProductOffering", "BundledProductOfferingChoiceOracle":"#/components/schemas/BundledProductOfferingChoiceOracle", "BundledProductOfferingOracle":"#/components/schemas/BundledProductOfferingOracle" } }The 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]
objectProductOfferingRefDiscriminator Values
- ProductOfferingRef
- BundledProductOffering
- BundledProductOfferingChoiceOracle
- BundledProductOfferingOracle
-
@baseType: string
The base type of the product offering reference.
-
@referredType(required): string
The type of the referred product offering reference.
-
@schemaLocation: string
The URI of the schema that defines the product offering reference.
-
@type(required): string
The class type of the product offering reference.
-
href: string
The hyperlink reference to the product offering reference.
-
id(required): string
The ID of the product offering reference.
-
name: string
The name of the product offering reference.
-
version: string
The version of the product offering.
-
versionState: number
The version state of the reference.
object-
isBundle: boolean
Whether the product offering reference is bundle.
-
lifecycleStatus: string
The status of the product offering reference.
-
version: string
The version of the product offering.
Response
- application/json
200 Response
ProductLineOracle-
object
ProductLine
Title:
ProductLineDiscriminator:{ "propertyName":"@type", "mapping":{ "ProductLine":"#/components/schemas/ProductLine", "ProductLineOracle":"#/components/schemas/ProductLineOracle" } }The entity that groups product offerings. -
object
type
objectProductLineDiscriminator Values
-
@baseType: string
The base type of the product line.
-
@schemaLocation: string
The URI of the schema that defines the product line.
-
@type(required): string
The class type of the product line.
-
description: string
The description of the product line.
-
href: string
The hyperlink reference to the product line.
-
id: string
Maximum Length:
30The ID of the product line. -
lastUpdate: string
(date-time)
The date and time when the product line was last updated.
-
lifecycleStatus: string
The status of the product line.
-
name(required): string
The name of the product line.
-
validFor: object
TimePeriodOracle
Title:
TimePeriodOracleThe validity period of the related party. -
version: string
The product line version.
object-
applicationName: string
The name of the application associated with the product line.
-
compatibilityRules: array
compatibilityRules
A list of compatibility rules associated with the product line.
-
created: string
(date-time)
The date and time of creation.
-
createdBy: string
The name of the person who created item.
-
externalId: string
The ID of the external associated with the product line.
-
lastUpdatedBy: string
The name of the person who updated item.
-
productOffering: array
productOffering
A list of product offerings associated with the product line.
-
project: object
ProjectRef
Title:
ProjectRefThe project reference resource. -
versionState: number
The version state of the product line.
array-
Array of:
object CompatibilityRulesOracle
Title:
CompatibilityRulesOracleSpecifies the compatibility rule for the offer.
array-
Array of:
ProductOfferingRefOracle
Title:
ProductOfferingRefOracle
objectProjectRef-
href: string
The hyperlink reference to the project reference.
-
id(required): string
The ID of the project reference.
-
name: string
The name of the project reference.
-
version: string
The version of the project.
objectCompatibilityRulesOracle-
active: boolean
Whether the compatibility rule has active.
-
compatibilityRuleType: string
Allowed Values:
[ "REQUIRES", "EXCLUDES" ]The type or classification of the compatibility rule. Valid values are REQUIRES, and EXCLUDES. -
name(required): string
The name of the compatibility rule.
-
objectProduct: string
The object offer component of the compatability rule.
-
objectProductLine: string
The object Product Line component of the compatability rule.
-
subjectProduct: string
The subject offer component of the compatability rule.
-
subjectProductLine: string
The subject Product Line component of the compatability rule.
-
validFor: object
TimePeriodOracle
Title:
TimePeriodOracleThe validity period of the related party.
objectTimePeriodOracle-
endDateTime: string
(date-time)
The end date and time of the time period.
-
startDateTime: string
(date-time)
The start date and time of the time period.
ProductOfferingRefOracle-
object
ProductOfferingRef
Title:
ProductOfferingRefDiscriminator:{ "propertyName":"@type", "mapping":{ "ProductOfferingRef":"#/components/schemas/ProductOfferingRef", "BundledProductOffering":"#/components/schemas/BundledProductOffering", "BundledProductOfferingChoiceOracle":"#/components/schemas/BundledProductOfferingChoiceOracle", "BundledProductOfferingOracle":"#/components/schemas/BundledProductOfferingOracle" } }The 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]
objectProductOfferingRefDiscriminator Values
- ProductOfferingRef
- BundledProductOffering
- BundledProductOfferingChoiceOracle
- BundledProductOfferingOracle
-
@baseType: string
The base type of the product offering reference.
-
@referredType(required): string
The type of the referred product offering reference.
-
@schemaLocation: string
The URI of the schema that defines the product offering reference.
-
@type(required): string
The class type of the product offering reference.
-
href: string
The hyperlink reference to the product offering reference.
-
id(required): string
The ID of the product offering reference.
-
name: string
The name of the product offering reference.
-
version: string
The version of the product offering.
-
versionState: number
The version state of the reference.
object-
isBundle: boolean
Whether the product offering reference is bundle.
-
lifecycleStatus: string
The status of the product offering reference.
-
version: string
The version of the product offering.
400 Response
array-
Array of:
object Discriminator: @type
Discriminator:
{ "propertyName":"@type", "mapping":{ "Error":"#/components/schemas/Error", "BulkError":"#/components/schemas/BulkError" } }
401 Response
objectError-
@schemaLocation: string
The URI of the schema that defines the error.
-
@type: string
The class type of a REST resource.
-
code(required): string
Application related code (as defined in the API or from a common list).
-
message: string
The text that provides more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
The text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
The URL pointing to documentation describing the error.
-
status: string
The status of the error.
404 Response
objectError-
@schemaLocation: string
The URI of the schema that defines the error.
-
@type: string
The class type of a REST resource.
-
code(required): string
Application related code (as defined in the API or from a common list).
-
message: string
The text that provides more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
The text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
The URL pointing to documentation describing the error.
-
status: string
The status of the error.
405 Response
objectError-
@schemaLocation: string
The URI of the schema that defines the error.
-
@type: string
The class type of a REST resource.
-
code(required): string
Application related code (as defined in the API or from a common list).
-
message: string
The text that provides more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
The text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
The URL pointing to documentation describing the error.
-
status: string
The status of the error.
500 Response
objectError-
@schemaLocation: string
The URI of the schema that defines the error.
-
@type: string
The class type of a REST resource.
-
code(required): string
Application related code (as defined in the API or from a common list).
-
message: string
The text that provides more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
The text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
The URL pointing to documentation describing the error.
-
status: string
The status of the error.
Examples
The following example shows how to create or update an array of 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/productLines/ -H 'Content-Type: application/json' -D @put_productlines.json | json_pp
Example of Request Body
The following shows an example of the request body in JSON format.
[
{
"@type": "ProductLineOracle",
"@baseType": "ProductLine",
"id": "TelecomProductline_Y2021_001",
"name": "TelecomProductline_Y2021_001",
"version": "1.0",
"description": "ProductLine129 description up",
"lifecycleStatus": "In design",
"project": {
"id": "BulkDocProject",
"name": "Bulk Doc Project"
}
},
{
"@type": "ProductLineOracle",
"@baseType": "ProductLine",
"id": "TelecomProductline_Y2021_002",
"name": "TelecomProductline_Y2021_002",
"version": "1.0",
"description": "ProductLine129 description up",
"lifecycleStatus": "In design",
"project": {
"id": "BulkDocProject",
"name": "Bulk Doc Project"
}
}
]
Example of Response Body
The following shows an example of the response body in JSON format.
[
{
"id": "TelecomProductline_Y2021_001",
"name": "TelecomProductline_Y2021_001",
"description": "ProductLine129 description up",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/productLines/TelecomProductline_Y2021_001",
"version": "1.0",
"lifecycleStatus": "In design",
"@type": "ProductLineOracle",
"@baseType": "ProductLine",
"project": {
"id": "BulkDocProject",
"name": "Bulk Doc Project",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/BulkDocProject"
}
},
{
"id": "TelecomProductline_Y2021_002",
"name": "TelecomProductline_Y2021_002",
"description": "ProductLine129 description up",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/productLines/TelecomProductline_Y2021_002",
"version": "1.0",
"lifecycleStatus": "In design",
"@type": "ProductLineOracle",
"@baseType": "ProductLine",
"project": {
"id": "BulkDocProject",
"name": "Bulk Doc Project",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/BulkDocProject"
}
}
]