{
"components":{
"securitySchemes":{
"BasicAuthentication":{
"type":"http",
"scheme":"basic"
}
},
"requestBodies":{
"importjob-post-request":{
"description":"The following table describes the body parameters in the request for this task.",
"content":{
"multipart/form-data":{
"schema":{
"$ref":"#/components/schemas/importjob-post-request"
}
}
}
}
},
"parameters":{
"Content-Type":{
"in":"header",
"name":"Content-Type",
"schema":{
"type":"string"
},
"required":false,
"x-filter-type":"skip",
"description":"The media type of the request or response payload."
},
"path":{
"in":"query",
"name":"path",
"schema":{
"type":"string"
},
"required":true,
"x-filter-type":"skip",
"description":"The path value for locating the resource."
},
"id":{
"name":"id",
"description":"The ID of the resource item.",
"in":"path",
"required":true,
"schema":{
"type":"string"
},
"x-filter-type":"skip"
},
"limit":{
"name":"limit",
"description":"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.",
"in":"query",
"required":false,
"schema":{
"type":"integer"
},
"x-filter-type":"skip"
},
"name":{
"name":"name",
"description":"The name of the resource.",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"x-filter-type":"skip"
},
"commercialName":{
"name":"commercialName",
"description":"The commercialName of the resource.",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"x-filter-type":"skip"
},
"nameSearch":{
"name":"nameSearch",
"description":"The name or displayName of the resource for search.",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"x-filter-type":"skip"
},
"DestinationName":{
"name":"DestinationName",
"description":"The unique name of the destination. You can filter destinations using the destination name. For example, DestinationName=RecordName. The DestinationName is the target-name of the Fabric systemDescriptor (TTD) for the registered spoke system projectPublishEvent endpoint.",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"x-filter-type":"skip"
},
"description":{
"name":"description",
"description":"The description of the resource.",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"x-filter-type":"skip"
},
"component":{
"name":"components",
"description":"The lifecycle status and latest version of resource.",
"in":"query",
"required":false,
"schema":{
"type":"string",
"enum":[
"Launched",
"Latest"
]
},
"x-filter-type":"skip"
},
"version":{
"name":"version",
"description":"The current version of the resource.",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"x-filter-type":"skip"
},
"lifecycleStatus":{
"name":"lifecycleStatus",
"description":"The current lifecycle status of the resource.",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"x-filter-type":"common"
},
"type":{
"name":"@type",
"description":"The class type of the resource.",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"x-filter-type":"skip"
},
"baseType":{
"name":"@baseType",
"description":"The base class type of the resource.",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"x-filter-type":"skip"
},
"schemaLocation":{
"name":"@schemaLocation",
"description":"The link to the location where the scheme of the resource is defined.",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"x-filter-type":"skip"
},
"offset":{
"name":"offset",
"description":"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.",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"x-filter-type":"skip"
},
"fields":{
"name":"fields",
"description":"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.",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"x-filter-type":"skip"
},
"productNumber":{
"name":"productNumber",
"description":"The product number associated with the resource.",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"x-filter-type":"skip"
},
"isBundle":{
"name":"isBundle",
"description":"Contains one of the values, True or False. If False, then a single product offering is included. If True, then a bundle of product offerings is included.",
"in":"query",
"required":false,
"schema":{
"type":"string"
}
},
"brand":{
"name":"brand",
"description":"The manufacturer or trademark of the specification.",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"x-filter-type":"skip"
},
"isSellable":{
"name":"isSellable",
"description":"Contains one of the values, True or False. If True, then the product offering is sold as a standalone product offering. If False, then the product offerings are sold within a bundle.",
"in":"query",
"required":false,
"schema":{
"type":"string"
}
},
"depth":{
"name":"depth",
"description":"The depth at which a resource item occurs in a resource hierarchy.",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"x-filter-type":"skip"
},
"catalogexpand":{
"name":"expand",
"in":"query",
"required":false,
"schema":{
"type":"array",
"items":{
"type":"string",
"enum":[
"catalog.category",
"catalog.category.subCategory"
]
}
},
"explode":false,
"x-filter-type":"skip",
"description":"The expand value for filtering resource results."
},
"poexpand":{
"name":"expand",
"in":"query",
"required":false,
"schema":{
"type":"array",
"items":{
"type":"string",
"enum":[
"productOffering.bundledProductOffering",
"productOffering.bundledProductOffering.productOfferingPrice",
"productOffering.productOfferingPrice.bundledPopRelationship",
"productOffering.productOfferingPrice.pricingLogicAlgorithm",
"productOffering.productOfferingPrice.policy",
"productOffering.productOfferingTerm.productOfferingPrice",
"productOffering.productOfferingTerm.customProfileSpec"
]
}
},
"explode":false,
"description":"The sub-entities that are embedded into each resource item returned in the response. To avoid huge responses, any sub-entity that contains more than 500 items is not expanded, and it is returned as a usual link. The link can retrieve the sub-entity in a separate call using the limit and offset parameters to control the response size.",
"x-filter-type":"skip"
},
"priceType":{
"name":"priceType",
"description":"The price types (such as a discount, penalty, allowance, and so on) applicable to a product offering.",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"x-filter-type":"skip"
},
"recurringChargePeriodType":{
"name":"recurringChargePeriodType",
"description":"The frequency (for example, weekly, monthly) for which the recurring charge is applied.",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"x-filter-type":"skip"
},
"recurringChargePeriodLength":{
"name":"recurringChargePeriodLength",
"description":"The period (for example, 1 week, 2 months) for which the recurring charge is applied. If set to zero, then the charge is not applicable.",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"x-filter-type":"skip"
},
"percentage":{
"name":"percentage",
"description":"The discount percentage applied for the product offering.",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"x-filter-type":"skip"
},
"priceSubType":{
"name":"priceSubType",
"description":"The price sub types (such as Installment, Lease, Down Payment etc) applicable to a product offering.",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"x-filter-type":"skip"
},
"specification":{
"name":"specification",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"description":"The product specification ID for filtering resource results.",
"x-filter-type":"skip"
},
"idQueryParam":{
"name":"id",
"description":"The unique ID of the resource item.",
"in":"query",
"schema":{
"type":"string"
},
"x-filter-type":"skip"
},
"fileName":{
"name":"fileName",
"description":"The name of the file associated with the resource.",
"in":"query",
"schema":{
"type":"string"
},
"x-filter-type":"skip"
},
"filenamePrefix":{
"name":"filenamePrefix",
"description":"The user defined optional file name prefix.",
"in":"query",
"schema":{
"type":"string"
},
"x-filter-type":"skip"
},
"createdBy":{
"name":"createdBy",
"description":"The job request submitter name.",
"in":"query",
"schema":{
"type":"string"
}
},
"taxCodes.taxCode":{
"name":"taxCodes.taxCode",
"description":"The tax code associated with the resource.",
"in":"query",
"schema":{
"type":"string"
},
"x-filter-type":"skip"
},
"productOfferingInfo.productType":{
"name":"productOfferingInfo.productType",
"description":"The type or classification of the resource.",
"in":"query",
"schema":{
"type":"string"
}
},
"productSpecification.id":{
"name":"productSpecification.id",
"description":"The ID of the product specification for filtering resource results.",
"in":"query",
"schema":{
"type":"string"
}
},
"productSpecification.name":{
"name":"productSpecification.name",
"description":"The product specification name for filtering offerings.",
"in":"query",
"schema":{
"type":"string"
}
},
"productLine.id":{
"name":"productLine.id",
"description":"The ID of the product line for filtering resource results.",
"in":"query",
"schema":{
"type":"string"
}
},
"productLine.name":{
"name":"productLine.name",
"description":"The product line name for filtering offerings.",
"in":"query",
"schema":{
"type":"string"
}
},
"pricelist.id":{
"name":"pricelist.id",
"description":"The ID of the pricelist for filtering resource results.",
"in":"query",
"schema":{
"type":"string"
}
},
"pricelist.name":{
"name":"pricelist.name",
"description":"The price list name for filtering offerings.",
"in":"query",
"schema":{
"type":"string"
}
},
"price.value":{
"name":"price.value",
"description":"The price value for filtering offer prices.",
"in":"query",
"schema":{
"type":"number"
}
},
"whereUsed":{
"name":"whereUsed",
"description":"Whether to enrich objects with usedBy information.",
"in":"query",
"schema":{
"type":"string"
},
"x-filter-type":"skip"
},
"profileType":{
"name":"profileType",
"description":"The type or classification of the resource.",
"in":"query",
"schema":{
"type":"string"
}
},
"eligibleVersionForProject":{
"name":"eligibleVersionForProject",
"description":"The project ID.",
"in":"query",
"schema":{
"type":"string"
},
"x-filter-type":"skip"
},
"eligibleForProject":{
"name":"eligibleForProject",
"description":"The project ID.",
"in":"query",
"schema":{
"type":"string"
},
"x-filter-type":"skip"
},
"catalogType":{
"name":"catalogType",
"description":"The catalog type value for filtering resource results.",
"in":"query",
"schema":{
"type":"string"
}
},
"category":{
"name":"category",
"description":"The category value for filtering resource results.",
"in":"query",
"schema":{
"type":"string"
},
"x-filter-type":"skip"
},
"balanceElementType":{
"name":"balanceElementType",
"description":"The balance element type value for filtering resource results.",
"in":"query",
"schema":{
"type":"string"
},
"x-filter-type":"skip"
},
"entityType":{
"name":"entityType",
"description":"The entity type value for filtering resource results.",
"in":"query",
"schema":{
"type":"string"
},
"x-filter-type":"skip"
},
"promotionType":{
"name":"promotionType",
"description":"The promotion type value for filtering resource results.",
"in":"query",
"schema":{
"type":"string"
}
},
"subject.id":{
"name":"subject.id",
"description":"The ID of the subject for filtering resource results.",
"in":"query",
"schema":{
"type":"string"
}
},
"subject.name":{
"name":"subject.name",
"description":"The subject name for filtering product rules.",
"in":"query",
"schema":{
"type":"string"
}
},
"subject.AtReferredType":{
"name":"subject.@referredType",
"description":"The subject type for filtering product rules.",
"in":"query",
"schema":{
"type":"string"
}
},
"priceTagRules.productType":{
"name":"priceTagRules.productType",
"description":"The product type for filtering price tags.",
"in":"query",
"schema":{
"type":"string"
},
"x-filter-type":"skip"
},
"priceTagRules.unitOfMeasure":{
"name":"priceTagRules.unitOfMeasure",
"description":"The unit of measure for filtering price tags.",
"in":"query",
"schema":{
"type":"string"
},
"x-filter-type":"skip"
},
"priceTagRules.balanceElementCode":{
"name":"priceTagRules.balanceElementCode",
"description":"The balance element code for filtering price tags.",
"in":"query",
"schema":{
"type":"string"
},
"x-filter-type":"skip"
},
"priceTagRules.serviceSpecification.id":{
"name":"priceTagRules.serviceSpecification.id",
"description":"The ID of the price tag rules service specification for filtering resource results.",
"in":"query",
"schema":{
"type":"string"
},
"x-filter-type":"skip"
},
"actionProjectId":{
"name":"actionProjectId",
"description":"The ID of the action project for filtering resource results.",
"in":"query",
"schema":{
"type":"string"
},
"x-filter-type":"skip"
},
"userName":{
"name":"userName",
"description":"The username for filtering project activities.",
"in":"query",
"schema":{
"type":"string"
},
"x-filter-type":"skip"
},
"project.id":{
"name":"project.id",
"description":"The ID of the project for filtering resource results.",
"in":"query",
"schema":{
"type":"string"
},
"x-filter-type":"common"
},
"project.version":{
"name":"project.version",
"description":"The project version for filtering entities.",
"in":"query",
"schema":{
"type":"string"
},
"x-filter-type":"common"
},
"validFor.startDateTime":{
"name":"validFor.startDateTime",
"description":"The valid for start date time for filtering entities.",
"in":"query",
"schema":{
"type":"string"
},
"x-filter-type":"common"
},
"validFor.endDateTime":{
"name":"validFor.endDateTime",
"description":"The valid for end date time for filtering entities.",
"in":"query",
"schema":{
"type":"string"
},
"x-filter-type":"common"
},
"businessUnitId":{
"name":"businessUnitId",
"description":"The ID of the business unit associated with the resource.",
"in":"query",
"required":false,
"schema":{
"type":"string"
}
},
"businessUnitName":{
"name":"businessUnitName",
"description":"The name of the business unit to which the offer belongs.",
"in":"query",
"required":false,
"schema":{
"type":"string"
}
},
"catalogId":{
"name":"catalogId",
"description":"The ID of the catalog associated with the resource.",
"in":"query",
"required":false,
"schema":{
"type":"string"
}
},
"team.id":{
"name":"team.id",
"description":"The ID of the team associated with the resource.",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"x-filter-type":"skip"
},
"lastUpdate":{
"name":"lastUpdate",
"description":"Filters resources by their last update date and time.",
"in":"query",
"required":false,
"schema":{
"type":"string"
},
"x-filter-type":"common"
}
},
"responses":{
"204":{
"description":"The request was completed successfully."
},
"400":{
"description":"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.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"401":{
"description":"Your request isn't authorized. The authentication credentials included with this request are missing or invalid.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"403":{
"description":"You don't have authorization to perform this request.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"404":{
"description":"The resource with the specified URI couldn't be found.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"405":{
"description":"HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"409":{
"description":"The request can't be completed due to a conflict with the current state of the resource.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"500":{
"description":"The server encountered something unexpected that prevented it from completing the request.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"501":{
"description":"The server doesn't support the functionality required to fulfill the request.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"importjob-post-response":{
"description":"The import job has been created successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/empty-response"
}
}
}
}
},
"schemas":{
"ImportJob":{
"title":"ImportJob",
"type":"object",
"properties":{
"id":{
"type":"integer",
"format":"int64",
"description":"The ID of the import job."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the import job."
},
"completionDate":{
"type":"string",
"format":"date-time",
"description":"The date and time when the import job completed."
},
"contentType":{
"type":"string",
"description":"The content type of the import job request."
},
"creationDate":{
"type":"string",
"format":"date-time",
"description":"The date and time when the import job was created."
},
"errorLog":{
"type":"string",
"description":"The error log for the import job request."
},
"path":{
"type":"string",
"description":"The path of the import job request file."
},
"url":{
"type":"string",
"description":"The URL of the import job request."
},
"status":{
"type":"string",
"description":"The status of the import job.",
"enum":[
"NOT_STARTED",
"RUNNING",
"SUCCEEDED",
"FAILED",
"COMPLETED",
"ERROR",
"BLOCKED",
"READY",
"CANCELLED",
"CANCELLING"
]
},
"@baseType":{
"type":"string",
"description":"Indicates the base class type of this REST resource."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the import job."
},
"@type":{
"type":"string",
"description":"The class type of the import job."
}
},
"required":[
"@type"
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"ImportJob":"#/components/schemas/ImportJob",
"ImportJobOracle":"#/components/schemas/ImportJobOracle"
}
},
"description":"The import job resource."
},
"ImportJobOracle":{
"title":"ImportJobOracle",
"allOf":[
{
"$ref":"#/components/schemas/ImportJob"
},
{
"type":"object",
"properties":{
"fileName":{
"type":"string",
"description":"The name of the file used by the import job."
},
"createdBy":{
"type":"string",
"description":"The name of the user who submitted the import job."
},
"errorLogUrl":{
"type":"string",
"description":"The URL of the error log."
},
"importSummary":{
"type":"object",
"properties":{
"id":{
"type":"integer",
"format":"int64",
"description":"The ID of the import job."
},
"totalImportObjects":{
"type":"integer",
"description":"The total number of imported objects."
},
"resources":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ImportSummaryResource"
},
"description":"A list of resources included in the import summary."
}
},
"description":"The summary of the import job."
}
}
}
]
},
"ExportJob":{
"title":"ExportJob",
"type":"object",
"description":"The task that exports resources to a file.",
"properties":{
"id":{
"type":"integer",
"format":"int64",
"description":"The ID of the export job."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the export job."
},
"completionDate":{
"type":"string",
"format":"date-time",
"description":"The date and time when the export job completed."
},
"contentType":{
"type":"string",
"description":"The content type of the exported file."
},
"creationDate":{
"type":"string",
"format":"date-time",
"description":"The date and time when the export job was created."
},
"errorLog":{
"type":"string",
"description":"The error log containing the failure reason for the export job."
},
"path":{
"type":"string",
"description":"The path of the root resource used as the source for the export job."
},
"query":{
"type":"string",
"description":"Scopes the exported data."
},
"url":{
"type":"string",
"description":"The URL of the file that contains the exported data."
},
"status":{
"type":"string",
"description":"The status of the export job.",
"enum":[
"NOT_STARTED",
"RUNNING",
"SUCCEEDED",
"FAILED",
"COMPLETED",
"ERROR",
"BLOCKED",
"READY",
"CANCELLED",
"CANCELLING"
]
},
"@baseType":{
"type":"string",
"description":"The base type of the export job."
},
"@schemaLocation":{
"type":"string",
"format":"uri",
"description":"A URI to a JSON-Schema file that defines additional attributes and relationships."
},
"@type":{
"type":"string",
"description":"The class type of the export job."
}
},
"required":[
"@type"
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"ExportJob":"#/components/schemas/ExportJob",
"ExportJobOracle":"#/components/schemas/ExportJobOracle"
}
}
},
"ExportJobOracle":{
"title":"ExportJobOracle",
"allOf":[
{
"$ref":"#/components/schemas/ExportJob"
},
{
"type":"object",
"properties":{
"createdBy":{
"type":"string",
"description":"The name of the user who submitted the export job."
},
"exportOptions":{
"$ref":"#/components/schemas/ExportOptionsOracle",
"description":"The export options for the export job."
},
"exportSummary":{
"type":"object",
"properties":{
"id":{
"type":"integer",
"format":"int64",
"description":"The ID of the export job."
},
"totalExportObjects":{
"type":"integer",
"description":"The total number of exported objects."
},
"message":{
"type":"string",
"description":"Optional text that provides more details about the export summary."
},
"resources":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ExportSummaryResource"
},
"description":"A list of resources included in the export summary."
}
},
"description":"The summary of the export job."
},
"errorLogUrl":{
"type":"string",
"description":"The URL of the error log."
}
},
"required":[
"exportOptions"
]
}
]
},
"ExportOptionsOracle":{
"title":"ExportOptionsOracle",
"type":"object",
"description":"The task that exports resources to a file.",
"properties":{
"resourceType":{
"type":"array",
"description":"A list of resource types associated with the export option.",
"items":{
"type":"string",
"enum":[
"productRule",
"package",
"commercial_bundle",
"service_bundle",
"service",
"device",
"accessory",
"productOffering",
"productOfferingPrice",
"priceplan",
"productLine",
"promotion",
"policyRule",
"pricingLogicAlgorithmSpecification",
"balanceElement",
"productSpecification",
"serviceSpecification",
"usageSpecification",
"customerProfileSpecification",
"pricelist",
"customProfileSpecification",
"taxServiceProvider",
"catalog",
"category",
"entitlement",
"priceTag"
]
}
},
"lifecycleStatus":{
"type":"string",
"description":"The status of the export option."
},
"lastUpdate":{
"$ref":"#/components/schemas/TimePeriodOracle",
"description":"The date and time when the export option was last updated."
},
"project":{
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"The ID of the export option."
},
"name":{
"type":"string",
"description":"The name of the export option."
}
},
"description":"The project associated with the export options."
},
"name":{
"type":"string",
"description":"For a given resource type, this is the name of the resource."
},
"id":{
"type":"string",
"description":"For a given resource type, this is the ID of the resource."
},
"filenamePrefix":{
"type":"string",
"maxLength":200,
"description":"The user defined optional file name prefix."
},
"exportReferenced":{
"type":"boolean",
"description":"Whether the export option has export referenced."
},
"@baseType":{
"type":"string",
"description":"The base type of the export option."
},
"@schemaLocation":{
"type":"string",
"format":"uri",
"description":"A URI to a JSON-Schema file that defines additional attributes and relationships."
},
"@type":{
"type":"string",
"description":"The class type of the export option."
},
"scheduleJob":{
"$ref":"#/components/schemas/ScheduleJobOracle",
"description":"The export option."
},
"notificationUsers":{
"type":"array",
"items":{
"type":"string"
},
"description":"A list of notification users associated with the export option."
},
"fileFormat":{
"type":"string",
"enum":[
"CSV",
"JSON"
],
"description":"The file format associated with the export options. Valid values are CSV, and JSON."
},
"filter":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ExportFilterOracle"
},
"description":"A list of filters associated with the export option."
}
}
},
"ScheduleJobOracle":{
"type":"object",
"properties":{
"name":{
"type":"string",
"description":"The name of the schedule job."
},
"description":{
"type":"string",
"description":"Indicates the description for the schedule."
},
"startDateTime":{
"type":"string",
"format":"date-time",
"description":"The date and time when the schedule job starts."
},
"endDateTime":{
"type":"string",
"format":"date-time",
"description":"The date and time when the schedule job ends."
},
"recurrenceFields":{
"type":"object",
"properties":{
"frequency":{
"type":"string",
"description":"The frequency of the scheduled job. Valid values are ONCE, HOURLY, MINUTELY, DAILY, WEEKLY, MONTHLY, and YEARLY.",
"enum":[
"ONCE",
"HOURLY",
"MINUTELY",
"DAILY",
"WEEKLY",
"MONTHLY",
"YEARLY"
]
},
"interval":{
"type":"integer",
"description":"The duration between subsequent runs of scheduled job."
},
"hourInterval":{
"type":"integer",
"description":"The hour duration between subsequent runs of scheduled job."
},
"minuteInterval":{
"type":"integer",
"description":"The minute duration between subsequent runs of scheduled job."
},
"dayOfWeek":{
"type":"array",
"items":{
"type":"string",
"description":"Indicates the day of week for schedule job recurrence. Valid values are MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, and SUNDAY.",
"enum":[
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY",
"SUNDAY"
]
},
"description":"A list of day of weeks associated with the schedule job."
},
"timeOfDay":{
"type":"object",
"description":"Indicates the time of day for schedule job recurrence.",
"properties":{
"hour":{
"type":"integer",
"description":"The hour associated with the schedule job.",
"minimum":0,
"maximum":23
},
"minute":{
"type":"integer",
"description":"The minute associated with the schedule job.",
"minimum":0,
"maximum":59
},
"second":{
"type":"integer",
"description":"The second associated with the schedule job.",
"minimum":0,
"maximum":59
}
}
},
"dayOfMonth":{
"type":"array",
"items":{
"type":"string",
"description":"Indicates the day of month for schedule job recurrence."
},
"description":"A list of day of months associated with the schedule job."
},
"monthOfyear":{
"type":"array",
"items":{
"type":"string",
"description":"Indicates the month of year for schedule job recurrence. Valid values are JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, and DECEMBER.",
"enum":[
"JANUARY",
"FEBRUARY",
"MARCH",
"APRIL",
"MAY",
"JUNE",
"JULY",
"AUGUST",
"SEPTEMBER",
"OCTOBER",
"NOVEMBER",
"DECEMBER"
]
},
"description":"A list of month ofyears associated with the schedule job."
},
"weekOfMonth":{
"type":"array",
"items":{
"type":"string",
"description":"Indicates the week of month for schedule job recurrence. Valid values are FIRST, SECOND, THIRD, FOURTH, FIFTH, and LAST.",
"enum":[
"FIRST",
"SECOND",
"THIRD",
"FOURTH",
"FIFTH",
"LAST"
]
},
"description":"A list of week of months associated with the schedule job."
},
"year":{
"type":"integer",
"description":"The year associated with the schedule job."
}
},
"required":[
"frequency"
],
"description":"The recurrence fields associated with the schedule job."
}
},
"required":[
"startDateTime",
"endDateTime",
"recurrenceFields"
],
"description":"The schedule job resource."
},
"ExportFilterOracle":{
"title":"ExportFilterOracle",
"type":"object",
"properties":{
"field":{
"type":"string",
"description":"The field or attribute name of the resource filter."
},
"value":{
"type":"string",
"description":"The value assigned to the export filter."
}
},
"required":[
"field",
"value"
],
"description":"The export filter resource."
},
"Catalog":{
"title":"Catalog",
"type":"object",
"properties":{
"id":{
"type":"string",
"maxLength":30,
"description":"The ID of the catalog."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the catalog."
},
"name":{
"type":"string",
"description":"The name of the catalog."
},
"description":{
"type":"string",
"description":"The description of this catalog."
},
"@type":{
"type":"string",
"description":"Indicates the (class) type of catalog. For entity catalogs, this will be 'EntityCatalog'."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the catalog."
},
"@baseType":{
"type":"string",
"description":"Indicates the base class type of this REST resource."
},
"version":{
"type":"string",
"description":"The catalog version."
},
"validFor":{
"$ref":"#/components/schemas/TimePeriod",
"description":"The period for which the catalog is valid."
},
"lastUpdate":{
"type":"string",
"format":"date-time",
"description":"The date and time when the catalog was last updated."
},
"catalogType":{
"type":"string",
"description":"The type or classification of the catalog."
},
"lifecycleStatus":{
"type":"string",
"description":"The status of the catalog."
},
"relatedParty":{
"type":"array",
"items":{
"$ref":"#/components/schemas/RelatedPartyRefOrPartyRoleRef"
},
"description":"A list of related parties associated with the catalog."
},
"category":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CategoryRef"
},
"description":"A list of categories associated with the catalog."
}
},
"required":[
"name",
"@type"
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"Catalog":"#/components/schemas/Catalog",
"CatalogOracle":"#/components/schemas/CatalogOracle"
}
},
"description":"The catalog resource."
},
"CatalogOracle":{
"title":"CatalogOracle",
"allOf":[
{
"$ref":"#/components/schemas/Catalog"
},
{
"type":"object",
"properties":{
"project":{
"$ref":"#/components/schemas/ProjectRef",
"description":"The project associated with the catalog."
},
"created":{
"type":"string",
"format":"date-time",
"description":"The date and time of the creation."
},
"createdBy":{
"type":"string",
"description":"The name of the person who created item."
},
"lastUpdatedBy":{
"type":"string",
"description":"The name of the person who updated item."
},
"externalId":{
"type":"string",
"description":"The ID of the external associated with the catalog."
},
"applicationName":{
"type":"string",
"description":"The name of the application associated with the catalog."
},
"versionState":{
"type":"number",
"description":"The version state of the catalog."
}
}
}
]
},
"Category":{
"title":"Category",
"type":"object",
"properties":{
"id":{
"type":"string",
"maxLength":30,
"description":"The ID of the category."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the category."
},
"lastUpdate":{
"type":"string",
"format":"date-time",
"description":"The date and time when the category was last updated."
},
"version":{
"type":"string",
"description":"The category version."
},
"lifecycleStatus":{
"type":"string",
"description":"The status of the category."
},
"validFor":{
"$ref":"#/components/schemas/TimePeriod",
"description":"The period for which the category is valid."
},
"isRoot":{
"type":"boolean",
"description":"If true, this Boolean indicates that the category is a root of categories."
},
"name":{
"type":"string",
"description":"The name of the category."
},
"description":{
"type":"string",
"description":"The description of the category."
},
"@type":{
"type":"string",
"description":"The class type of the category."
},
"@baseType":{
"type":"string",
"description":"The base type of the category."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the category."
},
"subCategory":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CategoryRef"
},
"description":"A list of sub categories associated with the category."
},
"parent":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CategoryRef"
},
"description":"A list of parents associated with the category."
},
"productOffering":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ProductOfferingRef"
},
"description":"A list of product offerings associated with the category."
}
},
"required":[
"name",
"@type"
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"Category":"#/components/schemas/Category",
"CategoryOracle":"#/components/schemas/CategoryOracle"
}
},
"description":"The category resource."
},
"CategoryOracle":{
"title":"CategoryOracle",
"allOf":[
{
"$ref":"#/components/schemas/Category"
},
{
"type":"object",
"properties":{
"project":{
"$ref":"#/components/schemas/ProjectRef",
"description":"The project associated with the category."
},
"created":{
"type":"string",
"format":"date-time",
"description":"The date and time of the creation."
},
"createdBy":{
"type":"string",
"description":"The name of the person who created item."
},
"lastUpdatedBy":{
"type":"string",
"description":"The name of the person who updated item."
},
"externalId":{
"type":"string",
"description":"The ID of the external associated with the category."
},
"applicationName":{
"type":"string",
"description":"The name of the application associated with the category."
},
"versionState":{
"type":"number",
"description":"The version state of the category."
}
}
}
]
},
"ProductOffering":{
"title":"ProductOffering",
"type":"object",
"properties":{
"id":{
"type":"string",
"maxLength":30,
"description":"The ID of the product offering."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the product offering."
},
"name":{
"type":"string",
"description":"The name of the product offering."
},
"description":{
"type":"string",
"description":"The description of the product offering."
},
"isBundle":{
"type":"boolean",
"description":"Determines whether a product offering represents a single product offering (false) or a bundle of product offerings (true)."
},
"lastUpdate":{
"type":"string",
"format":"date-time",
"description":"The date and time when the product offering was last updated."
},
"lifecycleStatus":{
"type":"string",
"description":"The status of the product offering."
},
"statusReason":{
"type":"string",
"description":"Indicates the current status reason."
},
"subStatus":{
"type":"string",
"description":"The status of the product offering."
},
"validFor":{
"$ref":"#/components/schemas/TimePeriod",
"description":"The period for which the product offering is valid."
},
"version":{
"type":"string",
"description":"The product offering version."
},
"@type":{
"type":"string",
"description":"The class type of the product offering."
},
"@baseType":{
"type":"string",
"description":"The base type of the product offering."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the product offering."
},
"isSellable":{
"type":"boolean",
"description":"A flag indicating whether this product offer can be sold as a standalone offer. If false, the offer can only be sold as part of a bundle."
},
"place":{
"type":"array",
"items":{
"$ref":"#/components/schemas/PlaceRef"
},
"description":"A list of places associated with the product offering."
},
"serviceLevelAgreement":{
"$ref":"#/components/schemas/SLARef",
"description":"The service level agreement associated with the product offering."
},
"productSpecification":{
"$ref":"#/components/schemas/ProductSpecificationRef",
"description":"The product specification associated with the product offering."
},
"channel":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ChannelRef"
},
"description":"A list of channels associated with the product offering."
},
"serviceCandidate":{
"$ref":"#/components/schemas/ServiceCandidateRefOracle",
"description":"The service candidate associated with the product offering."
},
"attachment":{
"type":"array",
"items":{
"anyOf":[
{
"$ref":"#/components/schemas/Attachment"
},
{
"$ref":"#/components/schemas/AttachmentOracle"
},
{
"$ref":"#/components/schemas/AttachmentRef"
}
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"Attachment":"#/components/schemas/Attachment",
"AttachmentOracle":"#/components/schemas/AttachmentOracle",
"AttachmentRef":"#/components/schemas/AttachmentRef"
}
}
},
"description":"A list of attachments associated with the product offering."
},
"category":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CategoryRef"
},
"description":"A list of categories associated with the product offering."
},
"resourceCandidate":{
"$ref":"#/components/schemas/ResourceCandidateRef",
"description":"The resource candidate associated with the product offering."
},
"productOfferingTerm":{
"type":"array",
"items":{
"anyOf":[
{
"$ref":"#/components/schemas/ProductOfferingTermOracle"
},
{
"$ref":"#/components/schemas/ServiceEntitlementOfferTermOracle"
},
{
"$ref":"#/components/schemas/CommitmentTermOracle"
},
{
"$ref":"#/components/schemas/SubscriptionTermOracle"
},
{
"$ref":"#/components/schemas/PaymentTermOracle"
}
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"ProductOfferingTermOracle":"#/components/schemas/ProductOfferingTermOracle",
"ServiceEntitlementOfferTermOracle":"#/components/schemas/ServiceEntitlementOfferTermOracle",
"CommitmentTermOracle":"#/components/schemas/CommitmentTermOracle",
"SubscriptionTermOracle":"#/components/schemas/SubscriptionTermOracle",
"PaymentTermOracle":"#/components/schemas/PaymentTermOracle"
}
}
},
"description":"A list of product offering terms associated with the product offering."
},
"marketSegment":{
"type":"array",
"items":{
"$ref":"#/components/schemas/MarketSegmentRef"
},
"description":"A list of market segments associated with the product offering."
},
"productOfferingPrice":{
"type":"array",
"items":{
"anyOf":[
{
"$ref":"#/components/schemas/ProductOfferingPriceRef"
},
{
"$ref":"#/components/schemas/ProductOfferingPriceRefOracle"
}
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"ProductOfferingPriceRef":"#/components/schemas/ProductOfferingPriceRef",
"ProductOfferingPriceRefOracle":"#/components/schemas/ProductOfferingPriceRefOracle"
}
}
},
"description":"A list of product offering prices associated with the product offering."
},
"agreement":{
"type":"array",
"items":{
"$ref":"#/components/schemas/AgreementRef"
},
"description":"A list of agreements associated with the product offering."
},
"bundledProductOffering":{
"type":"array",
"items":{
"anyOf":[
{
"$ref":"#/components/schemas/BundledProductOffering"
},
{
"$ref":"#/components/schemas/BundledProductOfferingChoiceOracle"
},
{
"$ref":"#/components/schemas/BundledProductOfferingOracle"
}
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"BundledProductOffering":"#/components/schemas/BundledProductOffering",
"BundledProductOfferingChoiceOracle":"#/components/schemas/BundledProductOfferingChoiceOracle",
"BundledProductOfferingOracle":"#/components/schemas/BundledProductOfferingOracle"
}
}
},
"description":"A list of bundled product offerings associated with the product offering."
},
"bundledGroupProductOffering":{
"type":"array",
"description":"A BundledGroupProductOffering. A group of ProductOfferings that can be selected for instantiation, for example between 2 and 7 from a list of 15 channel packs.",
"items":{
"$ref":"#/components/schemas/BundledGroupProductOfferingOracle"
}
},
"prodSpecCharValueUse":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ProductSpecificationCharacteristicValueUseOracle"
},
"description":"A list of prod specification characteristic value uses associated with the product offering."
},
"specCharValueUse":{
"type":"array",
"items":{
"$ref":"#/components/schemas/SpecCharValueUse"
},
"description":"A list of spec characteristic value uses associated with the product offering."
}
},
"required":[
"@type"
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"ProductOffering":"#/components/schemas/ProductOffering",
"ProductOfferingOracle":"#/components/schemas/ProductOfferingOracle"
}
},
"description":"The product offering resource."
},
"ProductOfferingOracle":{
"title":"ProductOfferingOracle",
"allOf":[
{
"$ref":"#/components/schemas/ProductOffering"
},
{
"type":"object",
"properties":{
"productLine":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ProductLineRef"
},
"description":"A list of product lines associated with the product offering."
},
"productOfferingCharacteristic":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ProductOfferCharacteristicOracle"
},
"description":"A list of product offering characteristics associated with the product offering."
},
"productOfferingInfo":{
"$ref":"#/components/schemas/ProductOfferingInfoOracle",
"description":"The product offering information."
},
"project":{
"$ref":"#/components/schemas/ProjectRef",
"description":"The project associated with the product offering."
},
"banner":{
"type":"array",
"items":{
"$ref":"#/components/schemas/BannerOracle"
},
"description":"A list of banners associated with the product offering."
},
"marketingFeature":{
"type":"array",
"items":{
"$ref":"#/components/schemas/FeatureOracle"
},
"description":"A list of marketing features associated with the product offering."
},
"approver":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ApproverRef"
},
"description":"A list of approvers associated with the product offering."
},
"approvalInfo":{
"$ref":"#/components/schemas/ApprovalInfoOracle",
"description":"The approval information for the product offering."
},
"created":{
"type":"string",
"format":"date-time",
"description":"The date and time of the creation."
},
"createdBy":{
"type":"string",
"description":"The name of the person who created item."
},
"lastUpdatedBy":{
"type":"string",
"description":"The name of the person who updated item."
},
"pricelist":{
"type":"array",
"items":{
"$ref":"#/components/schemas/PriceListGroupRefOracle"
},
"description":"A list of pricelists associated with the product offering."
},
"pricePlanRelationship":{
"type":"array",
"items":{
"$ref":"#/components/schemas/PricePlanRelationshipOracle"
},
"description":"A list of price plan relationships associated with the product offering."
},
"approvalHistory":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ApprovalHistory"
},
"description":"A list of approval histories associated with the product offering."
},
"usedBy":{
"type":"array",
"readOnly":true,
"items":{
"$ref":"#/components/schemas/UsedByRef"
},
"description":"A list of used bies associated with the product offering."
},
"choiceRelationship":{
"$ref":"#/components/schemas/ChoiceRelationshipOracle",
"description":"The choice relationship for the product offering."
},
"customProfileSpec":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CustomProfileSpecRefOracle"
},
"description":"A list of custom profile specifications associated with the product offering."
},
"customProfSpecCharValueUse":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CustomProfSpecCharValueUse"
},
"description":"A list of custom prof specification characteristic value uses associated with the product offering."
},
"externalConfigurationProperties":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ExternalConfigurationPropertiesOracle"
},
"description":"A list of external configuration properties associated with the product offering."
},
"externalId":{
"type":"string",
"description":"The ID of the external associated with the product offering."
},
"applicationName":{
"type":"string",
"description":"The name of the application associated with the product offering."
},
"searchTag":{
"type":"array",
"items":{
"type":"string",
"description":"The searchTag."
},
"description":"A list of search tags associated with the product offering."
},
"versionState":{
"type":"number",
"description":"The version state of the productOffering."
},
"commercialName":{
"type":"string",
"description":"The name of the commercial associated with the product offering."
},
"isDynamic":{
"type":"boolean",
"description":"Whether the product offering is dynamic."
},
"businessUnitId":{
"type":"number",
"description":"The ID of the business unit associated with the product offering."
},
"businessUnitName":{
"type":"string",
"description":"The name of the business unit associated with the product offering."
},
"productOfferingRelationship":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ProductOfferingRelationship"
},
"description":"A list of product offering relationships associated with the product offering."
},
"policySpecificationTerm":{
"$ref":"#/components/schemas/CustomProfileSpecRefOracle",
"description":"The policy specification term for the product offering."
},
"taxSupplier":{
"type":"array",
"items":{
"$ref":"#/components/schemas/TaxServiceProviderRefOracle"
},
"description":"A list of tax suppliers associated with the product offering."
}
},
"required":[
"productOfferingInfo"
]
}
]
},
"UsedByRef":{
"title":"UsedByRef",
"type":"object",
"description":"A reference to a resource that is aggregating another top-level resource.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the used by reference."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the used by reference."
},
"name":{
"type":"string",
"description":"The name of the used by reference."
},
"version":{
"type":"string",
"description":"The version of the using item."
},
"@referredType":{
"type":"string",
"description":"The type of the referred used by reference."
},
"@baseType":{
"type":"string",
"description":"The base type of the used by reference."
},
"referenceType":{
"type":"string",
"description":"The type or classification of the used by reference.",
"enum":[
"PACKAGE",
"COMMERCIAL_BUNDLE",
"SERVICE_BUNDLE",
"SERVICE",
"DEVICE",
"ACCESSORY",
"CHOICE",
"AGGREGATION",
"AWARD",
"DISCOUNT",
"TRADE_IN",
"COMPATIBILITY",
"ELIGIBILITY",
"MIGRATION",
"RECOMMENDATION",
"POLICY",
"DEVICE_SPEC",
"CHARGING_TERM",
"SUSPENSION_TERM",
"RETURN_CHECKLIST",
"ENTITY_PROFILE",
"PRODUCT_LINE",
"PRODUCT_OFFERING_PRICE",
"CATALOG",
"CATEGORY",
"PRODUCT_SPECIFICATION",
"USAGE_SPECIFICATION",
"SERVICE_SPECIFICATION"
]
}
}
},
"PriceListRefOracle":{
"title":"PriceListRefOracle",
"type":"object",
"description":"The pricelist reference.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the price list reference."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the price list reference."
},
"version":{
"type":"string",
"description":"The version of the pricelist."
},
"name":{
"type":"string",
"description":"The name of the price list reference."
},
"@type":{
"type":"string",
"description":"The class type of the price list reference."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the price list reference."
},
"@baseType":{
"type":"string",
"description":"The base type of the price list reference."
},
"@referredType":{
"type":"string",
"description":"The type of the referred price list reference."
},
"versionState":{
"type":"number",
"description":"The version state of the reference."
}
},
"required":[
"id",
"@type",
"@referredType"
]
},
"PriceListGroupRefOracle":{
"title":"PriceListGroupRefOracle",
"type":"object",
"description":"The price list group reference.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the price list group reference."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the price list group reference."
},
"version":{
"type":"string",
"description":"The version of the price list group reference."
},
"name":{
"type":"string",
"description":"The name of the price list group reference."
},
"@type":{
"type":"string",
"description":"The class type of the price list group reference."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the price list group reference."
},
"@baseType":{
"type":"string",
"description":"The base type of the price list group reference."
},
"@referredType":{
"type":"string",
"description":"The type of the referred price list group reference."
},
"productOfferingPrice":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ProductOfferingPriceRef"
},
"required":[
"id"
],
"description":"A list of product offering prices associated with the price list group reference."
},
"productOfferingTerm":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ProductOfferingTermSummaryOracle"
},
"description":"A list of product offering terms associated with the price list group reference."
}
},
"required":[
"id",
"@type",
"@referredType"
]
},
"TimePeriodRelativeOracle":{
"title":"TimePeriodRelativeOracle",
"type":"object",
"description":"The relative validity period of the related party.",
"properties":{
"startRelativeDateTime":{
"$ref":"#/components/schemas/RelativeTimeOffsetOracle",
"description":"The relative start date and time of the time period."
},
"endRelativeDateTime":{
"$ref":"#/components/schemas/RelativeTimeOffsetOracle",
"description":"The relative end date and time of the time period."
}
}
},
"RelativeTimeOffsetOracle":{
"title":"RelativeTimeOffsetOracle",
"type":"object",
"description":"The relative time offset resource.",
"properties":{
"relativeEvent":{
"type":"string",
"description":"The relative time offset event."
},
"offSetunit":{
"type":"string",
"description":"The relative time offset unit."
},
"offsetValue":{
"type":"integer",
"description":"The value assigned to the relative time offset."
}
}
},
"BalanceElementRef":{
"title":"BalanceElementRef",
"type":"object",
"description":"The balance element ref in price.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the balance element reference."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the balance element reference."
},
"version":{
"type":"string",
"description":"The version of the balance element."
},
"name":{
"type":"string",
"description":"The name of the balance element reference."
},
"@type":{
"type":"string",
"description":"The class type of the balance element reference."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the balance element reference."
},
"@baseType":{
"type":"string",
"description":"The base type of the balance element reference."
},
"@referredType":{
"type":"string",
"description":"The type of the referred balance element reference."
},
"versionState":{
"type":"number",
"description":"The version state of the reference."
}
},
"required":[
"id",
"@type",
"@referredType"
]
},
"PricePlanRelationshipOracle":{
"title":"PricePlanRelationshipOracle",
"allOf":[
{
"$ref":"#/components/schemas/ProductOfferingPriceRef"
},
{
"type":"object",
"properties":{
"version":{
"type":"string",
"description":"The version of the PricePlanRelationship being referred."
},
"appliesTo":{
"type":"string",
"description":"The bring in a open ended definition of alteration that specifies how price plan applicable to the offer. Valid values are ALL, ONE_TIME, RECURRING, and USAGE.",
"enum":[
"ALL",
"ONE_TIME",
"RECURRING",
"USAGE"
]
},
"popRelationship":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ProductOfferingPriceRelationshipOracle"
},
"description":"A list of pop relationships associated with the price plan relationship."
},
"applicableProductOffering":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ApplicableProductOfferingOracle"
},
"description":"A list of applicable product offerings associated with the price plan relationship."
}
}
}
]
},
"ApplicableProductOfferingOracle":{
"title":"ApplicableProductOfferingOracle",
"allOf":[
{
"$ref":"#/components/schemas/ProductOfferingRef"
},
{
"type":"object",
"properties":{
"relationshipHierarchy":{
"type":"string",
"description":"The hierarchy of the bundle offer tree."
},
"version":{
"type":"string",
"description":"The version of the referred offering."
}
}
}
]
},
"ProductOfferingRelationship":{
"title":"ProductOfferingRelationship",
"type":"object",
"description":"The relationship between/among product offerings.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the product offering relationship."
},
"name":{
"type":"string",
"description":"The name of the product offering relationship."
},
"relationshipType":{
"type":"string",
"description":"The type or classification of the product offering relationship. Valid values are AGGREGATION, MIGRATION, SUBSTITUTION, DEPENDENCY, EXCLUSIVITY, and PARENT.",
"enum":[
"AGGREGATION",
"MIGRATION",
"SUBSTITUTION",
"DEPENDENCY",
"EXCLUSIVITY",
"PARENT"
]
},
"role":{
"type":"string",
"description":"The role of the product productOffering relationship."
},
"validFor":{
"$ref":"#/components/schemas/TimePeriodOracle",
"description":"The period for which the product offering relationship is valid."
},
"@type":{
"type":"string",
"description":"The class type of the product offering relationship."
},
"@baseType":{
"type":"string",
"description":"The base type of the product offering relationship."
},
"@schemaLocation":{
"type":"string",
"format":"uri",
"description":"The URI of the schema that defines the product offering relationship."
}
},
"required":[
"id"
]
},
"ProductSpecification":{
"title":"ProductSpecification",
"type":"object",
"properties":{
"id":{
"type":"string",
"maxLength":30,
"description":"The ID of the product specification."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the product specification."
},
"name":{
"type":"string",
"description":"The name of the product specification."
},
"description":{
"type":"string",
"description":"A narrative that explains in detail what the product specification is."
},
"brand":{
"type":"string",
"description":"The manufacturer or trademark of the specification."
},
"isBundle":{
"type":"boolean",
"description":"Determines whether a product specification represents a single product specification (false) or a bundle of product specifications (true)."
},
"lastUpdate":{
"type":"string",
"format":"date-time",
"description":"The date and time when the product specification was last updated."
},
"lifecycleStatus":{
"type":"string",
"description":"The status of the product specification."
},
"productNumber":{
"type":"string",
"description":"The product number associated with the product specification."
},
"validFor":{
"$ref":"#/components/schemas/TimePeriod",
"description":"The period for which the product specification is valid."
},
"version":{
"type":"string",
"description":"The product specification version."
},
"@type":{
"type":"string",
"description":"The class type of the product specification."
},
"@baseType":{
"type":"string",
"description":"The base type of the product specification."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the product specification."
},
"relatedParty":{
"type":"array",
"items":{
"$ref":"#/components/schemas/RelatedPartyRefOrPartyRoleRef"
},
"description":"A list of related parties associated with the product specification."
},
"productSpecCharacteristic":{
"type":"array",
"items":{
"anyOf":[
{
"$ref":"#/components/schemas/CharacteristicSpecificationOracle"
},
{
"$ref":"#/components/schemas/AttributeRefOracle"
}
]
},
"description":"A list of product specification characteristics associated with the product specification."
},
"serviceSpecification":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ServiceSpecificationRefOracle"
},
"description":"A list of service specifications associated with the product specification."
},
"targetProductSchema":{
"$ref":"#/components/schemas/TargetProductSchema",
"description":"The target product schema for the product specification."
},
"productSpecificationRelationship":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ProductSpecificationRelationship"
},
"description":"A list of product specification relationships associated with the product specification."
},
"resourceSpecification":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ResourceSpecificationRef"
},
"description":"A list of resource specifications associated with the product specification."
},
"attachment":{
"type":"array",
"items":{
"anyOf":[
{
"$ref":"#/components/schemas/Attachment"
},
{
"$ref":"#/components/schemas/AttachmentOracle"
},
{
"$ref":"#/components/schemas/AttachmentRef"
}
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"Attachment":"#/components/schemas/Attachment",
"AttachmentOracle":"#/components/schemas/AttachmentOracle",
"AttachmentRef":"#/components/schemas/AttachmentRef"
}
}
},
"description":"A list of attachments associated with the product specification."
},
"bundledProductSpecification":{
"type":"array",
"items":{
"$ref":"#/components/schemas/BundledProductSpecification"
},
"description":"A list of bundled product specifications associated with the product specification."
}
},
"required":[
"name",
"@type"
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"ProductSpecification":"#/components/schemas/ProductSpecification",
"ProductSpecificationOracle":"#/components/schemas/ProductSpecificationOracle"
}
},
"description":"The product specification resource."
},
"ProductSpecificationOracle":{
"title":"ProductSpecificationOracle",
"allOf":[
{
"$ref":"#/components/schemas/ProductSpecification"
},
{
"type":"object",
"properties":{
"category":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CategoryRef"
},
"description":"A list of categories associated with the product specification."
},
"project":{
"$ref":"#/components/schemas/ProjectRef",
"description":"The project associated with the product specification."
},
"created":{
"type":"string",
"format":"date-time",
"description":"The date and time of the creation."
},
"createdBy":{
"type":"string",
"description":"The name of the person who created item."
},
"lastUpdatedBy":{
"type":"string",
"description":"The name of the person who updated item."
},
"usageSpecification":{
"type":"array",
"items":{
"$ref":"#/components/schemas/UsageSpecificationRefOracle"
},
"description":"A list of usage specifications associated with the product specification."
},
"customerProfileSpecification":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CustomerProfileSpecificationRef"
},
"description":"A list of customer profile specifications associated with the product specification."
},
"usedBy":{
"type":"array",
"items":{
"$ref":"#/components/schemas/UsedByRef"
},
"description":"A list of used bies associated with the product specification."
},
"customProfileSpec":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CustomProfileSpecRefOracle"
},
"description":"A list of custom profile specifications associated with the product specification."
},
"externalId":{
"type":"string",
"description":"The ID of the external associated with the product specification."
},
"applicationName":{
"type":"string",
"description":"The name of the application associated with the product specification."
},
"versionState":{
"type":"number",
"description":"The version state of the Product Specification."
}
}
}
]
},
"ProductOfferingPrice":{
"title":"ProductOfferingPrice",
"type":"object",
"properties":{
"id":{
"type":"string",
"maxLength":30,
"description":"The ID of the product offering price."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the product offering price."
},
"name":{
"type":"string",
"description":"The name of the product offering price."
},
"description":{
"type":"string",
"description":"The description of the product offering price."
},
"version":{
"type":"string",
"description":"The product offering price version."
},
"glid":{
"type":"string",
"description":"The general ledger ID associated with the product offering price."
},
"discountable":{
"type":"boolean",
"description":"Whether the product offering price is discountable."
},
"billOnPurchase":{
"type":"boolean",
"description":"Whether the product offering price has bill on purchase."
},
"validFor":{
"$ref":"#/components/schemas/TimePeriod",
"description":"The period for which the product offering price is valid."
},
"priceType":{
"type":"string",
"description":"The type or classification of the product offering price.",
"enum":[
"RECURRING",
"ONE_TIME",
"USAGE",
"ALTERATION",
"ALLOWANCE",
"ALLOWANCE_GRANT",
"OVERAGE",
"PENALTY",
"ONE_TIME_PRICE_PLAN",
"RECURRING_PRICE_PLAN",
"USAGE_PRICE_PLAN",
"ALTERATION_PRICE_PLAN",
"OVERAGE_PRICE_PLAN",
"COUNTER",
"ROLLOVER"
]
},
"unitOfMeasure":{
"$ref":"#/components/schemas/Quantity",
"description":"The unit of measure for the product offering price."
},
"recurringChargePeriodType":{
"type":"string",
"description":"The type or classification of the product offering price. Valid values are MONTHLY, BI_MONTHLY, QUARTERLY, SEMI_ANNUAL, ANNUAL, and DAILY.",
"enum":[
"MONTHLY",
"BI_MONTHLY",
"QUARTERLY",
"SEMI_ANNUAL",
"ANNUAL",
"DAILY"
]
},
"recurringChargePeriodLength":{
"type":"integer",
"description":"The period of the recurring charge. For recurring price, if no value is provided for this field, it will be set to 1."
},
"@type":{
"type":"string",
"description":"The class type of the product offering price."
},
"@baseType":{
"type":"string",
"description":"The base type of the product offering price."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the product offering price."
},
"isBundle":{
"type":"boolean",
"description":"Whether the product offering price is bundle."
},
"lastUpdate":{
"type":"string",
"format":"date-time",
"description":"The date and time when the product offering price was last updated."
},
"lifecycleStatus":{
"type":"string",
"description":"The status of the product offering price."
},
"price":{
"$ref":"#/components/schemas/Money",
"description":"The product offering price."
},
"percentage":{
"type":"number",
"description":"The percentage to apply for ProdOfferPriceAlteration."
},
"bundledPopRelationship":{
"type":"array",
"items":{
"$ref":"#/components/schemas/BundledProductOfferingPriceRelationship"
},
"description":"A list of bundled pop relationships associated with the product offering price."
},
"popRelationship":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ProductOfferingPriceRelationship"
},
"description":"A list of pop relationships associated with the product offering price."
},
"prodSpecCharValueUse":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ProductSpecificationCharacteristicValueUse"
},
"description":"A list of prod specification characteristic value uses associated with the product offering price."
},
"specCharValueUse":{
"type":"array",
"items":{
"$ref":"#/components/schemas/SpecCharValueUse"
},
"description":"A list of spec characteristic value uses associated with the product offering price."
},
"productOfferingTerm":{
"type":"array",
"items":{
"anyOf":[
{
"$ref":"#/components/schemas/ProductOfferingTermOracle"
},
{
"$ref":"#/components/schemas/ServiceEntitlementOfferTermOracle"
},
{
"$ref":"#/components/schemas/CommitmentTermOracle"
},
{
"$ref":"#/components/schemas/SubscriptionTermOracle"
},
{
"$ref":"#/components/schemas/PaymentTermOracle"
}
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"ProductOfferingTermOracle":"#/components/schemas/ProductOfferingTermOracle",
"ServiceEntitlementOfferTermOracle":"#/components/schemas/ServiceEntitlementOfferTermOracle",
"CommitmentTermOracle":"#/components/schemas/CommitmentTermOracle",
"SubscriptionTermOracle":"#/components/schemas/SubscriptionTermOracle",
"PaymentTermOracle":"#/components/schemas/PaymentTermOracle"
}
}
},
"description":"A list of product offering terms associated with the product offering price."
},
"place":{
"type":"array",
"items":{
"$ref":"#/components/schemas/PlaceRef"
},
"description":"A list of places associated with the product offering price."
},
"policy":{
"type":"array",
"items":{
"$ref":"#/components/schemas/PolicyRef"
},
"description":"A list of policies associated with the product offering price."
},
"pricingLogicAlgorithm":{
"type":"array",
"items":{
"$ref":"#/components/schemas/PricingLogicAlgorithmRef"
},
"description":"A list of pricing logic algorithms associated with the product offering price."
},
"tax":{
"type":"array",
"items":{
"$ref":"#/components/schemas/TaxItem"
},
"description":"A list of taxes associated with the product offering price."
},
"alterationBasedOn":{
"$ref":"#/components/schemas/AlterationBasedOnOracle",
"description":"The basis on which the product offering price alteration is calculated."
},
"alterationExpression":{
"type":"array",
"items":{
"$ref":"#/components/schemas/AlterationExpressionOracle"
},
"description":"A list of alteration expressions associated with the product offering price."
}
},
"required":[
"@type"
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"ProductOfferingPrice":"#/components/schemas/ProductOfferingPrice",
"ProductOfferingPriceOracle":"#/components/schemas/ProductOfferingPriceOracle",
"ProductOfferPriceAlterationOracle":"#/components/schemas/ProductOfferingPriceAlterationOracle",
"ProductOfferPriceAllowanceOracle":"#/components/schemas/ProductOfferingPriceAllowanceOracle",
"ProductOfferRolloverPriceOracle":"#/components/schemas/ProductOfferRolloverPriceOracle",
"ProductOfferingBeatPriceOracle":"#/components/schemas/ProductOfferingBeatPriceOracle",
"ProductOfferPriceCounterOracle":"#/components/schemas/ProductOfferingPriceCounterOracle",
"ProductOfferPriceOverageOracle":"#/components/schemas/ProductOfferingPriceOverageOracle",
"ProductOfferPricePlanOracle":"#/components/schemas/ProductOfferingPricePlanOracle",
"PenaltyPriceOracle":"#/components/schemas/PenaltyPriceOracle"
}
},
"description":"The product offering price resource."
},
"ProductOfferingPriceOracle":{
"title":"ProductOfferingPriceOracle",
"allOf":[
{
"$ref":"#/components/schemas/ProductOfferingPrice"
},
{
"type":"object",
"properties":{
"project":{
"$ref":"#/components/schemas/ProjectRef",
"description":"The project associated with the product offering price."
},
"created":{
"type":"string",
"format":"date-time",
"description":"The date and time of the creation."
},
"createdBy":{
"type":"string",
"description":"The name of the person who created item."
},
"lastUpdatedBy":{
"type":"string",
"description":"The name of the person who updated item."
},
"isTaxInclusive":{
"type":"boolean",
"description":"Whether the product offering price is tax inclusive."
},
"priceSubType":{
"type":"string",
"description":"The type or classification of the product offering price.",
"enum":[
"INSTALLMENT",
"LEASE",
"MIN_DOWNPAYMENT",
"UPGRADE_FEE",
"MIGRATION_FEE",
"PRICE_PLA",
"DEPOSIT",
"DOWNGRADE",
"EARLY_TERMINATION",
"PURCH_OPTION",
"LEASE_TOTAL",
"COMPOSITE_ALTRN",
"NON_CURRENCY_ALTRN",
"LEASE_DEFERRED_AMOUNT",
"VALUE_INCREMENT",
"VALUE_DECREMENT",
"PERCENT_INCREMENT",
"PERCENT_DECREMENT"
]
},
"priceTag":{
"type":"string",
"description":"The priceTag for the price."
},
"oneTimeFeeType":{
"type":"string",
"description":"The type or classification of the product offering price. Valid values are PURCHASE, CANCEL, and PENALTY.",
"enum":[
"PURCHASE",
"CANCEL",
"PENALTY"
]
},
"recurringFeeType":{
"type":"string",
"description":"The type or classification of the product offering price. Valid values are CYCLE, CYCLE_ARREAR, and CYCLE_FWD_ARREAR.",
"enum":[
"CYCLE",
"CYCLE_ARREAR",
"CYCLE_FWD_ARREAR"
]
},
"priceTagValueObject":{
"$ref":"#/components/schemas/PriceTagRefOracle",
"description":"The product offering price."
},
"pricelist":{
"type":"array",
"items":{
"$ref":"#/components/schemas/PriceListRefOracle"
},
"description":"A list of pricelists associated with the product offering price."
},
"customProfileSpec":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CustomProfileSpecRefOracle"
},
"description":"A list of custom profile specifications associated with the product offering price."
},
"usageSpecification":{
"$ref":"#/components/schemas/UsageSpecificationRefOracle",
"description":"The usage specification associated with the product offering price."
},
"balanceElement":{
"type":"array",
"items":{
"$ref":"#/components/schemas/BalanceElementRef"
},
"description":"A list of balance elements associated with the product offering price."
},
"relativeValidFor":{
"$ref":"#/components/schemas/TimePeriodRelativeOracle",
"description":"The relative time period during which the product offering price is valid."
},
"externalId":{
"type":"string",
"description":"The ID of the external associated with the product offering price."
},
"applicationName":{
"type":"string",
"description":"The name of the application associated with the product offering price."
},
"versionState":{
"type":"number",
"description":"The version state of the productOfferingPrice."
},
"triggerConditionGroup":{
"type":"array",
"items":{
"$ref":"#/components/schemas/TriggerConditionGroupOracle"
},
"description":"A list of trigger condition groups associated with the product offering price."
},
"counter":{
"type":"array",
"items":{
"anyOf":[
{
"$ref":"#/components/schemas/ProductOfferingPriceRef"
},
{
"$ref":"#/components/schemas/ProductOfferingPriceWOCounterOracle"
}
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"ProductOfferingPriceRef":"#/components/schemas/ProductOfferingPriceRef",
"ProductOfferingPriceCounterOracle":"#/components/schemas/ProductOfferingPriceWOCounterOracle"
}
}
},
"description":"A list of counters associated with the product offering price."
},
"alterationAppliedOn":{
"type":"string",
"description":"Indicates sharing option for the alteration price. Valid values are USER_BALANCE and SHARER_BALANCE.",
"enum":[
"USER_BALANCE",
"SHARER_BALANCE"
]
},
"discountMode":{
"type":"string",
"description":"Indicates the mode of processing discounts. Valid values are SEQUENTIAL and PARALLEL.",
"enum":[
"SEQUENTIAL",
"PARALLEL"
]
},
"chargeType":{
"type":"string",
"description":"The type or classification of the product offering price. Valid values are DEBIT, and CREDIT.",
"enum":[
"DEBIT",
"CREDIT"
]
}
},
"discriminator":{
"propertyName":"@type",
"mapping":{
"ProductOfferingPriceOracle":"#/components/schemas/ProductOfferingPriceOracle",
"ProductOfferPriceAlterationOracle":"#/components/schemas/ProductOfferingPriceAlterationOracle",
"ProductOfferPriceAllowanceOracle":"#/components/schemas/ProductOfferingPriceAllowanceOracle",
"ProductOfferRolloverPriceOracle":"#/components/schemas/ProductOfferRolloverPriceOracle",
"ProductOfferingBeatPriceOracle":"#/components/schemas/ProductOfferingBeatPriceOracle",
"ProductOfferPriceCounterOracle":"#/components/schemas/ProductOfferingPriceCounterOracle",
"ProductOfferPriceOverageOracle":"#/components/schemas/ProductOfferingPriceOverageOracle",
"ProductOfferPricePlanOracle":"#/components/schemas/ProductOfferingPricePlanOracle",
"PenaltyPriceOracle":"#/components/schemas/PenaltyPriceOracle"
}
}
}
]
},
"ProductOfferingPriceWOCounterOracle":{
"title":"ProductOfferingPriceWOCounterOracle",
"allOf":[
{
"$ref":"#/components/schemas/ProductOfferingPrice"
},
{
"type":"object",
"properties":{
"project":{
"$ref":"#/components/schemas/ProjectRef",
"description":"The product offering price without a counter."
},
"created":{
"type":"string",
"format":"date-time",
"description":"The date and time of the creation."
},
"createdBy":{
"type":"string",
"description":"The name of the person who created item."
},
"lastUpdatedBy":{
"type":"string",
"description":"The name of the person who updated item."
},
"isTaxInclusive":{
"type":"boolean",
"description":"Whether the product offering price without a counter is tax inclusive."
},
"priceSubType":{
"type":"string",
"description":"The type or classification of the product offering price without a counter.",
"enum":[
"INSTALLMENT",
"LEASE",
"MIN_DOWNPAYMENT",
"UPGRADE_FEE",
"MIGRATION_FEE",
"PRICE_PLA",
"DEPOSIT",
"DOWNGRADE",
"EARLY_TERMINATION",
"PURCH_OPTION",
"LEASE_TOTAL",
"COMPOSITE_ALTRN",
"NON_CURRENCY_ALTRN",
"LEASE_DEFERRED_AMOUNT",
"VALUE_INCREMENT",
"VALUE_DECREMENT",
"PERCENT_INCREMENT",
"PERCENT_DECREMENT"
]
},
"priceTag":{
"type":"string",
"description":"The priceTag for the price."
},
"oneTimeFeeType":{
"type":"string",
"description":"The type or classification of the product offering price without a counter. Valid values are PURCHASE, CANCEL, and PENALTY.",
"enum":[
"PURCHASE",
"CANCEL",
"PENALTY"
]
},
"recurringFeeType":{
"type":"string",
"description":"The type or classification of the product offering price without a counter. Valid values are CYCLE, CYCLE_ARREAR, and CYCLE_FWD_ARREAR.",
"enum":[
"CYCLE",
"CYCLE_ARREAR",
"CYCLE_FWD_ARREAR"
]
},
"priceTagValueObject":{
"$ref":"#/components/schemas/PriceTagRefOracle",
"description":"The product offering price without a counter."
},
"pricelist":{
"type":"array",
"items":{
"$ref":"#/components/schemas/PriceListRefOracle"
},
"description":"A list of pricelists associated with the product offering price without a counter."
},
"customProfileSpec":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CustomProfileSpecRefOracle"
},
"description":"A list of custom profile specifications associated with the product offering price without a counter."
},
"usageSpecification":{
"$ref":"#/components/schemas/UsageSpecificationRefOracle",
"description":"The product offering price without a counter."
},
"balanceElement":{
"type":"array",
"items":{
"$ref":"#/components/schemas/BalanceElementRef"
},
"description":"A list of balance elements associated with the product offering price without a counter."
},
"relativeValidFor":{
"$ref":"#/components/schemas/TimePeriodRelativeOracle",
"description":"The product offering price without a counter."
},
"externalId":{
"type":"string",
"description":"The ID of the external associated with the product offering price without a counter."
},
"applicationName":{
"type":"string",
"description":"The name of the application associated with the product offering price without a counter."
},
"versionState":{
"type":"number",
"description":"The version state of the productOfferingPrice."
},
"triggerConditionGroup":{
"type":"array",
"items":{
"$ref":"#/components/schemas/TriggerConditionGroupOracle"
},
"description":"A list of trigger condition groups associated with the product offering price without a counter."
},
"alterationAppliedOn":{
"type":"string",
"description":"Indicates sharing option for the alteration price. Valid values are USER_BALANCE and SHARER_BALANCE.",
"enum":[
"USER_BALANCE",
"SHARER_BALANCE"
]
},
"discountMode":{
"type":"string",
"description":"Indicates the mode of processing discounts. Valid values are SEQUENTIAL and PARALLEL.",
"enum":[
"SEQUENTIAL",
"PARALLEL"
]
}
},
"discriminator":{
"propertyName":"@type",
"mapping":{
"ProductOfferingPriceOracle":"#/components/schemas/ProductOfferingPriceOracle",
"ProductOfferPriceAlterationOracle":"#/components/schemas/ProductOfferingPriceAlterationOracle",
"ProductOfferPriceAllowanceOracle":"#/components/schemas/ProductOfferingPriceAllowanceOracle",
"ProductOfferRolloverPriceOracle":"#/components/schemas/ProductOfferRolloverPriceOracle",
"ProductOfferPriceCounterOracle":"#/components/schemas/ProductOfferingPriceCounterOracle",
"ProductOfferPriceOverageOracle":"#/components/schemas/ProductOfferingPriceOverageOracle",
"ProductOfferPricePlanOracle":"#/components/schemas/ProductOfferingPricePlanOracle",
"PenaltyPriceOracle":"#/components/schemas/PenaltyPriceOracle"
}
}
}
]
},
"ProductOfferingPriceAlterationOracle":{
"title":"ProductOfferingPriceAlterationOracle",
"allOf":[
{
"$ref":"#/components/schemas/ProductOfferingPriceOracle"
},
{
"type":"object",
"properties":{
"priority":{
"type":"integer",
"description":"The priority of this resource represented in numerical value."
},
"discountEligibility":{
"$ref":"#/components/schemas/PriceEligibilityOracle",
"description":"The product offering price alteration."
},
"alterationType":{
"type":"string",
"description":"The type or classification of the product offering price alteration. Valid values are DISCOUNT, MARKUP, OVERRIDE, DISCOUNT_OVERRIDE, and CHARGE_SHARE.",
"enum":[
"DISCOUNT",
"MARKUP",
"OVERRIDE",
"DISCOUNT_OVERRIDE",
"CHARGE_SHARE"
]
}
}
}
]
},
"PenaltyPriceOracle":{
"title":"PenaltyPriceOracle",
"allOf":[
{
"$ref":"#/components/schemas/ProductOfferingPriceOracle"
},
{
"type":"object",
"properties":{
"prorationReductionTerm":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ProrationReductionTermOracle"
},
"description":"A list of proration reduction terms associated with the penalty price."
}
}
}
]
},
"TriggerConditionGroupOracle":{
"title":"TriggerConditionGroupOracle",
"type":"object",
"description":"The group of alteration trigger conditions related by a logical AND or logical OR relationship.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the trigger condition group."
},
"groupName":{
"type":"string",
"description":"The name of the group associated with the trigger condition group."
},
"triggerCondition":{
"type":"array",
"items":{
"$ref":"#/components/schemas/TriggerConditionOracle"
},
"description":"A list of trigger conditions associated with the trigger condition group."
},
"conditionLogicalRelationship":{
"type":"string",
"description":"The logical relation type amongst the TriggerConditionGroup. Valid values are AND, and OR.",
"enum":[
"AND",
"OR"
]
}
},
"required":[
"id"
]
},
"TriggerConditionOracle":{
"title":"TriggerConditionOracle",
"type":"object",
"description":"A trigger condition for an alteration.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the trigger condition."
},
"name":{
"type":"string",
"description":"A string. The name given to the alteration trigger condition."
},
"stringExpression":{
"type":"string",
"description":"A string. Unique ID of the trigger condition."
},
"triggerOperator":{
"type":"string",
"description":"The operator connecting the trigger expression and the value. Valid values are EQUAL, GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, NOT_EQUAL, and INLIST.",
"enum":[
"EQUAL",
"GREATER_THAN",
"LESS_THAN",
"GREATER_THAN_OR_EQUAL",
"LESS_THAN_OR_EQUAL",
"NOT_EQUAL",
"INLIST"
]
},
"triggerValue":{
"type":"string",
"description":"The value with which the trigger expression needs to be compared with."
},
"triggerExpression":{
"type":"array",
"items":{
"$ref":"#/components/schemas/TriggerExpressionOracle"
},
"description":"A list of trigger expressions associated with the trigger condition."
}
},
"required":[
"name"
]
},
"TriggerExpressionOracle":{
"type":"object",
"title":"TriggerExpressionOracle",
"properties":{
"id":{
"type":"string",
"description":"The ID of the trigger expression."
},
"operator":{
"type":"string",
"description":"The operator of the expression."
},
"expressionType":{
"type":"string",
"description":"The type or classification of the trigger expression. Valid values are UNARY, BINARY, NUMERIC, STRING, TRIGGERCHAR, and BALANCEOFRESOURCE.",
"enum":[
"UNARY",
"BINARY",
"NUMERIC",
"STRING",
"TRIGGERCHAR",
"BALANCEOFRESOURCE"
]
},
"value":{
"oneOf":[
{
"type":"string"
},
{
"type":"number"
},
{
"type":"boolean"
}
],
"description":"A discrete value that the relationship can take on."
},
"@type":{
"type":"string",
"description":"The class type of the trigger expression."
},
"@baseType":{
"type":"string",
"description":"The base type of the trigger expression."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the trigger expression."
},
"expressionRelationship":{
"type":"array",
"items":{
"$ref":"#/components/schemas/TriggerExpressionRelationshipOracle"
},
"description":"A list of expression relationships associated with the trigger expression."
}
},
"required":[
"expressionType",
"id",
"@type"
],
"description":"The trigger expression resource."
},
"TriggerExpressionRelationshipOracle":{
"type":"object",
"title":"TriggerExpressionRelationshipOracle",
"description":"The trigger expression relationship resource.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the trigger expression relationship."
},
"name":{
"type":"string",
"description":"The name of the trigger expression relationship."
},
"relationshipType":{
"type":"string",
"enum":[
"LEFT_HAND_SIDE",
"RIGHT_HAND_SIDE"
],
"description":"The type or classification of the trigger expression relationship. Valid values are LEFT_HAND_SIDE, and RIGHT_HAND_SIDE."
},
"@type":{
"type":"string",
"description":"The class type of the trigger expression relationship."
},
"@baseType":{
"type":"string",
"description":"The base type of the trigger expression relationship."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the trigger expression relationship."
}
},
"required":[
"relationshipType",
"id",
"@type"
]
},
"PriceEligibilityOracle":{
"title":"PriceEligibilityOracle",
"type":"object",
"description":"Specifies the eligibility rule for the offer.",
"properties":{
"id":{
"type":"string",
"description":"A string. Unique identifier of the pricing eligibility rule."
},
"name":{
"type":"string",
"description":"The name of the price eligibility."
},
"description":{
"type":"string",
"description":"A narrative text describing the eligibility rule."
},
"eligibilityExpression":{
"type":"array",
"items":{
"$ref":"#/components/schemas/EligibilityExpressionOracle"
},
"description":"A list of eligibility expressions associated with the price eligibility."
},
"active":{
"type":"boolean",
"description":"Whether the price eligibility has active."
},
"validFor":{
"$ref":"#/components/schemas/TimePeriodOracle",
"description":"The period for which the price eligibility is valid."
}
},
"required":[
"name"
]
},
"EligibilityExpressionOracle":{
"type":"object",
"title":"EligibilityExpressionOracle",
"description":"The eligibility expression resource.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the eligibility expression."
},
"operator":{
"type":"string",
"description":"The operator of the expression."
},
"expressionType":{
"type":"string",
"description":"The type or classification of the eligibility expression. Valid values are ARITHMATIC, NUMERIC, LOGICAL, CHARGE, QUANTITY, and BALANCE.",
"enum":[
"ARITHMATIC",
"NUMERIC",
"LOGICAL",
"CHARGE",
"QUANTITY",
"BALANCE"
]
},
"value":{
"oneOf":[
{
"type":"string"
},
{
"type":"number"
},
{
"type":"boolean"
}
],
"description":"A discrete value that the relationship can take on."
},
"@type":{
"type":"string",
"description":"The class type of the eligibility expression."
},
"@baseType":{
"type":"string",
"description":"The base type of the eligibility expression."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the eligibility expression."
},
"expressionRelationship":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ExpressionRelationship"
},
"description":"A list of expression relationships associated with the eligibility expression."
}
},
"required":[
"expressionType",
"id",
"@type"
]
},
"ExpressionRelationship":{
"type":"object",
"title":"ExpressionRelationship",
"description":"The expression relationship resource.",
"properties":{
"expressionId":{
"type":"string",
"description":"The ID of the expression associated with the expression relationship."
},
"name":{
"type":"string",
"description":"The name of the expression relationship."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the expression relationship."
},
"relationshipType":{
"type":"string",
"description":"The type or classification of the expression relationship. Valid values are LEFT_HAND_SIDE, and RIGHT_HAND_SIDE.",
"enum":[
"LEFT_HAND_SIDE",
"RIGHT_HAND_SIDE"
]
},
"@type":{
"type":"string",
"description":"The class type of the expression relationship."
},
"@baseType":{
"type":"string",
"description":"The base type of the expression relationship."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the expression relationship."
}
},
"required":[
"relationshipType",
"expressionId",
"@type"
]
},
"ProductOfferingPriceAllowanceOracle":{
"title":"ProductOfferingPriceAllowanceOracle",
"allOf":[
{
"$ref":"#/components/schemas/ProductOfferingPriceOracle"
},
{
"type":"object",
"properties":{
"shareAllowance":{
"type":"boolean",
"description":"Whether the product offering price allowance has share allowance."
},
"usageUnit":{
"type":"string",
"description":"Indicates the usage unit.",
"enum":[
"NONE",
"SECOND",
"MINUTE",
"HOUR",
"DAY",
"MONTH",
"BYTE",
"KILOBYTE",
"MEGABYTE",
"GIGABYTE",
"PAGES",
"MOVIES",
"TIME_INTERVAL",
"QUANTITY",
"MBPS",
"GBPS"
]
},
"allowanceValidity":{
"title":"AllowanceValidityOracle",
"type":"object",
"description":"The validity of allowance.",
"properties":{
"value":{
"type":"number",
"description":"The value assigned to the product offering price allowance."
},
"unit":{
"type":"string",
"description":"Indicates the unit of allowance validity. Valid values are SECOND, MINUTE, HOUR, DAY, MONTH, ACCOUNTING_CYCLE, and BILLING_CYCLE.",
"enum":[
"SECOND",
"MINUTE",
"HOUR",
"DAY",
"MONTH",
"ACCOUNTING_CYCLE",
"BILLING_CYCLE"
]
},
"startCriteria":{
"type":"string",
"description":"Indicates start criteria of allowance validity. Valid values are EVENT_OCCURRENCE and FIRST_USAGE.",
"enum":[
"EVENT_OCCURRENCE",
"FIRST_USAGE"
]
}
},
"required":[
"value",
"unit"
]
},
"ruleName":{
"type":"string",
"maxLength":50,
"description":"The name of the rule associated with the product offering price allowance."
},
"rulePriority":{
"type":"number",
"description":"Indicates the priority of the rule associated."
}
}
}
]
},
"ProductOfferRolloverPriceOracle":{
"title":"ProductOfferRolloverPriceOracle",
"allOf":[
{
"$ref":"#/components/schemas/ProductOfferingPriceOracle"
},
{
"type":"object",
"properties":{
"rolloverFrequency":{
"type":"string",
"description":"The period to repeat the rollover for. Valid values are MONTH.",
"enum":[
"MONTH"
]
},
"rolloverRules":{
"type":"array",
"items":{
"$ref":"#/components/schemas/RolloverRuleOracle"
},
"description":"A list of rollover rules associated with the product offer rollover price."
}
}
}
]
},
"ProductOfferingBeatPriceOracle":{
"title":"ProductOfferingBeatPriceOracle",
"allOf":[
{
"$ref":"#/components/schemas/ProductOfferingPriceOracle"
},
{
"type":"object",
"properties":{
"beat":{
"$ref":"#/components/schemas/BeatOracle",
"description":"The product offering beat price."
}
}
}
]
},
"ProductOfferingPriceCounterOracle":{
"title":"ProductOfferingPriceCounterOracle",
"allOf":[
{
"$ref":"#/components/schemas/ProductOfferingPriceOracle"
},
{
"type":"object",
"properties":{
"counterValidity":{
"title":"CounterValidityOracle",
"type":"object",
"description":"The validity of counter.",
"properties":{
"value":{
"type":"number",
"description":"The value assigned to the product offering price counter."
},
"unit":{
"type":"string",
"description":"Indicates the unit of counter validity. Valid values are SECOND, MINUTE, HOUR, DAY, MONTH, ACCOUNTING_CYCLE, and BILLING_CYCLE.",
"enum":[
"SECOND",
"MINUTE",
"HOUR",
"DAY",
"MONTH",
"ACCOUNTING_CYCLE",
"BILLING_CYCLE"
]
},
"startCriteria":{
"type":"string",
"description":"Indicates start criteria of counter validity. Valid values are EVENT_OCCURRENCE and FIRST_USAGE.",
"enum":[
"EVENT_OCCURRENCE",
"FIRST_USAGE"
]
}
},
"required":[
"value",
"unit"
]
}
}
}
]
},
"ProductOfferingPriceOverageOracle":{
"title":"ProductOfferingPriceOverageOracle",
"allOf":[
{
"$ref":"#/components/schemas/ProductOfferingPriceOracle"
},
{
"type":"object"
}
]
},
"ProductOfferingPricePlanOracle":{
"title":"ProductOfferingPricePlanOracle",
"allOf":[
{
"$ref":"#/components/schemas/ProductOfferingPriceOracle"
},
{
"type":"object",
"properties":{
"alterationType":{
"type":"string",
"description":"The type or classification of the product offering price plan. Valid values are DISCOUNT, MARKUP, OVERRIDE, and DISCOUNT_OVERRIDE.",
"enum":[
"DISCOUNT",
"MARKUP",
"OVERRIDE",
"DISCOUNT_OVERRIDE"
]
},
"priceRange":{
"type":"string",
"description":"Indicates the range of prices this price plan defines."
},
"compositePopRelationship":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CompositePopRelationshipOracle"
},
"description":"A list of composite pop relationships associated with the product offering price plan."
},
"usageSpecMeteringRuleUse":{
"type":"array",
"items":{
"$ref":"#/components/schemas/UsageSpecMeteringRuleUse"
},
"description":"A list of usage specification metering rule uses associated with the product offering price plan."
},
"ruleName":{
"type":"string",
"maxLength":50,
"description":"The name of the rule associated with the product offering price plan."
},
"rulePriority":{
"type":"number",
"description":"Indicates the priority of the rule associated."
}
}
}
]
},
"UsageSpecMeteringRuleUse":{
"title":"UsageSpecMeteringRuleUse",
"type":"object",
"description":"The metering rules used in the usage price plan.",
"properties":{
"name":{
"type":"string",
"description":"The name of the usage specification metering rule use."
},
"id":{
"type":"string",
"description":"The ID of the usage specification metering rule use."
},
"usageSpecification":{
"$ref":"#/components/schemas/UsageSpecificationRefOracle",
"description":"The usage specification metering rule use."
}
},
"required":[
"name",
"id",
"usageSpecification"
]
},
"PricingLogicAlgorithm":{
"title":"PricingLogicAlgorithm",
"type":"object",
"properties":{
"id":{
"type":"string",
"maxLength":30,
"description":"The ID of the pricing logic algorithm."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the pricing logic algorithm."
},
"name":{
"type":"string",
"description":"The name of the pricing logic algorithm."
},
"description":{
"type":"string",
"description":"The description of this pla."
},
"version":{
"type":"string",
"description":"The pla version."
},
"validFor":{
"$ref":"#/components/schemas/TimePeriod",
"description":"The period for which the pricing logic algorithm is valid."
},
"@type":{
"type":"string",
"description":"The class type of the pricing logic algorithm."
},
"@baseType":{
"type":"string",
"description":"The base type of the pricing logic algorithm."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the pricing logic algorithm."
},
"lifecycleStatus":{
"type":"string",
"description":"The status of the pricing logic algorithm."
},
"plaSpecification":{
"$ref":"#/components/schemas/PlaSpecificationRef",
"description":"The pricing logic algorithm."
},
"lastUpdate":{
"type":"string",
"format":"date-time",
"description":"The date and time when the pricing logic algorithm was last updated."
},
"customProfileSpec":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CustomProfileSpecRefOracle"
},
"description":"A list of custom profile specifications associated with the pricing logic algorithm."
}
},
"required":[
"@type"
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"PricingLogicAlgorithm":"#/components/schemas/PricingLogicAlgorithm",
"PlaQuantityRangeOracle":"#/components/schemas/PlaQuantityRangeOracle"
}
},
"description":"The pricing logic algorithm resource."
},
"PlaQuantityRangeOracle":{
"title":"PlaQuantityRangeOracle",
"allOf":[
{
"$ref":"#/components/schemas/PricingLogicAlgorithm"
},
{
"type":"object",
"properties":{
"plaCharacteristic":{
"type":"array",
"items":{
"title":"plaCharacteristic",
"$ref":"#/components/schemas/PlaCharacteristicOracle"
},
"description":"A list of pla characteristics associated with the pricing logic algorithm quantity range."
},
"pricingType":{
"type":"string",
"description":"The type or classification of the pricing logic algorithm quantity range. Valid values are SIMPLE, and TIERED.",
"enum":[
"SIMPLE",
"TIERED"
]
},
"tierRange":{
"type":"array",
"items":{
"$ref":"#/components/schemas/TierRangeOracle"
},
"description":"A list of tier ranges associated with the pricing logic algorithm quantity range."
},
"project":{
"$ref":"#/components/schemas/ProjectRef",
"description":"The pricing logic algorithm quantity range."
},
"lastUpdate":{
"type":"string",
"format":"date-time",
"description":"The date and time when the pricing logic algorithm quantity range was last updated."
},
"created":{
"type":"string",
"format":"date-time",
"description":"The date and time of the creation."
},
"createdBy":{
"type":"string",
"description":"The name of the person who created item."
},
"lastUpdatedBy":{
"type":"string",
"description":"The name of the person who updated item."
},
"externalId":{
"type":"string",
"description":"The ID of the external associated with the pricing logic algorithm quantity range."
},
"applicationName":{
"type":"string",
"description":"The name of the application associated with the pricing logic algorithm quantity range."
},
"versionState":{
"type":"number",
"description":"The version state of the Pricing Logic Algorithm."
}
}
}
]
},
"ProductLine":{
"title":"ProductLine",
"type":"object",
"description":"The entity that groups product offerings.",
"properties":{
"id":{
"type":"string",
"maxLength":30,
"description":"The ID of the product line."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the product line."
},
"name":{
"type":"string",
"description":"The name of the product line."
},
"description":{
"type":"string",
"description":"The description of the product line."
},
"lastUpdate":{
"type":"string",
"format":"date-time",
"description":"The date and time when the product line was last updated."
},
"lifecycleStatus":{
"type":"string",
"description":"The status of the product line."
},
"version":{
"type":"string",
"description":"The product line version."
},
"validFor":{
"$ref":"#/components/schemas/TimePeriodOracle",
"description":"The period for which the product line is valid."
},
"@type":{
"type":"string",
"description":"The class type of the product line."
},
"@baseType":{
"type":"string",
"description":"The base type of the product line."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the product line."
}
},
"required":[
"name",
"@type"
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"ProductLine":"#/components/schemas/ProductLine",
"ProductLineOracle":"#/components/schemas/ProductLineOracle"
}
}
},
"ProductLineOracle":{
"title":"ProductLineOracle",
"allOf":[
{
"$ref":"#/components/schemas/ProductLine"
},
{
"type":"object",
"properties":{
"created":{
"type":"string",
"format":"date-time",
"description":"The date and time of creation."
},
"createdBy":{
"type":"string",
"description":"The name of the person who created item."
},
"lastUpdatedBy":{
"type":"string",
"description":"The name of the person who updated item."
},
"productOffering":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ProductOfferingRefOracle"
},
"description":"A list of product offerings associated with the product line."
},
"project":{
"$ref":"#/components/schemas/ProjectRef",
"description":"The product line."
},
"compatibilityRules":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CompatibilityRulesOracle"
},
"description":"A list of compatibility rules associated with the product line."
},
"externalId":{
"type":"string",
"description":"The ID of the external associated with the product line."
},
"applicationName":{
"type":"string",
"description":"The name of the application associated with the product line."
},
"versionState":{
"type":"number",
"description":"The version state of the product line."
}
}
}
]
},
"ProductOfferingTerm":{
"title":"ProductOfferingTerm",
"type":"object",
"description":"The service Entitlement details of a Product Offering.",
"properties":{
"name":{
"type":"string",
"description":"The name of the product offering term."
},
"description":{
"type":"string",
"description":"The description of the product offering term."
},
"duration":{
"$ref":"#/components/schemas/TermDurationRangeOracle",
"description":"The product offering term."
},
"validFor":{
"$ref":"#/components/schemas/TimePeriodOracle",
"description":"The period for which the product offering term is valid."
},
"@type":{
"type":"string",
"description":"The class type of the product offering term."
},
"@baseType":{
"type":"string",
"description":"The base type of the product offering term."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the product offering term."
}
},
"required":[
"@type"
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"ProductOfferingTerm":"#/components/schemas/ProductOfferingTerm",
"ProductOfferingTermOracle":"#/components/schemas/ProductOfferingTermOracle"
}
}
},
"TermDurationRangeOracle":{
"title":"TermDurationRangeOracle",
"allOf":[
{
"$ref":"#/components/schemas/TermDuration"
},
{
"type":"object",
"properties":{
"minDurationAmount":{
"type":"number",
"description":"The minimum term duration."
}
}
}
]
},
"ProductOfferingTermOracle":{
"title":"ProductOfferingTermOracle",
"allOf":[
{
"$ref":"#/components/schemas/ProductOfferingTerm"
},
{
"type":"object",
"properties":{
"isDefault":{
"type":"boolean",
"description":"Whether the product offering term is default."
},
"defaultingTerm":{
"type":"string",
"description":"The action taken on defaulting a term."
},
"attachment":{
"type":"array",
"items":{
"anyOf":[
{
"$ref":"#/components/schemas/Attachment"
},
{
"$ref":"#/components/schemas/AttachmentOracle"
},
{
"$ref":"#/components/schemas/AttachmentRef"
}
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"Attachment":"#/components/schemas/Attachment",
"AttachmentOracle":"#/components/schemas/AttachmentOracle",
"AttachmentRef":"#/components/schemas/AttachmentRef"
}
}
},
"description":"A list of attachments associated with the product offering term."
},
"productOfferingPrice":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ProductOfferingPriceRef"
},
"description":"A list of product offering prices associated with the product offering term."
},
"customProfileSpec":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CustomProfileSpecRefOracle"
},
"description":"A list of custom profile specifications associated with the product offering term."
}
},
"discriminator":{
"propertyName":"@type",
"mapping":{
"ProductOfferingTermOracle":"#/components/schemas/ProductOfferingTermOracle",
"ServiceEntitlementOfferTermOracle":"#/components/schemas/ServiceEntitlementOfferTermOracle",
"CommitmentTermOracle":"#/components/schemas/CommitmentTermOracle",
"SubscriptionTermOracle":"#/components/schemas/SubscriptionTermOracle",
"PaymentTermOracle":"#/components/schemas/PaymentTermOracle"
}
}
}
]
},
"ServiceEntitlementOfferTermOracle":{
"title":"ServiceEntitlementOfferTermOracle",
"allOf":[
{
"$ref":"#/components/schemas/ProductOfferingTermOracle"
},
{
"type":"object",
"properties":{
"serviceEntitlementName":{
"type":"string",
"description":"The name of the service entitlement associated with the service entitlement offer term."
},
"serviceEntitlementTermName":{
"type":"string",
"description":"The name of the service entitlement term associated with the service entitlement offer term."
},
"serviceSpecificationName":{
"type":"string",
"description":"The name of the service specification associated with the service entitlement offer term."
}
},
"required":[
"serviceEntitlementName",
"serviceEntitlementTermName",
"serviceSpecificationName"
]
}
]
},
"CommitmentTermOracle":{
"title":"CommitmentTermOracle",
"allOf":[
{
"$ref":"#/components/schemas/ProductOfferingTermOracle"
},
{
"type":"object",
"properties":{
"commitmentTermType":{
"type":"string",
"enum":[
"INSTALLMENT",
"LEASE",
"SERVICE"
],
"description":"The type or classification of the commitment term. Valid values are INSTALLMENT, LEASE, and SERVICE."
},
"durationType":{
"type":"string",
"enum":[
"DURATION_RANGE",
"FIXED"
],
"description":"The type or classification of the commitment term. Valid values are DURATION_RANGE, and FIXED."
},
"earlyTerminationOption":{
"type":"boolean",
"description":"Whether the commitment term has early termination option."
},
"earlyTerminationPenalty":{
"type":"boolean",
"description":"Whether the commitment term has early termination penalty."
},
"commitment":{
"type":"boolean",
"description":"Whether the commitment term has commitment."
},
"applyComponentCharge":{
"type":"boolean",
"description":"Whether the commitment term has apply component charge."
},
"penaltyType":{
"type":"string",
"enum":[
"FLAT",
"NONE",
"REDUCE_EQUAL_AMOUNT",
"BALANCE_OF_CONTRACT",
"FIXED_PRORATION",
"VARIABLE_PRORATION"
],
"description":"The type or classification of the commitment term. Valid values are FLAT, NONE, REDUCE_EQUAL_AMOUNT, BALANCE_OF_CONTRACT, FIXED_PRORATION, and VARIABLE_PRORATION."
},
"penaltyGracePeriodApplicable":{
"type":"boolean",
"description":"Whether the commitment term is penalty grace period applicable."
},
"gracePeriodDuration":{
"type":"integer",
"description":"The grace period duration associated with the commitment term."
},
"gracePeriodUnits":{
"type":"string",
"description":"The grace period units associated with the commitment term."
},
"autoRenewal":{
"type":"boolean",
"description":"Whether the commitment term has auto renewal."
},
"specifyPenaltyAs":{
"type":"string",
"enum":[
"PERC_OF_BILL_AMT"
],
"description":"The specify penalty as associated with the commitment term. Valid values are PERC_OF_BILL_AMT."
},
"penaltyPercentage":{
"type":"number",
"description":"The penalty percentage associated with the commitment term."
},
"reducePenalty":{
"type":"boolean",
"description":"Whether the commitment term has reduce penalty."
},
"endOfLeaseTermOptions":{
"type":"array",
"items":{
"$ref":"#/components/schemas/EndOfLeaseTermOptionsOracle"
},
"description":"A list of end of lease term options associated with the commitment term."
},
"upgradeRule":{
"$ref":"#/components/schemas/UpgradeEligibilityRuleOracle",
"description":"The commitment term."
}
}
}
]
},
"ProrationReductionTermOracle":{
"title":"ProrationReductionTerm",
"type":"object",
"description":"Provides references to Early Termination Fee (ETF) that prorates the ETF for a subscriber based on their contract duration. This proration allows a subscriber to pay less to terminate as more time passes giving them an option to stay on for an additional period in contract to minimize their exit fee.",
"properties":{
"fromOffset":{
"type":"number",
"description":"The start of the schedule."
},
"reductionPercentage":{
"type":"number",
"description":"The percentage of the amount to be deducted."
},
"durationUnits":{
"type":"string",
"description":"The term duration units. Valid values are DAYS, MONTHS, WEEKS, and YEARS.",
"enum":[
"DAYS",
"MONTHS",
"WEEKS",
"YEARS"
]
}
}
},
"SubscriptionTermOracle":{
"title":"SubscriptionTermOracle",
"allOf":[
{
"$ref":"#/components/schemas/ProductOfferingTermOracle"
},
{
"type":"object",
"properties":{
"earlyTerminationOption":{
"type":"boolean",
"description":"Whether the subscription term has early termination option."
}
}
}
]
},
"PaymentTermOracle":{
"title":"PaymentTermOracle",
"allOf":[
{
"$ref":"#/components/schemas/ProductOfferingTermOracle"
},
{
"type":"object",
"properties":{
"paymentType":{
"type":"string",
"enum":[
"PREPAID",
"POSTPAID",
"INSTALLMENT",
"LEASE"
],
"description":"The type or classification of the payment term. Valid values are PREPAID, POSTPAID, INSTALLMENT, and LEASE."
},
"creditCheckRequired":{
"type":"boolean",
"description":"Whether the payment term has credit check required."
}
}
}
]
},
"UpgradeEligibilityRuleOracle":{
"title":"UpgradeEligibilityRuleOracle",
"type":"object",
"properties":{
"minimumTerm":{
"type":"number",
"description":"The minimum terms required to be fulfilled for upgrade."
},
"minimumTermPercentage":{
"type":"string",
"description":"The minimum term percentage required to be fulfilled for upgrade."
},
"minimumBalance":{
"type":"number",
"description":"The minimum balance amount required for upgrade."
},
"minimumBalancePercentage":{
"type":"string",
"description":"The minimum balance amount percentage required for upgrade."
},
"minimumPayment":{
"type":"number",
"description":"The minimum payment for device upgrade."
},
"minimumPaymentPercentage":{
"type":"string",
"description":"The minimum payment percentage required for device upgrade."
}
},
"description":"The upgrade eligibility rule resource."
},
"EndOfLeaseTermOptionsOracle":{
"title":"EndOfLeaseTermOptionsOracle",
"type":"object",
"properties":{
"endOfLeaseType":{
"type":"string",
"description":"The type or classification of the end of lease term option. Valid values are RETURN, CONTINUE, and BUY_BACK.",
"enum":[
"RETURN",
"CONTINUE",
"BUY_BACK"
]
},
"description":{
"type":"string",
"description":"The minimum term percentage required to be fulfilled for upgrade."
},
"productOfferingPrice":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ProductOfferingPriceRef"
},
"description":"A list of product offering prices associated with the end of lease term option."
}
},
"description":"The end of lease term options resource."
},
"BannerOracle":{
"title":"BannerOracle",
"type":"object",
"properties":{
"name":{
"type":"string",
"description":"The name of the banner."
},
"description":{
"type":"string",
"description":"The description of the banner."
},
"priority":{
"type":"number",
"description":"The priority of this banner for the productOffering it is associated with."
},
"validFor":{
"$ref":"#/components/schemas/TimePeriodOracle",
"description":"The period for which the banner is valid."
}
},
"required":[
"name"
],
"description":"The banner resource."
},
"UploadSchemaOracle":{
"title":"UploadSchemaOracle",
"type":"object",
"properties":{
"primaryFile":{
"type":"object",
"description":"The file to upload and Download.",
"format":"binary"
},
"path":{
"type":"string",
"description":"The path of the file to upload and Download."
}
},
"description":"The upload schema resource."
},
"Error":{
"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":"The text that explains the reason for error. This can be shown to a client user."
},
"message":{
"type":"string",
"description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
},
"status":{
"type":"string",
"description":"The status of the error."
},
"referenceError":{
"type":"string",
"description":"The URL pointing to documentation describing the error."
},
"@type":{
"type":"string",
"description":"The class type of a REST resource."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the error."
}
},
"required":[
"code",
"reason"
],
"description":"The error resource."
},
"TimePeriodOracle":{
"description":"The validity period of the related party.",
"title":"TimePeriodOracle",
"type":"object",
"properties":{
"startDateTime":{
"type":"string",
"format":"date-time",
"description":"The start date and time of the time period."
},
"endDateTime":{
"type":"string",
"format":"date-time",
"description":"The end date and time of the time period."
}
}
},
"BeatOracle":{
"title":"BeatOracle",
"description":"The beat is basically the pulse measure used for charging usage quantity.",
"type":"object",
"properties":{
"minQuantity":{
"type":"number",
"description":"The minimum usage quantity of the beat."
},
"minQuantityUnit":{
"type":"string",
"description":"The unit of measure for the minQuantity of beat.",
"enum":[
"NONE",
"SECOND",
"MINUTE",
"HOUR",
"DAY",
"MONTH",
"BYTE",
"KILOBYTE",
"MEGABYTE",
"GIGABYTE",
"PAGES",
"MOVIES",
"TIME_INTERVAL",
"QUANTITY",
"MBPS",
"GBPS"
]
},
"incrementQuantity":{
"type":"number",
"description":"The usage quantity increment of the beat."
},
"incrementQuantityUnit":{
"type":"string",
"description":"The unit of measure for the incrementQuantity of beat.",
"enum":[
"NONE",
"SECOND",
"MINUTE",
"HOUR",
"DAY",
"MONTH",
"BYTE",
"KILOBYTE",
"MEGABYTE",
"GIGABYTE",
"PAGES",
"MOVIES",
"TIME_INTERVAL",
"QUANTITY",
"MBPS",
"GBPS"
]
},
"roundingMode":{
"type":"string",
"description":"The rounding strategy applied to beat usage quantities. Valid values are DOWN, DOWN_ALT, FLOOR, FLOOR_ALT, NEAREST, and UP.",
"enum":[
"DOWN",
"DOWN_ALT",
"FLOOR",
"FLOOR_ALT",
"NEAREST",
"UP"
]
}
}
},
"RelatedPartyRefOrPartyRoleRef":{
"title":"RelatedParty",
"description":"The relatedParty reference. A related party defines party or party role linked to a specific entity.",
"type":"object",
"properties":{
"role":{
"type":"string",
"description":"The role played by the related party or party role in the context of the specific entity it is linked to. Such as 'initiator', 'customer', 'salesAgent', 'user'."
},
"@type":{
"type":"string",
"description":"The class type of the related party reference or party role reference."
},
"@baseType":{
"type":"string",
"description":"The base type of the related party reference or party role reference."
},
"@schemaLocation":{
"type":"string",
"description":"A URI to a JSON-Schema file that defines additional attributes and relationships."
},
"partyOrPartyRole":{
"items":{
"anyOf":[
{
"$ref":"#/components/schemas/PartyRef"
},
{
"$ref":"#/components/schemas/PartyRoleRef"
}
]
},
"description":"A list of party or party roles associated with the related party reference or party role reference."
}
},
"required":[
"@type",
"partyOrPartyRole"
]
},
"PartyRef":{
"title":"PartyRef",
"type":"object",
"description":"The party reference resource.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the party reference."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the party reference."
},
"name":{
"type":"string",
"description":"The name of the party reference."
},
"@referredType":{
"type":"string",
"description":"The actual type of the target instance when needed for disambiguation."
},
"@type":{
"type":"string",
"description":"The class type of the party reference."
},
"@baseType":{
"type":"string",
"description":"The base type of the party reference."
},
"@schemaLocation":{
"type":"string",
"description":"A URI to a JSON-Schema file that defines additional attributes and relationships."
}
},
"required":[
"@type",
"@referredType"
]
},
"PartyRoleRef":{
"title":"PartyRoleRef",
"type":"object",
"description":"The party role reference resource.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the party role reference."
},
"name":{
"type":"string",
"description":"The name of the party role reference."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the party role reference."
},
"partyId":{
"type":"string",
"description":"The ID of the party associated with the party role reference."
},
"partyName":{
"type":"string",
"description":"The name of the engaged party that is linked to the PartyRole object."
},
"@referredType":{
"type":"string",
"description":"The actual type of the target instance when needed for disambiguation."
},
"@type":{
"type":"string",
"description":"The class type of the party role reference."
},
"@baseType":{
"type":"string",
"description":"The base type of the party role reference."
},
"@schemaLocation":{
"type":"string",
"description":"A URI to a JSON-Schema file that defines additional attributes and relationships."
}
},
"required":[
"@type",
"@referredType"
]
},
"ProductLineRef":{
"title":"ProductLineRef",
"type":"object",
"description":"The product line reference resource.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the product line reference."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the product line reference."
},
"name":{
"type":"string",
"description":"The name of the product line reference."
},
"version":{
"type":"string",
"description":"The version of the product Line."
},
"@referredType":{
"type":"string",
"description":"The type of the referred product line reference."
},
"@type":{
"type":"string",
"description":"The class type of the product line reference."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the product line reference."
},
"@baseType":{
"type":"string",
"description":"The base type of the product line reference."
},
"versionState":{
"type":"number",
"description":"The version state of the reference."
}
},
"required":[
"id",
"@type",
"@referredType"
]
},
"PlaceRef":{
"title":"PlaceRef",
"type":"object",
"description":"The place reference. Place defines the places where the products are sold or delivered.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the place reference."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the place reference."
},
"name":{
"type":"string",
"description":"A user-friendly name for the place, such as \"Paris Store\", \"London Store\", \"Main Home\"."
},
"@type":{
"type":"string",
"description":"The class type of the place reference."
},
"@baseType":{
"type":"string",
"description":"The base type of the place reference."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the place reference."
},
"@referredType":{
"type":"string",
"description":"The type of the referred place reference."
}
},
"required":[
"id",
"@type",
"@referredType"
]
},
"ExportSummaryResource":{
"type":"object",
"title":"ExportSummaryResource",
"description":"The object that contains exported resource details, such as name and count.",
"properties":{
"name":{
"type":"string",
"description":"The name of the export summary resource."
},
"count":{
"type":"integer",
"description":"Indicates the number of resource exported."
}
}
},
"ImportSummaryResource":{
"type":"object",
"title":"ImportSummaryResource",
"description":"The object that contains imported resource details, such as name and count.",
"properties":{
"name":{
"type":"string",
"description":"The name of the import summary resource."
},
"count":{
"type":"integer",
"description":"Indicates the number of resource imported."
}
}
},
"TargetProductSchema":{
"title":"TargetProductSchema",
"description":"The reference object to the schema and type of target product which is described by product specification.",
"type":"object",
"properties":{
"@type":{
"type":"string",
"description":"The class type of the target product schema."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the target product schema."
}
},
"required":[
"@type",
"@schemaLocation"
]
},
"TargetProductSchemaOracle":{
"title":"TargetProductSchemaOracle",
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/TargetProductSchema"
},
{
"type":"object",
"properties":{
"subType":{
"type":"string",
"description":"The type or classification of the target product schema."
}
}
}
]
},
"Attachment":{
"type":"object",
"title":"AttachmentRefOrValue",
"description":"The complements the description of an element (for instance a product) through video, pictures.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the attachment."
},
"description":{
"type":"string",
"description":"A narrative text describing the content of the attachment."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the attachment."
},
"name":{
"type":"string",
"description":"The name of the attachment."
},
"attachmentType":{
"type":"string",
"description":"The type or classification of the attachment."
},
"size":{
"$ref":"#/components/schemas/Quantity",
"description":"The attachment."
},
"url":{
"type":"string",
"description":"The uniform Resource Locator, is a web page address (a subset of URI)."
},
"mimeType":{
"type":"string",
"description":"Attachment mime type such as extension file for video, picture and document."
},
"validFor":{
"$ref":"#/components/schemas/TimePeriodOracle",
"description":"The period for which the attachment is valid."
},
"@type":{
"type":"string",
"description":"The class type of the attachment."
},
"@baseType":{
"type":"string",
"description":"The base type of the attachment."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the attachment."
}
},
"required":[
"@type"
]
},
"AttachmentOracle":{
"title":"AttachmentOracle",
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/Attachment"
},
{
"type":"object",
"properties":{
"rank":{
"type":"number",
"description":"The attachment rank in order of their relevance for each attachmentType."
}
}
}
]
},
"CharacteristicSpecification":{
"title":"CharacteristicSpecification",
"type":"object",
"description":"A characteristic quality or distinctive feature of a PlaSpecification. The characteristic can take on a discrete value, such as color, can take on a range of values, (for example, sensitivity of 100-240 mV), or can be derived from a formula (for example, usage time (hrs) = 30 - talk time *3). Certain characteristics, such as color, may be configured during the ordering or some other process.",
"properties":{
"id":{
"type":"string",
"maxLength":30,
"description":"The ID of the characteristic specification."
},
"name":{
"type":"string",
"description":"The name of the characteristic specification."
},
"description":{
"type":"string",
"description":"A narrative that explains in detail what the productSpecCharacteristic is."
},
"valueType":{
"type":"string",
"description":"The type or classification of the characteristic specification. Valid values are STRING, NUMBER, OBJECT, ARRAY, DECIMAL, BOOLEAN, DATE, DATETIME, and URL.",
"enum":[
"STRING",
"NUMBER",
"OBJECT",
"ARRAY",
"DECIMAL",
"BOOLEAN",
"DATE",
"DATETIME",
"URL"
]
},
"configurable":{
"type":"boolean",
"description":"Whether the characteristic specification is configurable."
},
"validFor":{
"$ref":"#/components/schemas/TimePeriodOracle",
"description":"The period for which the characteristic specification is valid."
},
"@type":{
"type":"string",
"description":"The class type of the characteristic specification."
},
"@baseType":{
"type":"string",
"description":"The base type of the characteristic specification."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the characteristic specification."
},
"@valueSchemaLocation":{
"type":"string",
"description":"The optional link to the schema that describes the value type."
},
"minCardinality":{
"type":"integer",
"description":"The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality."
},
"maxCardinality":{
"type":"integer",
"description":"The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality."
},
"isUnique":{
"type":"boolean",
"description":"An indicator that specifies if a value is unique for the specification. Possible values are; \"unique while value is in effect\" and \"unique whether value is in effect or not\"."
},
"regex":{
"type":"string",
"description":"A rule or principle represented as a regular expression for deriving the value of a characteristic value."
},
"extensible":{
"type":"boolean",
"description":"An indicator that specifies that the values for the characteristic can be extended by adding new values when instantiating a characteristic for a product."
},
"allowedUnits":{
"type":"array",
"items":{
"type":"string"
},
"description":"A list of allowed units associated with the characteristic specification."
},
"charSpecRelationship":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CharacteristicSpecificationRelationshipOracle"
},
"description":"A list of char specification relationships associated with the characteristic specification."
},
"characteristicValueSpecification":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CharacteristicValueSpecification"
},
"description":"A list of characteristic value specifications associated with the characteristic specification."
}
},
"required":[
"name",
"@type"
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"CharacteristicSpecification":"#/components/schemas/CharacteristicSpecification",
"CharacteristicSpecificationOracle":"#/components/schemas/CharacteristicSpecificationOracle",
"ProductOfferCharacteristicOracle":"#/components/schemas/ProductOfferCharacteristicOracle"
}
}
},
"CharacteristicSpecificationOracle":{
"title":"CharacteristicSpecificationOracle",
"allOf":[
{
"$ref":"#/components/schemas/CharacteristicSpecification"
},
{
"type":"object",
"properties":{
"characteristicType":{
"type":"string",
"description":"The type or classification of the characteristic specification. Valid values are SKU.",
"enum":[
"SKU"
]
},
"displayName":{
"type":"string",
"description":"The name of the display associated with the characteristic specification."
},
"version":{
"type":"string",
"description":"The attribute version."
},
"project":{
"$ref":"#/components/schemas/ProjectRef",
"description":"The characteristic specification."
},
"lifecycleStatus":{
"type":"string",
"description":"The status of the characteristic specification."
},
"created":{
"type":"string",
"format":"date-time",
"description":"The date and time of the creation."
},
"createdBy":{
"type":"string",
"description":"The name of the person who created item."
},
"lastUpdatedBy":{
"type":"string",
"description":"The name of the person who updated item."
},
"lastUpdate":{
"type":"string",
"format":"date-time",
"description":"The date and time when the characteristic specification was last updated."
},
"externalId":{
"type":"string",
"description":"The ID of the external associated with the characteristic specification."
},
"applicationName":{
"type":"string",
"description":"The name of the application associated with the characteristic specification."
},
"versionState":{
"type":"number",
"description":"The version state of the attribute."
},
"sensitive":{
"type":"boolean",
"description":"Whether the characteristic specification is sensitive."
},
"runtimeFilterable":{
"type":"boolean",
"description":"Whether the characteristic specification is runtime filterable."
},
"fulfillmentUpdatable":{
"type":"boolean",
"description":"Indicates runtime system to allow update coming from fulfillment system only for attributes that has this property set to true."
}
}
}
]
},
"CharacteristicSpecificationRelationship":{
"title":"CharacteristicSpecificationRelationship",
"type":"object",
"description":"An aggregation, migration, substitution, dependency or exclusivity relationship between/among productSpecCharacteristics.",
"properties":{
"relationshipType":{
"type":"string",
"description":"The type or classification of the characteristic specification relationship. Valid values are AGGREGATION, MIGRATION, SUBSTITUTION, DEPENDENCY, and EXCLUSIVITY.",
"enum":[
"AGGREGATION",
"MIGRATION",
"SUBSTITUTION",
"DEPENDENCY",
"EXCLUSIVITY"
]
},
"validFor":{
"$ref":"#/components/schemas/TimePeriodOracle",
"description":"The period for which the characteristic specification relationship is valid."
},
"parentSpecificationId":{
"type":"string",
"description":"The ID of the parent specification associated with the characteristic specification relationship."
},
"characteristicSpecificationId":{
"type":"string",
"description":"The ID of the characteristic specification associated with the characteristic specification relationship."
},
"name":{
"type":"string",
"description":"The name of the characteristic specification relationship."
},
"parentSpecificationHref":{
"type":"string",
"description":"The hyperlink reference to the target product specification."
},
"@type":{
"type":"string",
"description":"The class type of the characteristic specification relationship."
},
"@baseType":{
"type":"string",
"description":"The base type of the characteristic specification relationship."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the characteristic specification relationship."
}
},
"required":[
"parentSpecificationId",
"name",
"relationshipType",
"@type"
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"CharacteristicSpecificationRelationship":"#/components/schemas/CharacteristicSpecificationRelationship",
"CharacteristicSpecificationRelationshipOracle":"#/components/schemas/CharacteristicSpecificationRelationshipOracle"
}
}
},
"CharacteristicSpecificationRelationshipOracle":{
"title":"CharacteristicSpecificationRelationshipOracle",
"allOf":[
{
"$ref":"#/components/schemas/CharacteristicSpecificationRelationship"
},
{
"type":"object",
"properties":{
"displayName":{
"type":"string",
"description":"The name of the display associated with the characteristic specification relationship."
},
"charSpecSeq":{
"type":"integer",
"description":"The order in which a characteristic specification appears within another characteristic specification grouping. For example, a grouping can represent a person name where the given name is first, the middle name is second, and the last name is third."
},
"valueType":{
"type":"string",
"description":"The type or classification of the characteristic specification relationship. Valid values are STRING, NUMBER, OBJECT, ARRAY, DECIMAL, BOOLEAN, DATE, DATETIME, and URL.",
"enum":[
"STRING",
"NUMBER",
"OBJECT",
"ARRAY",
"DECIMAL",
"BOOLEAN",
"DATE",
"DATETIME",
"URL"
]
},
"specificationType":{
"type":"string",
"description":"The type or classification of the characteristic specification relationship."
},
"charValueSpecRelationship":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CharacteristicValueSpecificationRelationshipOracle"
},
"description":"A list of char value specification relationships associated with the characteristic specification relationship."
}
}
}
]
},
"CharacteristicValueSpecificationRelationshipOracle":{
"title":"CharacteristicValueSpecificationRelationshipOracle",
"type":"object",
"description":"A number or text that can be assigned to a CharacteristicValueSpecificationRelationship.",
"properties":{
"value":{
"oneOf":[
{
"type":"string"
},
{
"type":"object"
},
{
"type":"number"
},
{
"type":"boolean"
},
{
"type":"array"
}
],
"description":"A discrete value that the characteristic value relationship can take on. The value type is defined by the valueType characteristic."
},
"valueType":{
"type":"string",
"description":"The type or classification of the characteristic value specification relationship. Valid values are STRING, NUMBER, OBJECT, ARRAY, DECIMAL, BOOLEAN, DATE, DATETIME, and URL.",
"enum":[
"STRING",
"NUMBER",
"OBJECT",
"ARRAY",
"DECIMAL",
"BOOLEAN",
"DATE",
"DATETIME",
"URL"
]
},
"parentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"object"
},
{
"type":"number"
},
{
"type":"boolean"
},
{
"type":"array"
}
],
"description":"A discrete value that the parent characteristic value relationship can take on. The value type is defined by the valueType characteristic."
},
"relationshipType":{
"type":"string",
"description":"The type or classification of the characteristic value specification relationship. Valid values are AGGREGATION, MIGRATION, SUBSTITUTION, DEPENDENCY, EXCLUSIVITY, and MAPS_TO.",
"enum":[
"AGGREGATION",
"MIGRATION",
"SUBSTITUTION",
"DEPENDENCY",
"EXCLUSIVITY",
"MAPS_TO"
]
}
}
},
"CharacteristicValueSpecification":{
"title":"CharacteristicValueSpecification",
"type":"object",
"description":"A number or text that can be assigned to a ProductSpecCharacteristic.",
"properties":{
"isDefault":{
"type":"boolean",
"description":"Whether the characteristic value specification is default."
},
"unitOfMeasure":{
"type":"string",
"description":"The unit can be minutes or GB.",
"enum":[
"NONE",
"SECOND",
"MINUTE",
"HOUR",
"DAY",
"MONTH",
"BYTE",
"KILOBYTE",
"MEGABYTE",
"GIGABYTE",
"PAGES",
"MOVIES",
"TIME_INTERVAL",
"QUANTITY",
"MBPS",
"GBPS"
]
},
"validFor":{
"$ref":"#/components/schemas/TimePeriodOracle",
"description":"The period for which the characteristic value specification is valid."
},
"valueFrom":{
"type":"string",
"description":"The low range value that a characteristic can take on."
},
"valueTo":{
"type":"string",
"description":"The upper range value that a characteristic can take on."
},
"valueType":{
"type":"string",
"description":"The type or classification of the characteristic value specification. Valid values are STRING, NUMBER, OBJECT, ARRAY, DECIMAL, BOOLEAN, DATE, DATETIME, and URL.",
"enum":[
"STRING",
"NUMBER",
"OBJECT",
"ARRAY",
"DECIMAL",
"BOOLEAN",
"DATE",
"DATETIME",
"URL"
]
},
"rangeInterval":{
"type":"string",
"description":"An indicator that specifies the inclusion or exclusion of the valueFrom and valueTo attributes. If applicable, possible values are \"open\", \"closed\", \"closedBottom\" and \"closedTop\". Valid values are OPEN, CLOSED, CLOSED_BOTTOM, and CLOSED_TOP.",
"enum":[
"OPEN",
"CLOSED",
"CLOSED_BOTTOM",
"CLOSED_TOP"
]
},
"regex":{
"type":"string",
"description":"The regular expression to define constraint on the allowed value."
},
"@type":{
"type":"string",
"description":"The class type of the characteristic value specification."
},
"@baseType":{
"type":"string",
"description":"The base type of the characteristic value specification."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the characteristic value specification."
}
},
"required":[
"@type"
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"CharacteristicValueSpecification":"#/components/schemas/CharacteristicValueSpecification",
"StringCharacteristicValueSpecification":"#/components/schemas/StringCharacteristicValueSpecification",
"ObjectCharacteristicValueSpecification":"#/components/schemas/ObjectCharacteristicValueSpecification",
"StringArrayCharacteristicValueSpecification":"#/components/schemas/StringArrayCharacteristicValueSpecification",
"MapCharacteristicValueSpecification":"#/components/schemas/MapCharacteristicValueSpecification",
"NumberCharacteristicValueSpecification":"#/components/schemas/NumberCharacteristicValueSpecification",
"MapArrayCharacteristicValueSpecification":"#/components/schemas/MapArrayCharacteristicValueSpecification",
"ObjectArrayCharacteristicValueSpecification":"#/components/schemas/ObjectArrayCharacteristicValueSpecification",
"NumberArrayCharacteristicValueSpecification":"#/components/schemas/NumberArrayCharacteristicValueSpecification",
"IntegerCharacteristicValueSpecification":"#/components/schemas/IntegerCharacteristicValueSpecification",
"IntegerArrayCharacteristicValueSpecification":"#/components/schemas/IntegerArrayCharacteristicValueSpecification",
"StringCharacteristicValueSpecificationOracle":"#/components/schemas/StringCharacteristicValueSpecificationOracle",
"ObjectCharacteristicValueSpecificationOracle":"#/components/schemas/ObjectCharacteristicValueSpecificationOracle",
"StringArrayCharacteristicValueSpecificationOracle":"#/components/schemas/StringArrayCharacteristicValueSpecificationOracle",
"MapCharacteristicValueSpecificationOracle":"#/components/schemas/MapCharacteristicValueSpecificationOracle",
"NumberCharacteristicValueSpecificationOracle":"#/components/schemas/NumberCharacteristicValueSpecificationOracle",
"MapArrayCharacteristicValueSpecificationOracle":"#/components/schemas/MapArrayCharacteristicValueSpecificationOracle",
"ObjectArrayCharacteristicValueSpecificationOracle":"#/components/schemas/ObjectArrayCharacteristicValueSpecificationOracle",
"NumberArrayCharacteristicValueSpecificationOracle":"#/components/schemas/NumberArrayCharacteristicValueSpecificationOracle",
"IntegerCharacteristicValueSpecificationOracle":"#/components/schemas/IntegerCharacteristicValueSpecificationOracle",
"IntegerArrayCharacteristicValueSpecificationOracle":"#/components/schemas/IntegerArrayCharacteristicValueSpecificationOracle"
}
}
},
"StringCharacteristicValueSpecification":{
"title":"StringCharacteristicValueSpecification",
"allOf":[
{
"$ref":"#/components/schemas/CharacteristicValueSpecification"
},
{
"type":"object",
"properties":{
"value":{
"type":"string",
"description":"The value assigned to the string characteristic value specification."
}
},
"discriminator":{
"propertyName":"@type",
"mapping":{
"StringCharacteristicValueSpecification":"#/components/schemas/StringCharacteristicValueSpecification",
"StringCharacteristicValueSpecificationOracle":"#/components/schemas/StringCharacteristicValueSpecificationOracle"
}
}
}
]
},
"ObjectCharacteristicValueSpecification":{
"title":"ObjectCharacteristicValueSpecification",
"allOf":[
{
"$ref":"#/components/schemas/CharacteristicValueSpecification"
},
{
"type":"object",
"properties":{
"value":{
"type":"object",
"description":"The value assigned to the object characteristic value specification."
}
},
"discriminator":{
"propertyName":"@type",
"mapping":{
"ObjectCharacteristicValueSpecification":"#/components/schemas/ObjectCharacteristicValueSpecification",
"ObjectCharacteristicValueSpecificationOracle":"#/components/schemas/ObjectCharacteristicValueSpecificationOracle"
}
}
}
]
},
"StringArrayCharacteristicValueSpecification":{
"title":"StringArrayCharacteristicValueSpecification",
"allOf":[
{
"$ref":"#/components/schemas/CharacteristicValueSpecification"
},
{
"type":"object",
"properties":{
"value":{
"type":"array",
"items":{
"type":"string"
},
"description":"A list of values associated with the string array characteristic value specification."
}
},
"discriminator":{
"propertyName":"@type",
"mapping":{
"StringArrayCharacteristicValueSpecification":"#/components/schemas/StringArrayCharacteristicValueSpecification",
"StringArrayCharacteristicValueSpecificationOracle":"#/components/schemas/StringArrayCharacteristicValueSpecificationOracle"
}
}
}
]
},
"MapCharacteristicValueSpecification":{
"title":"MapCharacteristicValueSpecification",
"allOf":[
{
"$ref":"#/components/schemas/CharacteristicValueSpecification"
},
{
"type":"object",
"properties":{
"value":{
"type":"object",
"description":"The value assigned to the map characteristic value specification."
}
},
"discriminator":{
"propertyName":"@type",
"mapping":{
"MapCharacteristicValueSpecification":"#/components/schemas/MapCharacteristicValueSpecification",
"MapCharacteristicValueSpecificationOracle":"#/components/schemas/MapCharacteristicValueSpecificationOracle"
}
}
}
]
},
"NumberCharacteristicValueSpecification":{
"title":"NumberCharacteristicValueSpecification",
"allOf":[
{
"$ref":"#/components/schemas/CharacteristicValueSpecification"
},
{
"type":"object",
"properties":{
"value":{
"type":"number",
"description":"The value assigned to the number characteristic value specification."
}
},
"discriminator":{
"propertyName":"@type",
"mapping":{
"NumberCharacteristicValueSpecification":"#/components/schemas/NumberCharacteristicValueSpecification",
"NumberCharacteristicValueSpecificationOracle":"#/components/schemas/NumberCharacteristicValueSpecificationOracle"
}
}
}
]
},
"MapArrayCharacteristicValueSpecification":{
"title":"MapArrayCharacteristicValueSpecification",
"allOf":[
{
"$ref":"#/components/schemas/CharacteristicValueSpecification"
},
{
"type":"object",
"properties":{
"value":{
"type":"array",
"items":{
"type":"object"
},
"description":"A list of values associated with the map array characteristic value specification."
}
},
"discriminator":{
"propertyName":"@type",
"mapping":{
"MapArrayCharacteristicValueSpecification":"#/components/schemas/MapArrayCharacteristicValueSpecification",
"MapArrayCharacteristicValueSpecificationOracle":"#/components/schemas/MapArrayCharacteristicValueSpecificationOracle"
}
}
}
]
},
"ObjectArrayCharacteristicValueSpecification":{
"title":"ObjectArrayCharacteristicValueSpecification",
"allOf":[
{
"$ref":"#/components/schemas/CharacteristicValueSpecification"
},
{
"type":"object",
"properties":{
"value":{
"type":"array",
"items":{
"type":"object"
},
"description":"A list of values associated with the object array characteristic value specification."
}
},
"discriminator":{
"propertyName":"@type",
"mapping":{
"ObjectArrayCharacteristicValueSpecification":"#/components/schemas/ObjectArrayCharacteristicValueSpecification",
"ObjectArrayCharacteristicValueSpecificationOracle":"#/components/schemas/ObjectArrayCharacteristicValueSpecificationOracle"
}
}
}
]
},
"NumberArrayCharacteristicValueSpecification":{
"title":"NumberArrayCharacteristicValueSpecification",
"allOf":[
{
"$ref":"#/components/schemas/CharacteristicValueSpecification"
},
{
"type":"object",
"properties":{
"value":{
"type":"array",
"items":{
"type":"number"
},
"description":"A list of values associated with the number array characteristic value specification."
}
},
"discriminator":{
"propertyName":"@type",
"mapping":{
"NumberArrayCharacteristicValueSpecification":"#/components/schemas/NumberArrayCharacteristicValueSpecification",
"NumberArrayCharacteristicValueSpecificationOracle":"#/components/schemas/NumberArrayCharacteristicValueSpecificationOracle"
}
}
}
]
},
"IntegerCharacteristicValueSpecification":{
"title":"IntegerCharacteristicValueSpecification",
"allOf":[
{
"$ref":"#/components/schemas/CharacteristicValueSpecification"
},
{
"type":"object",
"properties":{
"value":{
"type":"integer",
"description":"The value assigned to the integer characteristic value specification."
}
},
"discriminator":{
"propertyName":"@type",
"mapping":{
"IntegerCharacteristicValueSpecification":"#/components/schemas/IntegerCharacteristicValueSpecification",
"IntegerCharacteristicValueSpecificationOracle":"#/components/schemas/IntegerCharacteristicValueSpecificationOracle"
}
}
}
]
},
"IntegerArrayCharacteristicValueSpecification":{
"title":"IntegerArrayCharacteristicValueSpecification",
"allOf":[
{
"$ref":"#/components/schemas/CharacteristicValueSpecification"
},
{
"type":"array",
"items":{
"type":"object",
"properties":{
"value":{
"type":"array",
"items":{
"type":"integer"
},
"description":"A list of values associated with the integer array characteristic value specification."
}
}
},
"discriminator":{
"propertyName":"@type",
"mapping":{
"IntegerArrayCharacteristicValueSpecification":"#/components/schemas/IntegerArrayCharacteristicValueSpecification",
"IntegerArrayCharacteristicValueSpecificationOracle":"#/components/schemas/IntegerArrayCharacteristicValueSpecificationOracle"
}
}
}
]
},
"CharacteristicValueSpecificationOracle":{
"title":"CharacteristicValueSpecificationOracle",
"type":"object",
"description":"A number or text that can be assigned to a ProductSpecCharacteristic.",
"properties":{
"attachment":{
"type":"array",
"items":{
"anyOf":[
{
"$ref":"#/components/schemas/Attachment"
},
{
"$ref":"#/components/schemas/AttachmentOracle"
},
{
"$ref":"#/components/schemas/AttachmentRef"
}
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"Attachment":"#/components/schemas/Attachment",
"AttachmentOracle":"#/components/schemas/AttachmentOracle",
"AttachmentRef":"#/components/schemas/AttachmentRef"
}
}
},
"description":"A list of attachments associated with the characteristic value specification."
},
"valueCode":{
"type":"string",
"description":"A optional code for the value where applicable, like RGB for color code."
},
"valueRelationship":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ValueRelationshipOracle"
},
"description":"A list of value relationships associated with the characteristic value specification."
},
"sequence":{
"type":"integer",
"description":"Indicates the sequence where attribute values appear during runtime."
}
}
},
"StringCharacteristicValueSpecificationOracle":{
"title":"StringCharacteristicValueSpecification",
"allOf":[
{
"$ref":"#/components/schemas/StringCharacteristicValueSpecification"
},
{
"$ref":"#/components/schemas/CharacteristicValueSpecificationOracle"
}
]
},
"ObjectCharacteristicValueSpecificationOracle":{
"title":"ObjectCharacteristicValueSpecificationOracle",
"allOf":[
{
"$ref":"#/components/schemas/ObjectCharacteristicValueSpecification"
},
{
"$ref":"#/components/schemas/CharacteristicValueSpecificationOracle"
}
]
},
"StringArrayCharacteristicValueSpecificationOracle":{
"title":"StringArrayCharacteristicValueSpecificationOracle",
"allOf":[
{
"$ref":"#/components/schemas/StringArrayCharacteristicValueSpecification"
},
{
"$ref":"#/components/schemas/CharacteristicValueSpecificationOracle"
}
]
},
"MapCharacteristicValueSpecificationOracle":{
"title":"MapCharacteristicValueSpecificationOracle",
"allOf":[
{
"$ref":"#/components/schemas/MapCharacteristicValueSpecification"
},
{
"$ref":"#/components/schemas/CharacteristicValueSpecificationOracle"
}
]
},
"NumberCharacteristicValueSpecificationOracle":{
"title":"NumberCharacteristicValueSpecificationOracle",
"allOf":[
{
"$ref":"#/components/schemas/NumberCharacteristicValueSpecification"
},
{
"$ref":"#/components/schemas/CharacteristicValueSpecificationOracle"
}
]
},
"MapArrayCharacteristicValueSpecificationOracle":{
"title":"MapArrayCharacteristicValueSpecificationOracle",
"allOf":[
{
"$ref":"#/components/schemas/MapArrayCharacteristicValueSpecification"
},
{
"$ref":"#/components/schemas/CharacteristicValueSpecificationOracle"
}
]
},
"ObjectArrayCharacteristicValueSpecificationOracle":{
"title":"ObjectArrayCharacteristicValueSpecificationOracle",
"allOf":[
{
"$ref":"#/components/schemas/ObjectArrayCharacteristicValueSpecification"
},
{
"$ref":"#/components/schemas/CharacteristicValueSpecificationOracle"
}
]
},
"NumberArrayCharacteristicValueSpecificationOracle":{
"title":"NumberArrayCharacteristicValueSpecificationOracle",
"allOf":[
{
"$ref":"#/components/schemas/NumberArrayCharacteristicValueSpecification"
},
{
"$ref":"#/components/schemas/CharacteristicValueSpecificationOracle"
}
]
},
"IntegerCharacteristicValueSpecificationOracle":{
"title":"IntegerCharacteristicValueSpecificationOracle",
"allOf":[
{
"$ref":"#/components/schemas/IntegerCharacteristicValueSpecification"
},
{
"$ref":"#/components/schemas/CharacteristicValueSpecificationOracle"
}
]
},
"IntegerArrayCharacteristicValueSpecificationOracle":{
"title":"IntegerArrayCharacteristicValueSpecificationOracle",
"allOf":[
{
"$ref":"#/components/schemas/IntegerArrayCharacteristicValueSpecification"
},
{
"$ref":"#/components/schemas/CharacteristicValueSpecificationOracle"
}
]
},
"SpecCharacteristicValueOracle":{
"title":"SpecCharacteristicValueOracle",
"type":"object",
"description":"A number or text that can be assigned to a SpecCharacteristic.",
"properties":{
"isDefault":{
"type":"boolean",
"description":"Whether the specification characteristic value is default."
},
"unitOfMeasure":{
"type":"string",
"description":"The unit can be minutes or GB."
},
"validFor":{
"$ref":"#/components/schemas/TimePeriodOracle",
"description":"The period for which the specification characteristic value is valid."
},
"value":{
"oneOf":[
{
"type":"string"
},
{
"type":"object"
},
{
"type":"number"
},
{
"type":"boolean"
},
{
"type":"array"
}
],
"description":"A discrete value that the characteristic can take on. The value type is defined by the valueType characteristic."
},
"valueFrom":{
"type":"string",
"description":"The low range value that a characteristic can take on."
},
"valueTo":{
"type":"string",
"description":"The upper range value that a characteristic can take on."
},
"valueType":{
"type":"string",
"description":"The type or classification of the specification characteristic value. Valid values are STRING, NUMBER, OBJECT, ARRAY, DECIMAL, BOOLEAN, DATE, and DATETIME.",
"enum":[
"STRING",
"NUMBER",
"OBJECT",
"ARRAY",
"DECIMAL",
"BOOLEAN",
"DATE",
"DATETIME"
]
},
"rangeInterval":{
"type":"string",
"description":"An indicator that specifies the inclusion or exclusion of the valueFrom and valueTo attributes. If applicable, possible values are \"open\", \"closed\", \"closedBottom\" and \"closedTop\"."
},
"regex":{
"type":"string",
"description":"The regular expression to define constraint on the allowed value."
},
"@type":{
"type":"string",
"description":"The class type of the specification characteristic value."
},
"@baseType":{
"type":"string",
"description":"The base type of the specification characteristic value."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the specification characteristic value."
}
},
"required":[
"value",
"@type"
]
},
"PLASpecCharacteristic":{
"title":"PLASpecCharacteristic",
"type":"object",
"description":"A characteristic quality or distinctive feature of a PlaSpecification. The characteristic can take on a discrete value, such as color, can take on a range of values, (for example, sensitivity of 100-240 mV), or can be derived from a formula (for example, usage time (hrs) = 30 - talk time *3). Certain characteristics, such as color, may be configured during the ordering or some other process.",
"properties":{
"name":{
"type":"string",
"description":"The name of the pla specification characteristic."
},
"description":{
"type":"string",
"description":"A narrative that explains in detail what the PLASpecCharacteristic is."
},
"valueType":{
"type":"string",
"description":"The type or classification of the pla specification characteristic. Valid values are STRING, NUMBER, OBJECT, ARRAY, DECIMAL, BOOLEAN, DATE, and DATETIME.",
"enum":[
"STRING",
"NUMBER",
"OBJECT",
"ARRAY",
"DECIMAL",
"BOOLEAN",
"DATE",
"DATETIME"
]
},
"configurable":{
"type":"boolean",
"description":"Whether the pla specification characteristic is configurable."
},
"validFor":{
"$ref":"#/components/schemas/TimePeriodOracle",
"description":"The period for which the pla specification characteristic is valid."
},
"@type":{
"type":"string",
"description":"The class type of the pla specification characteristic."
},
"@baseType":{
"type":"string",
"description":"The base type of the pla specification characteristic."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the pla specification characteristic."
},
"@valueSchemaLocation":{
"type":"string",
"description":"The optional link to the schema that describes the value type."
},
"minCardinality":{
"type":"integer",
"description":"The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality."
},
"maxCardinality":{
"type":"integer",
"description":"The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality."
},
"isUnique":{
"type":"boolean",
"description":"An indicator that specifies if a value is unique for the specification. Possible values are; \"unique while value is in effect\" and \"unique whether value is in effect or not\"."
},
"regex":{
"type":"string",
"description":"A rule or principle represented as a regular expression for deriving the value of a characteristic value."
},
"extensible":{
"type":"boolean",
"description":"An indicator that specifies that the values for the characteristic can be extended by adding new values when instantiating a characteristic for a product."
},
"plaSpecCharRelationship":{
"type":"array",
"items":{
"$ref":"#/components/schemas/PLASpecCharRelationship"
},
"description":"A list of pla specification characteristic relationships associated with the pla specification characteristic."
},
"plaSpecCharacteristicValue":{
"type":"array",
"items":{
"$ref":"#/components/schemas/PLASpecCharacteristicValue"
},
"description":"A list of pla specification characteristic values associated with the pla specification characteristic."
}
},
"required":[
"name",
"@type"
]
},
"PLASpecCharRelationship":{
"title":"PLASpecCharRelationship",
"type":"object",
"description":"An aggregation, migration, substitution, dependency or exclusivity relationship between/among PLASpecCharacteristic.",
"properties":{
"relationshipType":{
"type":"string",
"description":"The type or classification of the pla specification characteristic relationship. Valid values are AGGREGATION, MIGRATION, SUBSTITUTION, DEPENDENCY, and EXCLUSIVITY.",
"enum":[
"AGGREGATION",
"MIGRATION",
"SUBSTITUTION",
"DEPENDENCY",
"EXCLUSIVITY"
]
},
"validFor":{
"$ref":"#/components/schemas/TimePeriodOracle",
"description":"The period for which the pla specification characteristic relationship is valid."
},
"charSpecSeq":{
"type":"integer",
"description":"The order in which a characteristic specification appears within another characteristic specification grouping. For example, a grouping can represent a person name where the given name is first, the middle name is second, and the last name is third."
},
"id":{
"type":"string",
"description":"The ID of the pla specification characteristic relationship."
},
"name":{
"type":"string",
"description":"The name of the pla specification characteristic relationship."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the pla specification characteristic relationship."
},
"@type":{
"type":"string",
"description":"The class type of the pla specification characteristic relationship."
},
"@baseType":{
"type":"string",
"description":"The base type of the pla specification characteristic relationship."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the pla specification characteristic relationship."
}
},
"required":[
"id",
"name",
"relationshipType",
"@type"
]
},
"PLASpecCharacteristicValue":{
"title":"PLASpecCharacteristicValue",
"type":"object",
"description":"A number or text that can be assigned to a PLASpecCharacteristic.",
"properties":{
"isDefault":{
"type":"boolean",
"description":"Whether the pla specification characteristic value is default."
},
"unitOfMeasure":{
"type":"string",
"description":"The unit can be minutes or GB.",
"enum":[
"NONE",
"SECOND",
"MINUTE",
"HOUR",
"DAY",
"MONTH",
"BYTE",
"KILOBYTE",
"MEGABYTE",
"GIGABYTE",
"PAGES",
"MOVIES",
"TIME_INTERVAL",
"QUANTITY",
"MBPS",
"GBPS"
]
},
"validFor":{
"$ref":"#/components/schemas/TimePeriodOracle",
"description":"The period for which the pla specification characteristic value is valid."
},
"value":{
"oneOf":[
{
"type":"string"
},
{
"type":"object"
},
{
"type":"number"
},
{
"type":"boolean"
},
{
"type":"array"
}
],
"description":"A discrete value that the characteristic can take on. The value type is defined by the valueType characteristic."
},
"valueFrom":{
"type":"string",
"description":"The low range value that a characteristic can take on."
},
"valueTo":{
"type":"string",
"description":"The upper range value that a characteristic can take on."
},
"valueType":{
"type":"string",
"description":"The type or classification of the pla specification characteristic value. Valid values are STRING, NUMBER, OBJECT, ARRAY, DECIMAL, BOOLEAN, DATE, and DATETIME.",
"enum":[
"STRING",
"NUMBER",
"OBJECT",
"ARRAY",
"DECIMAL",
"BOOLEAN",
"DATE",
"DATETIME"
]
},
"rangeInterval":{
"type":"string",
"description":"An indicator that specifies the inclusion or exclusion of the valueFrom and valueTo attributes. If applicable, possible values are \"open\", \"closed\", \"closedBottom\" and \"closedTop\". Valid values are OPEN, CLOSED, CLOSED_BOTTOM, and CLOSED_TOP.",
"enum":[
"OPEN",
"CLOSED",
"CLOSED_BOTTOM",
"CLOSED_TOP"
]
},
"regex":{
"type":"string",
"description":"The regular expression to define constraint on the allowed value."
},
"@type":{
"type":"string",
"description":"The class type of the pla specification characteristic value."
},
"@baseType":{
"type":"string",
"description":"The base type of the pla specification characteristic value."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the pla specification characteristic value."
}
},
"required":[
"value",
"@type"
]
},
"CategoryRef":{
"title":"CategoryRef",
"type":"object",
"description":"The category reference. The category resource groups product offerings, service candidates, and resource candidates in logical containers. Categories can contain other categories and/or product offerings, resource candidates, or service candidates.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the category reference."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the category reference."
},
"version":{
"type":"string",
"description":"The category version."
},
"name":{
"type":"string",
"description":"The name of the category reference."
},
"@type":{
"type":"string",
"description":"The class type of the category reference."
},
"@baseType":{
"type":"string",
"description":"The base type of the category reference."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the category reference."
},
"@referredType":{
"type":"string",
"description":"The type of the referred category reference."
},
"versionState":{
"type":"number",
"description":"The version state of the reference."
}
},
"required":[
"id",
"@type",
"@referredType"
]
},
"ChoiceRelationshipOracle":{
"title":"ChoiceRelationshipOracle",
"allOf":[
{
"$ref":"#/components/schemas/ProductOfferingRef"
},
{
"type":"object",
"properties":{
"parentBundle":{
"$ref":"#/components/schemas/ProductOfferingRef",
"description":"The choice relationship."
}
}
}
]
},
"ProductOfferingRef":{
"title":"ProductOfferingRef",
"type":"object",
"description":"The 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":"The ID of the product offering reference."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the product offering reference."
},
"name":{
"type":"string",
"description":"The name of the product offering reference."
},
"@type":{
"type":"string",
"description":"The class type of the product offering reference."
},
"@baseType":{
"type":"string",
"description":"The base type of the product offering reference."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the product offering reference."
},
"@referredType":{
"type":"string",
"description":"The type of the referred product offering reference."
},
"versionState":{
"type":"number",
"description":"The version state of the reference."
},
"version":{
"type":"string",
"description":"The 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"
}
}
},
"EntityRef":{
"title":"EntityRef",
"type":"object",
"description":"The entity reference. It refers to the entity that is impacted by promotion action.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the entity reference."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the entity reference."
},
"name":{
"type":"string",
"description":"The name of the entity reference."
},
"@type":{
"type":"string",
"description":"The class type of the entity reference."
},
"@baseType":{
"type":"string",
"description":"The base type of the entity reference."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the entity reference."
},
"@referredType":{
"type":"string",
"description":"The type of the referred entity reference."
}
},
"required":[
"id",
"@type",
"@referredType"
]
},
"PromotionRef":{
"title":"PromotionRef",
"type":"object",
"description":"The promotion reference.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the promotion reference."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the promotion reference."
},
"name":{
"type":"string",
"description":"The name of the promotion reference."
},
"@type":{
"type":"string",
"description":"The class type of the promotion reference."
},
"@baseType":{
"type":"string",
"description":"The base type of the promotion reference."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the promotion reference."
},
"@referredType":{
"type":"string",
"description":"The type of the referred promotion reference."
}
},
"required":[
"id",
"@type",
"@referredType"
]
},
"ProductOfferingRefOracle":{
"title":"ProductOfferingRefOracle",
"allOf":[
{
"$ref":"#/components/schemas/ProductOfferingRef"
},
{
"type":"object",
"properties":{
"version":{
"type":"string",
"description":"The version of the product offering."
},
"lifecycleStatus":{
"type":"string",
"description":"The status of the product offering reference."
},
"isBundle":{
"type":"boolean",
"description":"Whether the product offering reference is bundle."
}
}
}
]
},
"PricingLogicAlgorithmRef":{
"title":"PricingLogicAlgorithmRef",
"type":"object",
"description":"The pricing logic algorithm reference. It represents an instantiation of an interface specification for an external rating function, including preset parameters and values gathered during rating.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the pricing logic algorithm reference."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the pricing logic algorithm reference."
},
"name":{
"type":"string",
"description":"The name of the pricing logic algorithm reference."
},
"description":{
"type":"string",
"description":"The description of the pla."
},
"validFor":{
"$ref":"#/components/schemas/TimePeriodOracle",
"description":"The period for which the pricing logic algorithm reference is valid."
},
"plaSpecId":{
"type":"string",
"description":"The ID of the pla specification associated with the pricing logic algorithm reference."
},
"@type":{
"type":"string",
"description":"The class type of the pricing logic algorithm reference."
},
"@baseType":{
"type":"string",
"description":"The base type of the pricing logic algorithm reference."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the pricing logic algorithm reference."
},
"versionState":{
"type":"number",
"description":"The version state of the reference."
}
},
"required":[
"id",
"@type"
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"PricingLogicAlgorithmRef":"#/components/schemas/PricingLogicAlgorithmRef",
"PlaQuantityRangeRefOracle":"#/components/schemas/PlaQuantityRangeRefOracle"
}
}
},
"PlaQuantityRangeRefOracle":{
"title":"PlaQuantityRangeRefOracle",
"allOf":[
{
"$ref":"#/components/schemas/PricingLogicAlgorithmRef"
},
{
"type":"object",
"properties":{
"pricingType":{
"type":"string",
"description":"The type or classification of the pricing logic algorithm quantity range reference. Valid values are SIMPLE, and TIERED.",
"enum":[
"SIMPLE",
"TIERED"
]
}
}
}
]
},
"PlaSpecificationRef":{
"title":"PlaSpecificationRef",
"type":"object",
"description":"A pricing logic algorithm specification reference. A PricingLogicAlgorithmSpec is a detailed description of a tangible or intangible object made available externally in the form of a PricingLogicAlgorithm to customers or other parties playing a party role.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the pricing logic algorithm specification reference."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the pricing logic algorithm specification reference."
},
"version":{
"type":"string",
"description":"The version of the pricing logic algorithm specification."
},
"name":{
"type":"string",
"description":"The name of the pricing logic algorithm specification reference."
},
"@type":{
"type":"string",
"description":"The class type of the pricing logic algorithm specification reference."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the pricing logic algorithm specification reference."
},
"@baseType":{
"type":"string",
"description":"The base type of the pricing logic algorithm specification reference."
},
"@referredType":{
"type":"string",
"description":"The type of the referred pricing logic algorithm specification reference."
},
"versionState":{
"type":"number",
"description":"The version state of the reference."
}
},
"required":[
"id",
"@type",
"@referredType"
]
},
"SLARef":{
"title":"SLARef",
"type":"object",
"description":"ServiceLevelAgreement reference: A service level agreement (SLA) is a type of agreement that represents a formal negotiated agreement between two parties designed to create a common understanding about products, services, priorities, responsibilities, and so forth. The SLA is a set of appropriate procedures and targets formally or informally agreed between parties in order to achieve and maintain specified Quality of Service.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the sla reference."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the sla reference."
},
"name":{
"type":"string",
"description":"The name of the sla reference."
},
"@referredType":{
"type":"string",
"description":"The type of the referred sla reference."
},
"@type":{
"type":"string",
"description":"The class type of the sla reference."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the sla reference."
},
"@baseType":{
"type":"string",
"description":"The base type of the sla reference."
}
},
"required":[
"id",
"@referredType",
"@type"
]
},
"ProductSpecificationRef":{
"title":"ProductSpecificationRef",
"type":"object",
"description":"The product specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the product specification reference."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the product specification reference."
},
"version":{
"type":"string",
"description":"The version of the product specification."
},
"name":{
"type":"string",
"description":"The name of the product specification reference."
},
"@referredType":{
"type":"string",
"description":"The type of the referred product specification reference."
},
"@type":{
"type":"string",
"description":"The class type of the product specification reference."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the product specification reference."
},
"@baseType":{
"type":"string",
"description":"The base type of the product specification reference."
},
"targetProductSchema":{
"$ref":"#/components/schemas/TargetProductSchema",
"description":"The product specification reference."
},
"versionState":{
"type":"number",
"description":"The version state of the reference."
}
},
"required":[
"id",
"@type",
"@referredType"
]
},
"ChannelRef":{
"type":"object",
"title":"ChannelRef",
"description":"The channel reference. The channel defines the channel for selling product offerings.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the channel reference."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the channel reference."
},
"name":{
"type":"string",
"description":"The name of the channel reference."
},
"@referredType":{
"type":"string",
"description":"(Class) type of the referred channel like DistributionChannel, SalesChannel and so on."
},
"@type":{
"type":"string",
"description":"The class type of the channel reference."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the channel reference."
},
"@baseType":{
"type":"string",
"description":"The base type of the channel reference."
}
},
"required":[
"id",
"@referredType",
"@type"
]
},
"ServiceCandidateRef":{
"title":"ServiceCandidateRef",
"type":"object",
"description":"The serviceCandidate reference. ServiceCandidate is an entity that makes a ServiceSpecification available to a catalog.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the service candidate reference."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the service candidate reference."
},
"version":{
"type":"string",
"description":"The version of the service candidate."
},
"name":{
"type":"string",
"description":"The name of the service candidate reference."
},
"@type":{
"type":"string",
"description":"The class type of the service candidate reference."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the service candidate reference."
},
"@baseType":{
"type":"string",
"description":"The base type of the service candidate reference."
},
"@referredType":{
"type":"string",
"description":"The type of the referred service candidate reference."
},
"versionState":{
"type":"number",
"description":"The version state of the reference."
}
},
"required":[
"id",
"@type",
"@referredType"
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"ServiceCandidateRef":"#/components/schemas/ServiceCandidateRef",
"ServiceCandidateRefOracle":"#/components/schemas/ServiceCandidateRefOracle"
}
}
},
"ServiceCandidateRefOracle":{
"title":"ServiceCandidateRefOracle",
"allOf":[
{
"$ref":"#/components/schemas/ServiceCandidateRef"
},
{
"type":"object",
"properties":{
"serviceCode":{
"type":"string",
"description":"The service code associated with the service candidate reference."
}
}
}
]
},
"ResourceCandidateRef":{
"type":"object",
"title":"ResourceCandidateRef",
"description":"The resourceCandidate reference: A resource candidate is an entity that makes a ResourceSpecification available to a catalog.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the resource candidate reference."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the resource candidate reference."
},
"version":{
"type":"string",
"description":"The version of the resource candidate."
},
"name":{
"type":"string",
"description":"The name of the resource candidate reference."
},
"@referredType":{
"type":"string",
"description":"The type of the referred resource candidate reference."
},
"@type":{
"type":"string",
"description":"The class type of the resource candidate reference."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the resource candidate reference."
},
"@baseType":{
"type":"string",
"description":"The base type of the resource candidate reference."
}
},
"required":[
"id",
"@referredType",
"@type"
]
},
"MarketSegmentRef":{
"title":"MarketSegmentRef",
"type":"object",
"description":"Provides references to the corresponding market segment as target of product offerings. A market segment is grouping of Parties, GeographicAreas, SalesChannels, and so forth.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the market segment reference."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the market segment reference."
},
"name":{
"type":"string",
"description":"The name of the market segment reference."
},
"@referredType":{
"type":"string",
"description":"The type of the referred market segment reference."
},
"@type":{
"type":"string",
"description":"The class type of the market segment reference."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the market segment reference."
},
"@baseType":{
"type":"string",
"description":"The base type of the market segment reference."
}
},
"required":[
"id",
"@referredType",
"@type"
]
},
"ServiceSpecificationRef":{
"title":"ServiceSpecificationRef",
"type":"object",
"description":"The service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the service specification reference."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the service specification reference."
},
"name":{
"type":"string",
"description":"The name of the service specification reference."
},
"version":{
"type":"string",
"description":"The service specification version."
},
"@referredType":{
"type":"string",
"description":"The type of the referred service specification reference."
},
"@type":{
"type":"string",
"description":"The class type of the service specification reference."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the service specification reference."
},
"@baseType":{
"type":"string",
"description":"The base type of the service specification reference."
},
"targetServiceSchema":{
"$ref":"#/components/schemas/TargetServiceSchema",
"description":"The service specification reference."
},
"versionState":{
"type":"number",
"description":"The version state of the reference."
}
},
"required":[
"id",
"@type",
"@referredType"
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"ServiceSpecificationRef":"#/components/schemas/ServiceSpecificationRef",
"ServiceSpecificationRefOracle":"#/components/schemas/ServiceSpecificationRefOracle"
}
}
},
"ServiceSpecificationRefOracle":{
"title":"ServiceSpecificationRefOracle",
"allOf":[
{
"$ref":"#/components/schemas/ServiceSpecificationRef"
},
{
"type":"object",
"properties":{
"serviceCode":{
"type":"string",
"description":"The service code associated with the service specification reference."
},
"role":{
"type":"string",
"description":"The service specification role. Valid values are PRIMARY, and AUXILIARY.",
"enum":[
"PRIMARY",
"AUXILIARY"
]
},
"isApplicableToChildServices":{
"type":"boolean",
"description":"Whether the service specification reference is applicable to child services."
}
}
}
]
},
"ProductSpecificationRelationship":{
"title":"ProductSpecificationRelationship",
"type":"object",
"description":"A migration, substitution, dependency or exclusivity relationship between/among product specifications.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the product specification relationship."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the product specification relationship."
},
"relationshipType":{
"type":"string",
"description":"The type or classification of the product specification relationship. Valid values are AGGREGATION, MIGRATION, SUBSTITUTION, DEPENDENCY, EXCLUSIVITY, and PARENT.",
"enum":[
"AGGREGATION",
"MIGRATION",
"SUBSTITUTION",
"DEPENDENCY",
"EXCLUSIVITY",
"PARENT"
]
},
"validFor":{
"$ref":"#/components/schemas/TimePeriodOracle",
"description":"The period for which the product specification relationship is valid."
},
"name":{
"type":"string",
"description":"The name of the product specification relationship."
},
"version":{
"type":"string",
"description":"The version of the referred product specification."
},
"@referredType":{
"type":"string",
"description":"The type of the referred product specification relationship."
},
"@baseType":{
"type":"string",
"description":"The base type of the product specification relationship."
},
"@schemaLocation":{
"type":"string",
"format":"uri",
"description":"The URI of the schema that defines the product specification relationship."
},
"@type":{
"type":"string",
"description":"The class type of the product specification relationship."
},
"characteristic":{
"type":"array",
"items":{
"anyOf":[
{
"$ref":"#/components/schemas/CharacteristicSpecificationOracle"
},
{
"$ref":"#/components/schemas/AttributeRefOracle"
}
]
},
"description":"A list of characteristics associated with the product specification relationship."
}
},
"required":[
"id",
"relationshipType"
]
},
"ResourceSpecificationRef":{
"title":"ResourceSpecificationRef",
"type":"object",
"description":"The resource Specification reference: The ResourceSpecification is required to realize a ProductSpecification.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the resource specification reference."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the resource specification reference."
},
"name":{
"type":"string",
"description":"The name of the resource specification reference."
},
"version":{
"type":"string",
"description":"The resource specification version."
},
"@referredType":{
"type":"string",
"description":"The type of the referred resource specification reference."
},
"@baseType":{
"type":"string",
"description":"The base type of the resource specification reference."
},
"@schemaLocation":{
"type":"string",
"format":"uri",
"description":"The URI of the schema that defines the resource specification reference."
},
"@type":{
"type":"string",
"description":"The class type of the resource specification reference."
}
},
"required":[
"id",
"@type",
"@referredType"
]
},
"BundledProductSpecification":{
"title":"BundledProductSpecification",
"type":"object",
"description":"A type of ProductSpecification that belongs to a grouping of ProductSpecifications made available to the market. It inherits of all attributes of ProductSpecification.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the bundled product specification."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the bundled product specification."
},
"lifecycleStatus":{
"type":"string",
"description":"The status of the bundled product specification."
},
"name":{
"type":"string",
"description":"The name of the bundled product specification."
},
"@type":{
"type":"string",
"description":"The class type of the bundled product specification."
},
"@baseType":{
"type":"string",
"description":"The base type of the bundled product specification."
},
"versionState":{
"type":"number",
"description":"The version state of the reference."
}
},
"required":[
"id",
"@type"
]
},
"Quantity":{
"title":"Quantity",
"description":"A number and unit representing how many of an ProductOffering is available at the offered price.",
"type":"object",
"properties":{
"amount":{
"type":"number",
"description":"A quantity of something, typically the total of a thing or things in number, size, value, extent, or money."
},
"units":{
"type":"string",
"description":"The unit of measure for the quantity, such as meters, cubic yards, kilograms [ISO 80000], and the currency referring to [ISO 4217].",
"enum":[
"NONE",
"SECOND",
"MINUTE",
"HOUR",
"DAY",
"MONTH",
"BYTE",
"KILOBYTE",
"MEGABYTE",
"GIGABYTE",
"PAGES",
"MOVIES",
"TIME_INTERVAL",
"QUANTITY",
"MBPS",
"GBPS"
]
}
},
"required":[
"units",
"amount"
]
},
"AlterationBasedOnOracle":{
"title":"AlterationBasedOnOracle",
"description":"A number, unit and an expression representing the relative alteration.",
"type":"object",
"properties":{
"expression":{
"type":"string",
"description":"The expression used for alteration."
},
"quantity":{
"type":"number",
"description":"The relative quantity based on which the alteration is done."
},
"units":{
"type":"string",
"description":"The units of quantity based on which the alteration is done, it can be any currency or non currency value configured as a balance element."
},
"roundingMethod":{
"type":"string",
"description":"The rounding method to be applied on the quantity. Valid values are NONE, and ROUND_DOWN.",
"enum":[
"NONE",
"ROUND_DOWN"
]
}
}
},
"EntitlementMetricsQuantityOracle":{
"title":"EntitlementMetricsQuantityOracle",
"description":"A number and unit representing entitlement metrics quantity.",
"type":"object",
"properties":{
"amount":{
"type":"number",
"description":"A quantity of something, typically the total of a thing or things in number."
},
"units":{
"type":"string",
"description":"The unit of measure for the quantity. Valid values are ENTL_MTCS_UNT_PRCT, ENTL_MTCS_UNT_HRS, ENTL_MTCS_UNT_MTS, ENTL_MTCS_UNT_PNTS, ENTL_MTCS_UNT_DAYS, and ENTL_MTCS_UNT_SCDS.",
"enum":[
"ENTL_MTCS_UNT_PRCT",
"ENTL_MTCS_UNT_HRS",
"ENTL_MTCS_UNT_MTS",
"ENTL_MTCS_UNT_PNTS",
"ENTL_MTCS_UNT_DAYS",
"ENTL_MTCS_UNT_SCDS"
]
}
},
"required":[
"units",
"amount"
]
},
"EntitlementQuantityOracle":{
"title":"EntitlementQuantityOracle",
"description":"A number and unit representing entitlement unit.",
"type":"object",
"properties":{
"amount":{
"type":"number",
"description":"A quantity of something, typically the total of a thing or things in number."
},
"units":{
"type":"string",
"description":"The unit of measure for the quantity. Valid values are ENTL_UNIT_ORDERS, and ENTL_UNIT_SERREQ.",
"enum":[
"ENTL_UNIT_ORDERS",
"ENTL_UNIT_SERREQ"
]
}
},
"required":[
"units",
"amount"
]
},
"TermDuration":{
"title":"TermDuration",
"allOf":[
{
"$ref":"#/components/schemas/Quantity"
},
{
"type":"object",
"properties":{
"units":{
"type":"string",
"description":"The term duration units. Valid values are DAYS, MONTHS, WEEKS, and YEARS.",
"enum":[
"DAYS",
"MONTHS",
"WEEKS",
"YEARS"
]
}
}
}
]
},
"Money":{
"title":"Money",
"description":"The amount of money that characterizes the price.",
"type":"object",
"properties":{
"value":{
"type":"number",
"description":"The value assigned to the money."
},
"unit":{
"type":"string",
"description":"The currency (ISO4217 norm uses 3 letters to define the currency)."
}
},
"required":[
"value",
"unit"
]
},
"ProductOfferingPriceRelationship":{
"title":"ProductOfferingPriceRelationship",
"type":"object",
"description":"The product offering price relationship.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the product offering price relationship."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the product offering price relationship."
},
"name":{
"type":"string",
"description":"The name of the product offering price relationship."
},
"version":{
"type":"string",
"description":"The version of the associated popRelationship."
},
"relationshipType":{
"type":"string",
"description":"The type or classification of the product offering price relationship. Valid values are DISCOUNT, MARKUP, OVERRIDE, DISCOUNT_OVERRIDE, and DEPENDENCY.",
"enum":[
"DISCOUNT",
"MARKUP",
"OVERRIDE",
"DISCOUNT_OVERRIDE",
"DEPENDENCY"
]
},
"@type":{
"type":"string",
"description":"The class type of the product offering price relationship."
},
"versionState":{
"type":"number",
"description":"The version state of the reference."
},
"@baseType":{
"type":"string",
"description":"The base type of the product offering price relationship."
},
"@schemaLocation":{
"type":"string",
"format":"uri",
"description":"The URI of the schema that defines the product offering price relationship."
},
"@referredType":{
"type":"string",
"description":"The type of the referred product offering price relationship."
}
},
"required":[
"id",
"relationshipType",
"@type",
"@referredType"
]
},
"ProductOfferingPriceRelationshipOracle":{
"title":"ProductOfferingPriceRelationshipOracle",
"allOf":[
{
"$ref":"#/components/schemas/ProductOfferingPriceRelationship"
},
{
"type":"object",
"properties":{
"version":{
"type":"string",
"description":"The version of the price being refered."
},
"sequential":{
"type":"boolean",
"description":"Whether the product offering price relationship has sequential."
},
"discountMode":{
"type":"string",
"description":"Indicates the mode of processing discounts. Valid values are SEQUENTIAL and PARALLEL.",
"enum":[
"SEQUENTIAL",
"PARALLEL"
]
}
}
}
]
},
"BundledProductOfferingPriceRelationship":{
"title":"BundledProductOfferingPriceRelationship",
"type":"object",
"description":"The bundle of product offering prices for all component offers associated with a bundle.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the bundled product offering price relationship."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the bundled product offering price relationship."
},
"name":{
"type":"string",
"description":"The name of the bundled product offering price relationship."
},
"version":{
"type":"string",
"description":"The version of the associated product offering price."
},
"@type":{
"type":"string",
"description":"The class type of the bundled product offering price relationship."
},
"@referredType":{
"type":"string",
"description":"The type of the referred bundled product offering price relationship."
},
"lifecycleStatus":{
"type":"string",
"description":"The status of the bundled product offering price relationship."
},
"versionState":{
"type":"number",
"description":"The version state of the reference."
},
"@baseType":{
"type":"string",
"description":"The base type of the bundled product offering price relationship."
},
"@schemaLocation":{
"type":"string",
"format":"uri",
"description":"The URI of the schema that defines the bundled product offering price relationship."
}
},
"required":[
"id",
"@type",
"@referredType"
]
},
"ProductSpecificationCharacteristicValueUse":{
"title":"ProductSpecificationCharacteristicValueUse",
"type":"object",
"description":"A use of the ProdSpecCharacteristicValue by a ProductOffering to which additional properties (attributes) apply or override the properties of similar properties contained in ProdSpecCharacteristicValue. It should be noted that characteristics which their value(s) addressed by this object must exist in corresponding product specification and has to be configurable. The available characteristic values for a ProductSpecCharacteristic in a Product specification can be modified at the ProductOffering level. For example, a characteristic 'Color' might have values White, Blue, Green, and Red. But, the list of values can be restricted to for example White and Blue in an associated product offering. It should be noted that the list of values in 'ProductSpecificationCharacteristicValueUse' is a strict subset of the list of values as defined in the corresponding product specification characteristics.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the product specification characteristic value use."
},
"name":{
"type":"string",
"description":"The name of the product specification characteristic value use."
},
"description":{
"type":"string",
"description":"A narrative that explains in detail what the productSpecCharacteristic is."
},
"valueType":{
"type":"string",
"description":"The type or classification of the product specification characteristic value use. Valid values are STRING, NUMBER, OBJECT, ARRAY, DECIMAL, BOOLEAN, DATE, DATETIME, and URL.",
"enum":[
"STRING",
"NUMBER",
"OBJECT",
"ARRAY",
"DECIMAL",
"BOOLEAN",
"DATE",
"DATETIME",
"URL"
]
},
"minCardinality":{
"type":"integer",
"description":"The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality."
},
"maxCardinality":{
"type":"integer",
"description":"The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality."
},
"validFor":{
"$ref":"#/components/schemas/TimePeriodOracle",
"description":"The period for which the product specification characteristic value use is valid."
},
"configurable":{
"type":"boolean",
"description":"Whether the product specification characteristic value use is configurable."
},
"productSpecCharacteristicValue":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CharacteristicValueSpecification"
},
"description":"A list of product specification characteristic values associated with the product specification characteristic value use."
},
"productSpecification":{
"$ref":"#/components/schemas/ProductSpecificationRef",
"description":"The product specification characteristic value use."
},
"@type":{
"type":"string",
"description":"The class type of the product specification characteristic value use."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the product specification characteristic value use."
},
"@baseType":{
"type":"string",
"description":"The base type of the product specification characteristic value use."
}
},
"required":[
"name",
"productSpecCharacteristicValue",
"productSpecification",
"@type"
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"ProdSpecCharValueUse":"#/components/schemas/ProductSpecificationCharacteristicValueUse",
"ProdSpecCharValueUseOracle":"#/components/schemas/ProductSpecificationCharacteristicValueUseOracle"
}
}
},
"ProductSpecificationCharacteristicValueUseOracle":{
"title":"ProductSpecificationCharacteristicValueUseOracle",
"allOf":[
{
"$ref":"#/components/schemas/ProductSpecificationCharacteristicValueUse"
},
{
"type":"object",
"properties":{
"displayName":{
"type":"string",
"description":"The name of the display associated with the product specification characteristic value use."
}
}
}
]
},
"SpecCharValueUse":{
"title":"SpecCharValueUse",
"type":"object",
"description":"A use of the SpecCharacteristicValue by a ProductOffering to which additional properties (attributes) apply or override the properties of similar properties contained in SpecCharacteristicValue. It should be noted that characteristics which their value(s) addressed by this object must exist in corresponding specification. The available characteristic values for a SpecCharacteristic in a specification can be modified at the ProductOffering level. For example, a characteristic 'Color' might have values White, Blue, Green, and Red. But, the list of values can be restricted to for example White and Blue in an associated product offering. It should be noted that the list of values in 'SpecCharValueUse' is a strict subset of the list of values as defined in the corresponding specification characteristics.",
"properties":{
"name":{
"type":"string",
"description":"The name of the specification characteristic value use."
},
"description":{
"type":"string",
"description":"A narrative that explains in detail what the productSpecCharacteristic is."
},
"valueType":{
"type":"string",
"description":"The type or classification of the specification characteristic value use. Valid values are STRING, NUMBER, OBJECT, ARRAY, DECIMAL, BOOLEAN, DATE, and DATETIME.",
"enum":[
"STRING",
"NUMBER",
"OBJECT",
"ARRAY",
"DECIMAL",
"BOOLEAN",
"DATE",
"DATETIME"
]
},
"minCardinality":{
"type":"integer",
"description":"The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality."
},
"maxCardinality":{
"type":"integer",
"description":"The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality."
},
"validFor":{
"$ref":"#/components/schemas/TimePeriodOracle",
"description":"The period for which the specCharacteristic is valid."
},
"specCharacteristicValue":{
"type":"array",
"items":{
"$ref":"#/components/schemas/SpecCharacteristicValueOracle"
},
"description":"A list of spec characteristic values associated with the specification characteristic value use."
},
"specification":{
"$ref":"#/components/schemas/ProductSpecificationRef",
"description":"The specification characteristic value use."
}
},
"required":[
"name",
"specCharacteristicValue",
"specification"
]
},
"CustomProfSpecCharValueUse":{
"title":"CustomProfSpecCharValueUse",
"type":"object",
"description":"A use of the CustomProfSpecCharValue by an entity to which additional properties (attributes) apply or override the properties of similar properties contained in ProdSpecCharacteristicValue. It should be noted that characteristics which their value(s) addressed by this object must exist in corresponding product specification. The available characteristic values for a ProductSpecCharacteristic in a Product specification can be modified at the ProductOffering level. For example, a characteristic 'Color' might have values White, Blue, Green, and Red. But, the list of values can be restricted to for example White and Blue in an associated product offering. It should be noted that the list of values in 'ProductSpecificationCharacteristicValueUse' is a strict subset of the list of values as defined in the corresponding product specification characteristics.",
"properties":{
"name":{
"type":"string",
"description":"The name of the custom prof specification characteristic value use."
},
"description":{
"type":"string",
"description":"A narrative that explains in detail what the customProfileSpecCharacteristic is."
},
"valueType":{
"type":"string",
"description":"The type or classification of the custom prof specification characteristic value use. Valid values are STRING, NUMBER, OBJECT, ARRAY, DECIMAL, BOOLEAN, DATE, and DATETIME.",
"enum":[
"STRING",
"NUMBER",
"OBJECT",
"ARRAY",
"DECIMAL",
"BOOLEAN",
"DATE",
"DATETIME"
]
},
"minCardinality":{
"type":"integer",
"description":"The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality."
},
"maxCardinality":{
"type":"integer",
"description":"The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality."
},
"validFor":{
"$ref":"#/components/schemas/TimePeriodOracle",
"description":"The period for which the custom prof specification characteristic value use is valid."
},
"customProfileSpecCharValue":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CustomProfileSpecCharValue"
},
"description":"A list of custom profile specification characteristic values associated with the custom prof specification characteristic value use."
},
"customProfileSpec":{
"$ref":"#/components/schemas/CustomProfileSpecRefOracle",
"description":"The custom prof specification characteristic value use."
}
},
"required":[
"name",
"customProfileSpecCharValue",
"customProfileSpec"
]
},
"CustomProfileSpecCharValue":{
"title":"CustomProfileSpecCharValue",
"type":"object",
"description":"A number or text that can be assigned to a CustomProfileSpecCharacteristic.",
"properties":{
"isDefault":{
"type":"boolean",
"description":"Whether the custom profile specification characteristic value is default."
},
"unitOfMeasure":{
"type":"string",
"description":"The unit can be minutes or GB.",
"enum":[
"NONE",
"SECOND",
"MINUTE",
"HOUR",
"DAY",
"MONTH",
"BYTE",
"KILOBYTE",
"MEGABYTE",
"GIGABYTE",
"PAGES",
"MOVIES",
"TIME_INTERVAL",
"QUANTITY",
"MBPS",
"GBPS"
]
},
"validFor":{
"$ref":"#/components/schemas/TimePeriodOracle",
"description":"The period for which the custom profile specification characteristic value is valid."
},
"value":{
"oneOf":[
{
"type":"string"
},
{
"type":"object"
},
{
"type":"number"
},
{
"type":"boolean"
},
{
"type":"array"
}
],
"description":"A discrete value that the characteristic can take on. The value type is defined by the valueType characteristic."
},
"valueFrom":{
"type":"string",
"description":"The low range value that a characteristic can take on."
},
"valueTo":{
"type":"string",
"description":"The upper range value that a characteristic can take on."
},
"displayText":{
"type":"string",
"description":"A string. A word, term, or phrase by which can be displyed for user experience."
},
"enabled":{
"type":"boolean",
"description":"Whether the custom profile specification characteristic value has enabled."
},
"sequence":{
"type":"integer",
"description":"The order sequence for the values input."
},
"valueType":{
"type":"string",
"description":"The type or classification of the custom profile specification characteristic value. Valid values are STRING, NUMBER, OBJECT, ARRAY, DECIMAL, BOOLEAN, DATE, DATETIME, PRODUCT_OFFER, PRODUCT_SPEC, PRODUCT_LINE, and SPEC_CHAR.",
"enum":[
"STRING",
"NUMBER",
"OBJECT",
"ARRAY",
"DECIMAL",
"BOOLEAN",
"DATE",
"DATETIME",
"PRODUCT_OFFER",
"PRODUCT_SPEC",
"PRODUCT_LINE",
"SPEC_CHAR"
]
},
"rangeInterval":{
"type":"string",
"description":"An indicator that specifies the inclusion or exclusion of the valueFrom and valueTo attributes. If applicable, possible values are \"open\", \"closed\", \"closedBottom\" and \"closedTop\". Valid values are OPEN, CLOSED, CLOSED_BOTTOM, and CLOSED_TOP.",
"enum":[
"OPEN",
"CLOSED",
"CLOSED_BOTTOM",
"CLOSED_TOP"
]
},
"regex":{
"type":"string",
"description":"The regular expression to define constraint on the allowed value."
},
"@type":{
"type":"string",
"description":"The class type of the custom profile specification characteristic value."
},
"@baseType":{
"type":"string",
"description":"The base type of the custom profile specification characteristic value."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the custom profile specification characteristic value."
},
"valueReferenceId":{
"type":"string",
"description":"The ID of the value reference associated with the custom profile specification characteristic value."
},
"valueReferenceType":{
"type":"string",
"description":"The type or classification of the custom profile specification characteristic value. Valid values are SERVICE_SPEC.",
"enum":[
"SERVICE_SPEC"
]
}
},
"required":[
"value",
"@type"
]
},
"ExternalConfigurationPropertiesOracle":{
"title":"ExternalConfigurationPropertiesOracle",
"type":"object",
"description":"A use of the ExternalConfigurationPropertiesOracle by an entity to which additional properties (attributes) apply or override the properties of similar properties contained in ProdSpecCharacteristicValue. It should be noted that characteristics which their value(s) addressed by this object must exist in corresponding product specification. The available characteristic values for a ProductSpecCharacteristic in a Product specification can be modified at the ProductOffering level. For example, a characteristic 'Color' might have values White, Blue, Green, and Red. But, the list of values can be restricted to for example White and Blue in an associated product offering. It should be noted that the list of values in 'ProductSpecificationCharacteristicValueUse' is a strict subset of the list of values as defined in the corresponding product specification characteristics.",
"properties":{
"name":{
"type":"string",
"description":"The name of the external configuration property."
},
"description":{
"type":"string",
"description":"A narrative that explains in detail what the external configuration characteristic is."
},
"sourceSystemName":{
"type":"string",
"description":"The name of the source system associated with the external configuration property."
},
"valueType":{
"type":"string",
"description":"The type or classification of the external configuration property. Valid values are STRING, NUMBER, OBJECT, ARRAY, DECIMAL, BOOLEAN, DATE, and DATETIME.",
"enum":[
"STRING",
"NUMBER",
"OBJECT",
"ARRAY",
"DECIMAL",
"BOOLEAN",
"DATE",
"DATETIME"
]
},
"minCardinality":{
"type":"integer",
"description":"The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality."
},
"maxCardinality":{
"type":"integer",
"description":"The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality."
},
"validFor":{
"$ref":"#/components/schemas/TimePeriodOracle",
"description":"The period for which the external configuration property is valid."
},
"externalConfigurationValue":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ExternalConfigurationValueOracle"
},
"description":"A list of external configuration values associated with the external configuration property."
}
},
"required":[
"name",
"externalConfigurationValue"
]
},
"TaxItem":{
"title":"TaxItem",
"type":"object",
"description":"An amount of money levied on the price of a Product by a legislative body.",
"properties":{
"taxAmount":{
"$ref":"#/components/schemas/Money",
"description":"The tax item."
},
"taxCategory":{
"type":"string",
"description":"A categorization of the tax rate."
},
"taxRate":{
"type":"number",
"description":"The tax rate associated with the tax item."
},
"@baseType":{
"type":"string",
"description":"The base type of the tax item."
},
"@schemaLocation":{
"type":"string",
"format":"uri",
"description":"A URI to a JSON-Schema file that defines additional attributes and relationships."
},
"@type":{
"type":"string",
"description":"When sub-classing, this defines the sub-class entity name."
}
},
"required":[
"@type"
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"TaxItem":"#/components/schemas/TaxItem",
"TaxItemOracle":"#/components/schemas/TaxItemOracle"
}
}
},
"TaxItemOracle":{
"title":"TaxItemOracle",
"allOf":[
{
"$ref":"#/components/schemas/TaxItem"
},
{
"type":"object",
"properties":{
"taxCode":{
"type":"string",
"description":"A tax code of the tax rate."
},
"taxTime":{
"type":"string",
"description":"The date and time of the tax item.",
"enum":[
"NONE",
"EVENT_TIME",
"BILLING_TIME"
]
},
"taxProvider":{
"type":"string",
"description":"A tax code for the vendor."
}
},
"required":[
"taxCode",
"taxProvider"
]
}
]
},
"TaxAmount":{
"title":"TaxAmount",
"description":"The tax amount resource.",
"type":"object",
"properties":{
"value":{
"type":"number",
"description":"The value assigned to the tax amount."
},
"unit":{
"type":"string",
"description":"The currency (ISO4217 norm uses 3 letters to define the currency)."
}
},
"required":[
"value",
"unit"
]
},
"PolicyRef":{
"title":"PolicyRef",
"type":"object",
"description":"The policy rule reference. PolicyRule is a set of rules that manage and control the state and state transitions of one or more managed objects.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the policy reference."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the policy reference."
},
"version":{
"type":"string",
"description":"The policy version."
},
"name":{
"type":"string",
"description":"The name of the policy reference."
},
"@type":{
"type":"string",
"description":"The class type of the policy reference."
},
"@baseType":{
"type":"string",
"description":"The base type of the policy reference."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the policy reference."
},
"@referredType":{
"type":"string",
"description":"The type of the referred policy reference."
},
"versionState":{
"type":"number",
"description":"The version state of the reference."
}
},
"required":[
"id",
"@referredType"
]
},
"ProductOfferingPriceRef":{
"title":"ProductOfferingPriceRef",
"type":"object",
"description":"The productPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased.",
"properties":{
"refId":{
"type":"string",
"description":"The ID of the ref associated with the product offering price reference."
},
"refName":{
"type":"string",
"description":"The name of the ref associated with the product offering price reference."
},
"id":{
"type":"string",
"description":"The ID of the product offering price reference."
},
"version":{
"type":"string",
"description":"The version of a related entity."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the product offering price reference."
},
"name":{
"type":"string",
"description":"The name of the product offering price reference."
},
"@baseType":{
"type":"string",
"description":"The base type of the product offering price reference."
},
"@schemaLocation":{
"type":"string",
"format":"uri",
"description":"The URI of the schema that defines the product offering price reference."
},
"@type":{
"type":"string",
"description":"The class type of the product offering price reference."
},
"@referredType":{
"type":"string",
"description":"The actual type of the target instance when needed for disambiguation."
},
"versionState":{
"type":"number",
"description":"The version state of the reference."
}
},
"required":[
"id",
"@referredType",
"@type"
]
},
"ProductOfferingPriceRefOrValue":{
"anyOf":[
{
"$ref":"#/components/schemas/ProductOfferingPrice"
},
{
"$ref":"#/components/schemas/ProductOfferingPriceRef"
},
{
"$ref":"#/components/schemas/ProductOfferingPriceOracle"
},
{
"$ref":"#/components/schemas/ProductOfferingPriceAlterationOracle"
},
{
"$ref":"#/components/schemas/ProductOfferingPriceAllowanceOracle"
},
{
"$ref":"#/components/schemas/ProductOfferRolloverPriceOracle"
},
{
"$ref":"#/components/schemas/ProductOfferingPriceOverageOracle"
},
{
"$ref":"#/components/schemas/ProductOfferingPricePlanOracle"
},
{
"$ref":"#/components/schemas/PenaltyPriceOracle"
}
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"ProductOfferingPriceRef":"#/components/schemas/ProductOfferingPriceRef",
"ProductOfferingPrice":"#/components/schemas/ProductOfferingPrice",
"ProductOfferingPriceOracle":"#/components/schemas/ProductOfferingPriceOracle",
"ProductOfferPriceAlterationOracle":"#/components/schemas/ProductOfferingPriceAlterationOracle",
"ProductOfferPriceAllowanceOracle":"#/components/schemas/ProductOfferingPriceAllowanceOracle",
"ProductOfferRolloverPriceOracle":"#/components/schemas/ProductOfferRolloverPriceOracle",
"ProductOfferPriceOverageOracle":"#/components/schemas/ProductOfferingPriceOverageOracle",
"ProductOfferPricePlanOracle":"#/components/schemas/ProductOfferingPricePlanOracle",
"PenaltyPriceOracle":"#/components/schemas/PenaltyPriceOracle"
}
},
"description":"The product offering price reference or value resource."
},
"AgreementRef":{
"title":"AgreementRef",
"type":"object",
"description":"Agreement reference. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications.",
"properties":{
"href":{
"type":"string",
"description":"The hyperlink reference to the agreement reference."
},
"id":{
"type":"string",
"description":"The ID of the agreement reference."
},
"name":{
"type":"string",
"description":"The name of the agreement reference."
},
"@referredType":{
"type":"string",
"description":"The type of the referred agreement reference."
}
},
"required":[
"id",
"@referredType"
]
},
"ProductOfferingInfoOracle":{
"title":"ProductOfferingInfoOracle",
"type":"object",
"description":"The more information on the Product Offering.",
"properties":{
"isEligibleForService":{
"type":"boolean",
"description":"Whether the product offering info is eligible for service."
},
"isEligibleForSelfService":{
"type":"boolean",
"description":"Whether the product offering info is eligible for self service."
},
"trackAsAsset":{
"type":"boolean",
"description":"When the product is purchased, you want to track it as a customer asset to allows you to create quotes and orders based on the asset."
},
"pricingCommitType":{
"type":"string",
"description":"The type or classification of the product offering info. Valid values are COMMITTED, and DYNAMIC.",
"enum":[
"COMMITTED",
"DYNAMIC"
]
},
"dynamicDiscountMethod":{
"type":"string",
"description":"The code that specifies whether the discount override is an amount or a percentage. Valid values are AMOUNT and PERCENTAGE.",
"enum":[
"AMOUNT",
"PERCENTAGE"
]
},
"fulfillmentItemCode":{
"$ref":"#/components/schemas/ProductSpecificationRef",
"description":"The fulfillment item code associated with the product offering info."
},
"isConfigurable":{
"type":"boolean",
"description":"Whether the product offering info is configurable."
},
"productType":{
"type":"string",
"description":"The type or classification of the product offering info. Valid values are PACKAGE, COMMERCIAL_BUNDLE, SERVICE_BUNDLE, SERVICE, DEVICE, ACCESSORY, CHOICE, AGGREGATION, TIME_BASED_OFFER, SYSTEM_OFFER, SYSTEM_DISCOUNT, and OTHERS.",
"enum":[
"PACKAGE",
"COMMERCIAL_BUNDLE",
"SERVICE_BUNDLE",
"SERVICE",
"DEVICE",
"ACCESSORY",
"CHOICE",
"AGGREGATION",
"TIME_BASED_OFFER",
"SYSTEM_OFFER",
"SYSTEM_DISCOUNT",
"OTHERS"
]
},
"isBillable":{
"type":"boolean",
"description":"Whether the product offering info is billable."
},
"checkEligibility":{
"type":"boolean",
"description":"Whether the product offering info has check eligibility."
},
"returnIfDefective":{
"type":"boolean",
"description":"Whether the product offering info has return if defective."
},
"allowBYOD":{
"type":"boolean",
"description":"Whether to allow byod for the product offering info."
},
"isShippable":{
"type":"boolean",
"description":"Whether the product offering info is shippable."
},
"allowManualOverride":{
"type":"boolean",
"description":"Whether to allow manual override for the product offering info."
},
"overrideDefaultDiscount":{
"type":"boolean",
"description":"Whether the product offering info has override default discount."
},
"maximumPriceOverrideLimit":{
"type":"number",
"description":"The maximum price override limit associated with the product offering info."
},
"installationRequired":{
"type":"boolean",
"description":"Whether the product offering info has installation required."
},
"billingType":{
"type":"string",
"description":"The type or classification of the product offering info. Valid values are SUBSCRIPTION, ITEM, SPECIAL_RATING, SERVICE_BUNDLE, and CHARGE_SHARE.",
"enum":[
"SUBSCRIPTION",
"ITEM",
"SPECIAL_RATING",
"SERVICE_BUNDLE",
"CHARGE_SHARE"
]
},
"specialRatingType":{
"type":"string",
"description":"The type or classification of the product offering info. Valid values are PHONE_NUMBER.",
"enum":[
"PHONE_NUMBER"
]
},
"specialRatingMaxItems":{
"type":"integer",
"description":"Indicates the maxItems for special rating."
},
"compositionType":{
"type":"string",
"description":"The type or classification of the product offering info. Valid values are PARTIAL_ITEM, and WHOLE_ITEM.",
"enum":[
"PARTIAL_ITEM",
"WHOLE_ITEM"
]
},
"serviceInstance":{
"type":"boolean",
"description":"Whether the product offering info has service instance."
},
"billingServiceType":{
"type":"string",
"description":"The type or classification of the product offering info."
},
"priority":{
"type":"number",
"description":"Indicates the order of processing."
},
"provisioningTag":{
"type":"string",
"description":"Indicates the provisioning tag."
},
"usedForAggregation":{
"type":"boolean",
"description":"Whether the product offering info has used for aggregation."
}
},
"required":[
"productType"
]
},
"CompatibilityRulesOracle":{
"title":"CompatibilityRulesOracle",
"type":"object",
"description":"Specifies the compatibility rule for the offer.",
"properties":{
"name":{
"type":"string",
"description":"The name of the compatibility rule."
},
"subjectProduct":{
"type":"string",
"description":"The subject offer component of the compatability rule."
},
"objectProduct":{
"type":"string",
"description":"The object offer component of the compatability rule."
},
"subjectProductLine":{
"type":"string",
"description":"The subject Product Line component of the compatability rule."
},
"objectProductLine":{
"type":"string",
"description":"The object Product Line component of the compatability rule."
},
"active":{
"type":"boolean",
"description":"Whether the compatibility rule has active."
},
"compatibilityRuleType":{
"type":"string",
"description":"The type or classification of the compatibility rule. Valid values are REQUIRES, and EXCLUDES.",
"enum":[
"REQUIRES",
"EXCLUDES"
]
},
"validFor":{
"$ref":"#/components/schemas/TimePeriodOracle",
"description":"The period for which the compatibility rule is valid."
}
},
"required":[
"name"
]
},
"BundledProductOffering":{
"allOf":[
{
"$ref":"#/components/schemas/ProductOfferingRef"
},
{
"type":"object",
"description":"A containment of a product offering within another product offering, including cardinality details such as whether the bundled offering is mandatory and how many times it can be instantiated in the parent product.",
"properties":{
"refId":{
"type":"string",
"description":"The ID of the ref associated with the bundled product offering."
},
"refName":{
"type":"string",
"description":"The name of the ref associated with the bundled product offering."
},
"lifecycleStatus":{
"type":"string",
"description":"The status of the bundled product offering."
},
"bundledProductOfferingOption":{
"$ref":"#/components/schemas/BundledProductOfferingOption",
"description":"The bundled product offering."
}
}
}
]
},
"BundledProductOfferingChoiceOracle":{
"title":"BundledProductOfferingChoiceOracle",
"allOf":[
{
"$ref":"#/components/schemas/BundledProductOffering"
},
{
"type":"object",
"properties":{
"default":{
"type":"boolean",
"description":"Whether the bundled product offering choice is the default value."
},
"productType":{
"type":"string",
"description":"The type or classification of the bundled product offering choice."
}
}
}
]
},
"BundledProductOfferingOracle":{
"title":"BundledProductOfferingOracle",
"allOf":[
{
"$ref":"#/components/schemas/BundledProductOffering"
},
{
"type":"object",
"properties":{
"productType":{
"type":"string",
"description":"The type or classification of the bundled product offering."
},
"action":{
"type":"string",
"description":"The defines the action on the bundled product offering for Package offers. Valid values are BPO_ACT_MODIFY, BPO_ACT_DISCONNECT, and BPO_ACT_PROMPT.",
"enum":[
"BPO_ACT_MODIFY",
"BPO_ACT_DISCONNECT",
"BPO_ACT_PROMPT"
]
},
"externalConfigurationProperties":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ExternalConfigurationPropertiesOracle"
},
"description":"A list of external configuration properties associated with the bundled product offering."
},
"recommendable":{
"type":"boolean",
"description":"Whether the bundled product offering is recommendable."
},
"productOfferingTerm":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ProductOfferingTermOracle"
},
"description":"A list of product offering terms associated with the bundled product offering."
},
"sequence":{
"type":"integer",
"description":"The bundled offer sequence."
},
"bundledProductOfferingOptionOverride":{
"$ref":"#/components/schemas/BundledProductOfferingOptionOverrideOracle",
"description":"The bundled product offering."
}
}
}
]
},
"BundledProductOfferingOption":{
"title":"BundledProductOfferingOption",
"type":"object",
"description":"A set of numbers that specifies the lower and upper limits for a ProductOffering that can be procured as part of the related BundledProductOffering. Values can range from 0 to unbounded.",
"properties":{
"numberRelOfferLowerLimit":{
"type":"integer",
"description":"The lower limit for a product offering that can be procured as part of the related BundledProductOffering."
},
"numberRelOfferUpperLimit":{
"type":"integer",
"description":"The upper limit for a product offering that can be procured as part of the related BundledProductOffering."
},
"numberRelOfferDefault":{
"type":"integer",
"description":"The default number of produc offereings that should be procured as part of the related BundledProductOffering."
}
},
"required":[
"numberRelOfferLowerLimit",
"numberRelOfferUpperLimit",
"numberRelOfferDefault"
]
},
"BundledProductOfferingOptionOverrideOracle":{
"title":"BundledProductOfferingOptionOverrideOracle",
"type":"object",
"description":"A set of numbers that override the lower and upper limits for a ProductOffering that can be procured as part of the related BundledProductOffering. Values can range from 0 to unbounded.",
"properties":{
"numberRelOfferLowerLimit":{
"type":"integer",
"description":"The lower limit for a product offering that can be procured as part of the related BundledProductOffering."
},
"numberRelOfferUpperLimit":{
"type":"integer",
"description":"The upper limit for a product offering that can be procured as part of the related BundledProductOffering."
},
"numberRelOfferDefault":{
"type":"integer",
"description":"The default number of produc offereings that should be procured as part of the related BundledProductOffering."
}
}
},
"BundledGroupProductOfferingOracle":{
"title":"BundledGroupProductOfferingOracle",
"type":"object",
"description":"A group of product offerings that can be chosen for instantiation of children of the parent product offering, for example a list of channels for selection under a TV offering. Sometimes known as Selection Group. The group can also hierarchically contain other groups.",
"properties":{
"id":{
"type":"string",
"description":"A string. Locally unique identifier of the group, useful in case the parent product offering or group includes multiple groups."
},
"name":{
"type":"string",
"description":"A String. The name of the group of child offerings. Required to distinguish several choice groups."
},
"bundledGroupProductOfferingOption":{
"$ref":"#/components/schemas/BundledGroupProductOfferingOptionOracle",
"description":"The bundled group product offering."
},
"bundledProductOffering":{
"type":"array",
"description":"A BundledProductOffering. Child offerings, from which instances can be created as direct or hierarchically indirect children of the parent offering.",
"items":{
"anyOf":[
{
"$ref":"#/components/schemas/BundledProductOffering"
},
{
"$ref":"#/components/schemas/BundledProductOfferingChoiceOracle"
},
{
"$ref":"#/components/schemas/BundledProductOfferingOracle"
}
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"BundledProductOffering":"#/components/schemas/BundledProductOffering",
"BundledProductOfferingChoiceOracle":"#/components/schemas/BundledProductOfferingChoiceOracle",
"BundledProductOfferingOracle":"#/components/schemas/BundledProductOfferingOracle"
}
}
}
},
"@type":{
"type":"string",
"description":"A String. When sub-classing this defines the sub-class Extensible name."
},
"@baseType":{
"type":"string",
"description":"A String. When sub-classing, this defines the super-class."
},
"@schemaLocation":{
"type":"string",
"description":"A String. A URI to a JSON-Schema file that defines additional attributes and relationships."
}
},
"required":[
"bundledProductOffering"
]
},
"BundledGroupProductOfferingOptionOracle":{
"title":"BundledGroupProductOfferingOptionOracle",
"type":"object",
"description":"Defines how many child offerings can be chosen from a bundled product offering group. For example, it can allow selection of 2 to 7 channel packs from a list and define default selections.",
"properties":{
"numberRelOfferLowerLimit":{
"type":"integer",
"description":"An Integer. The minimum total number of instances of the child offerings directly of hierarchically in the group that should be instantiated."
},
"numberRelOfferUpperLimit":{
"type":"integer",
"description":"An Integer. The maximum total number of instances of the child offerings directly of hierarchically in the group that should be instantiated."
},
"@type":{
"type":"string",
"description":"A String. When sub-classing this defines the sub-class Extensible name."
},
"@baseType":{
"type":"string",
"description":"A String. When sub-classing, this defines the super-class."
},
"@schemaLocation":{
"type":"string",
"description":"A String. A URI to a JSON-Schema file that defines additional attributes and relationships."
}
},
"required":[
"numberRelOfferLowerLimit",
"numberRelOfferUpperLimit"
]
},
"TimePeriod":{
"title":"TimePeriod",
"description":"The period for which the productOffering is valid.",
"type":"object",
"properties":{
"startDateTime":{
"type":"string",
"format":"date-time",
"description":"The start date and time of the time period."
},
"endDateTime":{
"type":"string",
"format":"date-time",
"description":"The end date and time of the time period."
}
}
},
"TargetServiceSchema":{
"title":"TargetServiceSchema",
"type":"object",
"description":"The reference object to the schema and type of target product which is described by product specification.",
"properties":{
"@type":{
"type":"string",
"description":"The class type of the target service schema."
},
"@baseType":{
"type":"string",
"description":"The base type of the target service schema."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the target service schema."
}
},
"required":[
"@type",
"@schemaLocation"
]
},
"ConditionAttribute":{
"title":"ConditionAttribute",
"type":"object",
"properties":{
"attribute":{
"type":"string",
"description":"Specifies the conditions fields."
},
"operation":{
"type":"string",
"description":"Specifies the operator for conditions."
},
"value":{
"type":"string",
"description":"The value assigned to the condition attribute."
}
},
"description":"The condition attribute resource."
},
"PricingLogicAlgorithmSpecification":{
"title":"PricingLogicAlgorithmSpecification",
"type":"object",
"description":"The specification models flexible interface definitions to support reuse by existing rating algorithms.",
"properties":{
"id":{
"type":"string",
"maxLength":30,
"description":"The ID of the pricing logic algorithm specification."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the pricing logic algorithm specification."
},
"name":{
"type":"string",
"description":"The 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":"The pricing logic algorithm specification version."
},
"@type":{
"type":"string",
"description":"The class type of the pricing logic algorithm specification."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the pricing logic algorithm specification."
},
"@baseType":{
"type":"string",
"description":"The base type of the pricing logic algorithm specification."
},
"targetProductSchema":{
"$ref":"#/components/schemas/TargetProductSchema",
"description":"The pricing logic algorithm specification."
},
"validFor":{
"$ref":"#/components/schemas/TimePeriod",
"description":"The period for which the pricing logic algorithm specification is valid."
},
"lifecycleStatus":{
"type":"string",
"description":"The status of the pricing logic algorithm specification."
},
"plaSpecCharacteristic":{
"type":"array",
"items":{
"$ref":"#/components/schemas/PLASpecCharacteristic"
},
"description":"A list of pla specification characteristics associated with the pricing logic algorithm specification."
},
"lastUpdate":{
"type":"string",
"format":"date-time",
"description":"The date and time when the pricing logic algorithm specification was last updated."
}
},
"required":[
"name",
"@type"
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"PricingLogicAlgorithmSpecification":"#/components/schemas/PricingLogicAlgorithmSpecification",
"PricingLogicAlgorithmSpecificationOracle":"#/components/schemas/PricingLogicAlgorithmSpecificationOracle"
}
}
},
"PricingLogicAlgorithmSpecificationOracle":{
"title":"PricingLogicAlgorithmSpecificationsOracle",
"allOf":[
{
"$ref":"#/components/schemas/PricingLogicAlgorithmSpecification"
},
{
"type":"object",
"properties":{
"project":{
"$ref":"#/components/schemas/ProjectRef",
"description":"The pricing logic algorithm specification."
},
"created":{
"type":"string",
"format":"date-time",
"description":"The date and time of the creation."
},
"createdBy":{
"type":"string",
"description":"The name of the person who created item."
},
"lastUpdatedBy":{
"type":"string",
"description":"The name of the person who updated item."
},
"plaSpecificationRelationship":{
"type":"array",
"items":{
"$ref":"#/components/schemas/PLASpecificationRelationship"
},
"description":"A list of pla specification relationships associated with the pricing logic algorithm specification."
},
"externalId":{
"type":"string",
"description":"The ID of the external associated with the pricing logic algorithm specification."
},
"applicationName":{
"type":"string",
"description":"The name of the application associated with the pricing logic algorithm specification."
},
"versionState":{
"type":"number",
"description":"The version state of the Pricing Logic Algorithm Specification."
}
},
"discriminator":{
"propertyName":"@type",
"mapping":{
"OneTimePLASpecOracle":"#/components/schemas/OneTimePLASpecOracle",
"UsagePLASpecOracle":"#/components/schemas/UsagePLASpecOracle",
"RecurringPLASpecOracle":"#/components/schemas/RecurringPLASpecOracle",
"PricingLogicAlgorithmSpecificationOracle":"#/components/schemas/PricingLogicAlgorithmSpecificationOracle"
}
}
}
]
},
"PLASpecificationRelationship":{
"title":"PLASpecificationRelationship",
"type":"object",
"description":"A migration, substitution, dependency or exclusivity relationship between/among pla specifications.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the pla specification relationship."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the pla specification relationship."
},
"relationshipType":{
"type":"string",
"description":"The type or classification of the pla specification relationship. Valid values are PARENT.",
"enum":[
"PARENT"
]
},
"validFor":{
"$ref":"#/components/schemas/TimePeriodOracle",
"description":"The period for which the pla specification relationship is valid."
},
"versionState":{
"type":"number",
"description":"The version state of the reference."
}
},
"required":[
"id",
"relationshipType"
]
},
"OneTimePLASpecOracle":{
"title":"OneTimePLASpecOracle",
"allOf":[
{
"$ref":"#/components/schemas/PricingLogicAlgorithmSpecificationOracle"
},
{
"type":"object"
}
]
},
"RecurringPLASpecOracle":{
"title":"RecurringPLASpecOracle",
"allOf":[
{
"$ref":"#/components/schemas/PricingLogicAlgorithmSpecificationOracle"
},
{
"type":"object"
}
]
},
"UsagePLASpecOracle":{
"title":"UsagePLASpecOracle",
"allOf":[
{
"$ref":"#/components/schemas/PricingLogicAlgorithmSpecificationOracle"
},
{
"type":"object",
"properties":{
"usageSpecification":{
"$ref":"#/components/schemas/UsageSpecificationRefOracle",
"description":"The usage pla specification."
}
}
}
]
},
"UsageSpecificationRef":{
"title":"UsageSpecificationRef",
"type":"object",
"description":"The usage specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the usage specification reference."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the usage specification reference."
},
"name":{
"type":"string",
"description":"The name of the usage specification reference."
},
"version":{
"type":"string",
"description":"The version of the usage specification."
},
"@referredType":{
"type":"string",
"description":"The type of the referred usage specification reference."
},
"@type":{
"type":"string",
"description":"The class type of the usage specification reference."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the usage specification reference."
},
"@baseType":{
"type":"string",
"description":"The base type of the usage specification reference."
},
"versionState":{
"type":"number",
"description":"The version state of the reference."
}
},
"required":[
"id",
"@type",
"@referredType"
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"UsageSpecificationRef":"#/components/schemas/UsageSpecificationRef",
"UsageSpecificationRefOracle":"#/components/schemas/UsageSpecificationRefOracle"
}
}
},
"UsageSpecificationRefOracle":{
"title":"UsageSpecificationRefOracle",
"allOf":[
{
"$ref":"#/components/schemas/UsageSpecificationRef"
},
{
"type":"object",
"properties":{
"usageCode":{
"type":"string",
"description":"The usage code associated with the usage specification reference."
}
}
}
]
},
"CustomerProfileSpecificationRef":{
"title":"CustomerProfileSpecificationRef",
"type":"object",
"description":"The customer Profile specification reference.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the customer profile specification reference."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the customer profile specification reference."
},
"name":{
"type":"string",
"description":"The name of the customer profile specification reference."
},
"version":{
"type":"string",
"description":"The version of the usage specification."
},
"@referredType":{
"type":"string",
"description":"The type of the referred customer profile specification reference."
},
"@type":{
"type":"string",
"description":"The class type of the customer profile specification reference."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the customer profile specification reference."
},
"@baseType":{
"type":"string",
"description":"The base type of the customer profile specification reference."
},
"versionState":{
"type":"number",
"description":"The version state of the reference."
}
},
"required":[
"id",
"@type",
"@referredType"
]
},
"TaxServiceProviderRefOracle":{
"title":"TaxServiceProviderRefOracle",
"type":"object",
"description":"The tax Service Provider reference.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the tax service provider reference."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the tax service provider reference."
},
"name":{
"type":"string",
"description":"The name of the tax service provider reference."
},
"version":{
"type":"string",
"description":"The version of the tax service provider."
},
"@referredType":{
"type":"string",
"description":"The type of the referred tax service provider reference."
},
"@type":{
"type":"string",
"description":"The class type of the tax service provider reference."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the tax service provider reference."
},
"@baseType":{
"type":"string",
"description":"The base type of the tax service provider reference."
},
"versionState":{
"type":"number",
"description":"The version state of the reference."
}
},
"required":[
"id",
"@type",
"@referredType"
]
},
"CustomProfileSpecRefOracle":{
"title":"CustomProfileSpecRefOracle",
"type":"object",
"description":"The custom Profile specification reference.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the custom profile specification reference."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the custom profile specification reference."
},
"name":{
"type":"string",
"description":"The name of the custom profile specification reference."
},
"version":{
"type":"string",
"description":"The version of the custom specification."
},
"@referredType":{
"type":"string",
"description":"The type of the referred custom profile specification reference."
},
"@type":{
"type":"string",
"description":"The class type of the custom profile specification reference."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the custom profile specification reference."
},
"@baseType":{
"type":"string",
"description":"The base type of the custom profile specification reference."
},
"versionState":{
"type":"number",
"description":"The version state of the reference."
}
},
"required":[
"id",
"@type",
"@referredType"
]
},
"Project":{
"title":"Project",
"type":"object",
"description":"A detailed description of the project.",
"properties":{
"id":{
"type":"string",
"maxLength":30,
"description":"The ID of the project."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the project."
},
"name":{
"type":"string",
"description":"The name of the project."
},
"description":{
"type":"string",
"description":"A narrative that describes the project."
},
"version":{
"type":"string",
"description":"The version of the object."
},
"lifecycleStatus":{
"type":"string",
"description":"The status of the project."
},
"@baseType":{
"type":"string",
"description":"The base type of the project."
},
"@schemaLocation":{
"type":"string",
"format":"uri",
"description":"A URI to a JSON-Schema file that defines additional attributes and relationships."
},
"@type":{
"type":"string",
"description":"When sub-classing, this defines the sub-class entity name."
},
"lastUpdate":{
"type":"string",
"format":"date-time",
"description":"The date and time when the project was last updated."
}
},
"required":[
"name",
"@type"
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"Project":"#/components/schemas/Project",
"ProjectOracle":"#/components/schemas/ProjectOracle"
}
}
},
"ProjectOracle":{
"title":"ProjectOracle",
"allOf":[
{
"$ref":"#/components/schemas/Project"
},
{
"type":"object",
"properties":{
"currentStatus":{
"type":"string",
"description":"Indicates the current status before the state change."
},
"action":{
"type":"string",
"description":"Indicates the last action performed on the project."
},
"validFor":{
"$ref":"#/components/schemas/TimePeriod",
"description":"The period for which the project is valid."
},
"publishJobRef":{
"$ref":"#/components/schemas/PublishJobRef",
"description":"The publish job reference for the project."
},
"projectItems":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ProjectItemRef"
},
"description":"A list of project items associated with the project."
},
"created":{
"type":"string",
"format":"date-time",
"description":"The date and time of the creation."
},
"launchedDate":{
"type":"string",
"format":"date-time",
"description":"The date and time when the project was launched."
},
"targetReleaseDate":{
"type":"string",
"format":"date",
"description":"The target release date and time for the project."
},
"createdBy":{
"type":"string",
"description":"The name of the person who created item."
},
"lastUpdatedBy":{
"type":"string",
"description":"The name of the person who updated item."
},
"approvalEnabled":{
"type":"boolean",
"description":"Whether the project has approval enabled."
},
"publishTrackingEnabled":{
"type":"boolean",
"description":"Whether the project has publish tracking enabled."
},
"subStatus":{
"type":"string",
"description":"The status of the project."
},
"approvalHistory":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ApprovalHistory"
},
"description":"A list of approval histories associated with the project."
},
"approver":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ApproverRef"
},
"description":"A list of approvers associated with the project."
},
"teamEnabled":{
"type":"boolean",
"description":"Whether the project has team enabled."
},
"rollbackType":{
"type":"string",
"description":"The type of rollback."
},
"projectType":{
"type":"string",
"description":"The type of project to show a rollback project."
},
"team":{
"type":"array",
"items":{
"$ref":"#/components/schemas/TeamOracle"
},
"description":"A list of teams associated with the project."
},
"notification":{
"type":"array",
"items":{
"$ref":"#/components/schemas/NotificationOracle"
},
"description":"A list of notifications associated with the project."
},
"projectHistory":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ProjectHistory"
},
"description":"A list of project histories associated with the project."
},
"lifecycleConfiguration":{
"$ref":"#/components/schemas/LifecycleConfigurationRef",
"description":"The lifecycle configuration for the project."
},
"externalId":{
"type":"string",
"description":"The ID of the external associated with the project."
},
"applicationName":{
"type":"string",
"description":"The name of the application associated with the project."
},
"versionState":{
"type":"number",
"description":"The version state of the project."
},
"sourceProject":{
"$ref":"#/components/schemas/ProjectRef",
"description":"The source project."
},
"attachment":{
"type":"array",
"items":{
"anyOf":[
{
"$ref":"#/components/schemas/Attachment"
},
{
"$ref":"#/components/schemas/AttachmentOracle"
},
{
"$ref":"#/components/schemas/AttachmentRef"
}
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"Attachment":"#/components/schemas/Attachment",
"AttachmentOracle":"#/components/schemas/AttachmentOracle",
"AttachmentRef":"#/components/schemas/AttachmentRef"
}
}
},
"description":"A list of attachments associated with the project."
}
}
}
]
},
"ProjectActionType":{
"type":"string",
"description":"The valid values for action on the project.",
"enum":[
"StateChange",
"RemoveProjectItem"
]
},
"PublishJobRef":{
"title":"PublishJobRef",
"type":"object",
"description":"The publish Job reference. A Job describes the details of the publishing state.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the publish job reference."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the publish job reference."
},
"@referredType":{
"type":"string",
"description":"The actual type of the target instance when needed for disambiguation."
}
},
"required":[
"id"
]
},
"TeamOracle":{
"title":"TeamOracle",
"type":"object",
"description":"The team details of an initiative. Includes the name, role and email address of team member which is part of initiative.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the team."
},
"name":{
"type":"string",
"description":"The name of the team."
},
"emailAddress":{
"type":"string",
"description":"The email address of the team member."
},
"partyNumber":{
"type":"string",
"description":"The party number associated with the team."
},
"roleCode":{
"type":"string",
"description":"The role code associated with the team."
},
"isPrimary":{
"type":"boolean",
"description":"Whether the team is primary."
}
}
},
"NotificationOracle":{
"title":"NotificationOracle",
"type":"object",
"description":"The notification details of an initiative. Includes the state.",
"properties":{
"state":{
"type":"string",
"description":"The state for which notification is configured, that is, lifecycleState."
},
"description":{
"type":"string",
"description":"The description of notification."
},
"message":{
"type":"string",
"description":"The notification Message."
},
"@type":{
"type":"string",
"description":"The class type of the notification."
},
"@baseType":{
"type":"string",
"description":"The base type of the notification."
},
"subscriber":{
"type":"array",
"items":{
"$ref":"#/components/schemas/SubscriberOracle"
},
"description":"A list of subscribers associated with the notification."
}
}
},
"ProjectItemRef":{
"title":"ProjectItemRef",
"type":"object",
"description":"The project Item reference. A project Item ref represents entities that can be ProductOffering or ProductOfferingSpecification or ProductOfferingPrice and so on.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the project item reference."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the project item reference."
},
"name":{
"type":"string",
"description":"The name of the project item reference."
},
"version":{
"type":"string",
"description":"The version of the object."
},
"lifecycleStatus":{
"type":"string",
"description":"The lifecycleStatus of the related entity."
},
"context":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ProjectItemContextsOracle"
},
"description":"A list of contexts associated with the project item reference."
},
"@referredType":{
"type":"string",
"description":"The actual type of the target instance when needed for disambiguation."
},
"@refBaseType":{
"type":"string",
"description":"The TMF base type of the target instance when needed for disambiguation."
},
"priceType":{
"type":"string",
"description":"The type or classification of the project item reference.",
"enum":[
"RECURRING",
"ONE_TIME",
"USAGE",
"ALTERATION",
"ALLOWANCE",
"OVERAGE",
"PENALTY",
"ONE_TIME_PRICE_PLAN",
"RECURRING_PRICE_PLAN",
"USAGE_PRICE_PLAN",
"ALTERATION_PRICE_PLAN",
"OVERAGE_PRICE_PLAN",
"COUNTER"
]
},
"ruleType":{
"type":"string",
"enum":[
"COMPATIBILITY",
"ELIGIBILITY",
"MIGRATION",
"RECOMMENDATION",
"CONSTRAINT"
],
"description":"The type or classification of the project item reference. Valid values are COMPATIBILITY, ELIGIBILITY, MIGRATION, RECOMMENDATION, and CONSTRAINT."
},
"entitlementType":{
"type":"string",
"description":"The type or classification of the project item reference. Valid values are ENTITLEMENT_PRICING, and ENTITLEMENT_SERVICE.",
"enum":[
"ENTITLEMENT_PRICING",
"ENTITLEMENT_SERVICE"
]
},
"promotionType":{
"type":"string",
"description":"The type or classification of the project item reference. Valid values are AWARD, DISCOUNT, TRADE_IN, and CROSS_PRODUCT_DISCOUNT.",
"enum":[
"AWARD",
"DISCOUNT",
"TRADE_IN",
"CROSS_PRODUCT_DISCOUNT"
]
},
"profileType":{
"type":"string",
"description":"The type or classification of the project item reference. Valid values are DEVICE_SPEC, BUSINESS_CONFIG, TRADE_IN, CHARGING_TERM, SUSPENSION_TERM, RETURN_CHECKLIST, ENTITY_PROFILE, RENEWAL_TERM, FINANCE_PLAN, and ZONE_VALUE_MAP.",
"enum":[
"DEVICE_SPEC",
"BUSINESS_CONFIG",
"TRADE_IN",
"CHARGING_TERM",
"SUSPENSION_TERM",
"RETURN_CHECKLIST",
"ENTITY_PROFILE",
"RENEWAL_TERM",
"FINANCE_PLAN",
"ZONE_VALUE_MAP"
]
},
"productType":{
"type":"string",
"description":"The type or classification of the project item reference. Valid values are PACKAGE, COMMERCIAL_BUNDLE, SERVICE_BUNDLE, SERVICE, DEVICE, ACCESSORY, CHOICE, AGGREGATION, SYSTEM_OFFER, and OTHERS.",
"enum":[
"PACKAGE",
"COMMERCIAL_BUNDLE",
"SERVICE_BUNDLE",
"SERVICE",
"DEVICE",
"ACCESSORY",
"CHOICE",
"AGGREGATION",
"SYSTEM_OFFER",
"OTHERS"
]
},
"isBundle":{
"type":"boolean",
"description":"Whether the project item reference is bundle."
},
"commercialName":{
"type":"string",
"description":"The name of the commercial associated with the project item reference."
},
"applicationName":{
"type":"string",
"description":"The name of the application associated with the project item reference."
},
"startDateTime":{
"type":"string",
"format":"date-time",
"description":"The start date and time for the project item reference."
},
"endDateTime":{
"type":"string",
"format":"date-time",
"description":"The end date and time for the project item reference."
},
"createdBy":{
"type":"string",
"description":"The name of the person who created item."
}
},
"required":[
"id",
"@referredType"
]
},
"ProjectItemContextsOracle":{
"title":"ProjectItemContextsOracle",
"type":"object",
"description":"The project item context objects which holds the KPI parameters.",
"properties":{
"type":{
"type":"string",
"description":"The type or classification of the project item context. Valid values are ACQUISITION, and RETENTION.",
"enum":[
"ACQUISITION",
"RETENTION"
]
},
"params":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ProjectItemContextParamsOracle"
},
"description":"A list of params associated with the project item context."
}
},
"required":[
"type",
"params"
]
},
"ProjectItemContextParamsOracle":{
"title":"ProjectItemContextParamsOracle",
"type":"object",
"description":"The project item context KPI parameters.",
"properties":{
"key":{
"type":"string",
"description":"The key of the context parameter."
},
"value":{
"type":"string",
"description":"The value assigned to the project item context param."
},
"name":{
"type":"string",
"description":"The name of the project item context param."
}
},
"required":[
"key",
"value",
"name"
]
},
"ProjectPublishEvent":{
"title":"ProjectPublishEvent",
"type":"object",
"description":"The project publish event resource.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the project publish event."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the project publish event."
},
"eventId":{
"type":"string",
"description":"The ID of the event associated with the project publish event."
},
"eventTime":{
"type":"string",
"format":"date-time",
"description":"The date and time when the project publish event occurred."
},
"eventType":{
"type":"string",
"description":"The type of the notification."
},
"correlationId":{
"type":"string",
"description":"The ID of the correlation associated with the project publish event."
},
"domain":{
"type":"string",
"description":"The domain of the event."
},
"title":{
"type":"string",
"description":"The title of the event."
},
"description":{
"type":"string",
"description":"An explanatory of the event."
},
"priority":{
"type":"string",
"description":"The priority associated with the project publish event."
},
"timeOcurred":{
"type":"string",
"format":"date-time",
"description":"The time the event occurred."
},
"event":{
"$ref":"#/components/schemas/ProjectPublishEventPayload",
"description":"The project publish event."
}
}
},
"ProjectPublishEventPayload":{
"title":"ProjectPublishEventPayload",
"type":"object",
"description":"The project publish event payload resource.",
"properties":{
"project":{
"$ref":"#/components/schemas/Publish_Job",
"description":"The project publish event payload."
}
}
},
"PublishJob":{
"title":"PublishJob",
"type":"object",
"description":"The returns the project that is initiated for publishing.",
"properties":{
"project":{
"$ref":"#/components/schemas/Project",
"description":"The publish job."
}
}
},
"Publish_Job":{
"title":"Publish_Job",
"type":"object",
"description":"A detailed description of a publish project available externally as a list of project items.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the publish job."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the publish job."
},
"lifecycleStatus":{
"type":"string",
"description":"The status of the publish job."
},
"name":{
"type":"string",
"description":"The name of the publish job."
},
"acknowledgementUrl":{
"type":"string",
"description":"The call back URL for acknowledgement."
},
"@referredType":{
"type":"string",
"description":"The type of the referred publish job."
},
"projectItems":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ProjectItemRef"
},
"description":"A list of project items associated with the publish job."
}
},
"required":[
"id",
"lifecycleStatus",
"projectItems"
]
},
"PublishJob_Create":{
"title":"PublishJob_Create",
"type":"object",
"description":"The task that initiates publishing of a project.",
"properties":{
"projectId":{
"type":"string",
"description":"The ID of the project associated with the publish job create."
}
},
"required":[
"eventId",
"projectId",
"status"
]
},
"PublishingAcknowledgement":{
"title":"PublishingAcknowledgement",
"type":"object",
"description":"A detailed description of an acknowledgment of the published project from a spoke system.",
"properties":{
"eventId":{
"type":"string",
"description":"The ID of the event associated with the publishing acknowledgement."
},
"projectId":{
"type":"string",
"description":"The ID of the project associated with the publishing acknowledgement."
},
"message":{
"type":"string",
"description":"The error message."
},
"status":{
"$ref":"#/components/schemas/PublishStatusType",
"description":"The status of the publishing acknowledgement."
},
"projectItemsStatus":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ProjectItemStatusRef"
},
"description":"A list of project items status associated with the publishing acknowledgement."
}
},
"required":[
"eventId",
"projectId",
"status",
"message"
]
},
"PublishStatusType":{
"title":"PublishStatusType",
"type":"string",
"description":"The valid values for the publish status.",
"enum":[
"SUCCESS",
"FAILURE"
]
},
"ProjectItemStatusRef":{
"title":"ProjectItemStatusRef",
"type":"object",
"description":"The project Item Publish Status reference.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the project item status reference."
},
"version":{
"type":"string",
"description":"The version of the object."
},
"status":{
"$ref":"#/components/schemas/PublishStatusType",
"description":"The status of the project item status reference."
},
"errorLog":{
"type":"string",
"description":"The error message for the failure."
},
"@referredType":{
"type":"string",
"description":"The actual type of the target instance when needed for disambiguation."
}
},
"required":[
"id",
"version",
"status",
"@referredType"
]
},
"ProjectRef":{
"title":"ProjectRef",
"type":"object",
"description":"The project reference resource.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the project reference."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the project reference."
},
"name":{
"type":"string",
"description":"The name of the project reference."
},
"version":{
"type":"string",
"description":"The version of the project."
}
},
"required":[
"id"
]
},
"SubscriberOracle":{
"title":"SubscriberOracle",
"type":"object",
"description":"The subscriber resource.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the subscriber."
},
"name":{
"type":"string",
"description":"The name of the subscriber."
},
"emailAddress":{
"type":"string",
"description":"The email address of the Subscriber."
},
"partyNumber":{
"type":"string",
"description":"The party number associated with the subscriber."
},
"roleCode":{
"type":"string",
"description":"The role code associated with the subscriber."
},
"@type":{
"type":"string",
"description":"The class type of the subscriber."
},
"@baseType":{
"type":"string",
"description":"The base type of the subscriber."
}
},
"required":[
"id"
]
},
"ApproverRef":{
"title":"ApproverRef",
"type":"object",
"description":"The approver reference resource.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the approver reference."
},
"name":{
"type":"string",
"description":"The name of the approver reference."
},
"emailAddress":{
"type":"string",
"description":"The email address of the approver."
},
"partyNumber":{
"type":"string",
"description":"The party number associated with the approver reference."
},
"roleCode":{
"type":"string",
"description":"The role code associated with the approver reference."
},
"@type":{
"type":"string",
"description":"The class type of the approver reference."
}
},
"required":[
"id"
]
},
"SubjectRef":{
"title":"SubjectRef",
"type":"object",
"description":"The subject reference resource.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the subject reference."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the subject reference."
},
"name":{
"type":"string",
"description":"The name of the subject reference."
},
"version":{
"type":"string",
"description":"The version of the subject."
},
"@referredType":{
"type":"string",
"description":"The actual type of the target instance when needed for disambiguation."
},
"entityPathExpression":{
"type":"string",
"description":"The path that represents the hierarchy of the component product offering within the product offering. It includes the offer ID and associated parents, such as package ID, bundled product offering ID, and atomic offer ID, and helps identify the subject entity in the runtime system."
},
"@baseType":{
"type":"string",
"description":"The base type of the subject reference."
}
},
"required":[
"id",
"@referredType"
]
},
"CharValueObjectRefOracle":{
"title":"CharValueObjectRefOracle",
"type":"object",
"description":"The Reference of the resource referred in CharValue of custom profile specification.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the characteristic value object reference."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the characteristic value object reference."
},
"name":{
"type":"string",
"description":"The name of the characteristic value object reference."
},
"resourceType":{
"type":"string",
"description":"The type or classification of the characteristic value object reference. Valid values are SERVICE_SPEC.",
"enum":[
"SERVICE_SPEC"
]
},
"@referredType":{
"type":"string",
"description":"The type of the referred characteristic value object reference."
},
"@baseType":{
"type":"string",
"description":"The base type of the characteristic value object reference."
},
"@schemaLocation":{
"type":"string",
"format":"uri",
"description":"The URI of the schema that defines the characteristic value object reference."
},
"@type":{
"type":"string",
"description":"The class type of the characteristic value object reference."
}
},
"required":[
"id",
"@type",
"@referredType"
]
},
"importjob-post-request":{
"title":"Item",
"type":"object",
"properties":{
"primaryFile":{
"type":"object",
"description":"The file to upload.",
"format":"binary"
},
"path":{
"type":"string",
"description":"The path of the file to upload."
}
},
"description":"The importjob-post-request resource."
},
"empty-response":{
"title":"Empty Response",
"type":"object",
"properties":{
},
"description":"The empty-response resource."
},
"TierRangeOracle":{
"title":"TierRangeOracle",
"type":"object",
"description":"Contains the minimum and maximum quantity for which the pricing is applicable.",
"properties":{
"minQuantity":{
"type":"integer",
"description":"A minimum quantity of something, typically the total of a thing or things in number, size, value, extent, or money."
},
"maxQuantity":{
"type":"integer",
"description":"A maximum quantity of something, typically the total of a thing or things in number, size, value, extent, or money."
},
"inclusivity":{
"type":"string",
"description":"Specifies whether to include the upper limit or lower limit. Valid values are UPPER_INCLUSIVE and LOWER_INCLUSIVE.",
"enum":[
"UPPER_INCLUSIVE",
"LOWER_INCLUSIVE"
]
},
"productOfferingPrice":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ProductOfferingPriceRef"
},
"description":"A list of product offering prices associated with the tier range."
}
}
},
"ProductOfferCharacteristicOracle":{
"title":"ProductOfferCharacteristicOracle",
"allOf":[
{
"$ref":"#/components/schemas/CharacteristicSpecification"
},
{
"type":"object",
"properties":{
"name":{
"type":"string",
"description":"The name of the product offer characteristic."
},
"displayName":{
"type":"string",
"description":"The name of the display associated with the product offer characteristic."
},
"description":{
"type":"string",
"description":"A narrative that explains in detail what the productSpecCharacteristic is."
},
"valueType":{
"type":"string",
"description":"The type or classification of the product offer characteristic."
},
"configurable":{
"type":"boolean",
"description":"Read only value, if true, the Boolean indicates that the productSpecCharacteristic is configurable."
},
"productSpecification":{
"$ref":"#/components/schemas/ProductSpecificationRef",
"description":"The product offer characteristic."
}
}
}
]
},
"PlaCharacteristicOracle":{
"title":"PlaCharacteristicOracle",
"type":"object",
"description":"A use of the ProdSpecCharacteristicValue by a ProductOffering to which additional properties (attributes) apply or override the properties of similar properties contained in ProdSpecCharacteristicValue.",
"properties":{
"name":{
"type":"string",
"description":"The name of the pricing logic algorithm characteristic."
},
"description":{
"type":"string",
"description":"A narrative that explains in detail what the productSpecCharacteristic is."
},
"valueType":{
"type":"string",
"description":"The type or classification of the pricing logic algorithm characteristic."
},
"plaCharacteristicValue":{
"type":"array",
"items":{
"$ref":"#/components/schemas/PlaCharacteristicValueOracle"
},
"description":"A list of pla characteristic values associated with the pricing logic algorithm characteristic."
}
}
},
"PlaCharacteristicValueOracle":{
"title":"PlaCharacteristicValueOracle",
"type":"object",
"description":"A number or text that can be assigned to a ProductSpecCharacteristic.",
"properties":{
"unitOfMeasure":{
"type":"string",
"description":"The unit can be minutes or GB.",
"enum":[
"NONE",
"SECOND",
"MINUTE",
"HOUR",
"DAY",
"MONTH",
"BYTE",
"KILOBYTE",
"MEGABYTE",
"GIGABYTE",
"PAGES",
"MOVIES",
"TIME_INTERVAL",
"QUANTITY",
"MBPS",
"GBPS"
]
},
"value":{
"oneOf":[
{
"type":"string"
},
{
"type":"object"
},
{
"type":"number"
},
{
"type":"boolean"
}
],
"description":"A discrete value that the characteristic can take on. The value type is defined by the valueType characteristic."
}
}
},
"Destination":{
"title":"Destination",
"type":"object",
"properties":{
"PubDestinationId":{
"type":"string",
"description":"The ID of the pub destination associated with the destination."
},
"CreationDate":{
"type":"string",
"format":"date-time",
"description":"The date and time when the record was created."
},
"DestinationName":{
"type":"string",
"description":"The name of the destination. You can filter destinations by destination name, for example DestinationName=RecordName. DestinationName is the target name of the Fabric system descriptor for the registered spoke system projectPublishEvent target."
},
"DestinationURL":{
"type":"string",
"description":"The URL of the destination."
},
"DestinationCharacteristics":{
"type":"string",
"description":"The destination characteristics stored as JSON data."
},
"DestinationDescription":{
"type":"string",
"description":"The description of the Destination."
},
"DestinationType":{
"type":"string",
"description":"The type of Destination like BRM etc."
},
"EntryLifecycleStatus":{
"type":"string",
"description":"The lifecycle status associated with Destination."
},
"CreatedBy":{
"type":"string",
"description":"The user who created the record."
},
"LastUpdateDate":{
"type":"string",
"format":"date-time",
"description":"The date and time when the destination was last updated."
},
"LastUpdateLogin":{
"type":"string",
"description":"The login of the user who last updated the destination."
},
"LastUpdatedBy":{
"type":"string",
"description":"The user who updated the record."
},
"ObjectVersionNumber":{
"type":"integer",
"description":"The attribute that implements optimistic locking."
}
},
"required":[
"DestinationName",
"DestinationType"
],
"description":"The destination resource."
},
"PublishDestinationOracle":{
"title":"PublishDestinationOracle",
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"The ID of the publish destination."
},
"created":{
"type":"string",
"format":"date-time",
"description":"The date and time when the record was created."
},
"name":{
"type":"string",
"description":"The name of the destination. You can filter destinations by destination name, for example DestinationName=RecordName. DestinationName is the target name of the Fabric system descriptor for the registered spoke system projectPublishEvent target."
},
"url":{
"type":"string",
"description":"The URL of the destination."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the publish destination."
},
"characteristics":{
"$ref":"#/components/schemas/DestinationCharacteristicsOracle",
"description":"The publish destination."
},
"description":{
"type":"string",
"description":"The description of the Destination."
},
"type":{
"type":"string",
"description":"The type of Destination like BRM etc."
},
"mode":{
"type":"string",
"description":"The mode of Destination like Internal etc."
},
"version":{
"type":"string",
"description":"The version of Destination."
},
"entryLifecycleStatus":{
"type":"string",
"description":"The lifecycle status associated with Destination."
},
"isDesignTime":{
"type":"boolean",
"description":"Whether the publish destination is design time."
},
"excludeReferences":{
"type":"boolean",
"description":"Whether the publish destination has exclude references."
},
"pauseEnabled":{
"type":"boolean",
"description":"Whether the publish destination has pause enabled."
},
"createdBy":{
"type":"string",
"description":"The user who created the record."
},
"lastUpdate":{
"type":"string",
"format":"date-time",
"description":"The date and time when the destination was last updated."
},
"lastUpdatedBy":{
"type":"string",
"description":"The user who updated the record."
},
"publishExclusionRule":{
"type":"array",
"items":{
"$ref":"#/components/schemas/PublishExclusionRuleOracle"
},
"description":"A list of publish exclusion rules associated with the publish destination."
}
},
"required":[
"name",
"type"
],
"description":"The publish destination resource."
},
"PublishExclusionRuleOracle":{
"type":"object",
"title":"PublishExclusionRuleOracle",
"description":"The publish exclusion rule resource.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the publish exclusion rule."
},
"resourceType":{
"type":"string",
"description":"The type or classification of the publish exclusion rule."
},
"Description":{
"type":"string",
"description":"A string. Description of the product rule."
},
"ExclusionRule":{
"type":"string",
"description":"The metering Expression applicable to the product rule."
}
}
},
"DestinationCharacteristicsOracle":{
"type":"object",
"title":"DestinationCharacteristicsOracle",
"description":"The destination characteristic resource.",
"properties":{
"order":{
"type":"integer",
"description":"The order of publish."
}
}
},
"SpecCharUseOracle":{
"title":"SpecCharUseOracle",
"type":"object",
"description":"The characteristic that defines Constraints.",
"properties":{
"name":{
"type":"string",
"description":"The name of the specification characteristic use."
},
"displayName":{
"type":"string",
"description":"The name of the display associated with the specification characteristic use."
},
"relationshipType":{
"type":"string",
"description":"The type or classification of the specification characteristic use. Valid values are AGGREGATION.",
"enum":[
"AGGREGATION"
]
},
"operator":{
"type":"string",
"description":"The logic expression operator.",
"enum":[
"EQUALS",
"GT",
"LT",
"GTE",
"LTE",
"NOT_EQUALS",
"IS_NULL",
"IS_NOT_NULL",
"CONTAINS",
"MAPS_TO",
"NOT_MAPS_TO",
"MATCHES",
"NOT_MATCHES"
]
},
"charSpecSeq ":{
"type":"integer",
"description":"The characteristic sequence."
},
"valueType":{
"type":"string",
"description":"The type or classification of the specification characteristic use."
},
"productSpecification":{
"$ref":"#/components/schemas/ProductSpecificationRef",
"description":"The specification characteristic use."
},
"serviceSpecification":{
"$ref":"#/components/schemas/ServiceSpecificationRefOracle",
"description":"The specification characteristic use."
},
"customerProfileSpecification":{
"$ref":"#/components/schemas/CustomerProfileSpecificationRef",
"description":"The specification characteristic use."
},
"customProfileSpecification":{
"$ref":"#/components/schemas/CustomProfileSpecRefOracle",
"description":"The specification characteristic use."
},
"usageSpecification":{
"$ref":"#/components/schemas/UsageSpecificationRefOracle",
"description":"The specification characteristic use."
},
"plaSpecification":{
"$ref":"#/components/schemas/PlaSpecificationRef",
"description":"The specification characteristic use."
},
"standardZone":{
"$ref":"#/components/schemas/CustomProfileSpecRefOracle",
"description":"The specification characteristic use."
},
"customAnalyzerRule":{
"$ref":"#/components/schemas/CustomProfileSpecRefOracle",
"description":"The specification characteristic use."
},
"timeModel":{
"$ref":"#/components/schemas/CustomProfileSpecRefOracle",
"description":"The specification characteristic use."
}
},
"required":[
"name",
"relationshipType"
]
},
"PolicyRule":{
"title":"PolicyRule",
"type":"object",
"description":"The policy resource represents a policy/rule applied to an entity or entity spec.",
"properties":{
"id":{
"type":"string",
"maxLength":30,
"description":"The ID of the policy rule."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the policy rule."
},
"version":{
"type":"string",
"description":"The policy rule version."
},
"name":{
"type":"string",
"description":"The name of the policy rule."
},
"description":{
"type":"string",
"description":"The description of the policy rule."
},
"validFor":{
"$ref":"#/components/schemas/TimePeriod",
"description":"The period for which the policy rule is valid."
},
"@type":{
"type":"string",
"description":"The class type of the policy rule."
},
"@baseType":{
"type":"string",
"description":"The base type of the policy rule."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the policy rule."
},
"lifecycleStatus":{
"type":"string",
"description":"The status of the policy rule."
},
"actionExecutionStrategy":{
"type":"string",
"description":"Indicates the current action execution strategy for policy rule. Valid values are DO_SUCCESS, DO_ALL, DO_FAILURE, and DO_ALL_OR_NOTHING.",
"enum":[
"DO_SUCCESS",
"DO_ALL",
"DO_FAILURE",
"DO_ALL_OR_NOTHING"
]
},
"sequencedActions":{
"type":"string",
"description":"Indicates the ordering of policy action in the policy rule. Valid values are MANDATORY, RECOMMENDED, and BEST_EFFORT.",
"enum":[
"MANDATORY",
"RECOMMENDED",
"BEST_EFFORT"
]
},
"targetPolicyEffect":{
"type":"string",
"description":"Indicates the effect of targeted policy in the policy rule. Valid values are PERMIT, and DENY.",
"enum":[
"PERMIT",
"DENY"
]
},
"priority":{
"type":"number",
"description":"The indicatest the policy rule priority."
},
"policyActionRelationship":{
"type":"array",
"items":{
"$ref":"#/components/schemas/PolicyActionRelationship"
},
"description":"A list of policy action relationships associated with the policy rule."
}
},
"required":[
"name"
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"PolicyRule":"#/components/schemas/PolicyRule",
"PolicyRuleOracle":"#/components/schemas/PolicyRuleOracle"
}
}
},
"PolicyRuleOracle":{
"title":"PolicyRuleOracle",
"allOf":[
{
"$ref":"#/components/schemas/PolicyRule"
},
{
"type":"object",
"properties":{
"lastUpdate":{
"type":"string",
"format":"date-time",
"description":"The date and time when the policy rule was last updated."
},
"created":{
"type":"string",
"format":"date-time",
"description":"The date and time of creation."
},
"createdBy":{
"type":"string",
"description":"The name of the person who created."
},
"lastUpdatedBy":{
"type":"string",
"description":"The name of the person who updated."
},
"productSpecification":{
"$ref":"#/components/schemas/ProductSpecificationRef",
"description":"The policy rule."
},
"serviceSpecification":{
"$ref":"#/components/schemas/ServiceSpecificationRefOracle",
"description":"The policy rule."
},
"customerProfileSpecification":{
"$ref":"#/components/schemas/CustomerProfileSpecificationRef",
"description":"The policy rule."
},
"customProfileSpecification":{
"$ref":"#/components/schemas/CustomProfileSpecRefOracle",
"description":"The policy rule."
},
"usageSpecification":{
"$ref":"#/components/schemas/UsageSpecificationRefOracle",
"description":"The policy rule."
},
"plaSpecification":{
"$ref":"#/components/schemas/PlaSpecificationRef",
"description":"The policy rule."
},
"valueMap":{
"$ref":"#/components/schemas/CustomProfileSpecRefOracle",
"description":"The policy rule."
},
"standardZone":{
"$ref":"#/components/schemas/CustomProfileSpecRefOracle",
"description":"The policy rule."
},
"customAnalyzerRule":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CustomProfileSpecRefOracle"
},
"description":"A list of custom analyzer rules associated with the policy rule."
},
"timeModel":{
"$ref":"#/components/schemas/CustomProfileSpecRefOracle",
"description":"The policy rule."
},
"specCharUse":{
"type":"array",
"items":{
"$ref":"#/components/schemas/SpecCharUseOracle"
},
"description":"A list of spec characteristic uses associated with the policy rule."
},
"project":{
"$ref":"#/components/schemas/ProjectRef",
"description":"The policy rule."
},
"externalId":{
"type":"string",
"description":"The ID of the external associated with the policy rule."
},
"applicationName":{
"type":"string",
"description":"The name of the application associated with the policy rule."
},
"versionState":{
"type":"number",
"description":"The version state of the Price policy."
}
}
}
]
},
"PolicyActionRelationship":{
"title":"PolicyActionRelationship",
"type":"object",
"description":"The policy actions and conditions in policy rule.",
"properties":{
"id":{
"type":"string",
"maxLength":30,
"description":"The ID of the policy action relationship."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the policy action relationship."
},
"name":{
"type":"string",
"description":"The name of the policy action relationship."
},
"priority":{
"type":"number",
"description":"The order of policy actions in policy action relationship."
},
"@type":{
"type":"string",
"description":"The class type of the policy action relationship."
},
"@baseType":{
"type":"string",
"description":"The base type of the policy action relationship."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the policy action relationship."
},
"constraint":{
"anyOf":[
{
"$ref":"#/components/schemas/PolicyConstraint"
},
{
"$ref":"#/components/schemas/PolicyConstraintOracle"
}
],
"description":"The constraint associated with the policy action relationship."
},
"policyAction":{
"anyOf":[
{
"$ref":"#/components/schemas/PolicyAction"
},
{
"$ref":"#/components/schemas/PolicyActionOracle"
}
],
"description":"The policy action associated with the policy action relationship."
}
}
},
"PolicyConstraint":{
"title":"PolicyConstraint",
"type":"object",
"description":"The policy constraint for a policy rule.",
"properties":{
"id":{
"type":"string",
"maxLength":30,
"description":"The ID of the policy constraint."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the policy constraint."
},
"name":{
"type":"string",
"description":"The name of the policy constraint."
},
"conditionCombinationLogic":{
"type":"string",
"description":"Indicates if all conditions needs to be applied /handle in constraint logic. Valid values are ANY_OF, ALL_OF, ONE_OF, and NONE.",
"enum":[
"ANY_OF",
"ALL_OF",
"ONE_OF",
"NONE"
]
},
"@type":{
"type":"string",
"description":"The class type of the policy constraint."
},
"validFor":{
"$ref":"#/components/schemas/TimePeriod",
"description":"The period for which the policy constraint is valid."
},
"@baseType":{
"type":"string",
"description":"The base type of the policy constraint."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the policy constraint."
},
"policyCondition":{
"items":{
"anyOf":[
{
"$ref":"#/components/schemas/PolicyCondition"
},
{
"$ref":"#/components/schemas/PolicyConditionOracle"
},
{
"$ref":"#/components/schemas/PolicyConditionComposite"
}
]
},
"description":"A list of policy conditions associated with the policy constraint."
}
}
},
"PolicyCondition":{
"title":"PolicyCondition",
"type":"object",
"description":"The policy condition for a policy action.",
"properties":{
"id":{
"type":"string",
"maxLength":30,
"description":"The ID of the policy condition."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the policy condition."
},
"name":{
"type":"string",
"description":"The name of the policy condition."
},
"description":{
"type":"string",
"description":"The decription of policy condition."
},
"version":{
"type":"string",
"description":"The policy rule version."
},
"isComposite":{
"type":"boolean",
"description":"Whether the policy condition is composite."
},
"validFor":{
"$ref":"#/components/schemas/TimePeriod",
"description":"The period for which the policy condition is valid."
},
"@type":{
"type":"string",
"description":"The class type of the policy condition."
},
"@baseType":{
"type":"string",
"description":"The base type of the policy condition."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the policy condition."
}
}
},
"PolicyAction":{
"title":"PolicyAction",
"type":"object",
"description":"The policy action for a policy rule.",
"properties":{
"id":{
"type":"string",
"maxLength":30,
"description":"The ID of the policy action."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the policy action."
},
"name":{
"type":"string",
"description":"The name of the policy action."
},
"description":{
"type":"string",
"description":"The decription of policy action."
},
"version":{
"type":"string",
"description":"The policy rule action."
},
"isComposite":{
"type":"boolean",
"description":"Whether the policy action is composite."
},
"validFor":{
"$ref":"#/components/schemas/TimePeriod",
"description":"The period for which the policy action is valid."
},
"@type":{
"type":"string",
"description":"The class type of the policy action."
},
"@baseType":{
"type":"string",
"description":"The base type of the policy action."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the policy action."
},
"lifecycleStatus":{
"type":"string",
"description":"The status of the policy action."
}
}
},
"PolicyConstraintOracle":{
"title":"PolicyConstraintOracle",
"allOf":[
{
"$ref":"#/components/schemas/PolicyConstraint"
},
{
"type":"object",
"properties":{
"impactCategory":{
"type":"string",
"description":"The impact category for Constraint rule. Read only field."
}
}
}
]
},
"PolicyActionOracle":{
"title":"PolicyActionOracle",
"allOf":[
{
"$ref":"#/components/schemas/PolicyAction"
},
{
"type":"object",
"properties":{
"actionValueType":{
"type":"string",
"description":"The type or classification of the policy action."
}
}
}
]
},
"PolicyConditionOracle":{
"title":"PolicyConditionOracle",
"allOf":[
{
"$ref":"#/components/schemas/PolicyCondition"
},
{
"type":"object",
"properties":{
"operator":{
"type":"string",
"description":"The represent the condition operator."
},
"value":{
"oneOf":[
{
"type":"string"
},
{
"type":"number"
},
{
"type":"boolean"
}
],
"description":"The value assigned to the policy condition."
},
"statement":{
"type":"string",
"description":"The represent the condition matching statement."
}
}
}
]
},
"PolicyConditionComposite":{
"title":"PolicyConditionComposite",
"allOf":[
{
"$ref":"#/components/schemas/PolicyCondition"
},
{
"type":"object",
"properties":{
"conditionCombinationLogic":{
"type":"string",
"enum":[
"ANY_OF",
"ALL_OF",
"ONE_OF",
"NONE"
],
"description":"Indicates if all conditions needs to be applied /handled in condition logic. Valid values are ANY_OF, ALL_OF, ONE_OF, and NONE."
},
"policyCondition":{
"type":"array",
"items":{
"$ref":"#/components/schemas/PolicyConditionOracle"
},
"description":"A list of policy conditions associated with the policy condition composite."
}
}
}
]
},
"ValueRelationshipOracle":{
"title":"ValueRelationshipOracle",
"type":"object",
"description":"The represent the value of a characteristic forming the constraint rule.",
"properties":{
"value":{
"oneOf":[
{
"type":"string"
},
{
"type":"object"
},
{
"type":"number"
},
{
"type":"boolean"
},
{
"type":"array"
}
],
"description":"The value assigned to the value relationship."
},
"unitOfMeasure":{
"type":"string",
"description":"A length, surface, volume, dry measure, liquid measure, money, weight, time, and the like. In general, a determinate quantity or magnitude of the kind designated, taken as a standard of comparison for others of the same kind, in assigning to them numerical values, as 1 foot, 1 yard, 1 mile, 1 square foot."
}
},
"required":[
"value"
]
},
"CompositePopRelationshipOracle":{
"title":"CompositePopRelationshipOracle",
"type":"object",
"description":"The composite relationship from a parent product offering price to a child product offering price.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the composite pop relationship."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the composite pop relationship."
},
"name":{
"type":"string",
"description":"The name of the composite pop relationship."
},
"version":{
"type":"string",
"description":"The version of the associated product offering price."
},
"relationshipType":{
"type":"string",
"description":"The type or classification of the composite pop relationship. Valid values are COMPOSITE.",
"enum":[
"COMPOSITE"
]
},
"@type":{
"type":"string",
"description":"The class type of the composite pop relationship."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the composite pop relationship."
},
"@baseType":{
"type":"string",
"description":"The base type of the composite pop relationship."
},
"@referredType":{
"type":"string",
"description":"A string. The actual type of the target instance when needed for disambiguation."
}
},
"required":[
"id",
"@type",
"@referredType"
]
},
"FeatureOracle":{
"title":"FeatureOracle",
"type":"object",
"properties":{
"name":{
"type":"string",
"description":"The name of the feature."
},
"description":{
"type":"string",
"description":"The description of the feature."
},
"blurb":{
"type":"string",
"description":"The description of the feature."
},
"url":{
"type":"string",
"description":"The reference of the image URL."
},
"rank":{
"description":"The numeric ranking of a marketing feature.",
"type":"integer"
},
"validFor":{
"$ref":"#/components/schemas/TimePeriod",
"description":"The period for which the feature is valid."
}
},
"required":[
"name"
],
"description":"The feature resource."
},
"ServiceSpecification":{
"title":"ServiceSpecification",
"type":"object",
"description":"The serviceSpecification is a class that offers characteristics to describe a type of service. Functionally, it acts as a template by which Services may be instantiated. By sharing the same specification, these services would therefore share the same set of characteristics.",
"properties":{
"id":{
"type":"string",
"maxLength":30,
"description":"The ID of the service specification."
},
"href":{
"type":"string",
"description":"A string. Reference of the service specification."
},
"version":{
"type":"string",
"description":"A string. Service specification version."
},
"name":{
"type":"string",
"description":"A string. Name of the service specification."
},
"description":{
"type":"string",
"description":"A string. A narrative that explains in detail what the service specification is."
},
"isBundle":{
"type":"boolean",
"description":"A boolean value that determines whether a service specification represents a single service specification (false) or a bundle of service specifications (true)."
},
"lifecycleStatus":{
"type":"string",
"description":"Indicates the current lifecycle status of the service specification."
},
"validFor":{
"$ref":"#/components/schemas/TimePeriod",
"description":"The period for which the service specification is valid."
},
"@type":{
"type":"string",
"description":"The class type of the service specification."
},
"@baseType":{
"type":"string",
"description":"The base type of the service specification."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the service specification."
},
"lastUpdate":{
"type":"string",
"format":"date-time",
"description":"A date time (DateTime). Date and time of the last update of the service specification."
},
"relatedParty":{
"type":"array",
"items":{
"$ref":"#/components/schemas/RelatedPartyRefOrPartyRoleRef"
},
"description":"A list of related parties associated with the service specification."
},
"resourceSpecification":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ResourceSpecificationRef"
},
"description":"A list of resource specifications associated with the service specification."
},
"serviceLevelSpecification":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ServiceLevelSpecificationRef"
},
"description":"A list of service level specifications associated with the service specification."
},
"serviceSpecCharacteristic":{
"type":"array",
"items":{
"anyOf":[
{
"$ref":"#/components/schemas/ServiceSpecCharacteristicOracle"
},
{
"$ref":"#/components/schemas/AttributeRefOracle"
}
]
},
"description":"A list of service specification characteristics associated with the service specification."
},
"serviceSpecRelationship":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ServiceSpecRelationship"
},
"description":"A list of service specification relationships associated with the service specification."
},
"targetServiceSchema":{
"$ref":"#/components/schemas/TargetServiceSchema",
"description":"The service specification."
},
"attachment":{
"type":"array",
"items":{
"anyOf":[
{
"$ref":"#/components/schemas/Attachment"
},
{
"$ref":"#/components/schemas/AttachmentOracle"
},
{
"$ref":"#/components/schemas/AttachmentRef"
}
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"Attachment":"#/components/schemas/Attachment",
"AttachmentOracle":"#/components/schemas/AttachmentOracle",
"AttachmentRef":"#/components/schemas/AttachmentRef"
}
}
},
"description":"A list of attachments associated with the service specification."
}
},
"required":[
"name",
"@type"
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"ServiceSpecification":"#/components/schemas/ServiceSpecification",
"ServiceSpecificationOracle":"#/components/schemas/ServiceSpecificationOracle"
}
}
},
"ServiceSpecificationOracle":{
"title":"ServiceSpecificationOracle",
"allOf":[
{
"$ref":"#/components/schemas/ServiceSpecification"
},
{
"type":"object",
"properties":{
"serviceCode":{
"type":"string",
"description":"The service code associated with the service specification."
},
"created":{
"type":"string",
"format":"date-time",
"description":"The date and time of creation."
},
"createdBy":{
"type":"string",
"description":"The name of the person who created."
},
"lastUpdatedBy":{
"type":"string",
"description":"The name of the person who updated."
},
"project":{
"$ref":"#/components/schemas/ProjectRef",
"description":"The service specification."
},
"externalId":{
"type":"string",
"description":"The ID of the external associated with the service specification."
},
"applicationName":{
"type":"string",
"description":"The name of the application associated with the service specification."
},
"versionState":{
"type":"number",
"description":"The version state of the Service Specification."
}
}
}
]
},
"AttachmentRef":{
"type":"object",
"title":"AttachmentRef",
"description":"A list of attachment references (AttachmentRef [*]). A list of attachments (Attachment [*]). Complements the description of the specification through video, pictures.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the attachment reference."
},
"description":{
"type":"string",
"description":"A narrative text describing the content of the attachment."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the attachment reference."
},
"name":{
"type":"string",
"description":"The name of the attachment reference."
},
"url":{
"type":"string",
"description":"The uniform Resource Locator, is a web page address (a subset of URI)."
},
"@type":{
"type":"string",
"description":"The class type of the attachment reference."
},
"@baseType":{
"type":"string",
"description":"The base type of the attachment reference."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the attachment reference."
},
"@referredType":{
"type":"string",
"description":"The type of the referred attachment reference."
}
},
"required":[
"id",
"@type",
"@referredType"
]
},
"AttachmentRefOracle":{
"title":"AttachmentRefOracle",
"allOf":[
{
"$ref":"#/components/schemas/AttachmentRef"
},
{
"type":"object",
"properties":{
"rank":{
"type":"number",
"description":"The attachment rank in order of their relevance for each attachmentType."
}
}
}
]
},
"ServiceSpecRelationship":{
"type":"object",
"title":"ServiceSpecRelationship",
"description":"A list of service specification relationships, such as migration, substitution, dependency, or exclusivity relationships.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the service specification relationship."
},
"href":{
"type":"string",
"description":"A string. Reference of the target serviceSpecification."
},
"name":{
"type":"string",
"description":"A string. The name given to the target service specification instance."
},
"relationshipType":{
"type":"string",
"description":"The type or classification of the service specification relationship. Valid values are AGGREGATION, MIGRATION, SUBSTITUTION, DEPENDENCY, and EXCLUSIVITY.",
"enum":[
"AGGREGATION",
"MIGRATION",
"SUBSTITUTION",
"DEPENDENCY",
"EXCLUSIVITY"
]
},
"role":{
"type":"string",
"description":"A string. The association role for this service specification."
},
"validFor":{
"$ref":"#/components/schemas/TimePeriodOracle",
"description":"The period for which the service specification relationship is valid."
},
"@type":{
"type":"string",
"description":"The class type of the service specification relationship."
},
"@baseType":{
"type":"string",
"description":"The base type of the service specification relationship."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the service specification relationship."
},
"versionState":{
"type":"number",
"description":"The version state of the reference."
}
},
"required":[
"id",
"relationshipType",
"@type"
]
},
"ServiceLevelSpecificationRef":{
"type":"object",
"title":"ServiceLevelSpecificationRef",
"description":"A list of service level specification references (ServiceLevelSpecificationRef [*]). A list of service level specifications related to this service specification, and which will need to be satisfiable for corresponding service instances; e.g. Gold, Platinum.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the service level specification reference."
},
"href":{
"type":"string",
"description":"A string. The hyperlink to access a service level specification."
},
"name":{
"type":"string",
"description":"A string. The name of Service Level Specification."
},
"@type":{
"type":"string",
"description":"The class type of the service level specification reference."
},
"@baseType":{
"type":"string",
"description":"The base type of the service level specification reference."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the service level specification reference."
},
"@referredType":{
"type":"string",
"description":"A string. The actual type of the target instance when needed for disambiguation."
}
},
"required":[
"id",
"@type",
"@referredType"
]
},
"ServiceSpecCharacteristic":{
"title":"ServiceSpecCharacteristic",
"type":"object",
"description":"A list of service spec characteristics (ServiceSpecCharacteristic [*]). A list of service spec characteristics (ServiceSpecCharacteristic [*]). This class represents the key features of this service specification.",
"properties":{
"name":{
"type":"string",
"description":"A string. A word, term, or phrase by which this characteristic specification is known and distinguished from other characteristic specifications."
},
"description":{
"type":"string",
"description":"A string. A narrative that explains in detail what the serviceSpecCharacteristic is."
},
"valueType":{
"type":"string",
"description":"The type or classification of the service specification characteristic. Valid values are STRING, NUMBER, OBJECT, ARRAY, DECIMAL, BOOLEAN, DATE, DATETIME, and URL.",
"enum":[
"STRING",
"NUMBER",
"OBJECT",
"ARRAY",
"DECIMAL",
"BOOLEAN",
"DATE",
"DATETIME",
"URL"
]
},
"configurable":{
"type":"boolean",
"description":"Whether the service specification characteristic is configurable."
},
"validFor":{
"$ref":"#/components/schemas/TimePeriodOracle",
"description":"The period for which the service specification characteristic is valid."
},
"@type":{
"type":"string",
"description":"The class type of the service specification characteristic."
},
"@baseType":{
"type":"string",
"description":"The base type of the service specification characteristic."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the service specification characteristic."
},
"@valueSchemaLocation":{
"type":"string",
"description":"A string. This (optional) field provides a link to the schema describing the value type."
},
"minCardinality":{
"type":"integer",
"description":"An integer. The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality."
},
"maxCardinality":{
"type":"integer",
"description":"An integer. The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality."
},
"isUnique":{
"type":"boolean",
"description":"A boolean. An indicator that specifies if a value is unique for the specification. Possible values are; 'unique while value is in effect' and 'unique whether value is in effect or not'."
},
"regex":{
"type":"string",
"description":"A rule or principle represented as a regular expression for deriving the value of a characteristic value."
},
"extensible":{
"type":"boolean",
"description":"A boolean. An indicator that specifies that the values for the characteristic can be extended by adding new values when instantiating a characteristic for an Entity."
},
"serviceSpecCharRelationship":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ServiceSpecCharRelationship"
},
"description":"A list of service specification characteristic relationships associated with the service specification characteristic."
},
"serviceSpecCharacteristicValue":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ServiceSpecCharacteristicValueOracle"
},
"description":"A list of service specification characteristic values associated with the service specification characteristic."
}
},
"required":[
"name",
"@type"
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"ServiceSpecCharacteristic":"#/components/schemas/ServiceSpecCharacteristic",
"ServiceSpecCharacteristicOracle":"#/components/schemas/ServiceSpecCharacteristicOracle"
}
}
},
"ServiceSpecCharacteristicOracle":{
"title":"ServiceSpecCharacteristicOracle",
"allOf":[
{
"$ref":"#/components/schemas/ServiceSpecCharacteristic"
},
{
"type":"object",
"properties":{
"displayName":{
"type":"string",
"description":"The name of the display associated with the service specification characteristic."
},
"sensitive":{
"type":"boolean",
"description":"Whether the service specification characteristic is sensitive."
},
"id":{
"type":"string",
"maxLength":30,
"description":"The ID of the service specification characteristic."
},
"version":{
"type":"string",
"description":"The attribute version."
},
"project":{
"$ref":"#/components/schemas/ProjectRef",
"description":"The service specification characteristic."
},
"lifecycleStatus":{
"type":"string",
"description":"The status of the service specification characteristic."
},
"created":{
"type":"string",
"format":"date-time",
"description":"The date and time of the creation."
},
"createdBy":{
"type":"string",
"description":"The name of the person who created item."
},
"lastUpdatedBy":{
"type":"string",
"description":"The name of the person who updated item."
},
"lastUpdate":{
"type":"string",
"format":"date-time",
"description":"The date and time when the service specification characteristic was last updated."
},
"externalId":{
"type":"string",
"description":"The ID of the external associated with the service specification characteristic."
},
"applicationName":{
"type":"string",
"description":"The name of the application associated with the service specification characteristic."
},
"versionState":{
"type":"number",
"description":"The version state of the attribute."
}
}
}
]
},
"ServiceSpecCharRelationship":{
"title":"ServiceSpecCharRelationship",
"type":"object",
"description":"A list of service spec char relationships (ServiceSpecCharRelationship [*]). A list of service spec char relationships (ServiceSpecCharRelationship [*]). An aggregation, migration, substitution, dependency or exclusivity relationship between/among Specification Characteristics.",
"properties":{
"relationshipType":{
"type":"string",
"description":"The type or classification of the service specification characteristic relationship. Valid values are AGGREGATION, MIGRATION, SUBSTITUTION, DEPENDENCY, and EXCLUSIVITY.",
"enum":[
"AGGREGATION",
"MIGRATION",
"SUBSTITUTION",
"DEPENDENCY",
"EXCLUSIVITY"
]
},
"role":{
"type":"string",
"description":"A string. The association role for this service specification."
},
"validFor":{
"description":"A time period. The period for which the serviceSpecCharRelationship is valid.",
"$ref":"#/components/schemas/TimePeriodOracle"
},
"id":{
"type":"string",
"description":"The ID of the service specification characteristic relationship."
},
"name":{
"type":"string",
"description":"A string. Name of the target characteristic."
},
"href":{
"type":"string",
"description":"A string. Reference of the target serviceSpecification."
},
"@type":{
"type":"string",
"description":"The class type of the service specification characteristic relationship."
},
"@baseType":{
"type":"string",
"description":"The base type of the service specification characteristic relationship."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the service specification characteristic relationship."
}
},
"required":[
"id",
"name",
"relationshipType",
"@type"
]
},
"ServiceSpecCharacteristicValue":{
"title":"ServiceSpecCharacteristicValue",
"type":"object",
"description":"A list of service spec characteristic values (ServiceSpecCharacteristicValue [*]). A list of service spec characteristic values (ServiceSpecCharacteristicValue [*]). A ServiceSpecCharacteristicValue object defines a set of attributes, each of which can be assigned to a corresponding set of attributes in a ServiceSpecCharacteristic object. The values of the attributes in the ServiceSpecCharacteristicValue object describe the values of the attributes that a corresponding ServiceSpecCharacteristic object can take on.",
"properties":{
"isDefault":{
"type":"boolean",
"description":"Whether the service specification characteristic value is default."
},
"unitOfMeasure":{
"type":"string",
"description":"A string. A length, surface, volume, dry measure, liquid measure, money, weight, time, and the like. In general, a determinate quantity or magnitude of the kind designated, taken as a standard of comparison for others of the same kind, in assigning to them numerical values, as 1 foot, 1 yard, 1 mile, 1 square foot.",
"enum":[
"NONE",
"SECOND",
"MINUTE",
"HOUR",
"DAY",
"MONTH",
"BYTE",
"KILOBYTE",
"MEGABYTE",
"GIGABYTE",
"PAGES",
"MOVIES",
"TIME_INTERVAL",
"QUANTITY",
"MBPS",
"GBPS"
]
},
"validFor":{
"description":"A time period. The period of time for which a value is applicable.",
"$ref":"#/components/schemas/TimePeriodOracle"
},
"value":{
"oneOf":[
{
"type":"string"
},
{
"type":"object"
},
{
"type":"number"
},
{
"type":"boolean"
},
{
"type":"array"
}
],
"description":"A discrete value that the characteristic can take on, or the actual value of the characteristic."
},
"valueFrom":{
"oneOf":[
{
"type":"string"
},
{
"type":"integer"
}
],
"description":"The low range value that a characteristic can take on."
},
"valueTo":{
"oneOf":[
{
"type":"string"
},
{
"type":"integer"
}
],
"description":"The upper range value that a characteristic can take on."
},
"valueType":{
"type":"string",
"description":"The type or classification of the service specification characteristic value. Valid values are STRING, NUMBER, OBJECT, ARRAY, DECIMAL, BOOLEAN, DATE, DATETIME, and URL.",
"enum":[
"STRING",
"NUMBER",
"OBJECT",
"ARRAY",
"DECIMAL",
"BOOLEAN",
"DATE",
"DATETIME",
"URL"
]
},
"rangeInterval":{
"type":"string",
"description":"A string. An indicator that specifies the inclusion or exclusion of the valueFrom and valueTo attributes. If applicable, possible values are 'open', 'closed', 'closedBottom' and 'closedTop'. Valid values are OPEN, CLOSED, CLOSED_BOTTOM, and CLOSED_TOP.",
"enum":[
"OPEN",
"CLOSED",
"CLOSED_BOTTOM",
"CLOSED_TOP"
]
},
"regex":{
"type":"string",
"description":"A string. A regular expression constraint for given value."
},
"@type":{
"type":"string",
"description":"The class type of the service specification characteristic value."
},
"@baseType":{
"type":"string",
"description":"The base type of the service specification characteristic value."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the service specification characteristic value."
}
},
"required":[
"value",
"@type"
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"ServiceSpecCharacteristicValue":"#/components/schemas/ServiceSpecCharacteristicValue",
"ServiceSpecCharacteristicValueOracle":"#/components/schemas/ServiceSpecCharacteristicValueOracle"
}
}
},
"ServiceSpecCharacteristicValueOracle":{
"title":"ServiceSpecCharacteristicValueOracle",
"allOf":[
{
"$ref":"#/components/schemas/ServiceSpecCharacteristicValue"
},
{
"type":"object",
"properties":{
"sequence":{
"type":"integer",
"description":"Indicates the sequence where attribute values appear during runtime."
}
}
}
]
},
"TaxServiceProviderOracle":{
"title":"TaxServiceProviderOracle",
"type":"object",
"description":"The tax service provider name and list of taxcodes supported.",
"properties":{
"id":{
"type":"string",
"maxLength":30,
"description":"The ID of the tax service provider."
},
"href":{
"type":"string",
"description":"A string. Reference of the tax service provider."
},
"name":{
"type":"string",
"description":"A string. Name of the tax service provider."
},
"description":{
"type":"string",
"description":"A string. A narrative that explains in detail what the tax service provider is."
},
"validFor":{
"$ref":"#/components/schemas/TimePeriod",
"description":"The period for which the tax service provider is valid."
},
"@type":{
"type":"string",
"description":"The class type of the tax service provider."
},
"@baseType":{
"type":"string",
"description":"The base type of the tax service provider."
},
"@schemaLocation":{
"type":"string",
"description":"A link to the schema describing this tax service provider."
},
"lastUpdate":{
"type":"string",
"format":"date-time",
"description":"A date time (DateTime). Date and time of the last update of the tax service provider."
},
"created":{
"type":"string",
"format":"date-time",
"description":"The date and time of creation."
},
"createdBy":{
"type":"string",
"description":"The name of the person who created."
},
"lastUpdatedBy":{
"type":"string",
"description":"The name of the person who updated."
},
"taxCodes":{
"type":"array",
"items":{
"$ref":"#/components/schemas/TaxCodeGLRelationship"
},
"description":"A list of tax codes associated with the tax service provider."
},
"project":{
"$ref":"#/components/schemas/ProjectRef",
"description":"The tax service provider."
},
"externalId":{
"type":"string",
"description":"The ID of the external associated with the tax service provider."
},
"applicationName":{
"type":"string",
"description":"The name of the application associated with the tax service provider."
},
"versionState":{
"type":"number",
"description":"The version state of the Tax Service Provider."
},
"lifecycleStatus":{
"type":"string",
"description":"The status of the tax service provider."
},
"version":{
"type":"string",
"description":"The tax service provider version."
}
},
"required":[
"name",
"@type"
]
},
"TaxCodeGLRelationship":{
"title":"TaxCodeGLRelationship",
"type":"object",
"description":"The taxCodeGLRelationship object.",
"properties":{
"taxCode":{
"type":"string",
"description":"The tax code associated with the tax code gl relationship."
},
"taxPercentage":{
"type":"number",
"description":"The tax percentage value."
},
"description":{
"type":"string",
"description":"The description of the tax code."
},
"glid":{
"type":"string",
"description":"The glid value."
},
"@type":{
"type":"string",
"description":"The class type of the tax code gl relationship."
},
"@baseType":{
"type":"string",
"description":"The base class type (immediate parent) of the ServiceSpecCharacteristicRelationship."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the tax code gl relationship."
}
},
"required":[
"taxCode",
"@type"
]
},
"UsageSpecification":{
"title":"UsageSpecification",
"type":"object",
"description":"The Usage Specification resource represents a set of usage characteristics and relationships.",
"properties":{
"id":{
"type":"string",
"maxLength":30,
"description":"The ID of the usage specification."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the usage specification."
},
"version":{
"type":"string",
"description":"The usage specification version."
},
"name":{
"type":"string",
"description":"A string. Name of the usage specification."
},
"description":{
"type":"string",
"description":"A string. A narrative that explains in detail what the usage specification is."
},
"lifecycleStatus":{
"type":"string",
"description":"Indicates the current lifecycle status of the usage specification."
},
"validFor":{
"$ref":"#/components/schemas/TimePeriod",
"description":"The period for which the usage specification is valid."
},
"@type":{
"type":"string",
"description":"The class type of the usage specification."
},
"@baseType":{
"type":"string",
"description":"The base type of the usage specification."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the usage specification."
},
"lastUpdate":{
"type":"string",
"format":"date-time",
"description":"The date and time when the usage specification was last updated."
},
"usageSpecRelationship":{
"type":"array",
"items":{
"$ref":"#/components/schemas/UsageSpecRelationship"
},
"description":"A list of usage specification relationships associated with the usage specification."
},
"usageSpecCharacteristic":{
"type":"array",
"items":{
"$ref":"#/components/schemas/UsageSpecCharacteristicOracle"
},
"description":"A list of usage specification characteristics associated with the usage specification."
}
},
"required":[
"name",
"@type"
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"UsageSpecification":"#/components/schemas/UsageSpecification",
"UsageSpecificationOracle":"#/components/schemas/UsageSpecificationOracle"
}
}
},
"UsageSpecificationOracle":{
"title":"UsageSpecificationOracle",
"allOf":[
{
"$ref":"#/components/schemas/UsageSpecification"
},
{
"type":"object",
"properties":{
"usageCode":{
"type":"string",
"description":"The usage code associated with the usage specification."
},
"created":{
"type":"string",
"format":"date-time",
"description":"The date and time when the usage specification was created."
},
"createdBy":{
"type":"string",
"description":"The user who created the usage specification."
},
"lastUpdatedBy":{
"type":"string",
"description":"The user who last updated the usage specification."
},
"meteringRule":{
"type":"array",
"items":{
"$ref":"#/components/schemas/MeteringRuleOracle"
},
"description":"A list of metering rules associated with the usage specification."
},
"requestSpecification":{
"type":"array",
"items":{
"$ref":"#/components/schemas/RequestSpecificationRefOracle"
},
"description":"A list of request specifications associated with the usage specification."
},
"project":{
"$ref":"#/components/schemas/ProjectRef",
"description":"The project associated with the usage specification."
},
"externalId":{
"type":"string",
"description":"The external ID associated with the usage specification."
},
"applicationName":{
"type":"string",
"description":"The name of the application associated with the usage specification."
},
"versionState":{
"type":"number",
"description":"The version state of the usage specification."
}
},
"required":[
"meteringRule"
]
}
]
},
"UsageSpecRelationship":{
"type":"object",
"title":"UsageSpecRelationship",
"description":"A list of usage spec relationships (UsageSpecRelationship [*]). A list of usage specifications related to this specification.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the usage specification relationship."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the usage specification relationship."
},
"name":{
"type":"string",
"description":"The name of the usage specification relationship."
},
"relationshipType":{
"type":"string",
"description":"The type or classification of the usage specification relationship. Valid values are AGGREGATION, MIGRATION, SUBSTITUTION, DEPENDENCY, and EXCLUSIVITY.",
"enum":[
"AGGREGATION",
"MIGRATION",
"SUBSTITUTION",
"DEPENDENCY",
"EXCLUSIVITY"
]
},
"validFor":{
"$ref":"#/components/schemas/TimePeriodOracle",
"description":"The period for which the usage specification relationship is valid."
},
"@type":{
"type":"string",
"description":"The class type of the usage specification relationship."
},
"@baseType":{
"type":"string",
"description":"The base type of the usage specification relationship."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the usage specification relationship."
},
"versionState":{
"type":"number",
"description":"The version state of the reference."
}
},
"required":[
"id",
"relationshipType",
"@type"
]
},
"MeteringRuleOracle":{
"type":"object",
"title":"MeteringRule",
"description":"The metering rule resource.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the metering rule."
},
"name":{
"type":"string",
"description":"The name of the metering rule."
},
"description":{
"type":"string",
"description":"A string. Description of the metering rule."
},
"validFor":{
"$ref":"#/components/schemas/TimePeriodOracle",
"description":"The period for which the metering rule is valid."
},
"roundingMethod":{
"type":"string",
"description":"The rounding applicable to the metering rule."
},
"stringExpression":{
"type":"string",
"description":"The metering Expression applicable to the metering rule."
},
"unitOfMeasure":{
"type":"string",
"description":"The unit of Measure of Usage."
},
"@type":{
"type":"string",
"description":"The class type of the metering rule."
},
"@baseType":{
"type":"string",
"description":"The base type of the metering rule."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the metering rule."
},
"meteringExpression":{
"type":"array",
"items":{
"$ref":"#/components/schemas/MeteringExpressionOracle"
},
"description":"A list of metering expressions associated with the metering rule."
}
},
"required":[
"id",
"@type"
]
},
"MeteringExpressionOracle":{
"type":"object",
"title":"MeteringExpression",
"description":"The metering expression resource.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the metering expression."
},
"operator":{
"type":"string",
"description":"The operator of the expression. Valid values are NOT EQUALS, MULTIPLY, ADD, DIVIDE, NOT, EQUALS, and SUBTRACT.",
"enum":[
"NOT EQUALS",
"MULTIPLY",
"ADD",
"DIVIDE",
"NOT",
"EQUALS",
"SUBTRACT"
]
},
"expressionType":{
"type":"string",
"description":"The type or classification of the metering expression. Valid values are UNARY, BINARY, NUMERIC, and CHARACTERISTIC.",
"enum":[
"UNARY",
"BINARY",
"NUMERIC",
"CHARACTERISTIC"
]
},
"value":{
"oneOf":[
{
"type":"string"
},
{
"type":"object"
},
{
"type":"number"
},
{
"type":"boolean"
}
],
"description":"A discrete value that the relationship can take on."
},
"@type":{
"type":"string",
"description":"The class type of the metering expression."
},
"@baseType":{
"type":"string",
"description":"The base type of the metering expression."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the metering expression."
},
"meteringExpressionRelationship":{
"type":"object",
"items":{
"$ref":"#/components/schemas/MeteringExpressionRelationshipOracle"
},
"description":"A list of metering expression relationships associated with the metering expression."
}
},
"required":[
"id",
"expressionType",
"@type"
]
},
"MeteringExpressionRelationshipOracle":{
"type":"object",
"title":"MeteringExpressionRelationship",
"description":"The metering expression relationship resource.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the metering expression relationship."
},
"name":{
"type":"string",
"description":"The name of the metering expression relationship."
},
"relationshipType":{
"type":"string",
"description":"The type or classification of the metering expression relationship. Valid values are LEFT_HAND_SIDE, and RIGHT_HAND_SIDE.",
"enum":[
"LEFT_HAND_SIDE",
"RIGHT_HAND_SIDE"
]
},
"@type":{
"type":"string",
"description":"The class type of the metering expression relationship."
},
"@baseType":{
"type":"string",
"description":"The base type of the metering expression relationship."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the metering expression relationship."
}
},
"required":[
"relationshipType",
"id",
"@type"
]
},
"AlterationExpressionOracle":{
"type":"object",
"title":"AlterationExpressionOracle",
"properties":{
"id":{
"type":"string",
"description":"The ID of the alteration expression."
},
"operator":{
"type":"string",
"description":"The operator of the expression."
},
"expressionType":{
"type":"string",
"description":"The type or classification of the alteration expression. Valid values are UNARY, BINARY, NUMERIC, STRING, ALTERATIONCHAR, and BALANCEOFRESOURCE.",
"enum":[
"UNARY",
"BINARY",
"NUMERIC",
"STRING",
"ALTERATIONCHAR",
"BALANCEOFRESOURCE"
]
},
"value":{
"oneOf":[
{
"type":"string"
},
{
"type":"number"
},
{
"type":"boolean"
}
],
"description":"A discrete value that the relationship can take on."
},
"@type":{
"type":"string",
"description":"The class type of the alteration expression."
},
"@baseType":{
"type":"string",
"description":"The immediate base class type of the alteration expression."
},
"@schemaLocation":{
"type":"string",
"description":"A link to the schema describing this alteration expression entity."
},
"expressionRelationship":{
"type":"object",
"items":{
"$ref":"#/components/schemas/ExpressionRelationshipOracle"
},
"description":"A list of expression relationships associated with the alteration expression."
}
},
"required":[
"expressionType",
"id",
"@type"
],
"description":"The alteration expression resource."
},
"ExpressionRelationshipOracle":{
"type":"object",
"title":"ExpressionRelationshipOracle",
"description":"The expression relationship resource.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the expression relationship."
},
"name":{
"type":"string",
"description":"The name of the expression relationship."
},
"relationshipType":{
"type":"string",
"enum":[
"LEFT_HAND_SIDE",
"RIGHT_HAND_SIDE"
],
"description":"The type or classification of the expression relationship. Valid values are LEFT_HAND_SIDE, and RIGHT_HAND_SIDE."
},
"@type":{
"type":"string",
"description":"The class type of the expression relationship."
},
"@baseType":{
"type":"string",
"description":"The base type of the expression relationship."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the expression relationship."
}
},
"required":[
"relationshipType",
"id",
"@type"
]
},
"RequestSpecificationRefOracle":{
"type":"object",
"title":"RequestSpecificationRefOracle",
"description":"A list of request level specification references (RequestSpecificationRef [*]). A list of request level specifications related to this usage specification, and which will need to be satisfiable for corresponding usage instances.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the request specification reference."
},
"href":{
"type":"string",
"description":"A string. The hyperlink to access a request specification."
},
"name":{
"type":"string",
"description":"A string. The name given to the target request specification instance."
},
"version":{
"type":"string",
"description":"A string. Version of the target request Specification."
},
"specType":{
"type":"string",
"description":"The type or classification of the request specification reference. Valid values are INITIATE, UPDATE, TERMINATE, EVENT, and OFFLINE.",
"enum":[
"INITIATE",
"UPDATE",
"TERMINATE",
"EVENT",
"OFFLINE"
]
},
"@type":{
"type":"string",
"description":"The class type of the request specification reference."
},
"@baseType":{
"type":"string",
"description":"The base type of the request specification reference."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the request specification reference."
},
"@referredType":{
"type":"string",
"description":"A string. The actual type of the target instance when needed for disambiguation."
}
},
"required":[
"id",
"specType",
"@type",
"@referredType"
]
},
"UsageSpecCharacteristic":{
"title":"UsageSpecCharacteristic",
"type":"object",
"description":"A list of usage spec characteristics (UsageSpecCharacteristic [*]). This class represents the key features of this usage specification.",
"properties":{
"name":{
"type":"string",
"description":"A string. A word, term, or phrase by which this characteristic specification is known and distinguished from other characteristic specifications."
},
"description":{
"type":"string",
"description":"A string. A narrative that explains in detail what the usageSpecCharacteristic is."
},
"valueType":{
"type":"string",
"description":"The type or classification of the usage specification characteristic. Valid values are STRING, NUMBER, OBJECT, ARRAY, DECIMAL, BOOLEAN, DATE, and DATETIME.",
"enum":[
"STRING",
"NUMBER",
"OBJECT",
"ARRAY",
"DECIMAL",
"BOOLEAN",
"DATE",
"DATETIME"
]
},
"configurable":{
"type":"boolean",
"description":"Whether the usage specification characteristic is configurable."
},
"validFor":{
"$ref":"#/components/schemas/TimePeriodOracle",
"description":"The period for which the usage specification characteristic is valid."
},
"@type":{
"type":"string",
"description":"The class type of the usage specification characteristic."
},
"@baseType":{
"type":"string",
"description":"The base type of the usage specification characteristic."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the usage specification characteristic."
},
"@valueSchemaLocation":{
"type":"string",
"description":"A string. This (optional) field provides a link to the schema describing the value type."
},
"minCardinality":{
"type":"integer",
"description":"An integer. The minimum number of instances a CharacteristicValue can take on."
},
"maxCardinality":{
"type":"integer",
"description":"An integer. The maximum number of instances a CharacteristicValue can take on."
},
"isUnique":{
"type":"boolean",
"description":"A boolean. An indicator that specifies if a value is unique for the specification. Possible values are; 'unique while value is in effect' and 'unique whether value is in effect or not'."
},
"regex":{
"type":"string",
"description":"A rule or principle represented as a regular expression for deriving the value of a characteristic value."
},
"extensible":{
"type":"boolean",
"description":"A boolean. An indicator that specifies that the values for the characteristic can be extended by adding new values when instantiating a characteristic for an Entity."
},
"usageSpecCharacteristicRelationship":{
"type":"array",
"items":{
"$ref":"#/components/schemas/UsageSpecCharacteristicRelationship"
},
"description":"A list of usage specification characteristic relationships associated with the usage specification characteristic."
},
"usageSpecCharacteristicValue":{
"type":"array",
"items":{
"$ref":"#/components/schemas/UsageSpecCharacteristicValue"
},
"description":"A list of usage specification characteristic values associated with the usage specification characteristic."
}
},
"required":[
"name",
"@type"
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"UsageSpecCharacteristic":"#/components/schemas/UsageSpecCharacteristic",
"UsageSpecCharacteristicOracle":"#/components/schemas/UsageSpecCharacteristicOracle"
}
}
},
"UsageSpecCharacteristicOracle":{
"title":"UsageSpecCharacteristicOracle",
"allOf":[
{
"$ref":"#/components/schemas/UsageSpecCharacteristic"
},
{
"type":"object",
"properties":{
"isInvoiceable":{
"type":"boolean",
"description":"Whether the usage specification characteristic is invoiceable."
},
"isServiceId":{
"type":"boolean",
"description":"Whether the usage specification characteristic is service id."
},
"isTransient":{
"type":"boolean",
"description":"Whether the usage specification characteristic is transient."
}
}
}
]
},
"UsageSpecCharacteristicRelationship":{
"title":"UsageSpecCharacteristicRelationship",
"type":"object",
"description":"A list of usage spec char relationships. An aggregation, migration, substitution, dependency or exclusivity relationship between/among Specification Characteristics.",
"properties":{
"relationshipType":{
"type":"string",
"description":"The type or classification of the usage specification characteristic relationship. Valid values are AGGREGATION, MIGRATION, SUBSTITUTION, DEPENDENCY, and EXCLUSIVITY.",
"enum":[
"AGGREGATION",
"MIGRATION",
"SUBSTITUTION",
"DEPENDENCY",
"EXCLUSIVITY"
]
},
"charSpecSeq":{
"type":"integer",
"description":"The characteristic sequence."
},
"validFor":{
"description":"A time period. The period for which the usageSpecCharRelationship is valid.",
"$ref":"#/components/schemas/TimePeriodOracle"
},
"id":{
"type":"string",
"description":"The ID of the usage specification characteristic relationship."
},
"name":{
"type":"string",
"description":"A string. Name of the target characteristic."
},
"href":{
"type":"string",
"description":"A string. Reference of the target serviceSpecification."
},
"@type":{
"type":"string",
"description":"The class type of the usage specification characteristic relationship."
},
"@baseType":{
"type":"string",
"description":"The base type of the usage specification characteristic relationship."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the usage specification characteristic relationship."
}
},
"required":[
"id",
"name",
"relationshipType",
"@type"
]
},
"UsageSpecCharacteristicValue":{
"title":"UsageSpecCharacteristicValue",
"type":"object",
"description":"A list of usage spec characteristic values A UsageSpecCharacteristicValue object defines a set of attributes, each of which can be assigned to a corresponding set of attributes in a UsageSpecCharacteristic object. The values of the attributes in the UsageSpecCharacteristicValue object describe the values of the attributes that a corresponding UsageSpecCharacteristic object can take on.",
"properties":{
"isDefault":{
"type":"boolean",
"description":"Whether the usage specification characteristic value is default."
},
"unitOfMeasure":{
"type":"string",
"description":"A string. A length, surface, volume, dry measure, liquid measure, money, weight, time, and the like. In general, a determinate quantity or magnitude of the kind designated, taken as a standard of comparison for others of the same kind, in assigning to them numerical values, as 1 foot, 1 yard, 1 mile, 1 square foot."
},
"validFor":{
"description":"A time period. The period of time for which a value is applicable.",
"$ref":"#/components/schemas/TimePeriodOracle"
},
"value":{
"oneOf":[
{
"type":"string"
},
{
"type":"object"
},
{
"type":"number"
},
{
"type":"boolean"
},
{
"type":"array"
}
],
"description":"A discrete value that the characteristic can take on, or the actual value of the characteristic."
},
"valueFrom":{
"type":"string",
"description":"An integer. The low range value that a characteristic can take on."
},
"valueTo":{
"type":"string",
"description":"An integer. The upper range value that a characteristic can take on."
},
"valueType":{
"type":"string",
"description":"The type or classification of the usage specification characteristic value. Valid values are STRING, NUMBER, OBJECT, ARRAY, DECIMAL, BOOLEAN, DATE, and DATETIME.",
"enum":[
"STRING",
"NUMBER",
"OBJECT",
"ARRAY",
"DECIMAL",
"BOOLEAN",
"DATE",
"DATETIME"
]
},
"rangeInterval":{
"type":"string",
"description":"A string. An indicator that specifies the inclusion or exclusion of the valueFrom and valueTo attributes. If applicable, possible values are 'open', 'closed', 'closedBottom' and 'closedTop'. Valid values are OPEN, CLOSED, CLOSED_BOTTOM, and CLOSED_TOP.",
"enum":[
"OPEN",
"CLOSED",
"CLOSED_BOTTOM",
"CLOSED_TOP"
]
},
"regex":{
"type":"string",
"description":"A string. A regular expression constraint for given value."
},
"@type":{
"type":"string",
"description":"The class type of the usage specification characteristic value."
},
"@baseType":{
"type":"string",
"description":"The base type of the usage specification characteristic value."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the usage specification characteristic value."
}
},
"required":[
"value",
"@type"
]
},
"CustomerProfileSpecificationOracle":{
"title":"CustomerProfileSpecificationOracle",
"type":"object",
"description":"The Customer Profile Specification resource represents a set of customer profile characteristics and relationships.",
"properties":{
"id":{
"type":"string",
"maxLength":30,
"description":"The ID of the customer profile specification."
},
"href":{
"type":"string",
"description":"A string. Reference of the customer profile specification."
},
"version":{
"type":"string",
"description":"The customer profile specification version."
},
"name":{
"type":"string",
"description":"A string. Name of the customer profile specification."
},
"description":{
"type":"string",
"description":"A string. A narrative that explains in detail what the customer profile specification is."
},
"lifecycleStatus":{
"type":"string",
"description":"Indicates the current lifecycle status of the customer profile specification."
},
"validFor":{
"$ref":"#/components/schemas/TimePeriod",
"description":"The period for which the customer profile specification is valid."
},
"@type":{
"type":"string",
"description":"The class type of the customer profile specification."
},
"@baseType":{
"type":"string",
"description":"The base type of the customer profile specification."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the customer profile specification."
},
"lastUpdate":{
"type":"string",
"format":"date-time",
"description":"A date time (DateTime). Date and time of the last update of the Customer Profile specification."
},
"custProfSpecificationRelationship":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CustProfSpecRelationshipOracle"
},
"description":"A list of cust prof specification relationships associated with the customer profile specification."
},
"custProfSpecCharacteristic":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CustProfSpecCharacteristicOracle"
},
"description":"A list of cust prof specification characteristics associated with the customer profile specification."
},
"relatedParty":{
"type":"array",
"items":{
"$ref":"#/components/schemas/RelatedPartyRefOrPartyRoleRef"
},
"description":"A list of related parties associated with the customer profile specification."
},
"project":{
"$ref":"#/components/schemas/ProjectRef",
"description":"The customer profile specification."
},
"created":{
"type":"string",
"format":"date-time",
"description":"The date and time of the creation."
},
"createdBy":{
"type":"string",
"description":"The name of the person who created item."
},
"lastUpdatedBy":{
"type":"string",
"description":"The name of the person who updated item."
},
"externalId":{
"type":"string",
"description":"The ID of the external associated with the customer profile specification."
},
"applicationName":{
"type":"string",
"description":"The name of the application associated with the customer profile specification."
},
"versionState":{
"type":"number",
"description":"The version state of the Customer Profile Specification."
}
},
"required":[
"name",
"@type"
]
},
"CustProfSpecCharacteristicOracle":{
"title":"CustProfSpecCharacteristicOracle",
"type":"object",
"description":"A list of customer profile spec characteristics (CustomerProfileSpecificationCharacteristic [*]). This class represents the key features of this customer profile specification.",
"properties":{
"name":{
"type":"string",
"description":"A string. A word, term, or phrase by which this characteristic specification is known and distinguished from other characteristic specifications."
},
"description":{
"type":"string",
"description":"A string. A narrative that explains in detail what the SpecCharacteristic is."
},
"valueType":{
"type":"string",
"description":"The type or classification of the cust prof specification characteristic. Valid values are STRING, NUMBER, OBJECT, ARRAY, DECIMAL, BOOLEAN, DATE, and DATETIME.",
"enum":[
"STRING",
"NUMBER",
"OBJECT",
"ARRAY",
"DECIMAL",
"BOOLEAN",
"DATE",
"DATETIME"
]
},
"configurable":{
"type":"boolean",
"description":"Whether the cust prof specification characteristic is configurable."
},
"validFor":{
"$ref":"#/components/schemas/TimePeriodOracle",
"description":"The period for which the cust prof specification characteristic is valid."
},
"@type":{
"type":"string",
"description":"The class type of the cust prof specification characteristic."
},
"@baseType":{
"type":"string",
"description":"The base type of the cust prof specification characteristic."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the cust prof specification characteristic."
},
"@valueSchemaLocation":{
"type":"string",
"description":"A string. This (optional) field provides a link to the schema describing the value type."
},
"minCardinality":{
"type":"integer",
"description":"An integer. The minimum number of instances a CharacteristicValue can take on."
},
"maxCardinality":{
"type":"integer",
"description":"An integer. The maximum number of instances a CharacteristicValue can take on."
},
"isUnique":{
"type":"boolean",
"description":"A boolean. An indicator that specifies if a value is unique for the specification. Possible values are; 'unique while value is in effect' and 'unique whether value is in effect or not'."
},
"regex":{
"type":"string",
"description":"A rule or principle represented as a regular expression for deriving the value of a characteristic value."
},
"extensible":{
"type":"boolean",
"description":"A boolean. An indicator that specifies that the values for the characteristic can be extended by adding new values when instantiating a characteristic for an Entity."
},
"custProfSpecCharRelationship":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CustProfSpecCharRelationshipOracle"
},
"description":"A list of cust prof specification characteristic relationships associated with the cust prof specification characteristic."
},
"custProfSpecCharacteristicValue":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CustProfSpecCharacteristicValueOracle"
},
"description":"A list of cust prof specification characteristic values associated with the cust prof specification characteristic."
}
},
"required":[
"name",
"@type"
]
},
"CustProfSpecCharRelationshipOracle":{
"title":"CustProfSpecCharRelationshipOracle",
"type":"object",
"description":"A list of customer profile spec char relationships. An aggregation, migration, substitution, dependency or exclusivity relationship between/among Specification Characteristics.",
"properties":{
"relationshipType":{
"type":"string",
"description":"The type or classification of the cust prof specification characteristic relationship. Valid values are AGGREGATION, MIGRATION, SUBSTITUTION, DEPENDENCY, and EXCLUSIVITY.",
"enum":[
"AGGREGATION",
"MIGRATION",
"SUBSTITUTION",
"DEPENDENCY",
"EXCLUSIVITY"
]
},
"charSpecSeq":{
"type":"integer",
"description":"The characteristic sequence."
},
"validFor":{
"description":"A time period. The period for which the customerProfileSpecCharRelationship is valid.",
"$ref":"#/components/schemas/TimePeriodOracle"
},
"id":{
"type":"string",
"description":"The ID of the cust prof specification characteristic relationship."
},
"name":{
"type":"string",
"description":"A string. Name of the target characteristic."
},
"href":{
"type":"string",
"description":"A string. Reference of the target customer profile."
},
"@type":{
"type":"string",
"description":"The class type of the cust prof specification characteristic relationship."
},
"@baseType":{
"type":"string",
"description":"The base type of the cust prof specification characteristic relationship."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the cust prof specification characteristic relationship."
}
},
"required":[
"id",
"name",
"relationshipType",
"@type"
]
},
"CustProfSpecCharacteristicValueOracle":{
"title":"CustProfSpecCharacteristicValueOracle",
"type":"object",
"description":"A list of customer profile spec characteristic values A CustomerProfileSpecificationCharacteristicValue object defines a set of attributes, each of which can be assigned to a corresponding set of attributes in a SpecCharacteristic object. The values of the attributes in the SpecCharacteristicValue object describe the values of the attributes that a corresponding SpecCharacteristic object can take on.",
"properties":{
"isDefault":{
"type":"boolean",
"description":"Whether the cust prof specification characteristic value is default."
},
"unitOfMeasure":{
"type":"string",
"description":"A string. A length, surface, volume, dry measure, liquid measure, money, weight, time, and the like. In general, a determinate quantity or magnitude of the kind designated, taken as a standard of comparison for others of the same kind, in assigning to them numerical values, as 1 foot, 1 yard, 1 mile, 1 square foot."
},
"validFor":{
"description":"A time period. The period of time for which a value is applicable.",
"$ref":"#/components/schemas/TimePeriodOracle"
},
"value":{
"oneOf":[
{
"type":"string"
},
{
"type":"object"
},
{
"type":"number"
},
{
"type":"boolean"
},
{
"type":"array"
}
],
"description":"A discrete value that the characteristic can take on, or the actual value of the characteristic."
},
"valueFrom":{
"type":"string",
"description":"An integer. The low range value that a characteristic can take on."
},
"valueTo":{
"type":"string",
"description":"An integer. The upper range value that a characteristic can take on."
},
"valueType":{
"type":"string",
"description":"The type or classification of the cust prof specification characteristic value. Valid values are STRING, NUMBER, OBJECT, ARRAY, DECIMAL, BOOLEAN, DATE, and DATETIME.",
"enum":[
"STRING",
"NUMBER",
"OBJECT",
"ARRAY",
"DECIMAL",
"BOOLEAN",
"DATE",
"DATETIME"
]
},
"rangeInterval":{
"type":"string",
"description":"A string. An indicator that specifies the inclusion or exclusion of the valueFrom and valueTo attributes. If applicable, possible values are 'open', 'closed', 'closedBottom' and 'closedTop'. Valid values are OPEN, CLOSED, CLOSED_BOTTOM, and CLOSED_TOP.",
"enum":[
"OPEN",
"CLOSED",
"CLOSED_BOTTOM",
"CLOSED_TOP"
]
},
"regex":{
"type":"string",
"description":"A string. A regular expression constraint for given value."
},
"@type":{
"type":"string",
"description":"The class type of the cust prof specification characteristic value."
},
"@baseType":{
"type":"string",
"description":"The base type of the cust prof specification characteristic value."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the cust prof specification characteristic value."
}
},
"required":[
"value",
"@type"
]
},
"CustProfSpecRelationshipOracle":{
"type":"object",
"title":"CustProfSpecRelationshipOracle",
"description":"A list of usage spec relationships (CustomerProfileSpecificationRelationship [*]). A list of customer profile specifications related to this specification.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the cust prof specification relationship."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the cust prof specification relationship."
},
"name":{
"type":"string",
"description":"The name of the cust prof specification relationship."
},
"relationshipType":{
"type":"string",
"description":"The type or classification of the cust prof specification relationship. Valid values are AGGREGATION, MIGRATION, SUBSTITUTION, DEPENDENCY, and EXCLUSIVITY.",
"enum":[
"AGGREGATION",
"MIGRATION",
"SUBSTITUTION",
"DEPENDENCY",
"EXCLUSIVITY"
]
},
"validFor":{
"$ref":"#/components/schemas/TimePeriodOracle",
"description":"The period for which the cust prof specification relationship is valid."
},
"@type":{
"type":"string",
"description":"The class type of the cust prof specification relationship."
},
"@baseType":{
"type":"string",
"description":"The base type of the cust prof specification relationship."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the cust prof specification relationship."
}
},
"required":[
"id",
"relationshipType",
"@type"
]
},
"PricelistOracle":{
"title":"PricelistOracle",
"type":"object",
"description":"A list of offers and its coresponding prices which can be used for selling the offer in a region or a particular set of customers.",
"properties":{
"id":{
"type":"string",
"maxLength":30,
"description":"The ID of the pricelist."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the pricelist."
},
"name":{
"type":"string",
"description":"The name of the pricelist."
},
"description":{
"type":"string",
"description":"The description of the pricelist."
},
"lastUpdate":{
"type":"string",
"format":"date-time",
"description":"The date and time when the pricelist was last updated."
},
"lifecycleStatus":{
"type":"string",
"description":"The status of the pricelist."
},
"pricelistType":{
"type":"string",
"description":"The type or classification of the pricelist. Valid values are RESIDENTIAL, and BUSINESS.",
"enum":[
"RESIDENTIAL",
"BUSINESS"
]
},
"validFor":{
"$ref":"#/components/schemas/TimePeriod",
"description":"The period for which the pricelist is valid."
},
"@type":{
"type":"string",
"description":"The class type of the pricelist."
},
"@baseType":{
"type":"string",
"description":"The base type of the pricelist."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the pricelist."
},
"currency":{
"type":"string",
"description":"The currency (ISO4217 norm uses 3 letters to define the currency)."
},
"project":{
"$ref":"#/components/schemas/ProjectRef",
"description":"The pricelist."
},
"version":{
"type":"string",
"description":"The promotion version."
},
"relatedParty":{
"type":"array",
"items":{
"$ref":"#/components/schemas/RelatedPartyRefOrPartyRoleRef"
},
"description":"A list of related parties associated with the pricelist."
},
"productOffering":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ProductOfferingRef"
},
"description":"A list of product offerings associated with the pricelist."
},
"promotion":{
"type":"array",
"items":{
"$ref":"#/components/schemas/PromotionRef"
},
"description":"A list of promotions associated with the pricelist."
},
"created":{
"type":"string",
"format":"date-time",
"description":"The date and time of the creation."
},
"createdBy":{
"type":"string",
"description":"The name of the person who created item."
},
"lastUpdatedBy":{
"type":"string",
"description":"The name of the person who updated item."
},
"balanceElement":{
"$ref":"#/components/schemas/BalanceElementRef",
"description":"The pricelist."
},
"externalId":{
"type":"string",
"description":"The ID of the external associated with the pricelist."
},
"applicationName":{
"type":"string",
"description":"The name of the application associated with the pricelist."
},
"versionState":{
"type":"number",
"description":"The version state of the price list."
},
"businessUnitId":{
"type":"number",
"description":"The ID of the business unit associated with the pricelist."
},
"businessUnitName":{
"type":"string",
"description":"The name of the business unit associated with the pricelist."
}
},
"required":[
"@type"
]
},
"PricelistOracle_Create":{
"title":"PricelistOracle",
"type":"object",
"description":"A list of offers and its coresponding prices which can be used for selling the offer in a region or a particular set of customers.",
"properties":{
"id":{
"type":"string",
"maxLength":30,
"description":"The ID of the pricelist create."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the pricelist create."
},
"name":{
"type":"string",
"description":"The name of the pricelist create."
},
"pricelistType":{
"type":"string",
"description":"Indicates if the pricelist is a Residential, Business or other type of resource."
},
"description":{
"type":"string",
"description":"The description of the pricelist."
},
"lastUpdate":{
"type":"string",
"format":"date-time",
"description":"The date and time when the pricelist was last updated."
},
"lifecycleStatus":{
"type":"string",
"description":"The status of the pricelist create."
},
"validFor":{
"$ref":"#/components/schemas/TimePeriod",
"description":"The period for which the pricelist create is valid."
},
"@type":{
"type":"string",
"description":"The class type of the pricelist create."
},
"@baseType":{
"type":"string",
"description":"The base type of the pricelist create."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the pricelist create."
},
"currency":{
"type":"string",
"description":"The currency (ISO4217 norm uses 3 letters to define the currency)."
},
"project":{
"$ref":"#/components/schemas/ProjectRef",
"description":"The pricelist create."
},
"version":{
"type":"string",
"description":"The promotion version."
},
"relatedParty":{
"type":"array",
"items":{
"$ref":"#/components/schemas/RelatedPartyRefOrPartyRoleRef"
},
"description":"A list of related parties associated with the pricelist create."
},
"balanceElement":{
"$ref":"#/components/schemas/BalanceElementRef",
"description":"The pricelist create."
},
"versionState":{
"type":"number",
"description":"The version state of the promotion."
},
"businessUnitId":{
"type":"number",
"description":"The ID of the business unit associated with the pricelist create."
},
"businessUnitName":{
"type":"string",
"description":"The name of the business unit associated with the pricelist create."
}
}
},
"CustomProfileSpecificationOracle":{
"title":"CustomProfileSpecificationOracle",
"type":"object",
"description":"The custom profile specification resource.",
"properties":{
"id":{
"type":"string",
"maxLength":30,
"description":"The ID of the custom profile specification."
},
"href":{
"type":"string",
"description":"A string. Reference of the Custom ProfileSpec."
},
"version":{
"type":"string",
"description":"A string. Custom ProfileSpec version."
},
"name":{
"type":"string",
"description":"A string. Name of the Custom ProfileSpec."
},
"description":{
"type":"string",
"description":"A string. A narrative that explains in detail what the Custom ProfileSpec is."
},
"lifecycleStatus":{
"type":"string",
"description":"Indicates the current lifecycle status of the custom profile specification."
},
"validFor":{
"$ref":"#/components/schemas/TimePeriod",
"description":"The period for which the custom profile specification is valid."
},
"@type":{
"type":"string",
"description":"The class type of the custom profile specification."
},
"@baseType":{
"type":"string",
"description":"The base type of the custom profile specification."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the custom profile specification."
},
"lastUpdate":{
"type":"string",
"format":"date-time",
"description":"A date time (DateTime). Date and time of the last update of the Custom ProfileSpec."
},
"relatedParty":{
"type":"array",
"items":{
"$ref":"#/components/schemas/RelatedPartyRefOrPartyRoleRef"
},
"description":"A list of related parties associated with the custom profile specification."
},
"customProfileSpecChar":{
"type":"array",
"items":{
"anyOf":[
{
"$ref":"#/components/schemas/CustomProfileSpecChar"
},
{
"$ref":"#/components/schemas/BusinessConfigurationCharOracle"
},
{
"$ref":"#/components/schemas/ZoneValueMapCharOracle"
}
]
},
"description":"A list of custom profile specification characteristics associated with the custom profile specification."
},
"customProfileSpecRel":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CustomProfileSpecRel"
},
"description":"A list of custom profile specification rels associated with the custom profile specification."
},
"targetProductSchema":{
"$ref":"#/components/schemas/TargetProductSchemaOracle",
"description":"The custom profile specification."
},
"profileType":{
"type":"string",
"description":"The type or classification of the custom profile specification.",
"enum":[
"DEVICE_SPEC",
"BUSINESS_CONFIG",
"TRADE_IN",
"CHARGING_TERM",
"SUSPENSION_TERM",
"RETURN_CHECKLIST",
"ENTITY_PROFILE",
"RENEWAL_TERM",
"FINANCE_PLAN",
"ZONE_VALUE_MAP",
"STANDARD_ZONE",
"CUSTOM_ANALYZER_RULE",
"POLICY_SPEC_TERM",
"TIME_MODEL"
]
},
"profileCode":{
"type":"string",
"description":"The profile code associated with the custom profile specification."
},
"created":{
"type":"string",
"format":"date-time",
"description":"The date and time of creation."
},
"createdBy":{
"type":"string",
"description":"The name of the person who created."
},
"lastUpdatedBy":{
"type":"string",
"description":"The name of the person who updated."
},
"project":{
"$ref":"#/components/schemas/ProjectRef",
"description":"The custom profile specification."
},
"externalId":{
"type":"string",
"description":"The ID of the external associated with the custom profile specification."
},
"applicationName":{
"type":"string",
"description":"The name of the application associated with the custom profile specification."
},
"versionState":{
"type":"number",
"description":"The version state of the Customer Profile Specification."
},
"charValueObject":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CharValueObjectRefOracle"
},
"description":"A list of char value objects associated with the custom profile specification."
}
},
"required":[
"name",
"profileType",
"@type"
]
},
"CustomProfileSpecRel":{
"title":"CustomProfileSpecRel",
"type":"object",
"description":"A migration, substitution, dependency or exclusivity relationship between/among custom profile specifications.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the custom profile specification rel."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the custom profile specification rel."
},
"relationshipType":{
"type":"string",
"description":"The type or classification of the custom profile specification rel. Valid values are AGGREGATION, MIGRATION, SUBSTITUTION, DEPENDENCY, EXCLUSIVITY, PARENT, CONDITION, EXCLUDES, REQUIRES, and ALLOWED.",
"enum":[
"AGGREGATION",
"MIGRATION",
"SUBSTITUTION",
"DEPENDENCY",
"EXCLUSIVITY",
"PARENT",
"CONDITION",
"EXCLUDES",
"REQUIRES",
"ALLOWED"
]
},
"validFor":{
"$ref":"#/components/schemas/TimePeriodOracle",
"description":"The period for which the custom profile specification rel is valid."
},
"versionState":{
"type":"number",
"description":"The version state of the reference."
}
},
"required":[
"id",
"relationshipType"
]
},
"CustomProfileSpecChar":{
"title":"CustomProfileSpecChar",
"type":"object",
"description":"A list of custom profile spec characteristics (CustomProfileSpecChar [*]). A list of custom profile spec characteristics (CustomProfileSpecChar [*]). This class represents the key features of this custom profile specification.",
"properties":{
"name":{
"type":"string",
"description":"A string. A word, term, or phrase by which this characteristic specification is known and distinguished from other characteristic specifications."
},
"displayText":{
"type":"string",
"description":"A string. A word, term, or phrase by which can be displyed for user experience."
},
"description":{
"type":"string",
"description":"A string. A narrative that explains in detail what the CustomProfileSpecChar is."
},
"attributeName":{
"type":"string",
"description":"A string. A fully qualified name of the attribute that represents the characteristic."
},
"sourceSystemName":{
"type":"string",
"description":"The name of the source system associated with the custom profile specification characteristic."
},
"characteristicType":{
"type":"string",
"description":"The type or classification of the custom profile specification characteristic. Valid values are ONE_TIME, RECURRING, USAGE, FEATURE, ATTRIBUTE, RESTRICTION, GEOGRAPHY, RULE, UI_FEATURE, RESOURCE, and LOOKUP.",
"enum":[
"ONE_TIME",
"RECURRING",
"USAGE",
"FEATURE",
"ATTRIBUTE",
"RESTRICTION",
"GEOGRAPHY",
"RULE",
"UI_FEATURE",
"RESOURCE",
"LOOKUP"
]
},
"valueType":{
"type":"string",
"description":"The type or classification of the custom profile specification characteristic. Valid values are STRING, NUMBER, OBJECT, ARRAY, DECIMAL, BOOLEAN, DATE, DATETIME, PRODUCT_OFFER, PRODUCT_SPEC, PRODUCT_LINE, and CATEGORY.",
"enum":[
"STRING",
"NUMBER",
"OBJECT",
"ARRAY",
"DECIMAL",
"BOOLEAN",
"DATE",
"DATETIME",
"PRODUCT_OFFER",
"PRODUCT_SPEC",
"PRODUCT_LINE",
"CATEGORY"
]
},
"configurable":{
"type":"boolean",
"description":"Whether the custom profile specification characteristic is configurable."
},
"validFor":{
"$ref":"#/components/schemas/TimePeriodOracle",
"description":"The period for which the custom profile specification characteristic is valid."
},
"@type":{
"type":"string",
"description":"The class type of the custom profile specification characteristic."
},
"@baseType":{
"type":"string",
"description":"The base type of the custom profile specification characteristic."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the custom profile specification characteristic."
},
"@valueSchemaLocation":{
"type":"string",
"description":"A string. This (optional) field provides a link to the schema describing the value type."
},
"minCardinality":{
"type":"integer",
"description":"An integer. The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality."
},
"maxCardinality":{
"type":"integer",
"description":"An integer. The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality."
},
"isUnique":{
"type":"boolean",
"description":"A boolean. An indicator that specifies if a value is unique for the specification. Possible values are; 'unique while value is in effect' and 'unique whether value is in effect or not'."
},
"active":{
"type":"boolean",
"description":"Whether the custom profile specification characteristic has active."
},
"regex":{
"type":"string",
"description":"A rule or principle represented as a regular expression for deriving the value of a characteristic value."
},
"extensible":{
"type":"boolean",
"description":"A boolean. An indicator that specifies that the values for the characteristic can be extended by adding new values when instantiating a characteristic for an Entity."
},
"allowedUnits":{
"type":"array",
"items":{
"type":"string"
},
"description":"A list of allowed units associated with the custom profile specification characteristic."
},
"customProfileSpecCharRel":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CustomProfileSpecCharRel"
},
"description":"A list of custom profile specification characteristic rels associated with the custom profile specification characteristic."
},
"customProfileSpecCharValue":{
"type":"array",
"items":{
"anyOf":[
{
"$ref":"#/components/schemas/CustomProfileSpecCharValue"
},
{
"$ref":"#/components/schemas/BusinessConfigurationCharValueOracle"
}
]
},
"description":"A list of custom profile specification characteristic values associated with the custom profile specification characteristic."
},
"balanceElementCode":{
"type":"string",
"description":"The balance element code associated with the custom profile specification characteristic."
},
"balanceElement":{
"$ref":"#/components/schemas/BalanceElementRef",
"description":"The custom profile specification characteristic."
}
},
"required":[
"name",
"@type"
]
},
"CustomProfileSpecCharRel":{
"title":"CustomProfileSpecCharRel",
"type":"object",
"description":"A list of custom profile spec char relationships (CustomProfileSpecCharRel [*]). A list of custom profile spec char relationships (CustomProfileSpecCharRel [*]). An aggregation, migration, substitution, dependency or exclusivity relationship between/among Specification Characteristics.",
"properties":{
"relationshipType":{
"type":"string",
"description":"The type or classification of the custom profile specification characteristic rel. Valid values are AGGREGATION, CONDITION, EXCLUDES, REQUIRES, ALLOWED, and PARENT.",
"enum":[
"AGGREGATION",
"CONDITION",
"EXCLUDES",
"REQUIRES",
"ALLOWED",
"PARENT"
]
},
"validFor":{
"description":"A time period. The period for which the custom profileSpecCharRelationship is valid.",
"$ref":"#/components/schemas/TimePeriodOracle"
},
"id":{
"type":"string",
"description":"The ID of the custom profile specification characteristic rel."
},
"name":{
"type":"string",
"description":"A string. Name of the target characteristic."
},
"href":{
"type":"string",
"description":"A string. Reference of the target custom profileSpecification."
},
"@type":{
"type":"string",
"description":"The class type of the custom profile specification characteristic rel."
},
"@baseType":{
"type":"string",
"description":"The base type of the custom profile specification characteristic rel."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the custom profile specification characteristic rel."
}
},
"required":[
"id",
"name",
"relationshipType",
"@type"
]
},
"BusinessConfigurationCharOracle":{
"title":"BusinessConfigurationCharOracle",
"allOf":[
{
"$ref":"#/components/schemas/CustomProfileSpecChar"
},
{
"type":"object",
"properties":{
"userDefined":{
"type":"boolean",
"description":"Whether the business configuration characteristic has user defined."
},
"dataSource":{
"type":"array",
"items":{
"$ref":"#/components/schemas/DataSourceOracle"
},
"description":"A list of data sources associated with the business configuration characteristic."
}
}
}
]
},
"ExternalConfigurationValueOracle":{
"title":"ExternalConfigurationValueOracle",
"allOf":[
{
"$ref":"#/components/schemas/CustomProfileSpecCharValue"
}
]
},
"BusinessConfigurationCharValueOracle":{
"title":"BusinessConfigurationCharValueOracle",
"allOf":[
{
"$ref":"#/components/schemas/CustomProfileSpecCharValue"
},
{
"type":"object",
"properties":{
"userDefined":{
"type":"boolean",
"description":"Whether the business configuration characteristic value has user defined."
},
"geographyDataSource":{
"type":"array",
"items":{
"$ref":"#/components/schemas/GeographyDataSourceOracle"
},
"description":"A list of geography data sources associated with the business configuration characteristic value."
}
}
}
]
},
"DataSourceOracle":{
"title":"DataSourceOracle",
"type":"object",
"description":"The data source for the target system.",
"properties":{
"value":{
"type":"string",
"description":"The value assigned to the data source."
},
"type":{
"type":"string",
"description":"The type or classification of the data source."
},
"userDefined":{
"type":"boolean",
"description":"Whether the data source has user defined."
},
"entity":{
"type":"string",
"description":"The describes which entity the datasource belongs to. Valid values are PRODUCT_ORDER, and SHOPPING_CART.",
"enum":[
"PRODUCT_ORDER",
"SHOPPING_CART"
]
}
}
},
"GeographyDataSourceOracle":{
"title":"GeographyDataSourceOracle",
"allOf":[
{
"$ref":"#/components/schemas/DataSourceOracle"
},
{
"type":"object",
"properties":{
"geographyLevel":{
"type":"number",
"description":"The level of the geography system."
},
"geographyType":{
"type":"string",
"description":"The type or classification of the geography data source."
}
}
}
]
},
"ImpExpJobOracle":{
"title":"ImpExpJobs",
"type":"object",
"description":"The import or export job represents a migration or publish job.",
"properties":{
"id":{
"type":"string",
"maxLength":150,
"description":"The ID of the import or export job."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the import or export job."
},
"contentType":{
"type":"string",
"description":"The content type of the import or export job."
},
"path":{
"type":"string",
"description":"The path value for locating the import or export job."
},
"status":{
"type":"string",
"description":"The status of the import or export job."
},
"url":{
"type":"string",
"description":"The URL for the import or export job."
},
"jobType":{
"type":"string",
"description":"The job type of the import or export job."
},
"parentJobId":{
"type":"string",
"maxLength":150,
"description":"The ID of the parent job associated with the import or export job."
},
"jobProgressCode":{
"type":"number",
"description":"The job progress code associated with the import or export job."
},
"itemId":{
"type":"string",
"description":"The ID of the item associated with the import or export job."
},
"itemName":{
"type":"string",
"description":"The name of the item associated with the import or export job."
},
"itemDescription":{
"type":"string",
"description":"The description of the item processed by the import or export job."
},
"itemType":{
"type":"string",
"description":"The type of item processed by the import or export job."
},
"includeRef":{
"type":"string",
"description":"The include reference used by the import or export job."
},
"query":{
"type":"string",
"description":"The query used by the import or export job."
},
"errorLog":{
"type":"string",
"description":"The error log for the import or export job."
},
"lastUpdate":{
"type":"string",
"format":"date-time",
"description":"The date and time when the import or export job was last updated."
},
"startDate":{
"type":"string",
"format":"date-time",
"description":"The date and time when the import or export job started."
},
"completionDate":{
"type":"string",
"format":"date-time",
"description":"The date and time when the import or export job completed."
},
"schemaModifiedDateTime":{
"type":"string",
"description":"The date and time when the schema for the import or export job was modified."
},
"nextRunJobId":{
"type":"string",
"description":"The ID of the next scheduled run for the import or export job."
},
"eventName":{
"type":"string",
"description":"The name of the event for the import or export job."
},
"created":{
"type":"string",
"format":"date-time",
"description":"The date and time of creation."
},
"createdBy":{
"type":"string",
"description":"The name of the person who created."
},
"lastUpdatedBy":{
"type":"string",
"description":"The name of the person who updated."
}
}
},
"ProductRuleOracle":{
"title":"ProductRules",
"type":"object",
"description":"The Product Rule resource represents a set of rules and relationships.",
"properties":{
"id":{
"type":"string",
"maxLength":30,
"description":"The ID of the product rule."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the product rule."
},
"version":{
"type":"string",
"description":"The version value associated with the product rule."
},
"ruleType":{
"type":"string",
"enum":[
"COMPATIBILITY",
"ELIGIBILITY",
"MIGRATION",
"RECOMMENDATION",
"CONSTRAINT"
],
"description":"The type or classification of the product rule. Valid values are COMPATIBILITY, ELIGIBILITY, MIGRATION, RECOMMENDATION, and CONSTRAINT."
},
"ruleSubType":{
"type":"string",
"enum":[
{
}
],
"description":"The type or classification of the product rule. Valid values are {}."
},
"name":{
"type":"string",
"description":"The name of the product rule."
},
"description":{
"type":"string",
"description":"The text description of the product rule."
},
"lifecycleStatus":{
"type":"string",
"description":"The status of the product rule."
},
"@type":{
"type":"string",
"description":"The class type of the product rule."
},
"@baseType":{
"type":"string",
"description":"The base type of the product rule."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the product rule."
},
"lastUpdate":{
"type":"string",
"format":"date-time",
"description":"The date and time when the product rule was last updated."
},
"created":{
"type":"string",
"format":"date-time",
"description":"The date and time of creation."
},
"createdBy":{
"type":"string",
"description":"The name of the person who created."
},
"lastUpdatedBy":{
"type":"string",
"description":"The name of the person who updated."
},
"ruleCondition":{
"type":"array",
"items":{
"$ref":"#/components/schemas/RuleConditionOracle"
},
"description":"A list of rule conditions associated with the product rule."
},
"project":{
"$ref":"#/components/schemas/ProjectRef",
"description":"The product rule."
},
"customProfileSpec":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CustomProfileSpecRefOracle"
},
"description":"A list of custom profile specifications associated with the product rule."
},
"subject":{
"$ref":"#/components/schemas/SubjectRef",
"description":"The product rule."
},
"externalId":{
"type":"string",
"description":"The ID of the external associated with the product rule."
},
"applicationName":{
"type":"string",
"description":"The name of the application associated with the product rule."
},
"versionState":{
"type":"number",
"description":"The version state of the product rule."
},
"scope":{
"type":"string",
"enum":[
"ALL",
"BUNDLE",
"PACKAGE"
],
"description":"The scope associated with the product rule. Valid values are ALL, BUNDLE, and PACKAGE."
}
},
"required":[
"name",
"@type"
],
"discriminator":{
"propertyName":"@type",
"mapping":{
}
}
},
"RuleConditionOracle":{
"type":"object",
"title":"RuleConditionOracle",
"description":"The rule condition resource.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the rule condition."
},
"name":{
"type":"string",
"description":"The name of the rule condition."
},
"description":{
"type":"string",
"description":"A string. Description of the product rule."
},
"validFor":{
"$ref":"#/components/schemas/TimePeriodOracle",
"description":"The period for which the rule condition is valid."
},
"roundingMethod":{
"type":"string",
"description":"The rounding applicable to the product rule."
},
"stringExpression":{
"type":"string",
"description":"The metering Expression applicable to the product rule."
},
"unitOfMeasure":{
"type":"string",
"description":"The unit of Measure of Rules."
},
"@type":{
"type":"string",
"description":"The class type of the rule condition."
},
"@baseType":{
"type":"string",
"description":"The base type of the rule condition."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the rule condition."
},
"productRuleExpression":{
"type":"array",
"items":{
"anyOf":[
{
"$ref":"#/components/schemas/RuleExpressionOracle"
},
{
"$ref":"#/components/schemas/EntityRuleExpressionOracle"
},
{
"$ref":"#/components/schemas/EligibilityRuleExpressionOracle"
}
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"RuleExpressionOracle":"#/components/schemas/RuleExpressionOracle",
"EntityRuleExpressionOracle":"#/components/schemas/EntityRuleExpressionOracle",
"EligibilityRuleExpressionOracle":"#/components/schemas/EligibilityRuleExpressionOracle"
}
}
},
"description":"A list of product rule expressions associated with the rule condition."
},
"productRuleResult":{
"type":"array",
"items":{
"anyOf":[
{
"$ref":"#/components/schemas/RuleResultOracle"
},
{
"$ref":"#/components/schemas/RecommendationRuleResultOracle"
},
{
"$ref":"#/components/schemas/MigrationRuleResultOracle"
}
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"RuleResultOracle":"#/components/schemas/RuleResultOracle",
"RecommendationRuleResultOracle":"#/components/schemas/RecommendationRuleResultOracle",
"MigrationRuleResultOracle":"#/components/schemas/MigrationRuleResultOracle"
}
}
},
"description":"A list of product rule results associated with the rule condition."
}
},
"required":[
"id",
"@type"
]
},
"RuleExpressionOracle":{
"type":"object",
"title":"RuleExpressionOracle",
"properties":{
"id":{
"type":"string",
"description":"The ID of the rule expression."
},
"operator":{
"type":"string",
"description":"The operator of the expression."
},
"expressionType":{
"type":"string",
"description":"The type or classification of the rule expression. Valid values are UNARY, BINARY, NUMERIC, CHARACTERISTIC, ENTITY, and ELIGIBILTY_PARAM.",
"enum":[
"UNARY",
"BINARY",
"NUMERIC",
"CHARACTERISTIC",
"ENTITY",
"ELIGIBILTY_PARAM"
]
},
"value":{
"oneOf":[
{
"type":"string"
},
{
"type":"object"
},
{
"type":"number"
},
{
"type":"boolean"
}
],
"description":"A discrete value that the relationship can take on."
},
"valueFrom":{
"type":"integer",
"description":"An integer. The low range value that a rule can take on."
},
"valueTo":{
"type":"integer",
"description":"An integer. The upper range value that a rule can take on."
},
"valueType":{
"type":"string",
"description":"The type or classification of the rule expression. Valid values are STRING, NUMBER, DECIMAL, BOOLEAN, DATE, DATETIME, PRODUCT_OFFERING, PRODUCT_SPEC, and PRODUCT_LINE.",
"enum":[
"STRING",
"NUMBER",
"DECIMAL",
"BOOLEAN",
"DATE",
"DATETIME",
"PRODUCT_OFFERING",
"PRODUCT_SPEC",
"PRODUCT_LINE"
]
},
"rangeInterval":{
"type":"string",
"description":"A string. An indicator that specifies the inclusion or exclusion of the valueFrom and valueTo attributes. If applicable, possible values are 'open', 'closed', 'closedBottom' and 'closedTop'. Valid values are OPEN, CLOSED, CLOSED_BOTTOM, and CLOSED_TOP.",
"enum":[
"OPEN",
"CLOSED",
"CLOSED_BOTTOM",
"CLOSED_TOP"
]
},
"@type":{
"type":"string",
"description":"The class type of the rule expression."
},
"@baseType":{
"type":"string",
"description":"The base type of the rule expression."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the rule expression."
},
"productRuleExpressionRelationship":{
"type":"object",
"items":{
"$ref":"#/components/schemas/ProductRuleExprRelationshipOracle"
},
"description":"A list of product rule expression relationships associated with the rule expression."
}
},
"required":[
"id",
"expressionType",
"@type"
],
"description":"The rule expression resource."
},
"ProductRuleExprRelationshipOracle":{
"type":"object",
"title":"ProductRuleExpressionRelationshipOracle",
"description":"The product rule expr relationship resource.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the product rule expr relationship."
},
"name":{
"type":"string",
"description":"The name of the product rule expr relationship."
},
"relationshipType":{
"type":"string",
"enum":[
"LEFT_HAND_SIDE",
"RIGHT_HAND_SIDE"
],
"description":"The type or classification of the product rule expr relationship. Valid values are LEFT_HAND_SIDE, and RIGHT_HAND_SIDE."
},
"@type":{
"type":"string",
"description":"The class type of the product rule expr relationship."
},
"@baseType":{
"type":"string",
"description":"The base type of the product rule expr relationship."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the product rule expr relationship."
}
},
"required":[
"relationshipType",
"id",
"@type"
]
},
"EntityRuleExpressionOracle":{
"title":"EntityRuleExpressionOracle",
"allOf":[
{
"$ref":"#/components/schemas/RuleExpressionOracle"
},
{
"type":"object",
"properties":{
"allowedOperator":{
"type":"string",
"enum":[
"REQUIRES",
"REQUIRES_MUTUAL",
"EXCLUDES",
"COMPATIBLE"
],
"description":"The allowed operator associated with the entity rule expression. Valid values are REQUIRES, REQUIRES_MUTUAL, EXCLUDES, and COMPATIBLE."
}
}
}
]
},
"EligibilityRuleExpressionOracle":{
"title":"RuleExpressionOracle",
"allOf":[
{
"$ref":"#/components/schemas/RuleExpressionOracle"
},
{
"type":"object",
"properties":{
"eligibilityParam":{
"type":"string",
"description":"The type of the entity."
}
}
}
]
},
"RuleResultOracle":{
"type":"object",
"title":"RuleResultOracle",
"properties":{
"id":{
"type":"string",
"description":"The ID of the rule result."
},
"value":{
"type":"string",
"description":"A discrete value that the result can take on."
},
"valueType":{
"type":"string",
"description":"The type or classification of the rule result. Valid values are STRING, NUMBER, DECIMAL, BOOLEAN, DATE, DATETIME, PRODUCT_OFFERING, PRODUCT_SPEC, and PRODUCT_LINE.",
"enum":[
"STRING",
"NUMBER",
"DECIMAL",
"BOOLEAN",
"DATE",
"DATETIME",
"PRODUCT_OFFERING",
"PRODUCT_SPEC",
"PRODUCT_LINE"
]
},
"@type":{
"type":"string",
"description":"The class type of the rule result."
},
"@baseType":{
"type":"string",
"description":"The base type of the rule result."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the rule result."
}
},
"required":[
"id",
"@type"
],
"description":"The rule result resource."
},
"RecommendationRuleResultOracle":{
"title":"RecommendationRuleResultOracle",
"allOf":[
{
"$ref":"#/components/schemas/RuleResultOracle"
},
{
"type":"object",
"properties":{
"messageType":{
"type":"string",
"enum":[
"CROSS_SELL_RECOMMEND",
"UPSELL_RECOMMEND"
],
"description":"The type or classification of the recommendation rule result. Valid values are CROSS_SELL_RECOMMEND, and UPSELL_RECOMMEND."
},
"message":{
"type":"string",
"description":"The message associated with the recommendation rule result."
},
"score":{
"type":"integer",
"description":"The score within Recommendation rules must be unique and range of values supported is 0>=x<=100."
}
}
}
]
},
"MigrationRuleResultOracle":{
"title":"MigrationRuleResultOracle",
"allOf":[
{
"$ref":"#/components/schemas/RuleResultOracle"
},
{
"type":"object",
"properties":{
"commitmentStart":{
"type":"string",
"description":"For Original Start, the commitment starts on the date of the original promotion. For Now, it starts today. For Original End, it starts on the end date of the original promotion. Valid values are ORIGINAL_START, ORIGINAL_END, and NOW.",
"enum":[
"ORIGINAL_START",
"ORIGINAL_END",
"NOW"
]
},
"penalty":{
"type":"integer",
"description":"The amount, in currency, to charge if the customer terminates the promotion before the specified end date."
},
"duration":{
"type":"string",
"description":"For Original Duration, Uses the duration fields that are defined for the original promotion, that is the promotion from which it is upgraded. For New Duration, Uses the duration fields that are defined for the new promotion, that is the promotion to which it is upgraded.",
"enum":[
"ORIGINAL_DURATION",
"NEW_DURATION"
]
},
"productOfferingPrice":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ProductOfferingPriceRef"
},
"description":"A list of product offering prices associated with the migration rule result."
}
}
}
]
},
"BalanceElementOracle":{
"title":"BalanceElementOracle",
"type":"object",
"description":"The balance element represents the currency and non currency units used in Pricing.",
"properties":{
"id":{
"type":"string",
"maxLength":30,
"description":"The ID of the balance element."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the balance element."
},
"name":{
"type":"string",
"description":"The name of the balance element."
},
"description":{
"type":"string",
"description":"The description of balance element."
},
"lastUpdate":{
"type":"string",
"format":"date-time",
"description":"The date and time when the balance element was last updated."
},
"lifecycleStatus":{
"type":"string",
"description":"The status of the balance element."
},
"validFor":{
"$ref":"#/components/schemas/TimePeriod",
"description":"The period for which the balance element is valid."
},
"@type":{
"type":"string",
"description":"The class type of the balance element."
},
"@baseType":{
"type":"string",
"description":"The base type of the balance element."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the balance element."
},
"consumptionRule":{
"type":"string",
"description":"The consumption Rule of Balance Element. Valid values are NONE, EST, LST, EET, LET, ESTLET, ESTEET, LSTEET, LSTLET, EETEST, LETEST, and LETLST.",
"enum":[
"NONE",
"EST",
"LST",
"EET",
"LET",
"ESTLET",
"ESTEET",
"LSTEET",
"LSTLET",
"EETEST",
"LETEST",
"LETLST"
]
},
"balanceElementType":{
"type":"string",
"description":"The type or classification of the balance element. Valid values are COUNTER, ALLOWANCE, CURRENCY, CRYPTO, and PSEUDO.",
"enum":[
"COUNTER",
"ALLOWANCE",
"CURRENCY",
"CRYPTO",
"PSEUDO"
]
},
"code":{
"type":"string",
"description":"The currency code, using the three-letter ISO 4217 code for currency balance elements or a user-defined code for non-currency balance elements."
},
"numericCode":{
"type":"number",
"description":"The unique numeric code, using the ISO 4217 numeric code for currency balance elements or an autogenerated value greater than 1000 for non-currency balance elements."
},
"symbol":{
"type":"string",
"description":"The symbol of the currency or pseudo currency."
},
"roundingMethod":{
"type":"string",
"description":"The default rounding applicable to the balance element."
},
"decimalPlaces":{
"type":"string",
"description":"The allowed decimal places."
},
"project":{
"$ref":"#/components/schemas/ProjectRef",
"description":"The balance element."
},
"version":{
"type":"string",
"description":"The balance element version."
},
"relatedParty":{
"type":"array",
"items":{
"$ref":"#/components/schemas/RelatedPartyRefOrPartyRoleRef"
},
"description":"A list of related parties associated with the balance element."
},
"created":{
"type":"string",
"format":"date-time",
"description":"The date and time of the creation."
},
"createdBy":{
"type":"string",
"description":"The name of the person who created item."
},
"lastUpdatedBy":{
"type":"string",
"description":"The name of the person who updated item."
},
"externalId":{
"type":"string",
"description":"The ID of the external associated with the balance element."
},
"applicationName":{
"type":"string",
"description":"The name of the application associated with the balance element."
},
"versionState":{
"type":"number",
"description":"The version state of the balance element."
}
},
"required":[
"@type"
]
},
"Promotion":{
"title":"Promotion",
"type":"object",
"description":"Promotion Resource provides the additional discount, voucher, bonus or gift to the customer who meets the pre-defined criteria. Using promotion, the enterprise is able to attract the users and encourage more consumption, especially continuous purchases. Normally Promotion is not regarded as one type of product or product offering. It is often applied when the customer buys the product offerings with the price or amount surpassing the certain limit.",
"properties":{
"id":{
"type":"string",
"maxLength":30,
"description":"The ID of the promotion."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the promotion."
},
"name":{
"type":"string",
"description":"The name of the promotion."
},
"description":{
"type":"string",
"description":"The description of promotion."
},
"lastUpdate":{
"type":"string",
"format":"date-time",
"description":"The date and time when the promotion was last updated."
},
"lifecycleStatus":{
"type":"string",
"description":"The status of the promotion."
},
"validFor":{
"$ref":"#/components/schemas/TimePeriod",
"description":"The period for which the promotion is valid."
},
"@type":{
"type":"string",
"description":"The class type of the promotion."
},
"@baseType":{
"type":"string",
"description":"The base type of the promotion."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the promotion."
},
"promotionType":{
"type":"string",
"description":"The type or classification of the promotion. Valid values are AWARD, DISCOUNT, TRADE_IN, and CROSS_PRODUCT_DISCOUNT.",
"enum":[
"AWARD",
"DISCOUNT",
"TRADE_IN",
"CROSS_PRODUCT_DISCOUNT"
]
},
"attachment":{
"type":"array",
"items":{
"anyOf":[
{
"$ref":"#/components/schemas/Attachment"
},
{
"$ref":"#/components/schemas/AttachmentOracle"
},
{
"$ref":"#/components/schemas/AttachmentRef"
}
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"Attachment":"#/components/schemas/Attachment",
"AttachmentOracle":"#/components/schemas/AttachmentOracle",
"AttachmentRef":"#/components/schemas/AttachmentRef"
}
}
},
"description":"A list of attachments associated with the promotion."
},
"pattern":{
"type":"array",
"items":{
"anyOf":[
{
"$ref":"#/components/schemas/PromotionPatternOracle"
},
{
"$ref":"#/components/schemas/PromotionTreePatternOracle"
}
]
},
"description":"A list of patterns associated with the promotion."
}
},
"required":[
"@type"
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"Promotion":"#/components/schemas/Promotion",
"PromotionOracle":"#/components/schemas/PromotionOracle"
}
}
},
"PromotionOracle":{
"title":"PromotionOracle",
"allOf":[
{
"$ref":"#/components/schemas/Promotion"
},
{
"type":"object",
"properties":{
"project":{
"$ref":"#/components/schemas/ProjectRef",
"description":"The promotion."
},
"version":{
"type":"string",
"description":"The promotion version."
},
"priceList":{
"type":"array",
"items":{
"$ref":"#/components/schemas/PriceListRefOracle"
},
"description":"A list of price lists associated with the promotion."
},
"category":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CategoryRef"
},
"description":"A list of categories associated with the promotion."
},
"agreement":{
"type":"array",
"items":{
"$ref":"#/components/schemas/AgreementRef"
},
"description":"A list of agreements associated with the promotion."
},
"created":{
"type":"string",
"format":"date-time",
"description":"The date and time of the creation."
},
"createdBy":{
"type":"string",
"description":"The name of the person who created item."
},
"lastUpdatedBy":{
"type":"string",
"description":"The name of the person who updated item."
},
"customProfileSpec":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CustomProfileSpecRefOracle"
},
"description":"A list of custom profile specifications associated with the promotion."
},
"customProfSpecCharValueUse":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CustomProfSpecCharValueUse"
},
"description":"A list of custom prof specification characteristic value uses associated with the promotion."
},
"externalId":{
"type":"string",
"description":"The ID of the external associated with the promotion."
},
"applicationName":{
"type":"string",
"description":"The name of the application associated with the promotion."
},
"versionState":{
"type":"number",
"description":"The version state of the promotion."
},
"active":{
"type":"boolean",
"description":"Whether the promotion has active."
}
}
}
]
},
"PromotionPattern":{
"title":"PromotionPattern",
"type":"object",
"description":"The detailed pattern of the promotion. The pattern decides the conditions of promotion and the benefit of the promotion to be given to the eligible customer.",
"properties":{
"name":{
"type":"string",
"description":"The name of the promotion pattern."
},
"description":{
"type":"string",
"description":"The description of promotion pattern."
},
"priority":{
"type":"integer",
"description":"The piority of this Promotion Pattern."
},
"criteriaGroupLogicalRelationship":{
"type":"string",
"description":"The logical relation type among the promotion criteria group. Valid values are AND and OR.",
"enum":[
"AND",
"OR"
]
},
"@type":{
"type":"string",
"description":"The class type of the promotion pattern."
},
"@baseType":{
"type":"string",
"description":"The base type of the promotion pattern."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the promotion pattern."
},
"criteriaGroup":{
"type":"array",
"items":{
"$ref":"#/components/schemas/PromotionCriteriaGroupOracle"
},
"description":"A list of criteria groups associated with the promotion pattern."
},
"action":{
"type":"array",
"items":{
"$ref":"#/components/schemas/PromotionActionOracle"
},
"description":"A list of actions associated with the promotion pattern."
},
"validFor":{
"$ref":"#/components/schemas/TimePeriod",
"description":"The period for which the promotion pattern is valid."
}
},
"required":[
"criteriaGroup",
"action",
"@type"
]
},
"PromotionPatternOracle":{
"title":"PromotionPatternOracle",
"allOf":[
{
"$ref":"#/components/schemas/PromotionPattern"
},
{
"type":"object",
"properties":{
"active":{
"type":"boolean",
"description":"Whether the promotion pattern has active."
}
}
}
]
},
"PromotionTreePatternOracle":{
"title":"PromotionPatternTreeOracle",
"allOf":[
{
"$ref":"#/components/schemas/PromotionPatternOracle"
},
{
"type":"object",
"properties":{
"isRoot":{
"type":"boolean",
"description":"Whether the promotion tree pattern is root."
},
"patternRelationship":{
"description":"A list of pattern relationships associated with the promotion tree pattern.",
"type":"array",
"items":{
"$ref":"#/components/schemas/PatternRelationshipOracle"
}
}
},
"required":[
"patternRelationship"
]
}
]
},
"PatternRelationshipOracle":{
"title":"PatternRelationshipOracle",
"type":"object",
"properties":{
"id":{
"type":"string",
"maxLength":30,
"description":"The ID of the pattern relationship."
},
"name":{
"type":"string",
"description":"The name of the pattern relationship."
},
"@baseType":{
"type":"string",
"description":"The base type of the pattern relationship."
},
"@type":{
"type":"string",
"description":"The class type of the pattern relationship."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the pattern relationship."
},
"relationshipType":{
"type":"string",
"description":"The type or classification of the pattern relationship. Valid values are TRUE_STATE, and FALSE_STATE.",
"enum":[
"TRUE_STATE",
"FALSE_STATE"
]
}
},
"required":[
"relationshipType",
"@type"
],
"description":"The pattern relationship resource."
},
"PromotionCriteriaGroup":{
"title":"PromotionCriteriaGroup",
"type":"object",
"description":"The group of the criteria of the promotion.The logical relationship between different groups is decided by the ???relationTypeInGroup???.",
"properties":{
"id":{
"type":"string",
"maxLength":30,
"description":"The ID of the promotion criteria group."
},
"groupName":{
"type":"string",
"description":"The name of the group associated with the promotion criteria group."
},
"criteriaLogicalRelationship":{
"type":"string",
"description":"The logical relation type among the promotion criteria group. Valid values are AND and OR.",
"enum":[
"AND",
"OR"
]
},
"@type":{
"type":"string",
"description":"The class type of the promotion criteria group."
},
"@baseType":{
"type":"string",
"description":"The base type of the promotion criteria group."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the promotion criteria group."
},
"criteria":{
"type":"array",
"items":{
"$ref":"#/components/schemas/PromotionCriteriaOracle"
},
"description":"A list of criterias associated with the promotion criteria group."
}
},
"required":[
"criteria",
"@type"
]
},
"PromotionCriteria":{
"title":"PromotionCriteria",
"type":"object",
"description":"The criteria of the promotion.",
"properties":{
"id":{
"type":"string",
"maxLength":30,
"description":"The ID of the promotion criteria."
},
"criteriaParameter":{
"type":"string",
"description":"The parameter (factor) of the criteria."
},
"criteriaValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"object"
},
{
"type":"number"
},
{
"type":"boolean"
},
{
"type":"array"
}
],
"description":"The value is filled for the comparison of the criteria."
},
"criteriaOperator":{
"type":"string",
"description":"The logic expression including parameter and operator. Valid values are EQUALS, GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUALS, LESS_THAN_OR_EQUALS, NOT_EQUALS, IN_BETWEEN, and IN.",
"enum":[
"EQUALS",
"GREATER_THAN",
"LESS_THAN",
"GREATER_THAN_OR_EQUALS",
"LESS_THAN_OR_EQUALS",
"NOT_EQUALS",
"IN_BETWEEN",
"IN"
]
},
"@type":{
"type":"string",
"description":"The class type of the promotion criteria."
},
"@baseType":{
"type":"string",
"description":"The base type of the promotion criteria."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the promotion criteria."
}
},
"required":[
"criteriaOperator",
"criteriaParameter",
"criteriaValue",
"@type"
]
},
"PromotionCriteriaOracle":{
"title":"PromotionCriteriaOracle",
"allOf":[
{
"$ref":"#/components/schemas/PromotionCriteria"
},
{
"type":"object",
"properties":{
"description":{
"type":"string",
"description":"A narrative text describing the criteria object."
},
"valueFrom":{
"type":"string",
"description":"The low range value that a rule can take on."
},
"valueTo":{
"type":"string",
"description":"The upper range value that a rule can take on."
},
"valueType":{
"type":"string",
"description":"The type or classification of the promotion criteria. Valid values are STRING, NUMBER, OBJECT, ARRAY, DECIMAL, BOOLEAN, DATE, DATETIME, PRODUCT_OFFER, PRODUCT_LINE, CATEGORY, and PRODUCT_SPEC.",
"enum":[
"STRING",
"NUMBER",
"OBJECT",
"ARRAY",
"DECIMAL",
"BOOLEAN",
"DATE",
"DATETIME",
"PRODUCT_OFFER",
"PRODUCT_LINE",
"CATEGORY",
"PRODUCT_SPEC"
]
},
"regex":{
"type":"string",
"description":"The regular expression to define constraint on the allowed value."
},
"unitOfMeasure":{
"type":"string",
"description":"The unit can be minutes or GB.",
"enum":[
"NONE",
"SECOND",
"MINUTE",
"HOUR",
"DAY",
"MONTH",
"BYTE",
"KILOBYTE",
"MEGABYTE",
"GIGABYTE",
"PAGES",
"MOVIES",
"TIME_INTERVAL",
"QUANTITY",
"MBPS",
"GBPS"
]
},
"isDefault":{
"type":"boolean",
"description":"Whether the promotion criteria is default."
},
"rangeInterval":{
"type":"string",
"description":"An indicator that specifies the inclusion or exclusion of the valueFrom and valueTo attributes. If applicable, possible values are ''open'', ''closed'', ''closedBottom'' and ''closedTop'. Valid values are OPEN, CLOSED, CLOSED_BUTTON, and CLOSED_TOP.",
"enum":[
"OPEN",
"CLOSED",
"CLOSED_BUTTON",
"CLOSED_TOP"
]
}
}
}
]
},
"PromotionCriteriaGroupOracle":{
"title":"PromotionCriteriaGroupOracle",
"allOf":[
{
"$ref":"#/components/schemas/PromotionCriteriaGroup"
},
{
"type":"object",
"properties":{
"criteriaProfileSpec":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CustomProfileSpecRefOracle"
},
"description":"A list of criteria profile specifications associated with the promotion criteria group."
}
}
}
]
},
"PromotionAction":{
"title":"PromotionAction",
"type":"object",
"properties":{
"id":{
"type":"string",
"maxLength":30,
"description":"The ID of the promotion action."
},
"actionType":{
"type":"array",
"items":{
"type":"string",
"description":"The type or classification of the promotion action. Valid values are VOUCHER, GIFT, ALLOWANCE, DISCOUNT, DONATION, OVERRIDE, PERCENT_MARKUP, and FIXED_MARKUP.",
"enum":[
"VOUCHER",
"GIFT",
"ALLOWANCE",
"DISCOUNT",
"DONATION",
"OVERRIDE",
"PERCENT_MARKUP",
"FIXED_MARKUP"
]
},
"description":"A list of action types associated with the promotion action."
},
"actionValue":{
"type":"string",
"description":"The value assigned to the promotion action."
},
"actionObjectId":{
"type":"string",
"description":"The ID of the action object associated with the promotion action."
},
"actionEntityRef":{
"$ref":"#/components/schemas/EntityRef",
"description":"The promotion action."
},
"@type":{
"type":"string",
"description":"The class type of the promotion action."
},
"@baseType":{
"type":"string",
"description":"The base type of the promotion action."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the promotion action."
}
},
"required":[
"actionValue",
"actionType",
"@type"
],
"description":"The promotion action resource."
},
"PromotionActionOracle":{
"title":"PromotionActionOracle",
"allOf":[
{
"$ref":"#/components/schemas/PromotionAction"
},
{
"type":"object",
"properties":{
"actionValueObj":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ActionObjectRefOracle"
},
"description":"A list of action value objs associated with the promotion action."
},
"eligibility":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ActionObjectRefOracle"
},
"description":"A list of eligibilities associated with the promotion action."
}
}
}
]
},
"ActionObjectRefOracle":{
"type":"object",
"title":"ActionObjectRefOracle",
"description":"The action object reference resource.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the action object reference."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the action object reference."
},
"name":{
"type":"string",
"description":"The name of the action object reference."
},
"actionObjectType":{
"type":"string",
"description":"The type or classification of the action object reference. Valid values are PRODUCT_OFFERING, PRODUCT_OFFERING_PRICE, PRODUCTLINE, CATEGORY, and PRODUCT_SPECIFICATION.",
"enum":[
"PRODUCT_OFFERING",
"PRODUCT_OFFERING_PRICE",
"PRODUCTLINE",
"CATEGORY",
"PRODUCT_SPECIFICATION"
]
},
"appliesTo":{
"type":"string",
"description":"The price type of benefit. Valid values are ALL, ONE_TIME, RECURRING, and USAGE.",
"enum":[
"ALL",
"ONE_TIME",
"RECURRING",
"USAGE"
]
},
"@type":{
"type":"string",
"description":"The class type of the action object reference."
},
"maxQuantity":{
"type":"integer",
"description":"A maximum quantity of items required to be eligible for benefit."
},
"@baseType":{
"type":"string",
"description":"The base type of the action object reference."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the action object reference."
},
"@referredType":{
"type":"string",
"description":"The type of the referred action object reference."
}
},
"required":[
"id",
"@type"
]
},
"PromotionEligibilityOracle":{
"title":"PromotionEligibilityOracle",
"type":"object",
"description":"Specifies the promotion eligibility rule for the offer.",
"properties":{
"name":{
"type":"string",
"description":"The name of the promotion eligibility."
},
"description":{
"type":"string",
"description":"A narrative text describing the eligibility rule."
},
"active":{
"type":"boolean",
"description":"Whether the promotion eligibility has active."
},
"conditionPara":{
"type":"string",
"description":"The parameter (factor) of the criteria."
},
"conditionValue":{
"type":"string",
"description":"The value is filled for the comparison of the criteria."
},
"promotionType":{
"type":"string",
"description":"The type of promotion allowed."
},
"customProfileSpec":{
"$ref":"#/components/schemas/CustomProfileSpecRefOracle",
"description":"The promotion eligibility."
},
"conditionOperator":{
"type":"string",
"description":"The logic expression including parameter and operator. Valid values are EQUALS, GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUALS, LESS_THAN_OR_EQUALS, and NOT_EQUALS.",
"enum":[
"EQUALS",
"GREATER_THAN",
"LESS_THAN",
"GREATER_THAN_OR_EQUALS",
"LESS_THAN_OR_EQUALS",
"NOT_EQUALS"
]
},
"validFor":{
"$ref":"#/components/schemas/TimePeriodOracle",
"description":"The period for which the promotion eligibility is valid."
}
},
"required":[
"name"
]
},
"PlaceOracle":{
"title":"PlaceOracle",
"type":"object",
"properties":{
"id":{
"type":"string",
"maxLength":30,
"description":"The ID of the place."
},
"name":{
"type":"string",
"description":"The name of the place."
},
"description":{
"type":"string",
"description":"The description of place."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the place."
},
"lastUpdate":{
"type":"string",
"format":"date-time",
"description":"The date and time when the place was last updated."
},
"lifecycleStatus":{
"type":"string",
"description":"The status of the place."
},
"validFor":{
"$ref":"#/components/schemas/TimePeriod",
"description":"The period for which the place is valid."
},
"@type":{
"type":"string",
"description":"The class type of the place."
},
"@baseType":{
"type":"string",
"description":"The base type of the place."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the place."
},
"project":{
"$ref":"#/components/schemas/ProjectRef",
"description":"The place."
},
"version":{
"type":"string",
"description":"The place version."
},
"created":{
"type":"string",
"format":"date-time",
"description":"The date and time of the place creation."
},
"createdBy":{
"type":"string",
"description":"The name of the person who created the place."
},
"lastUpdatedBy":{
"type":"string",
"description":"The name of the person who updated the place."
},
"versionState":{
"type":"number",
"description":"The version state of the place."
},
"externalId":{
"type":"string",
"description":"The ID of the external associated with the place."
},
"applicationName":{
"type":"string",
"description":"The name of the application associated with the place."
}
},
"required":[
"name",
"@type"
],
"description":"The place resource."
},
"MarketSegmentOracle":{
"title":"MarketSegmentOracle",
"type":"object",
"properties":{
"id":{
"type":"string",
"maxLength":30,
"description":"The ID of the market segment."
},
"name":{
"type":"string",
"description":"The name of the market segment."
},
"description":{
"type":"string",
"description":"The description of market segment."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the market segment."
},
"lastUpdate":{
"type":"string",
"format":"date-time",
"description":"The date and time when the market segment was last updated."
},
"lifecycleStatus":{
"type":"string",
"description":"The status of the market segment."
},
"validFor":{
"$ref":"#/components/schemas/TimePeriod",
"description":"The period for which the market segment is valid."
},
"@type":{
"type":"string",
"description":"The class type of the market segment."
},
"@baseType":{
"type":"string",
"description":"The base type of the market segment."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the market segment."
},
"project":{
"$ref":"#/components/schemas/ProjectRef",
"description":"The market segment."
},
"version":{
"type":"string",
"description":"The market segment version."
},
"created":{
"type":"string",
"format":"date-time",
"description":"The date and time of the market segment creation."
},
"createdBy":{
"type":"string",
"description":"The name of the person who created the market segment."
},
"lastUpdatedBy":{
"type":"string",
"description":"The name of the person who updated the market segment."
},
"versionState":{
"type":"number",
"description":"The version state of the market segment."
},
"externalId":{
"type":"string",
"description":"The ID of the external associated with the market segment."
},
"applicationName":{
"type":"string",
"description":"The name of the application associated with the market segment."
}
},
"required":[
"name",
"@type"
],
"description":"The market segment resource."
},
"PriceTagOracle":{
"title":"PriceTagOracle",
"type":"object",
"properties":{
"id":{
"type":"string",
"maxLength":30,
"description":"The ID of the price tag."
},
"name":{
"type":"string",
"description":"The name of the price tag."
},
"description":{
"type":"string",
"description":"The description of priceTag."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the price tag."
},
"lastUpdate":{
"type":"string",
"format":"date-time",
"description":"The date and time when the price tag was last updated."
},
"lifecycleStatus":{
"type":"string",
"description":"The status of the price tag."
},
"validFor":{
"$ref":"#/components/schemas/TimePeriod",
"description":"The period for which the price tag is valid."
},
"@type":{
"type":"string",
"description":"The class type of the price tag."
},
"@baseType":{
"type":"string",
"description":"The base type of the price tag."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the price tag."
},
"project":{
"$ref":"#/components/schemas/ProjectRef",
"description":"The price tag."
},
"version":{
"type":"string",
"description":"The price tag version."
},
"priceTagRules":{
"type":"array",
"items":{
"$ref":"#/components/schemas/PriceTagRuleOracle"
},
"description":"A list of price tag rules associated with the price tag."
},
"created":{
"type":"string",
"format":"date-time",
"description":"The date and time of the priceTag creation."
},
"createdBy":{
"type":"string",
"description":"The name of the person who created the priceTag."
},
"lastUpdatedBy":{
"type":"string",
"description":"The name of the person who updated the priceTag."
},
"versionState":{
"type":"number",
"description":"The version state of the priceTag."
}
},
"required":[
"name",
"@type"
],
"description":"The price tag resource."
},
"PriceTagRuleOracle":{
"title":"PriceTagRuleOracle",
"type":"object",
"properties":{
"id":{
"type":"string",
"maxLength":30,
"description":"The ID of the price tag rule."
},
"balanceElement":{
"$ref":"#/components/schemas/BalanceElementRef",
"description":"The price tag rule."
},
"productType":{
"type":"string",
"description":"The type or classification of the price tag rule. Valid values are ALL, ACCOUNT, and SERVICE.",
"enum":[
"ALL",
"ACCOUNT",
"SERVICE"
]
},
"valueType":{
"type":"string",
"description":"The type or classification of the price tag rule. Valid values are ALL, LIST, and RANGE.",
"enum":[
"ALL",
"LIST",
"RANGE"
]
},
"value":{
"type":"string",
"description":"Value corresponding to the selected valueType in semicolon selected format."
},
"unitOfMeasure":{
"type":"string",
"description":"The unit of measure for which the priceTag rule applies to."
},
"balanceElementCode":{
"type":"string",
"description":"Currency (ISO4217 norm uses 3 letters to define the currency and user defined code for non currency."
},
"serviceSpecification":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ServiceSpecificationRefOracle"
},
"description":"A list of service specifications associated with the price tag rule."
}
},
"required":[
"id"
],
"description":"The price tag rule resource."
},
"RolloverRuleOracle":{
"title":"RolloverRuleOracle",
"type":"object",
"properties":{
"id":{
"type":"string",
"maxLength":30,
"description":"The ID of the rollover rule."
},
"balanceElementCode":{
"type":"string",
"description":"Currency (ISO4217 norm uses 3 letters to define the currency and user defined code for non currency."
},
"maxRolloverAmountPerCycle":{
"type":"number",
"description":"The maximum amount that can be rolled over in a cycle."
},
"maxCumulativeRolloverAmount":{
"type":"number",
"description":"The maximum rollover amount that can be accumulated."
},
"maximumRolloverCycles":{
"title":"MaximumRolloverCycleOracle",
"type":"object",
"description":"Indicates the maximum allowed rollover cycles and the unit.",
"properties":{
"value":{
"type":"number",
"description":"The value assigned to the rollover rule."
},
"unit":{
"type":"string",
"description":"Indicates the unit of rollover cycle. Valid values are DAYS, WEEKS, MONTHS, and YEARS.",
"enum":[
"DAYS",
"WEEKS",
"MONTHS",
"YEARS"
]
}
},
"required":[
"value",
"unit"
]
},
"glid":{
"type":"string",
"description":"The gLID for the rollover charge."
},
"unitOfMeasure":{
"type":"string",
"description":"The unit of measure for which the priceTag rule applies to."
},
"balanceElement":{
"$ref":"#/components/schemas/BalanceElementRef",
"description":"The rollover rule."
}
},
"required":[
"id",
"balanceElementCode"
],
"description":"The rollover rule resource."
},
"PriceTagRefOracle":{
"title":"PriceTagRefOracle",
"type":"object",
"description":"The priceTag reference.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the price tag reference."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the price tag reference."
},
"name":{
"type":"string",
"description":"The name of the price tag reference."
},
"@baseType":{
"type":"string",
"description":"The base type of the price tag reference."
},
"@schemaLocation":{
"type":"string",
"format":"uri",
"description":"The URI of the schema that defines the price tag reference."
},
"@type":{
"type":"string",
"description":"The class type of the price tag reference."
},
"@referredType":{
"type":"string",
"description":"The actual type of the target instance when needed for disambiguation."
},
"versionState":{
"type":"number",
"description":"The version state of the reference."
}
},
"required":[
"id",
"@type",
"@referredType"
]
},
"EntitlementOracle":{
"title":"EntitlementOracle",
"type":"object",
"properties":{
"id":{
"type":"string",
"maxLength":30,
"description":"The ID of the entitlement."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the entitlement."
},
"name":{
"type":"string",
"description":"The name of the entitlement."
},
"description":{
"type":"string",
"description":"The description of entitlement."
},
"lastUpdate":{
"type":"string",
"format":"date-time",
"description":"The date and time when the entitlement was last updated."
},
"lifecycleStatus":{
"type":"string",
"description":"The status of the entitlement."
},
"validFor":{
"$ref":"#/components/schemas/TimePeriod",
"description":"The period for which the entitlement is valid."
},
"@type":{
"type":"string",
"description":"The class type of the entitlement."
},
"@baseType":{
"type":"string",
"description":"The base type of the entitlement."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the entitlement."
},
"project":{
"$ref":"#/components/schemas/ProjectRef",
"description":"The entitlement."
},
"version":{
"type":"string",
"description":"The promotion version."
},
"entitlementType":{
"type":"string",
"description":"The type or classification of the entitlement. Valid values are ENTITLEMENT_PRICING, and ENTITLEMENT_SERVICE.",
"enum":[
"ENTITLEMENT_PRICING",
"ENTITLEMENT_SERVICE"
]
},
"pricelist":{
"type":"array",
"items":{
"$ref":"#/components/schemas/PriceListRefOracle"
},
"description":"A list of pricelists associated with the entitlement."
},
"metrics":{
"type":"array",
"items":{
"$ref":"#/components/schemas/EntitlementMetricsOracle"
},
"description":"A list of metrics associated with the entitlement."
},
"quantity":{
"$ref":"#/components/schemas/EntitlementQuantityOracle",
"description":"The entitlement."
},
"priority":{
"type":"number",
"description":"The priority of this entitlement in relation to other entitlement associatedto the project."
},
"associatedProducts":{
"type":"array",
"items":{
"$ref":"#/components/schemas/AssociatedProductsEntitlementsOracle"
},
"description":"A list of associated products associated with the entitlement."
},
"benefits":{
"type":"array",
"items":{
"$ref":"#/components/schemas/EntitlementsBenefitsOracle"
},
"description":"A list of benefits associated with the entitlement."
},
"created":{
"type":"string",
"format":"date-time",
"description":"The date and time of the creation."
},
"createdBy":{
"type":"string",
"description":"The name of the person who created item."
},
"lastUpdatedBy":{
"type":"string",
"description":"The name of the person who updated item."
},
"versionState":{
"type":"number",
"description":"The version state of the entitlement."
}
},
"required":[
"associatedProducts"
],
"description":"The entitlement resource."
},
"EntitlementMetricsOracle":{
"title":"EntitlementMetricsOracle",
"type":"object",
"description":"The entitlement metric resource.",
"properties":{
"id":{
"type":"string",
"maxLength":30,
"description":"The ID of the entitlement metric."
},
"name":{
"type":"string",
"description":"The name of the entitlement metric."
},
"description":{
"type":"string",
"description":"The description of entitlement metrics."
},
"priority":{
"type":"number",
"description":"The piority of this metrics."
},
"metricsType":{
"type":"string",
"description":"The type or classification of the entitlement metric. Valid values are ENTL_MET_RESP_TIME, ENTL_MET_SERV_AVAIL, ENTL_MET_RESL_TIME, and ENTL_MET_ESCL_TIME.",
"enum":[
"ENTL_MET_RESP_TIME",
"ENTL_MET_SERV_AVAIL",
"ENTL_MET_RESL_TIME",
"ENTL_MET_ESCL_TIME"
]
},
"metricsQuantity":{
"$ref":"#/components/schemas/EntitlementMetricsQuantityOracle",
"description":"The name of the person who updated item."
}
}
},
"AssociatedProductsEntitlementsOracle":{
"type":"object",
"title":"AssociatedProductsEntitlementsOracle",
"description":"The products which are associated to entitlement, benefit or conditions.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the associated products entitlement."
},
"name":{
"type":"string",
"description":"The name of the associated products entitlement."
},
"actionObjectType":{
"type":"string",
"description":"The type or classification of the associated products entitlement. Valid values are PRODUCT_OFFERING, PRODUCT_OFFERING_PRICE, PRODUCTLINE, CATEGORY, and PRODUCT_SPECIFICATION.",
"enum":[
"PRODUCT_OFFERING",
"PRODUCT_OFFERING_PRICE",
"PRODUCTLINE",
"CATEGORY",
"PRODUCT_SPECIFICATION"
]
},
"@type":{
"type":"string",
"description":"The class type of the associated products entitlement."
},
"@baseType":{
"type":"string",
"description":"The base type of the associated products entitlement."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the associated products entitlement."
},
"@referredType":{
"type":"string",
"description":"The type of the referred associated products entitlement."
}
},
"required":[
"id"
]
},
"EntitlementsBenefitsOracle":{
"title":"EntitlementsBenefitsOracle",
"type":"object",
"description":"The entitlement benefits.",
"properties":{
"id":{
"type":"string",
"maxLength":30,
"description":"The ID of the entitlements benefit."
},
"name":{
"type":"string",
"description":"The name of the entitlements benefit."
},
"description":{
"type":"string",
"description":"The description of entitlements benefit."
},
"products":{
"type":"array",
"items":{
"$ref":"#/components/schemas/AssociatedProductsEntitlementsOracle"
},
"description":"A list of products associated with the entitlements benefit."
},
"priority":{
"type":"number",
"description":"The piority of this benifit."
},
"benefitType":{
"type":"string",
"description":"The type or classification of the entitlements benefit. Valid values are ENTL_BFT_TYP_DSNT.",
"enum":[
"ENTL_BFT_TYP_DSNT"
]
},
"productOfferingPrice":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ProductOfferingPriceRefOracle"
},
"description":"A list of product offering prices associated with the entitlements benefit."
},
"schedule":{
"type":"string",
"description":"The allows to define the benifit schedule. Valid values are ENTL_BFT_SCDL_MNTLY, ENTL_BFT_SCDL_ANLY, ENTL_BFT_SCDL_ASINRD, ENTL_BFT_SCDL_BIANLY, ENTL_BFT_SCDL_CTRTRM, ENTL_BFT_SCDL_CTRYR, ENTL_BFT_SCDL_QRTLY, and ENTL_BFT_SCDL_WEKLY.",
"enum":[
"ENTL_BFT_SCDL_MNTLY",
"ENTL_BFT_SCDL_ANLY",
"ENTL_BFT_SCDL_ASINRD",
"ENTL_BFT_SCDL_BIANLY",
"ENTL_BFT_SCDL_CTRTRM",
"ENTL_BFT_SCDL_CTRYR",
"ENTL_BFT_SCDL_QRTLY",
"ENTL_BFT_SCDL_WEKLY"
]
},
"status":{
"type":"string",
"description":"The status of the entitlements benefit.",
"enum":[
"ENTL_BFT_STS_ACTV",
"ENTL_BFT_STS_CNCLD",
"ENTL_BFT_STS_EXHSTD",
"ENTL_BFT_STS_NEW",
"ENTL_BFT_STS_ONHOLD"
]
},
"relationShipAmongGroup":{
"type":"string",
"description":"The condition relationship for the benfit. Valid values are ENTL_BFT_CND_REL_ALL, and ENTL_BFT_CND_REL_ANY.",
"enum":[
"ENTL_BFT_CND_REL_ALL",
"ENTL_BFT_CND_REL_ANY"
]
},
"entitlementConditionsGroup":{
"type":"array",
"items":{
"$ref":"#/components/schemas/EntitlementConditionsGroupOracle"
},
"description":"A list of entitlement conditions groups associated with the entitlements benefit."
},
"@type":{
"type":"string",
"description":"The class type of the entitlements benefit."
},
"@baseType":{
"type":"string",
"description":"The base type of the entitlements benefit."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the entitlements benefit."
}
},
"required":[
"products",
"productOfferingPrice"
]
},
"ProductOfferingPriceRefOracle":{
"title":"ProductOfferingPriceRefOracle",
"allOf":[
{
"$ref":"#/components/schemas/ProductOfferingPriceRef"
},
{
"type":"object",
"properties":{
"appliesTo":{
"type":"string",
"description":"The bring in a open ended definition of alteration that specifies how price plan applicable to the offer. Valid values are ALL, ONE_TIME, RECURRING, and USAGE.",
"enum":[
"ALL",
"ONE_TIME",
"RECURRING",
"USAGE"
]
},
"isBundlePrice":{
"type":"boolean",
"description":"Whether the product offering price reference is bundle price."
}
}
}
]
},
"EntitlementConditionsGroupOracle":{
"title":"EntitlementConditionsGroupOracle",
"type":"object",
"description":"The group of the condition for the entitlement.The logical relationship between different groups is decided by the ???relationTypeInGroup???.",
"properties":{
"id":{
"type":"string",
"maxLength":30,
"description":"The ID of the entitlement conditions group."
},
"groupName":{
"type":"string",
"description":"The name of the group associated with the entitlement conditions group."
},
"relationTypeInGroup ":{
"type":"string",
"description":"The logical relation type among the entitlement condition group. Valid values are AND and OR.",
"enum":[
"AND",
"OR"
]
},
"order":{
"type":"number",
"description":"The seqeunce number for this condition."
},
"status":{
"type":"string",
"description":"The status of the entitlement conditions group.",
"enum":[
"ENT_CND_STA_ACTV",
"ENT_CND_STA_CNCLD",
"ENT_CND_STA_EXHSTD",
"ENT_CND_STA_NEW",
"ENT_CND_STA_ONHLD"
]
},
"conditionTiming":{
"type":"string",
"description":"The condition timing, whether it is annually, weekly, or another supported interval. Valid values are ENT_CND_TMG_ANLY, ENT_CND_TMG_BIANLY, ENT_CND_TMG_CTRTRM, ENT_CND_TMG_CTRYR, ENT_CND_TMG_MTLY, ENT_CND_TMG_QRTLY, and ENT_CND_TMG_WEKLY.",
"enum":[
"ENT_CND_TMG_ANLY",
"ENT_CND_TMG_BIANLY",
"ENT_CND_TMG_CTRTRM",
"ENT_CND_TMG_CTRYR",
"ENT_CND_TMG_MTLY",
"ENT_CND_TMG_QRTLY",
"ENT_CND_TMG_WEKLY"
]
},
"products":{
"type":"array",
"items":{
"$ref":"#/components/schemas/AssociatedProductsEntitlementsOracle"
},
"description":"A list of products associated with the entitlement conditions group."
},
"@type":{
"type":"string",
"description":"The class type of the entitlement conditions group."
},
"@baseType":{
"type":"string",
"description":"The base type of the entitlement conditions group."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the entitlement conditions group."
},
"condition":{
"type":"array",
"items":{
"$ref":"#/components/schemas/EntitlementConditionOracle"
},
"description":"A list of conditions associated with the entitlement conditions group."
}
},
"required":[
"products"
]
},
"EntitlementConditionOracle":{
"title":"EntitlementConditionOracle",
"type":"object",
"description":"The condition of the entitlement.",
"properties":{
"id":{
"type":"string",
"maxLength":30,
"description":"The ID of the entitlement condition."
},
"conditionType":{
"type":"string",
"description":"The type or classification of the entitlement condition. Valid values are ENTL_COND_TYP_VOL.",
"enum":[
"ENTL_COND_TYP_VOL"
]
},
"conditionValue":{
"type":"string",
"description":"The value assigned to the entitlement condition."
},
"unitOfMeasure":{
"type":"string",
"description":"The unit of measure to satisfy the condition. Valid values are ENT_CND_UOM_ORDRS.",
"enum":[
"ENT_CND_UOM_ORDRS"
]
},
"operator":{
"type":"string",
"description":"The logic expression including parameter and operator. Valid values are EQUALS, GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUALS, LESS_THAN_OR_EQUALS, and NOT_EQUALS.",
"enum":[
"EQUALS",
"GREATER_THAN",
"LESS_THAN",
"GREATER_THAN_OR_EQUALS",
"LESS_THAN_OR_EQUALS",
"NOT_EQUALS"
]
},
"@type":{
"type":"string",
"description":"The class type of the entitlement condition."
},
"@baseType":{
"type":"string",
"description":"The base type of the entitlement condition."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the entitlement condition."
}
}
},
"LifecycleStateOracle":{
"title":"LifecycleStateOracle",
"type":"object",
"description":"A list of Lifecycle state user will define for a given lifecycleConfig (LifecycleState [*]). This class represents the key features of this lifecycle state.",
"properties":{
"name":{
"type":"string",
"description":"A string. A word, term, or phrase by which this lifecycle state is known and distinguished from other lifecycle states."
},
"description":{
"type":"string",
"description":"A string. A narrative that explains in detail what the LifecycleState is."
},
"isEditable":{
"type":"boolean",
"description":"A boolean. If true, the Boolean indicates that the project is editable in this state or not."
},
"isContentEditable":{
"type":"boolean",
"description":"A boolean. If true, the Boolean indicates that the entity in the project is editable or not."
},
"isApprovalRequired":{
"type":"boolean",
"description":"A boolean. If true, the Boolean indicates whether this state needs approval to move tro next state."
},
"isPublishable":{
"type":"boolean",
"description":"A boolean. If true, the Boolean indicates whether publish is allowed in this state."
},
"isSensitive":{
"type":"boolean",
"description":"Whether the lifecycle state is sensitive."
},
"isSharable":{
"type":"boolean",
"description":"A boolean. If true, the Boolean indicates whether the entity can be shared with other projects in this state."
},
"isEnabled":{
"type":"boolean",
"description":"A boolean. If true, the Boolean indicates whether the state is enabled or not."
},
"stateOrder":{
"type":"integer",
"description":"The sequence number of the state that shows the transition."
},
"errorState":{
"type":"string",
"description":"A string. Indicates the state it will end up during transition if error happens for automatic transition like approval or publish."
},
"userAction":{
"type":"string",
"description":"A string. The name of the action for user triggered state transition."
},
"@type":{
"type":"string",
"description":"The class type of the lifecycle state."
},
"@baseType":{
"type":"string",
"description":"The base type of the lifecycle state."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the lifecycle state."
},
"destination":{
"type":"array",
"items":{
"$ref":"#/components/schemas/DestinationRefOracle"
},
"description":"A list of destinations associated with the lifecycle state."
}
},
"required":[
"name",
"stateOrder",
"@type"
]
},
"DestinationRefOracle":{
"title":"DestinationRefOracle",
"type":"object",
"description":"A list of destinations references associated with lifecycle state.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the destination reference."
},
"name":{
"type":"string",
"description":"A string. Name of the target destination."
},
"href":{
"type":"string",
"description":"A string. Reference of the target destination."
},
"@referredType":{
"type":"string",
"description":"The type of the referred destination reference."
},
"@type":{
"type":"string",
"description":"The class type of the destination reference."
},
"@baseType":{
"type":"string",
"description":"The base type of the destination reference."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the destination reference."
}
},
"required":[
"id",
"name"
]
},
"LifecycleConfigurationOracle":{
"title":"LifecycleConfigurationOracle",
"type":"object",
"description":"The Lifecycle Config resource represents a set of lifecycle configurations and lifecycle states.",
"properties":{
"id":{
"type":"string",
"maxLength":100,
"description":"The ID of the lifecycle configuration."
},
"href":{
"type":"string",
"description":"A string. Reference of the lifecycle configuration."
},
"version":{
"type":"string",
"description":"The lifecycle configuration version."
},
"name":{
"type":"string",
"description":"A string. Name of the lifecycle configuration."
},
"description":{
"type":"string",
"description":"A string. A narrative that explains in detail what the lifecycle configuration is."
},
"lifecycleStatus":{
"type":"string",
"description":"The current lifecycle status of the lifecycle configuration.",
"enum":[
"ACTIVE",
"PENDING",
"INACTIVE"
]
},
"@type":{
"type":"string",
"description":"The class type of the lifecycle configuration."
},
"@baseType":{
"type":"string",
"description":"The base type of the lifecycle configuration."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the lifecycle configuration."
},
"lastUpdate":{
"type":"string",
"format":"date-time",
"description":"A date time (DateTime). Date and time of the last update of the lifecycle configuration."
},
"lifecycleState":{
"type":"array",
"items":{
"$ref":"#/components/schemas/LifecycleStateOracle"
},
"description":"A list of lifecycle states associated with the lifecycle configuration."
},
"created":{
"type":"string",
"format":"date-time",
"description":"The date and time of the creation."
},
"createdBy":{
"type":"string",
"description":"The name of the person who created item."
},
"lastUpdatedBy":{
"type":"string",
"description":"The name of the person who updated item."
},
"externalId":{
"type":"string",
"description":"The ID of the external associated with the lifecycle configuration."
},
"applicationName":{
"type":"string",
"description":"The name of the application associated with the lifecycle configuration."
},
"versionState":{
"type":"number",
"description":"The version state of the Life cycle configuration."
}
},
"required":[
"name",
"@type"
]
},
"LifecycleConfigurationRef":{
"title":"LifecycleConfigurationRef",
"type":"object",
"description":"The lifecycle configuration reference resource.",
"properties":{
"id":{
"type":"string",
"maxLength":100,
"description":"The ID of the lifecycle configuration reference."
},
"href":{
"type":"string",
"description":"A string. Reference of the lifecycle configuration."
},
"version":{
"type":"string",
"description":"The lifecycle configuration version."
},
"name":{
"type":"string",
"description":"A string. Name of the lifecycle configuration."
},
"@referredType":{
"type":"string",
"description":"The type of the referred lifecycle configuration reference."
}
},
"required":[
"@referredType"
]
},
"ApprovalHistory":{
"title":"ApprovalHistory",
"type":"object",
"properties":{
"id":{
"type":"string",
"maxLength":100,
"description":"The ID of the approval history."
},
"approvalAction":{
"type":"string",
"description":"The approval action."
},
"approvalFor":{
"type":"string",
"description":"The approval target."
},
"requestor":{
"type":"string",
"description":"The requestor."
},
"approver":{
"type":"string",
"description":"The approver."
},
"comments":{
"type":"string",
"description":"A string. A narrative that explains in detail what the approval history is."
},
"approvalDate":{
"type":"string",
"format":"date-time",
"description":"A date time (DateTime). Date and time of the approval."
},
"projectId":{
"type":"string",
"maxLength":100,
"description":"The ID of the project associated with the approval history."
},
"projectName":{
"type":"string",
"maxLength":100,
"description":"The name of the project associated with the approval history."
},
"entityName":{
"type":"string",
"maxLength":100,
"description":"A string. Entity name."
}
},
"required":[
"id"
],
"description":"The approval history resource."
},
"ApprovalInfoOracle":{
"title":"ApprovalInfoOracle",
"type":"object",
"properties":{
"id":{
"type":"string",
"maxLength":100,
"description":"The ID of the approval info."
},
"approvalFor":{
"type":"string",
"description":"The approval target."
},
"requestor":{
"type":"string",
"description":"The requestor."
},
"comments":{
"type":"string",
"description":"A string. A narrative that explains in detail what the approval history is."
},
"requestedOn":{
"type":"string",
"format":"date-time",
"description":"A date time (DateTime). Date and time of the approval."
},
"entityName":{
"type":"string",
"maxLength":100,
"description":"A string. Entity name."
}
},
"required":[
"requestor"
],
"description":"The approval info resource."
},
"ProjectHistory":{
"title":"ProjectHistory",
"type":"object",
"properties":{
"id":{
"type":"string",
"maxLength":100,
"description":"The ID of the project history."
},
"action":{
"type":"string",
"description":"The action."
},
"stateFrom":{
"type":"string",
"description":"A string. State From."
},
"stateTo":{
"type":"string",
"description":"A string. State To."
},
"entityName":{
"type":"string",
"maxLength":100,
"description":"The name of the entity associated with the project history."
}
},
"required":[
"id"
],
"description":"The project history resource."
},
"CatalogImportOracle":{
"title":"CatalogImportOracle",
"type":"object",
"description":"The list of all catalog business objects in import.",
"properties":{
"catalog":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CatalogOracle"
},
"description":"A list of catalogs associated with the catalog import."
},
"category":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CategoryOracle"
},
"description":"A list of categories associated with the catalog import."
},
"productSpecification":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ProductSpecificationOracle"
},
"description":"A list of product specifications associated with the catalog import."
},
"productLine":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ProductLineOracle"
},
"description":"A list of product lines associated with the catalog import."
},
"productOffering":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ProductOfferingOracle"
},
"description":"A list of product offerings associated with the catalog import."
},
"productOfferingPrice":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ProductOfferingPriceOracle"
},
"description":"A list of product offering prices associated with the catalog import."
},
"pricingLogicAlgorithm":{
"type":"array",
"items":{
"$ref":"#/components/schemas/PlaQuantityRangeOracle"
},
"description":"A list of pricing logic algorithms associated with the catalog import."
},
"pricingLogicAlgorithmSpecification":{
"type":"array",
"items":{
"$ref":"#/components/schemas/PricingLogicAlgorithmSpecificationOracle"
},
"description":"A list of pricing logic algorithm specifications associated with the catalog import."
},
"pricelist":{
"type":"array",
"items":{
"$ref":"#/components/schemas/PricelistOracle"
},
"description":"A list of pricelists associated with the catalog import."
},
"promotion":{
"type":"array",
"items":{
"$ref":"#/components/schemas/PromotionOracle"
},
"description":"A list of promotions associated with the catalog import."
},
"customerProfileSpecification":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CustomerProfileSpecificationOracle"
},
"description":"A list of customer profile specifications associated with the catalog import."
},
"usageSpecification":{
"type":"array",
"items":{
"$ref":"#/components/schemas/UsageSpecificationOracle"
},
"description":"A list of usage specifications associated with the catalog import."
},
"serviceSpecification":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ServiceSpecificationOracle"
},
"description":"A list of service specifications associated with the catalog import."
},
"customProfileSpecification":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CustomProfileSpecificationOracle"
},
"description":"A list of custom profile specifications associated with the catalog import."
},
"taxServiceProvider":{
"type":"array",
"items":{
"$ref":"#/components/schemas/TaxServiceProviderOracle"
},
"description":"A list of tax service providers associated with the catalog import."
},
"balanceElement":{
"type":"array",
"items":{
"$ref":"#/components/schemas/BalanceElementOracle"
},
"description":"A list of balance elements associated with the catalog import."
},
"productRule":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ProductRuleOracle"
},
"description":"A list of product rules associated with the catalog import."
},
"entitlement":{
"type":"array",
"items":{
"$ref":"#/components/schemas/EntitlementOracle"
},
"description":"A list of entitlements associated with the catalog import."
},
"project":{
"type":"object",
"items":{
"$ref":"#/components/schemas/ProjectOracle"
},
"description":"A list of projects associated with the catalog import."
}
}
},
"BulkError":{
"type":"array",
"items":{
"$ref":"#/components/schemas/BulkErrorObj"
},
"description":"The bulk error resource."
},
"BulkErrorObj":{
"title":"BulkErrorObj",
"type":"object",
"properties":{
"id":{
"type":"string",
"maxLength":30,
"description":"The ID of the bulk error obj."
},
"name":{
"type":"string",
"description":"The name of the bulk error obj."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the bulk error obj."
},
"errorMessage":{
"type":"string",
"description":"The text that provides more details and corrective actions related to the error."
},
"@type":{
"type":"string",
"description":"The class type of a REST resource."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the bulk error obj."
}
},
"description":"The bulk error obj resource."
},
"ProductSpecifications":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ProductSpecificationOracle"
},
"minItems":1,
"maxItems":50,
"description":"The product specifications resource."
},
"ProductOfferings":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ProductOfferingOracle"
},
"minItems":1,
"maxItems":50,
"description":"The product offerings resource."
},
"ProductOfferingPrices":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ProductOfferingPriceOracle"
},
"minItems":1,
"maxItems":50,
"description":"The product offering prices resource."
},
"ProductLines":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ProductLineOracle"
},
"minItems":1,
"maxItems":50,
"description":"The product lines resource."
},
"Catalogs":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CatalogOracle"
},
"minItems":1,
"maxItems":50,
"description":"The catalogs resource."
},
"Categories":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CategoryOracle"
},
"minItems":1,
"maxItems":50,
"description":"The categories resource."
},
"PLAs":{
"type":"array",
"items":{
"$ref":"#/components/schemas/PlaQuantityRangeOracle"
},
"minItems":1,
"maxItems":50,
"description":"The pl as resource."
},
"PricingLogicAlgorithmSpecifications":{
"type":"array",
"items":{
"$ref":"#/components/schemas/PricingLogicAlgorithmSpecification"
},
"minItems":1,
"maxItems":50,
"description":"The pricing logic algorithm specifications resource."
},
"BalanceElements":{
"type":"array",
"items":{
"$ref":"#/components/schemas/BalanceElementOracle"
},
"minItems":1,
"maxItems":50,
"description":"The balance elements resource."
},
"PriceLists":{
"type":"array",
"items":{
"$ref":"#/components/schemas/PricelistOracle_Create"
},
"minItems":1,
"maxItems":50,
"description":"The price lists resource."
},
"CustomerProfileSpecifications":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CustomerProfileSpecificationOracle"
},
"minItems":1,
"maxItems":50,
"description":"The customer profile specifications resource."
},
"CustomProfileSpecifications":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CustomProfileSpecificationOracle"
},
"minItems":1,
"maxItems":50,
"description":"The custom profile specifications resource."
},
"Promotions":{
"type":"array",
"items":{
"$ref":"#/components/schemas/PromotionOracle"
},
"minItems":1,
"maxItems":50,
"description":"The promotions resource."
},
"Entitlements":{
"type":"array",
"items":{
"$ref":"#/components/schemas/EntitlementOracle"
},
"minItems":1,
"maxItems":50,
"description":"The entitlements resource."
},
"PriceTags":{
"type":"array",
"items":{
"$ref":"#/components/schemas/PriceTagOracle"
},
"minItems":1,
"maxItems":50,
"description":"The price tags resource."
},
"UsageSpecifications":{
"type":"array",
"items":{
"$ref":"#/components/schemas/UsageSpecificationOracle"
},
"minItems":1,
"maxItems":50,
"description":"The usage specifications resource."
},
"ServiceSpecifications":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ServiceSpecificationOracle"
},
"minItems":1,
"maxItems":50,
"description":"The service specifications resource."
},
"PolicyRules":{
"type":"array",
"items":{
"$ref":"#/components/schemas/PolicyRuleOracle"
},
"minItems":1,
"maxItems":50,
"description":"The policy rules resource."
},
"TaxServiceProviders":{
"type":"array",
"items":{
"$ref":"#/components/schemas/TaxServiceProviderOracle"
},
"minItems":1,
"maxItems":50,
"description":"The tax service providers resource."
},
"ProductRules":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ProductRuleOracle"
},
"minItems":1,
"maxItems":50,
"description":"The product rules resource."
},
"Attributes":{
"type":"array",
"items":{
"$ref":"#/components/schemas/AttributeOracle"
},
"minItems":1,
"maxItems":50,
"description":"The attributes resource."
},
"Channels":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ChannelOracle"
},
"minItems":1,
"maxItems":50,
"description":"The channels resource."
},
"Places":{
"type":"array",
"items":{
"$ref":"#/components/schemas/PlaceOracle"
},
"minItems":1,
"maxItems":50,
"description":"The places resource."
},
"MarketSegments":{
"type":"array",
"items":{
"$ref":"#/components/schemas/MarketSegmentOracle"
},
"minItems":1,
"maxItems":50,
"description":"The market segments resource."
},
"ProductOfferingTermSummaryOracle":{
"title":"TermSummary",
"type":"object",
"description":"The product offering term summary resource.",
"properties":{
"name":{
"type":"string",
"description":"The name of the product offering term summary."
},
"@type":{
"type":"string",
"description":"The class type of the product offering term summary."
},
"@baseType":{
"type":"string",
"description":"The base type of the product offering term summary."
},
"commitmentTermType":{
"type":"string",
"enum":[
"INSTALLMENT",
"LEASE",
"SERVICE"
],
"description":"The type or classification of the product offering term summary. Valid values are INSTALLMENT, LEASE, and SERVICE."
},
"duration":{
"$ref":"#/components/schemas/TermDuration",
"description":"The product offering term summary."
}
},
"required":[
"@type"
]
},
"GeographyStructureOracle":{
"title":"GeographyStructure",
"type":"object",
"description":"The geography structure resource.",
"properties":{
"geographyType":{
"type":"string",
"description":"The type or classification of the geography structure."
},
"parentGeographyType":{
"type":"string",
"description":"The type or classification of the geography structure."
}
}
},
"RetireSchemaOracle":{
"title":"RetireSchema",
"type":"object",
"description":"The retire schema resource.",
"properties":{
"id":{
"type":"string",
"maxLength":30,
"description":"The ID of the retire schema."
},
"version":{
"type":"string",
"description":"The entity version."
},
"retirementDate":{
"type":"string",
"format":"date-time",
"description":"The date and time when the schema is retired."
},
"project":{
"$ref":"#/components/schemas/ProjectRef",
"description":"The retire schema."
}
}
},
"ObsoleteSchemaOracle":{
"title":"ObsoleteSchema",
"type":"array",
"items":{
"$ref":"#/components/schemas/ObsoleteSchemaRef"
},
"minItems":1,
"maxItems":50,
"description":"The obsolete schema resource."
},
"ObsoleteSchemaRef":{
"title":"ObsoleteSchemaRef",
"type":"object",
"properties":{
"id":{
"type":"string",
"maxLength":30,
"description":"The ID of the obsolete schema reference."
},
"name":{
"type":"string",
"description":"The name of the obsolete schema reference."
},
"version":{
"type":"string",
"description":"The entity version."
}
},
"description":"The obsolete schema reference resource."
},
"FolderOracle":{
"title":"FolderOracle",
"type":"object",
"properties":{
"name":{
"type":"string",
"description":"Folder path to from where to retrieve the contents."
},
"folderPath":{
"type":"string",
"description":"The complete folder path of the directory(UCM path)."
},
"fileList":{
"type":"array",
"items":{
"type":"object",
"description":"The information about the folder contents fetch from UCM.",
"properties":{
"name":{
"type":"string",
"description":"The name of the folder."
},
"url":{
"type":"string",
"description":"The URL to download the content."
}
}
},
"description":"A list of file lists associated with the folder."
}
},
"description":"The folder resource."
},
"ZoneValueMapCharOracle":{
"title":"ZoneValueMapCharOracle",
"allOf":[
{
"$ref":"#/components/schemas/CustomProfileSpecChar"
},
{
"type":"object",
"properties":{
"isRoot":{
"type":"boolean",
"description":"Whether the zone value map characteristic is root."
}
}
}
]
},
"AttributeOracle":{
"title":"AttributeOracle",
"type":"object",
"properties":{
"id":{
"type":"string",
"maxLength":30,
"description":"The ID of the attribute."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the attribute."
},
"name":{
"type":"string",
"description":"The name of the attribute."
},
"displayName":{
"type":"string",
"description":"The name of the display associated with the attribute."
},
"version":{
"type":"string",
"description":"The attribute version."
},
"description":{
"type":"string",
"description":"A narrative that explains in detail what the attribute is."
},
"project":{
"$ref":"#/components/schemas/ProjectRef",
"description":"The attribute."
},
"valueType":{
"type":"string",
"description":"The type or classification of the attribute. Valid values are STRING, NUMBER, OBJECT, ARRAY, DECIMAL, BOOLEAN, DATE, DATETIME, and URL.",
"enum":[
"STRING",
"NUMBER",
"OBJECT",
"ARRAY",
"DECIMAL",
"BOOLEAN",
"DATE",
"DATETIME",
"URL"
]
},
"lifecycleStatus":{
"type":"string",
"description":"The status of the attribute."
},
"configurable":{
"type":"boolean",
"description":"Whether the attribute is configurable."
},
"validFor":{
"$ref":"#/components/schemas/TimePeriodOracle",
"description":"The period for which the attribute is valid."
},
"@type":{
"type":"string",
"description":"The class type of the attribute."
},
"@baseType":{
"type":"string",
"description":"The base type of the attribute."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the attribute."
},
"@valueSchemaLocation":{
"type":"string",
"description":"The optional link to the schema that describes the value type."
},
"minCardinality":{
"type":"integer",
"description":"The minimum number of instances an atribute can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality."
},
"maxCardinality":{
"type":"integer",
"description":"The maximum number of instances an attribute can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality."
},
"isUnique":{
"type":"boolean",
"description":"An indicator that specifies if a value is unique for the attribute. Possible values are; \"unique while value is in effect\" and \"unique whether value is in effect or not\"."
},
"regex":{
"type":"string",
"description":"A rule or principle represented as a regular expression for deriving the value of an attribute value."
},
"sensitive":{
"type":"boolean",
"description":"Whether the attribute is sensitive."
},
"runtimeFilterable":{
"type":"boolean",
"description":"Whether the attribute is runtime filterable."
},
"fulfillmentUpdatable":{
"type":"boolean",
"description":"Indicates runtime system to allow update coming from fulfillment system only for attributes that has this property set to true."
},
"extensible":{
"type":"boolean",
"description":"An indicator that specifies that the values for the attribute can be extended by adding new values when instantiating a attribute for a characteristic."
},
"allowedUnits":{
"type":"array",
"items":{
"type":"string"
},
"description":"A list of allowed units associated with the attribute."
},
"created":{
"type":"string",
"format":"date-time",
"description":"The date and time of the creation."
},
"createdBy":{
"type":"string",
"description":"The name of the person who created item."
},
"lastUpdatedBy":{
"type":"string",
"description":"The name of the person who updated item."
},
"lastUpdate":{
"type":"string",
"format":"date-time",
"description":"The date and time when the attribute was last updated."
},
"externalId":{
"type":"string",
"description":"The ID of the external associated with the attribute."
},
"applicationName":{
"type":"string",
"description":"The name of the application associated with the attribute."
},
"versionState":{
"type":"number",
"description":"The version state of the attribute."
},
"attributeRelationship":{
"type":"array",
"items":{
"$ref":"#/components/schemas/AttributeRelationshipOracle"
},
"description":"A list of attribute relationships associated with the attribute."
},
"attributeValue":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CharacteristicValueSpecification"
},
"description":"A list of attribute values associated with the attribute."
}
},
"required":[
"name",
"@type"
],
"description":"The attribute resource."
},
"AttributeRefOracle":{
"title":"AttributeRefOracle",
"type":"object",
"description":"The attribute Reference: Attributes that defines characteristics of product specification.",
"properties":{
"id":{
"type":"string",
"description":"The ID of the attribute reference."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the attribute reference."
},
"name":{
"type":"string",
"description":"The name of the attribute reference."
},
"displayName":{
"type":"string",
"description":"The name of the display associated with the attribute reference."
},
"@referredType":{
"type":"string",
"description":"The type of the referred attribute reference."
},
"@type":{
"type":"string",
"description":"The class type of the attribute reference."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the attribute reference."
},
"@baseType":{
"type":"string",
"description":"The base type of the attribute reference."
},
"versionState":{
"type":"number",
"description":"The version state of the reference."
},
"attributeValue":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CharacteristicValueSpecification"
},
"description":"A list of attribute values associated with the attribute reference."
}
},
"required":[
"@type"
]
},
"AttributeRelationshipOracle":{
"title":"AttributeRelationshipOracle",
"type":"object",
"description":"An aggregation, migration, substitution, dependency or exclusivity relationship between/among attributes.",
"properties":{
"relationshipType":{
"type":"string",
"description":"The type or classification of the attribute relationship. Valid values are AGGREGATION, MIGRATION, SUBSTITUTION, DEPENDENCY, and EXCLUSIVITY.",
"enum":[
"AGGREGATION",
"MIGRATION",
"SUBSTITUTION",
"DEPENDENCY",
"EXCLUSIVITY"
]
},
"validFor":{
"$ref":"#/components/schemas/TimePeriodOracle",
"description":"The period for which the attribute relationship is valid."
},
"id":{
"type":"string",
"description":"The ID of the attribute relationship."
},
"name":{
"type":"string",
"description":"The name of the attribute relationship."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the attribute relationship."
},
"@type":{
"type":"string",
"description":"The class type of the attribute relationship."
},
"@baseType":{
"type":"string",
"description":"The base type of the attribute relationship."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the attribute relationship."
}
},
"required":[
"id",
"name",
"relationshipType",
"@type"
]
},
"ChannelOracle":{
"title":"ChannelOracle",
"type":"object",
"properties":{
"id":{
"type":"string",
"maxLength":30,
"description":"The ID of the channel."
},
"name":{
"type":"string",
"description":"The name of the channel."
},
"description":{
"type":"string",
"description":"The description of channel."
},
"href":{
"type":"string",
"description":"The hyperlink reference to the channel."
},
"channelType":{
"type":"string",
"description":"The type or classification of the channel."
},
"lastUpdate":{
"type":"string",
"format":"date-time",
"description":"The date and time when the channel was last updated."
},
"lifecycleStatus":{
"type":"string",
"description":"The status of the channel."
},
"validFor":{
"$ref":"#/components/schemas/TimePeriod",
"description":"The period for which the channel is valid."
},
"@type":{
"type":"string",
"description":"The class type of the channel."
},
"@baseType":{
"type":"string",
"description":"The base type of the channel."
},
"@schemaLocation":{
"type":"string",
"description":"The URI of the schema that defines the channel."
},
"project":{
"$ref":"#/components/schemas/ProjectRef",
"description":"The channel."
},
"version":{
"type":"string",
"description":"The channel version."
},
"created":{
"type":"string",
"format":"date-time",
"description":"The date and time of the channel creation."
},
"createdBy":{
"type":"string",
"description":"The name of the person who created the channel."
},
"lastUpdatedBy":{
"type":"string",
"description":"The name of the person who updated the channel."
},
"versionState":{
"type":"number",
"description":"The version state of the channel."
},
"externalId":{
"type":"string",
"description":"The ID of the external associated with the channel."
},
"applicationName":{
"type":"string",
"description":"The name of the application associated with the channel."
}
},
"required":[
"name",
"@type"
],
"description":"The channel resource."
},
"ProductOfferingPrice_Schemas":{
"title":"ProductOfferingPrice_Schemas",
"oneOf":[
{
"$ref":"#/components/schemas/ProductOfferingPriceOracle"
},
{
"$ref":"#/components/schemas/ProductOfferingPriceAlterationOracle"
},
{
"$ref":"#/components/schemas/ProductOfferingPriceAllowanceOracle"
},
{
"$ref":"#/components/schemas/ProductOfferRolloverPriceOracle"
},
{
"$ref":"#/components/schemas/ProductOfferingPriceCounterOracle"
},
{
"$ref":"#/components/schemas/ProductOfferingPriceOverageOracle"
},
{
"$ref":"#/components/schemas/ProductOfferingPricePlanOracle"
},
{
"$ref":"#/components/schemas/PenaltyPriceOracle"
},
{
"$ref":"#/components/schemas/ProductOfferingBeatPriceOracle"
}
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"ProductOfferingPriceOracle":"#/components/schemas/ProductOfferingPriceOracle",
"ProductOfferPriceAlterationOracle":"#/components/schemas/ProductOfferingPriceAlterationOracle",
"ProductOfferPriceAllowanceOracle":"#/components/schemas/ProductOfferingPriceAllowanceOracle",
"ProductOfferRolloverPriceOracle":"#/components/schemas/ProductOfferRolloverPriceOracle",
"ProductOfferPriceCounterOracle":"#/components/schemas/ProductOfferingPriceCounterOracle",
"ProductOfferPriceOverageOracle":"#/components/schemas/ProductOfferingPriceOverageOracle",
"ProductOfferPricePlanOracle":"#/components/schemas/ProductOfferingPricePlanOracle",
"PenaltyPriceOracle":"#/components/schemas/PenaltyPriceOracle",
"ProductOfferingBeatPriceOracle":"#/components/schemas/ProductOfferingBeatPriceOracle"
}
},
"description":"The product offering price resource."
},
"PricingLogicAlgorithmSpecification_Schemas":{
"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"
}
},
"description":"The pricing logic algorithm specification resource."
}
}
},
"info":{
"description":"You can use Oracle REST APIs to view and manage data stored in Launch Cloud Service.
Whether you're experienced with or new to REST, use this guide to find what you need, including:
A quick start that walks you through a simple request example.
Use cases that provide real-world solutions with code examples.
Detailed descriptions for each REST API resource.
",
"version":"2026.06.30",
"title":"REST API Reference for Launch Cloud Service",
"x-summary":"You can use Oracle REST APIs to view and manage data stored in Launch Cloud Service."
},
"openapi":"3.0.0",
"paths":{
"/catalog":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5"
}
],
"get":{
"tags":[
"Catalogs"
],
"summary":"Get all catalogs",
"operationId":"listCatalog",
"parameters":[
{
"$ref":"#/components/parameters/limit"
},
{
"$ref":"#/components/parameters/offset"
},
{
"$ref":"#/components/parameters/idQueryParam"
},
{
"$ref":"#/components/parameters/name"
},
{
"$ref":"#/components/parameters/description"
},
{
"$ref":"#/components/parameters/version"
},
{
"$ref":"#/components/parameters/lifecycleStatus"
},
{
"$ref":"#/components/parameters/type"
},
{
"$ref":"#/components/parameters/baseType"
},
{
"$ref":"#/components/parameters/schemaLocation"
},
{
"$ref":"#/components/parameters/catalogType"
},
{
"$ref":"#/components/parameters/fields"
},
{
"$ref":"#/components/parameters/eligibleForProject"
},
{
"$ref":"#/components/parameters/whereUsed"
},
{
"$ref":"#/components/parameters/project.id"
},
{
"$ref":"#/components/parameters/project.version"
},
{
"$ref":"#/components/parameters/validFor.startDateTime"
},
{
"$ref":"#/components/parameters/validFor.endDateTime"
},
{
"$ref":"#/components/parameters/depth"
},
{
"$ref":"#/components/parameters/catalogexpand"
},
{
"$ref":"#/components/parameters/lastUpdate"
}
],
"responses":{
"200":{
"description":"The list of catalogs was returned successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CatalogOracle"
}
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"catalog-get",
"x-filename-id":"catalog-get",
"x-export-filter":true,
"description":"Returns a list of catalogs that match the search criteria."
},
"post":{
"tags":[
"Catalogs"
],
"summary":"Create a catalog",
"operationId":"createCatalog",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/CatalogOracle"
}
}
},
"description":"The request payload for creating a catalog."
},
"responses":{
"201":{
"description":"Your request is successful and a new resource has been created.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/CatalogOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"catalog-post",
"x-filename-id":"catalog-post",
"description":"Creates a new catalog using the supplied request payload and returns the created resource."
}
},
"/catalog/{id}":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5"
}
],
"parameters":[
{
"$ref":"#/components/parameters/id"
}
],
"get":{
"tags":[
"Catalogs"
],
"summary":"Get a catalog",
"operationId":"retrieveCatalog",
"parameters":[
{
"$ref":"#/components/parameters/fields"
},
{
"$ref":"#/components/parameters/depth"
},
{
"$ref":"#/components/parameters/catalogexpand"
},
{
"$ref":"#/components/parameters/eligibleVersionForProject"
}
],
"responses":{
"200":{
"description":"The catalog was returned successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/CatalogOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"catalog-{id}-get",
"x-filename-id":"catalog-id-get",
"description":"Returns the catalog that matches the specified ID, including its configured details."
},
"patch":{
"tags":[
"Catalogs"
],
"summary":"Update a catalog",
"operationId":"patchCatalog",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/CatalogOracle"
}
}
},
"description":"The request payload for updating a catalog."
},
"responses":{
"200":{
"description":"The catalog was updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/CatalogOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"catalog-{id}-patch",
"x-filename-id":"catalog-id-patch",
"description":"Updates the catalog that matches the specified ID using the supplied request payload."
},
"put":{
"tags":[
"Catalogs"
],
"summary":"Create or update a catalog",
"operationId":"putCatalog",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/CatalogOracle"
}
}
},
"description":"The request payload for creating or updating a catalog."
},
"responses":{
"200":{
"description":"The catalog was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/CatalogOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"catalog-{id}-put",
"x-filename-id":"catalog-id-put",
"description":"Creates or updates the catalog with the specified ID."
},
"delete":{
"tags":[
"Catalogs"
],
"summary":"Delete a catalog",
"operationId":"deleteCatalog",
"responses":{
"204":{
"$ref":"#/components/responses/204"
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"catalog-{id}-delete",
"x-filename-id":"catalog-id-delete",
"description":"Deletes the catalog that matches the specified ID from the catalog configuration."
}
},
"/category":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5"
}
],
"get":{
"tags":[
"Categories"
],
"summary":"Get all categories",
"operationId":"listCategory",
"parameters":[
{
"$ref":"#/components/parameters/limit"
},
{
"$ref":"#/components/parameters/offset"
},
{
"$ref":"#/components/parameters/idQueryParam"
},
{
"$ref":"#/components/parameters/name"
},
{
"$ref":"#/components/parameters/description"
},
{
"$ref":"#/components/parameters/version"
},
{
"$ref":"#/components/parameters/lifecycleStatus"
},
{
"$ref":"#/components/parameters/type"
},
{
"$ref":"#/components/parameters/baseType"
},
{
"$ref":"#/components/parameters/schemaLocation"
},
{
"$ref":"#/components/parameters/fields"
},
{
"$ref":"#/components/parameters/eligibleForProject"
},
{
"$ref":"#/components/parameters/whereUsed"
},
{
"$ref":"#/components/parameters/project.id"
},
{
"$ref":"#/components/parameters/project.version"
},
{
"$ref":"#/components/parameters/validFor.startDateTime"
},
{
"$ref":"#/components/parameters/validFor.endDateTime"
},
{
"$ref":"#/components/parameters/catalogId"
},
{
"$ref":"#/components/parameters/lastUpdate"
}
],
"responses":{
"200":{
"description":"The list of categories was returned successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CategoryOracle"
}
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"category-get",
"x-filename-id":"category-get",
"x-export-filter":true,
"description":"Returns a list of categories that match the search criteria."
},
"post":{
"tags":[
"Categories"
],
"summary":"Create a category",
"operationId":"createCategory",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/CategoryOracle"
}
}
},
"description":"The request payload for creating a category."
},
"responses":{
"201":{
"description":"The category was created successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/CategoryOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"category-post",
"x-filename-id":"category-post",
"description":"Creates a new category using the supplied request payload and returns the created resource."
}
},
"/category/{id}":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5"
}
],
"parameters":[
{
"$ref":"#/components/parameters/id"
}
],
"get":{
"tags":[
"Categories"
],
"summary":"Get a category",
"operationId":"retrieveCategory",
"parameters":[
{
"$ref":"#/components/parameters/fields"
},
{
"$ref":"#/components/parameters/eligibleVersionForProject"
}
],
"responses":{
"200":{
"description":"The category was returned successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/CategoryOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"category-{id}-get",
"x-filename-id":"category-id-get",
"description":"Returns the category that matches the specified ID, including its configured details."
},
"patch":{
"tags":[
"Categories"
],
"summary":"Update a category",
"operationId":"patchCategory",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/CategoryOracle"
}
}
},
"description":"The request payload for updating a category."
},
"responses":{
"200":{
"description":"The category was updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/CategoryOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"category-{id}-patch",
"x-filename-id":"category-id-patch",
"description":"Updates the category that matches the specified ID using the supplied request payload."
},
"put":{
"tags":[
"Categories"
],
"summary":"Create or update a category",
"operationId":"putCategory",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/CategoryOracle"
}
}
},
"description":"The request payload for creating or updating a category."
},
"responses":{
"200":{
"description":"The category was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/CategoryOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"category-{id}-put",
"x-filename-id":"category-id-put",
"description":"Creates or updates the category with the specified ID."
},
"delete":{
"tags":[
"Categories"
],
"summary":"Delete category",
"operationId":"deleteCategory",
"responses":{
"204":{
"$ref":"#/components/responses/204"
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"category-{id}-delete",
"x-filename-id":"category-id-delete",
"description":"Deletes the category that matches the specified ID from the catalog configuration."
}
},
"/productSpecification":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5"
}
],
"get":{
"tags":[
"Product Specifications"
],
"summary":"Get all product specifications",
"operationId":"listProductSpecification",
"parameters":[
{
"$ref":"#/components/parameters/limit"
},
{
"$ref":"#/components/parameters/offset"
},
{
"$ref":"#/components/parameters/idQueryParam"
},
{
"$ref":"#/components/parameters/name"
},
{
"$ref":"#/components/parameters/description"
},
{
"$ref":"#/components/parameters/version"
},
{
"$ref":"#/components/parameters/lifecycleStatus"
},
{
"$ref":"#/components/parameters/type"
},
{
"$ref":"#/components/parameters/baseType"
},
{
"$ref":"#/components/parameters/schemaLocation"
},
{
"$ref":"#/components/parameters/productNumber"
},
{
"$ref":"#/components/parameters/brand"
},
{
"$ref":"#/components/parameters/fields"
},
{
"$ref":"#/components/parameters/whereUsed"
},
{
"$ref":"#/components/parameters/eligibleForProject"
},
{
"$ref":"#/components/parameters/project.id"
},
{
"$ref":"#/components/parameters/project.version"
},
{
"$ref":"#/components/parameters/validFor.startDateTime"
},
{
"$ref":"#/components/parameters/validFor.endDateTime"
},
{
"$ref":"#/components/parameters/lastUpdate"
}
],
"responses":{
"200":{
"description":"The list of product specifications was returned successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ProductSpecificationOracle"
}
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"productSpecification-get",
"x-filename-id":"productspecification-get",
"x-export-filter":true,
"description":"Returns a list of product specifications that match the search criteria."
},
"post":{
"tags":[
"Product Specifications"
],
"summary":"Create a product specification",
"operationId":"createProductSpecification",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ProductSpecificationOracle"
}
}
},
"description":"The request payload for creating a product specification."
},
"responses":{
"201":{
"description":"The product specification was created successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ProductSpecificationOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"productSpecification-post",
"x-filename-id":"productspecification-post",
"description":"Creates a new product specification using the supplied request payload and returns the created resource."
}
},
"/productSpecification/{id}":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5"
}
],
"get":{
"tags":[
"Product Specifications"
],
"summary":"Get a product specification",
"operationId":"retrieveProductSpecification",
"parameters":[
{
"$ref":"#/components/parameters/id"
},
{
"$ref":"#/components/parameters/fields"
},
{
"$ref":"#/components/parameters/eligibleVersionForProject"
}
],
"responses":{
"200":{
"description":"The product specification was returned successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ProductSpecificationOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"productSpecification-{id}-get",
"x-filename-id":"productspecification-id-get",
"description":"Returns the product specification that matches the specified ID, including its configured details."
},
"patch":{
"tags":[
"Product Specifications"
],
"summary":"Update a product specification",
"operationId":"patchProductSpecification",
"parameters":[
{
"$ref":"#/components/parameters/id"
}
],
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ProductSpecificationOracle"
}
}
},
"description":"The request payload for updating a product specification."
},
"responses":{
"200":{
"description":"The product specification was updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ProductSpecificationOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"productSpecification-{id}-patch",
"x-filename-id":"productspecification-id-patch",
"description":"Updates the product specification that matches the specified ID using the supplied request payload."
},
"put":{
"tags":[
"Product Specifications"
],
"summary":"Create or update a product specification",
"operationId":"putProductSpecification",
"parameters":[
{
"$ref":"#/components/parameters/id"
}
],
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ProductSpecificationOracle"
}
}
},
"description":"The request payload for creating or updating a product specification."
},
"responses":{
"200":{
"description":"The product specification was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ProductSpecificationOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"productSpecification-{id}-put",
"x-filename-id":"productspecification-id-put",
"description":"Creates or updates the product specification with the specified ID."
},
"delete":{
"tags":[
"Product Specifications"
],
"summary":"Delete a product specification",
"operationId":"deleteProductSpecification",
"parameters":[
{
"$ref":"#/components/parameters/id"
}
],
"responses":{
"204":{
"$ref":"#/components/responses/204"
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"productSpecification-{id}-delete",
"x-filename-id":"productspecification-id-delete",
"description":"Deletes the product specification that matches the specified ID from the catalog configuration."
}
},
"/productOffering":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5"
}
],
"get":{
"tags":[
"Product Offerings"
],
"summary":"Get all product offerings",
"operationId":"listProductOffering",
"parameters":[
{
"$ref":"#/components/parameters/limit"
},
{
"$ref":"#/components/parameters/offset"
},
{
"$ref":"#/components/parameters/idQueryParam"
},
{
"$ref":"#/components/parameters/name"
},
{
"$ref":"#/components/parameters/commercialName"
},
{
"$ref":"#/components/parameters/nameSearch"
},
{
"$ref":"#/components/parameters/description"
},
{
"$ref":"#/components/parameters/version"
},
{
"$ref":"#/components/parameters/lifecycleStatus"
},
{
"$ref":"#/components/parameters/isBundle"
},
{
"$ref":"#/components/parameters/isSellable"
},
{
"$ref":"#/components/parameters/type"
},
{
"$ref":"#/components/parameters/baseType"
},
{
"$ref":"#/components/parameters/schemaLocation"
},
{
"$ref":"#/components/parameters/productOfferingInfo.productType"
},
{
"$ref":"#/components/parameters/productSpecification.id"
},
{
"$ref":"#/components/parameters/productSpecification.name"
},
{
"$ref":"#/components/parameters/productLine.id"
},
{
"$ref":"#/components/parameters/productLine.name"
},
{
"$ref":"#/components/parameters/pricelist.id"
},
{
"$ref":"#/components/parameters/pricelist.name"
},
{
"$ref":"#/components/parameters/fields"
},
{
"$ref":"#/components/parameters/whereUsed"
},
{
"$ref":"#/components/parameters/eligibleForProject"
},
{
"$ref":"#/components/parameters/project.id"
},
{
"$ref":"#/components/parameters/project.version"
},
{
"$ref":"#/components/parameters/validFor.startDateTime"
},
{
"$ref":"#/components/parameters/validFor.endDateTime"
},
{
"$ref":"#/components/parameters/businessUnitId"
},
{
"$ref":"#/components/parameters/businessUnitName"
},
{
"$ref":"#/components/parameters/lastUpdate"
}
],
"responses":{
"200":{
"description":"The list of product offerings was returned successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ProductOfferingOracle"
}
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"productOffering-get",
"x-filename-id":"productoffering-get",
"x-export-filter":true,
"description":"Returns a list of product offerings that match the search criteria."
},
"post":{
"tags":[
"Product Offerings"
],
"summary":"Create a product offering",
"operationId":"createProductOffering",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ProductOfferingOracle"
}
}
},
"description":"The request payload for creating a product offering."
},
"responses":{
"201":{
"description":"The product offering was created successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ProductOfferingOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"productOffering-post",
"x-filename-id":"productoffering-post",
"description":"Creates a new product offering using the supplied request payload and returns the created resource."
}
},
"/productOffering/{id}":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5"
}
],
"get":{
"tags":[
"Product Offerings"
],
"parameters":[
{
"$ref":"#/components/parameters/id"
},
{
"$ref":"#/components/parameters/fields"
},
{
"$ref":"#/components/parameters/depth"
},
{
"$ref":"#/components/parameters/poexpand"
},
{
"$ref":"#/components/parameters/version"
},
{
"$ref":"#/components/parameters/component"
},
{
"$ref":"#/components/parameters/eligibleVersionForProject"
}
],
"summary":"Get a product offering",
"operationId":"retrieveProductOffering",
"responses":{
"200":{
"description":"The product offering was returned successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ProductOfferingOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"productOffering-{id}-get",
"x-filename-id":"productoffering-id-get",
"description":"Returns the product offering that matches the specified ID, including its configured details."
},
"patch":{
"tags":[
"Product Offerings"
],
"summary":"Update a product offering",
"operationId":"patchProductOffering",
"parameters":[
{
"$ref":"#/components/parameters/id"
}
],
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ProductOfferingOracle"
}
}
},
"description":"The request payload for updating a product offering."
},
"responses":{
"200":{
"description":"The product offering was updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ProductOfferingOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"productOffering-{id}-patch",
"x-filename-id":"productoffering-id-patch",
"description":"Updates the product offering that matches the specified ID using the supplied request payload."
},
"put":{
"tags":[
"Product Offerings"
],
"summary":"Create or update a product offering",
"operationId":"putProductOffering",
"parameters":[
{
"$ref":"#/components/parameters/id"
}
],
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ProductOfferingOracle"
}
}
},
"description":"The request payload for creating or updating a product offering."
},
"responses":{
"200":{
"description":"The product offering was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ProductOfferingOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"productOffering-{id}-put",
"x-filename-id":"productoffering-id-put",
"description":"Creates or updates the product offering with the specified ID."
},
"delete":{
"tags":[
"Product Offerings"
],
"summary":"Delete a product offering",
"operationId":"deleteProductOffering",
"parameters":[
{
"$ref":"#/components/parameters/id"
}
],
"responses":{
"204":{
"$ref":"#/components/responses/204"
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"productOffering-{id}-delete",
"x-filename-id":"productoffering-id-delete",
"description":"Deletes the product offering that matches the specified ID from the catalog configuration."
}
},
"/productLine":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1"
}
],
"get":{
"tags":[
"Product Lines"
],
"summary":"Get all product lines",
"operationId":"listProductLine",
"parameters":[
{
"$ref":"#/components/parameters/limit"
},
{
"$ref":"#/components/parameters/offset"
},
{
"$ref":"#/components/parameters/idQueryParam"
},
{
"$ref":"#/components/parameters/name"
},
{
"$ref":"#/components/parameters/description"
},
{
"$ref":"#/components/parameters/version"
},
{
"$ref":"#/components/parameters/lifecycleStatus"
},
{
"$ref":"#/components/parameters/fields"
},
{
"$ref":"#/components/parameters/eligibleForProject"
},
{
"$ref":"#/components/parameters/whereUsed"
},
{
"$ref":"#/components/parameters/project.id"
},
{
"$ref":"#/components/parameters/project.version"
},
{
"$ref":"#/components/parameters/validFor.startDateTime"
},
{
"$ref":"#/components/parameters/validFor.endDateTime"
},
{
"$ref":"#/components/parameters/lastUpdate"
}
],
"responses":{
"200":{
"description":"The list of product lines was returned successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ProductLineOracle"
}
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"productLine-get",
"x-filename-id":"productline-get",
"x-export-filter":true,
"description":"Returns a list of product lines that match the search criteria."
},
"post":{
"tags":[
"Product Lines"
],
"summary":"Create a product line",
"operationId":"createProductLine",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ProductLineOracle"
}
}
},
"description":"The request payload for creating a product line."
},
"responses":{
"201":{
"description":"The product line was created successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ProductLineOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"productLine-post",
"x-filename-id":"productline-post",
"description":"Creates a new product line using the supplied request payload and returns the created resource."
}
},
"/productLine/{id}":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1"
}
],
"get":{
"tags":[
"Product Lines"
],
"summary":"Get a product line",
"operationId":"retrieveProductLine",
"parameters":[
{
"$ref":"#/components/parameters/id"
},
{
"$ref":"#/components/parameters/fields"
},
{
"$ref":"#/components/parameters/eligibleVersionForProject"
}
],
"responses":{
"200":{
"description":"The product line was returned successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ProductLineOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"productLine-{id}-get",
"x-filename-id":"productline-id-get",
"description":"Returns the product line that matches the specified ID, including its configured details."
},
"patch":{
"tags":[
"Product Lines"
],
"summary":"Update a product line",
"operationId":"patchProductLine",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ProductLineOracle"
}
}
},
"description":"The request payload for updating a product line."
},
"responses":{
"200":{
"description":"The product line was updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ProductLineOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"productLine-{id}-patch",
"x-filename-id":"productline-id-patch",
"description":"Updates the product line that matches the specified ID using the supplied request payload."
},
"put":{
"tags":[
"Product Lines"
],
"summary":"Create or update a product line",
"operationId":"putProductLine",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ProductLineOracle"
}
}
},
"description":"The request payload for creating or updating a product line."
},
"responses":{
"200":{
"description":"The product line was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ProductLineOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"productLine-{id}-put",
"x-filename-id":"productline-id-put",
"description":"Creates or updates the product line with the specified ID."
},
"delete":{
"tags":[
"Product Lines"
],
"operationId":"deleteProductLine",
"summary":"Delete a product line",
"responses":{
"204":{
"$ref":"#/components/responses/204"
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"productLine-{id}-delete",
"x-filename-id":"productline-id-delete",
"description":"Deletes the product line that matches the specified ID from the catalog configuration."
},
"parameters":[
{
"$ref":"#/components/parameters/id"
}
]
},
"/productOfferingPrice":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5"
}
],
"get":{
"tags":[
"Product Offering Prices"
],
"summary":"Get all product offering prices",
"operationId":"listProductOfferingPrice",
"parameters":[
{
"$ref":"#/components/parameters/limit"
},
{
"$ref":"#/components/parameters/offset"
},
{
"$ref":"#/components/parameters/idQueryParam"
},
{
"$ref":"#/components/parameters/name"
},
{
"$ref":"#/components/parameters/description"
},
{
"$ref":"#/components/parameters/version"
},
{
"$ref":"#/components/parameters/lifecycleStatus"
},
{
"$ref":"#/components/parameters/type"
},
{
"$ref":"#/components/parameters/baseType"
},
{
"$ref":"#/components/parameters/schemaLocation"
},
{
"$ref":"#/components/parameters/priceType"
},
{
"$ref":"#/components/parameters/recurringChargePeriodType"
},
{
"$ref":"#/components/parameters/recurringChargePeriodLength"
},
{
"$ref":"#/components/parameters/percentage"
},
{
"$ref":"#/components/parameters/fields"
},
{
"$ref":"#/components/parameters/priceSubType"
},
{
"$ref":"#/components/parameters/eligibleForProject"
},
{
"$ref":"#/components/parameters/pricelist.id"
},
{
"$ref":"#/components/parameters/pricelist.name"
},
{
"$ref":"#/components/parameters/price.value"
},
{
"$ref":"#/components/parameters/whereUsed"
},
{
"$ref":"#/components/parameters/project.id"
},
{
"$ref":"#/components/parameters/project.version"
},
{
"$ref":"#/components/parameters/validFor.startDateTime"
},
{
"$ref":"#/components/parameters/validFor.endDateTime"
},
{
"$ref":"#/components/parameters/isBundle"
},
{
"$ref":"#/components/parameters/lastUpdate"
}
],
"responses":{
"200":{
"description":"The list of product offering prices was returned successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ProductOfferingPrice_Schemas"
}
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"productOfferingPrice-get",
"x-filename-id":"productofferingprice-get",
"x-export-filter":true,
"description":"Returns a list of product offering prices that match the search criteria."
},
"post":{
"tags":[
"Product Offering Prices"
],
"summary":"Create a product offering price",
"operationId":"createProductOfferingPrice",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ProductOfferingPrice_Schemas"
}
}
},
"description":"The request payload for creating a product offering price."
},
"responses":{
"201":{
"description":"The product offering price was created successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ProductOfferingPrice_Schemas"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"productOfferingPrice-post",
"x-filename-id":"productofferingprice-post",
"description":"Creates a new product offering price using the supplied request payload and returns the created resource."
}
},
"/productOfferingPrice/{id}":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5"
}
],
"get":{
"tags":[
"Product Offering Prices"
],
"operationId":"retrieveProductOfferingPrice",
"summary":"Get a product offering price",
"parameters":[
{
"$ref":"#/components/parameters/fields"
},
{
"$ref":"#/components/parameters/eligibleVersionForProject"
}
],
"responses":{
"200":{
"description":"The product offering price was returned successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ProductOfferingPrice_Schemas"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"productOfferingPrice-{id}-get",
"x-filename-id":"productofferingprice-id-get",
"description":"Returns the product offering price with the specified ID."
},
"patch":{
"tags":[
"Product Offering Prices"
],
"summary":"Update a product offering price",
"operationId":"patchProductOfferingPrice",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ProductOfferingPrice_Schemas"
}
}
},
"description":"The request payload for updating a product offering price."
},
"responses":{
"200":{
"description":"The product offering price was updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ProductOfferingPrice_Schemas"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"productOfferingPrice-{id}-patch",
"x-filename-id":"productofferingprice-id-patch",
"description":"Updates the product offering price with the specified ID."
},
"put":{
"tags":[
"Product Offering Prices"
],
"summary":"Create or update a product offering price",
"operationId":"putProductOfferingPrice",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ProductOfferingPrice_Schemas"
}
}
},
"description":"The request payload for creating or updating a product offering price."
},
"responses":{
"200":{
"description":"The product offering price was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ProductOfferingPrice_Schemas"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"productOfferingPrice-{id}-put",
"x-filename-id":"productofferingprice-id-put",
"description":"Creates or updates the product offering price with the specified ID."
},
"delete":{
"tags":[
"Product Offering Prices"
],
"summary":"Delete a product offering price",
"operationId":"deleteProductOfferingPrice",
"responses":{
"204":{
"$ref":"#/components/responses/204"
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"productOfferingPrice-{id}-delete",
"x-filename-id":"productofferingprice-id-delete",
"description":"Deletes the product offering price with the specified ID."
},
"parameters":[
{
"$ref":"#/components/parameters/id"
}
]
},
"/pricingLogicAlgorithm":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1"
}
],
"get":{
"tags":[
"Pricing Logic Algorithms"
],
"summary":"Get all pricing logic algorithms",
"operationId":"listPla",
"parameters":[
{
"$ref":"#/components/parameters/limit"
},
{
"$ref":"#/components/parameters/offset"
},
{
"$ref":"#/components/parameters/idQueryParam"
},
{
"$ref":"#/components/parameters/name"
},
{
"$ref":"#/components/parameters/description"
},
{
"$ref":"#/components/parameters/version"
},
{
"$ref":"#/components/parameters/lifecycleStatus"
},
{
"$ref":"#/components/parameters/fields"
},
{
"$ref":"#/components/parameters/eligibleForProject"
},
{
"$ref":"#/components/parameters/whereUsed"
},
{
"$ref":"#/components/parameters/project.id"
},
{
"$ref":"#/components/parameters/project.version"
},
{
"$ref":"#/components/parameters/validFor.startDateTime"
},
{
"$ref":"#/components/parameters/validFor.endDateTime"
},
{
"$ref":"#/components/parameters/lastUpdate"
}
],
"responses":{
"200":{
"description":"The list of pricing logic algorithms was returned successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/PlaQuantityRangeOracle"
}
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"pricingLogicAlgorithm-get",
"x-filename-id":"pricinglogicalgorithm-get",
"x-export-filter":true,
"description":"Returns a list of pricing logic algorithms that match the search criteria."
},
"post":{
"tags":[
"Pricing Logic Algorithms"
],
"summary":"Create a pricing logic algorithm",
"operationId":"createPla",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PlaQuantityRangeOracle"
}
}
},
"description":"The request payload for creating a pricing logic algorithm."
},
"responses":{
"201":{
"description":"The pricing logic algorithm was created successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PlaQuantityRangeOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"pricingLogicAlgorithm-post",
"x-filename-id":"pricinglogicalgorithm-post",
"description":"Creates a new pricing logic algorithm using the supplied request payload and returns the created resource."
}
},
"/pricingLogicAlgorithm/{id}":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1"
}
],
"parameters":[
{
"$ref":"#/components/parameters/id"
}
],
"get":{
"tags":[
"Pricing Logic Algorithms"
],
"summary":"Get a pricing logic algorithm",
"operationId":"retrievePla",
"parameters":[
{
"$ref":"#/components/parameters/fields"
},
{
"$ref":"#/components/parameters/eligibleVersionForProject"
}
],
"responses":{
"200":{
"description":"The pricing logic algorithm was returned successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PlaQuantityRangeOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"pricingLogicAlgorithm-{id}-get",
"x-filename-id":"pricinglogicalgorithm-id-get",
"description":"Returns the pricing logic algorithm with the specified ID."
},
"patch":{
"tags":[
"Pricing Logic Algorithms"
],
"summary":"Update a pricing logic algorithm",
"operationId":"patchPla",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PlaQuantityRangeOracle"
}
}
},
"description":"The request payload for updating a pricing logic algorithm."
},
"responses":{
"200":{
"description":"The pricing logic algorithm was updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PlaQuantityRangeOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"pricingLogicAlgorithm-{id}-patch",
"x-filename-id":"pricinglogicalgorithm-id-patch",
"description":"Updates the pricing logic algorithm with the specified ID."
},
"put":{
"tags":[
"Pricing Logic Algorithms"
],
"summary":"Create or update a pricing logic algorithm",
"operationId":"putPla",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PlaQuantityRangeOracle"
}
}
},
"description":"The request payload for creating or updating a pricing logic algorithm."
},
"responses":{
"200":{
"description":"The pricing logic algorithm was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PlaQuantityRangeOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"pricingLogicAlgorithm-{id}-put",
"x-filename-id":"pricinglogicalgorithm-id-put",
"description":"Creates or updates the pricing logic algorithm with the specified ID."
},
"delete":{
"tags":[
"Pricing Logic Algorithms"
],
"summary":"Delete a pricing logic algorithm",
"operationId":"deletePla",
"responses":{
"204":{
"$ref":"#/components/responses/204"
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"pricingLogicAlgorithm-{id}-delete",
"x-filename-id":"pricinglogicalgorithm-id-delete",
"description":"Deletes the pricing logic algorithm with the specified ID."
}
},
"/pricingLogicAlgorithmSpecification":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1"
}
],
"get":{
"tags":[
"Pricing Logic Algorithm Specifications"
],
"summary":"Get all pricing logic algorithm specifications",
"operationId":"listPlaSpecification",
"parameters":[
{
"$ref":"#/components/parameters/limit"
},
{
"$ref":"#/components/parameters/offset"
},
{
"$ref":"#/components/parameters/idQueryParam"
},
{
"$ref":"#/components/parameters/name"
},
{
"$ref":"#/components/parameters/description"
},
{
"$ref":"#/components/parameters/version"
},
{
"$ref":"#/components/parameters/lifecycleStatus"
},
{
"$ref":"#/components/parameters/fields"
},
{
"$ref":"#/components/parameters/eligibleForProject"
},
{
"$ref":"#/components/parameters/project.id"
},
{
"$ref":"#/components/parameters/project.version"
},
{
"$ref":"#/components/parameters/validFor.startDateTime"
},
{
"$ref":"#/components/parameters/validFor.endDateTime"
},
{
"$ref":"#/components/parameters/lastUpdate"
}
],
"responses":{
"200":{
"description":"The list of pricing logic algorithm specifications was returned successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/PricingLogicAlgorithmSpecification_Schemas"
}
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"pricingLogicAlgorithmSpecification-get",
"x-filename-id":"pricinglogicalgorithmspecification-get",
"x-export-filter":true,
"description":"Returns a list of pricing logic algorithm specifications that match the search criteria."
},
"post":{
"tags":[
"Pricing Logic Algorithm Specifications"
],
"summary":"Create a pricing logic algorithm specification",
"operationId":"createPlaSpecification",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PricingLogicAlgorithmSpecification_Schemas"
}
}
},
"description":"The request payload for creating a pricing logic algorithm specification."
},
"responses":{
"201":{
"description":"The pricing logic algorithm specification was created successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PricingLogicAlgorithmSpecification_Schemas"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"pricingLogicAlgorithmSpecification-post",
"x-filename-id":"pricinglogicalgorithmspecification-post",
"description":"Creates a new pricing logic algorithm specification using the supplied request payload and returns the created resource."
}
},
"/pricingLogicAlgorithmSpecification/{id}":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1"
}
],
"parameters":[
{
"$ref":"#/components/parameters/id"
}
],
"get":{
"tags":[
"Pricing Logic Algorithm Specifications"
],
"summary":"Get a pricing logic algorithm specification",
"operationId":"retrievePlaSpecification",
"parameters":[
{
"$ref":"#/components/parameters/fields"
},
{
"$ref":"#/components/parameters/eligibleVersionForProject"
}
],
"responses":{
"200":{
"description":"The pricing logic algorithm specification was returned successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PricingLogicAlgorithmSpecification_Schemas"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
},
"501":{
"$ref":"#/components/responses/501"
}
},
"x-internal-id":"pricingLogicAlgorithmSpecification-{id}-get",
"x-filename-id":"pricinglogicalgorithmspecification-id-get",
"description":"Returns the pricing logic algorithm specification with the specified ID."
},
"patch":{
"tags":[
"Pricing Logic Algorithm Specifications"
],
"summary":"Update a pricing logic algorithm specification",
"operationId":"patchPlaSpecification",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PricingLogicAlgorithmSpecification_Schemas"
}
}
},
"description":"The request payload for updating a pricing logic algorithm specification."
},
"responses":{
"200":{
"description":"The pricing logic algorithm specification was updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PricingLogicAlgorithmSpecification_Schemas"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
},
"501":{
"$ref":"#/components/responses/501"
}
},
"x-internal-id":"pricingLogicAlgorithmSpecification-{id}-patch",
"x-filename-id":"pricinglogicalgorithmspecification-id-patch",
"description":"Updates the pricing logic algorithm specification with the specified ID."
},
"put":{
"tags":[
"Pricing Logic Algorithm Specifications"
],
"summary":"Create or update a pricing logic algorithm specification",
"operationId":"putPlaSpecification",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PricingLogicAlgorithmSpecification_Schemas"
}
}
},
"description":"The request payload for creating or updating a pricing logic algorithm specification."
},
"responses":{
"200":{
"description":"The pricing logic algorithm specification was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PricingLogicAlgorithmSpecification_Schemas"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
},
"501":{
"$ref":"#/components/responses/501"
}
},
"x-internal-id":"pricingLogicAlgorithmSpecification-{id}-put",
"x-filename-id":"pricinglogicalgorithmspecification-id-put",
"description":"Creates or updates the pricing logic algorithm specification with the specified ID."
},
"delete":{
"tags":[
"Pricing Logic Algorithm Specifications"
],
"summary":"Delete a pricing logic algorithm specification",
"operationId":"deletePlaSpecification",
"responses":{
"204":{
"$ref":"#/components/responses/204"
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
},
"501":{
"$ref":"#/components/responses/501"
}
},
"x-internal-id":"pricingLogicAlgorithmSpecification-{id}-delete",
"x-filename-id":"pricinglogicalgorithmspecification-id-delete",
"description":"Deletes the pricing logic algorithm specification with the specified ID."
}
},
"/project":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1"
}
],
"get":{
"tags":[
"Projects"
],
"operationId":"listProject",
"summary":"Get all projects",
"description":"Returns a list of projects that match the search criteria.",
"parameters":[
{
"$ref":"#/components/parameters/limit"
},
{
"$ref":"#/components/parameters/offset"
},
{
"$ref":"#/components/parameters/idQueryParam"
},
{
"$ref":"#/components/parameters/name"
},
{
"$ref":"#/components/parameters/description"
},
{
"$ref":"#/components/parameters/version"
},
{
"$ref":"#/components/parameters/lifecycleStatus"
},
{
"$ref":"#/components/parameters/fields"
},
{
"$ref":"#/components/parameters/whereUsed"
},
{
"$ref":"#/components/parameters/validFor.startDateTime"
},
{
"$ref":"#/components/parameters/validFor.endDateTime"
},
{
"$ref":"#/components/parameters/team.id"
},
{
"$ref":"#/components/parameters/lastUpdate"
}
],
"responses":{
"200":{
"description":"The list of projects was returned successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ProjectOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"403":{
"$ref":"#/components/responses/403"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"409":{
"$ref":"#/components/responses/409"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"project-get",
"x-filename-id":"project-get",
"x-export-filter":true
},
"post":{
"operationId":"createProject",
"summary":"Create a project",
"description":"Creates a new project using the supplied request payload and returns the created resource.",
"tags":[
"Projects"
],
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ProjectOracle"
}
}
},
"description":"The request payload for creating a project."
},
"responses":{
"201":{
"description":"Your request is successful and a new resource has been created.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ProjectOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"403":{
"$ref":"#/components/responses/403"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"409":{
"$ref":"#/components/responses/409"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"project-post",
"x-filename-id":"project-post"
}
},
"/project/{id}":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1"
}
],
"get":{
"operationId":"retrieveProject",
"summary":"Get a project",
"description":"This operation retrieves a Project entity. Attribute selection is enabled for all first level attributes.",
"tags":[
"Projects"
],
"parameters":[
{
"$ref":"#/components/parameters/fields"
}
],
"responses":{
"200":{
"description":"The project was returned successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ProjectOracle"
}
}
}
},
"401":{
"$ref":"#/components/responses/401"
},
"403":{
"$ref":"#/components/responses/403"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"409":{
"$ref":"#/components/responses/409"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"project-{id}-get",
"x-filename-id":"project-id-get"
},
"patch":{
"operationId":"patchProject",
"summary":"Update a project",
"description":"Updates the project that matches the specified ID using the supplied request payload.",
"tags":[
"Projects"
],
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ProjectOracle"
}
}
},
"description":"The request payload for updating a project."
},
"responses":{
"200":{
"description":"The project was updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ProjectOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"403":{
"$ref":"#/components/responses/403"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"409":{
"$ref":"#/components/responses/409"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"project-{id}-patch",
"x-filename-id":"project-id-patch"
},
"put":{
"operationId":"putProject",
"summary":"Create or update a project",
"description":"Creates or updates the project with the specified ID.",
"tags":[
"Projects"
],
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ProjectOracle"
}
}
},
"description":"The request payload for creating or updating a project."
},
"responses":{
"200":{
"description":"The project was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ProjectOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"403":{
"$ref":"#/components/responses/403"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"409":{
"$ref":"#/components/responses/409"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"project-{id}-put",
"x-filename-id":"project-id-put"
},
"delete":{
"operationId":"deleteProject",
"summary":"Delete a project",
"description":"Deletes the project that matches the specified ID from the catalog configuration.",
"tags":[
"Projects"
],
"responses":{
"204":{
"$ref":"#/components/responses/204"
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"403":{
"$ref":"#/components/responses/403"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"409":{
"$ref":"#/components/responses/409"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"project-{id}-delete",
"x-filename-id":"project-id-delete"
},
"parameters":[
{
"$ref":"#/components/parameters/id"
}
]
},
"/policyRule":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/policyManagement/v5"
}
],
"get":{
"tags":[
"Policy Rule"
],
"summary":"Get all policy rules",
"operationId":"listPolicyRule",
"parameters":[
{
"$ref":"#/components/parameters/limit"
},
{
"$ref":"#/components/parameters/offset"
},
{
"$ref":"#/components/parameters/idQueryParam"
},
{
"$ref":"#/components/parameters/name"
},
{
"$ref":"#/components/parameters/description"
},
{
"$ref":"#/components/parameters/version"
},
{
"$ref":"#/components/parameters/lifecycleStatus"
},
{
"$ref":"#/components/parameters/fields"
},
{
"$ref":"#/components/parameters/eligibleForProject"
},
{
"$ref":"#/components/parameters/whereUsed"
},
{
"$ref":"#/components/parameters/project.id"
},
{
"$ref":"#/components/parameters/project.version"
},
{
"$ref":"#/components/parameters/validFor.startDateTime"
},
{
"$ref":"#/components/parameters/validFor.endDateTime"
},
{
"$ref":"#/components/parameters/lastUpdate"
}
],
"responses":{
"200":{
"description":"The list of policy rules was returned successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PolicyRuleOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"policyRule-get",
"x-filename-id":"policyrule-get",
"x-export-filter":true,
"description":"Returns a list of policy rules that match the search criteria."
},
"post":{
"tags":[
"Policy Rule"
],
"summary":"Create a policy rule",
"operationId":"createPolicyRule",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PolicyRuleOracle"
}
}
},
"description":"The request payload for creating a policy rule."
},
"responses":{
"201":{
"description":"The policy rule was created successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PolicyRuleOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"policyRule-post",
"x-filename-id":"policyrule-post",
"description":"Creates a new policy rule using the supplied request payload and returns the created resource."
}
},
"/policyRule/{id}":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/policyManagement/v5"
}
],
"parameters":[
{
"$ref":"#/components/parameters/id"
}
],
"get":{
"tags":[
"Policy Rule"
],
"summary":"Get a policy rule",
"operationId":"retrievePolicyRule",
"parameters":[
{
"$ref":"#/components/parameters/fields"
},
{
"$ref":"#/components/parameters/eligibleVersionForProject"
}
],
"responses":{
"200":{
"description":"The policy rule was returned successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PolicyRuleOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"policyRule-{id}-get",
"x-filename-id":"policyrule-id-get",
"description":"Returns the policy rule that matches the specified ID, including its configured details."
},
"patch":{
"tags":[
"Policy Rule"
],
"summary":"Update a policy rule",
"operationId":"patchPolicyRule",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PolicyRuleOracle"
}
}
},
"description":"The request payload for updating a policy rule."
},
"responses":{
"200":{
"description":"The policy rule was updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PolicyRuleOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"policyRule-{id}-patch",
"x-filename-id":"policyrule-id-patch",
"description":"Updates the policy rule that matches the specified ID using the supplied request payload."
},
"put":{
"tags":[
"Policy Rule"
],
"summary":"Create or update a policy rule",
"operationId":"putPolicyRule",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PolicyRuleOracle"
}
}
},
"description":"The request payload for creating or updating a policy rule."
},
"responses":{
"200":{
"description":"The policy rule was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PolicyRuleOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"policyRule-{id}-put",
"x-filename-id":"policyrule-id-put",
"description":"Creates or updates the policy rule with the specified ID."
},
"delete":{
"tags":[
"Policy Rule"
],
"summary":"Delete a policy rule",
"operationId":"deletePolicyRule",
"responses":{
"204":{
"$ref":"#/components/responses/204"
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"policyRule-{id}-delete",
"x-filename-id":"policyrule-id-delete",
"description":"Deletes the policy rule that matches the specified ID from the catalog configuration."
}
},
"/schema":{
"servers":[
{
"description":"The launch REST Server.",
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1"
}
],
"post":{
"tags":[
"Content Management"
],
"summary":"Upload schema file",
"operationId":"createSchema",
"requestBody":{
"content":{
"multipart/form-data":{
"schema":{
"type":"object",
"properties":{
"primaryFile":{
"description":"The file to upload.",
"type":"string"
},
"path":{
"description":"The path of the file to upload.",
"type":"string"
}
},
"required":[
"primaryFile",
"path"
]
}
}
},
"description":"The request payload for uploading a schema file."
},
"responses":{
"201":{
"description":"Your request is successful and a new resource has been created.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/UploadSchemaOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"schema-post",
"x-filename-id":"schema-post",
"description":"Uploads a schema file using the supplied request payload so it can be managed as catalog content."
},
"put":{
"tags":[
"Content Management"
],
"summary":"Create or update a schema file",
"operationId":"putSchema",
"requestBody":{
"content":{
"multipart/form-data":{
"schema":{
"type":"object",
"properties":{
"primaryFile":{
"description":"The file to upload.",
"type":"string"
},
"path":{
"description":"The path of the file to upload.",
"type":"string"
}
},
"required":[
"primaryFile",
"path"
]
}
}
},
"description":"The request payload for creating or updating a schema file."
},
"responses":{
"201":{
"description":"The list of schemas was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/UploadSchemaOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"schema-put",
"x-filename-id":"schema-put",
"description":"Creates or updates one or more schema files using the supplied request payload."
}
},
"/schema/{name}":{
"servers":[
{
"description":"The launch REST Server.",
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1"
}
],
"get":{
"tags":[
"Content Management"
],
"summary":"Download schema file",
"operationId":"retrieveSchema",
"parameters":[
{
"name":"name",
"in":"path",
"description":"The name of the file to download.",
"schema":{
"type":"string"
},
"required":true
},
{
"name":"path",
"in":"query",
"description":"The path of the file to download.",
"schema":{
"type":"string"
},
"required":true
}
],
"responses":{
"200":{
"description":"The list of schemas was returned successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Error"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"schema-{name}-get",
"x-filename-id":"schema-name-get",
"description":"Returns a list of schemas that match the search criteria."
},
"delete":{
"tags":[
"Content Management"
],
"summary":"Delete schema file",
"operationId":"deleteSchema",
"parameters":[
{
"name":"name",
"in":"path",
"description":"The name of the file to download.",
"schema":{
"type":"string"
},
"required":true
},
{
"name":"path",
"in":"query",
"description":"The path of the file to download.",
"schema":{
"type":"string"
},
"required":true
}
],
"responses":{
"204":{
"$ref":"#/components/responses/204"
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"schema-{name}-delete",
"x-filename-id":"schema-name-delete",
"description":"Deletes one or more schema files identified by the request path or query details."
}
},
"/place":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1"
}
],
"get":{
"tags":[
"Places"
],
"summary":"Get all Places",
"operationId":"listPlaces",
"parameters":[
{
"$ref":"#/components/parameters/limit"
},
{
"$ref":"#/components/parameters/offset"
},
{
"$ref":"#/components/parameters/idQueryParam"
},
{
"$ref":"#/components/parameters/name"
},
{
"$ref":"#/components/parameters/description"
},
{
"$ref":"#/components/parameters/lifecycleStatus"
},
{
"$ref":"#/components/parameters/fields"
},
{
"$ref":"#/components/parameters/eligibleForProject"
},
{
"$ref":"#/components/parameters/whereUsed"
},
{
"$ref":"#/components/parameters/project.id"
},
{
"$ref":"#/components/parameters/project.version"
},
{
"$ref":"#/components/parameters/validFor.startDateTime"
},
{
"$ref":"#/components/parameters/validFor.endDateTime"
},
{
"$ref":"#/components/parameters/lastUpdate"
}
],
"responses":{
"200":{
"description":"The list of places was returned successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/PlaceOracle"
}
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"place-get",
"x-filename-id":"place-get",
"x-export-filter":true,
"description":"Returns a list of places that match the search criteria."
},
"post":{
"tags":[
"Places"
],
"summary":"Create a place",
"operationId":"createPlace",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PlaceOracle"
}
}
},
"description":"The request payload for creating a place."
},
"responses":{
"201":{
"description":"Your request is successful and a new resource has been created.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PlaceOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"place-post",
"x-filename-id":"place-post",
"description":"Creates a new place using the supplied request payload and returns the created resource."
}
},
"/place/{id}":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1"
}
],
"parameters":[
{
"$ref":"#/components/parameters/id"
}
],
"get":{
"tags":[
"Places"
],
"summary":"Get a place",
"operationId":"retrievePlace",
"parameters":[
{
"$ref":"#/components/parameters/fields"
}
],
"responses":{
"200":{
"description":"The place was returned successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PlaceOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"place-{id}-get",
"x-filename-id":"place-id-get",
"description":"Returns the place that matches the specified ID, including its configured details."
},
"put":{
"tags":[
"Places"
],
"summary":"Create or update a place",
"operationId":"putPlace",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PlaceOracle"
}
}
},
"description":"The request payload for creating or updating a place."
},
"responses":{
"200":{
"description":"The place was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PlaceOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"place-{id}-put",
"x-filename-id":"place-id-put",
"description":"Creates or updates the place with the specified ID."
},
"patch":{
"tags":[
"Places"
],
"summary":"Update a place",
"operationId":"patchPlace",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PlaceOracle"
}
}
},
"description":"The request payload for updating a place."
},
"responses":{
"200":{
"description":"The place was updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PlaceOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"place-{id}-patch",
"x-filename-id":"place-id-patch",
"description":"Updates the place that matches the specified ID using the supplied request payload."
},
"delete":{
"tags":[
"Places"
],
"summary":"Delete a place",
"operationId":"deletePlace",
"parameters":[
{
"$ref":"#/components/parameters/id"
}
],
"responses":{
"204":{
"$ref":"#/components/responses/204"
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"place-{id}-delete",
"x-filename-id":"place-id-delete",
"description":"Deletes the place that matches the specified ID from the catalog configuration."
}
},
"/marketSegment":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1"
}
],
"get":{
"tags":[
"MarketSegments"
],
"summary":"Get all market segments",
"operationId":"listMarketSegments",
"parameters":[
{
"$ref":"#/components/parameters/limit"
},
{
"$ref":"#/components/parameters/offset"
},
{
"$ref":"#/components/parameters/idQueryParam"
},
{
"$ref":"#/components/parameters/name"
},
{
"$ref":"#/components/parameters/description"
},
{
"$ref":"#/components/parameters/lifecycleStatus"
},
{
"$ref":"#/components/parameters/fields"
},
{
"$ref":"#/components/parameters/eligibleForProject"
},
{
"$ref":"#/components/parameters/whereUsed"
},
{
"$ref":"#/components/parameters/project.id"
},
{
"$ref":"#/components/parameters/project.version"
},
{
"$ref":"#/components/parameters/validFor.startDateTime"
},
{
"$ref":"#/components/parameters/validFor.endDateTime"
},
{
"$ref":"#/components/parameters/lastUpdate"
}
],
"responses":{
"200":{
"description":"The list of market segments was returned successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/MarketSegmentOracle"
}
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"marketSegment-get",
"x-filename-id":"marketsegment-get",
"x-export-filter":true,
"description":"Returns a list of market segments that match the search criteria."
},
"post":{
"tags":[
"MarketSegments"
],
"summary":"Create a market segment",
"operationId":"createMarketSegment",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/MarketSegmentOracle"
}
}
},
"description":"The request payload for creating a market segment."
},
"responses":{
"201":{
"description":"The market segment was created successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/MarketSegmentOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"marketSegment-post",
"x-filename-id":"marketsegment-post",
"description":"Creates a new market segment using the supplied request payload and returns the created resource."
}
},
"/marketSegment/{id}":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1"
}
],
"parameters":[
{
"$ref":"#/components/parameters/id"
}
],
"get":{
"tags":[
"MarketSegments"
],
"summary":"Get a market segment",
"operationId":"retrieveMarketSegment",
"parameters":[
{
"$ref":"#/components/parameters/fields"
}
],
"responses":{
"200":{
"description":"The market segment was returned successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/MarketSegmentOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"marketSegment-{id}-get",
"x-filename-id":"marketsegment-id-get",
"description":"Returns the market segment that matches the specified ID, including its configured details."
},
"put":{
"tags":[
"MarketSegments"
],
"summary":"Create or update a market segment",
"operationId":"putMarketSegment",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/MarketSegmentOracle"
}
}
},
"description":"The request payload for creating or updating a market segment."
},
"responses":{
"200":{
"description":"The market segment was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/MarketSegmentOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"marketSegment-{id}-put",
"x-filename-id":"marketsegment-id-put",
"description":"Creates or updates the market segment with the specified ID."
},
"patch":{
"tags":[
"MarketSegments"
],
"summary":"Update a market segment",
"operationId":"patchMarketSegment",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/MarketSegmentOracle"
}
}
},
"description":"The request payload for updating a market segment."
},
"responses":{
"200":{
"description":"The market segment was updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/MarketSegmentOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"marketSegment-{id}-patch",
"x-filename-id":"marketsegment-id-patch",
"description":"Updates the market segment that matches the specified ID using the supplied request payload."
},
"delete":{
"tags":[
"MarketSegments"
],
"summary":"Delete a market segment",
"operationId":"deleteMarketSegment",
"parameters":[
{
"$ref":"#/components/parameters/id"
}
],
"responses":{
"204":{
"$ref":"#/components/responses/204"
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"marketSegment-{id}-delete",
"x-filename-id":"marketsegment-id-delete",
"description":"Deletes the market segment that matches the specified ID from the catalog configuration."
}
},
"/priceTag":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1"
}
],
"get":{
"tags":[
"Price Tags"
],
"summary":"Get all PriceTags",
"operationId":"listPriceTags",
"parameters":[
{
"$ref":"#/components/parameters/limit"
},
{
"$ref":"#/components/parameters/offset"
},
{
"$ref":"#/components/parameters/idQueryParam"
},
{
"$ref":"#/components/parameters/name"
},
{
"$ref":"#/components/parameters/description"
},
{
"$ref":"#/components/parameters/lifecycleStatus"
},
{
"$ref":"#/components/parameters/fields"
},
{
"$ref":"#/components/parameters/eligibleForProject"
},
{
"$ref":"#/components/parameters/whereUsed"
},
{
"$ref":"#/components/parameters/priceTagRules.productType"
},
{
"$ref":"#/components/parameters/priceTagRules.unitOfMeasure"
},
{
"$ref":"#/components/parameters/priceTagRules.balanceElementCode"
},
{
"$ref":"#/components/parameters/priceTagRules.serviceSpecification.id"
},
{
"$ref":"#/components/parameters/project.id"
},
{
"$ref":"#/components/parameters/project.version"
},
{
"$ref":"#/components/parameters/validFor.startDateTime"
},
{
"$ref":"#/components/parameters/validFor.endDateTime"
},
{
"$ref":"#/components/parameters/lastUpdate"
}
],
"responses":{
"200":{
"description":"The list of price tags was returned successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/PriceTagOracle"
}
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-export-filter":true,
"description":"Returns a list of price tags that match the search criteria.",
"x-internal-id":"priceTag-get",
"x-filename-id":"pricetag-get"
},
"post":{
"tags":[
"Price Tags"
],
"summary":"Create a price tag",
"operationId":"createPriceTag",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PriceTagOracle"
}
}
},
"description":"The request payload for creating a price tag."
},
"responses":{
"201":{
"description":"The price tag was created successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PriceTagOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Creates a new price tag using the supplied request payload and returns the created resource.",
"x-internal-id":"priceTag-post",
"x-filename-id":"pricetag-post"
}
},
"/priceTag/{id}":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1"
}
],
"parameters":[
{
"$ref":"#/components/parameters/id"
}
],
"get":{
"tags":[
"Price Tags"
],
"summary":"Get a price tag",
"operationId":"retrievePriceTag",
"parameters":[
{
"$ref":"#/components/parameters/fields"
}
],
"responses":{
"200":{
"description":"The price tag was returned successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PriceTagOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Returns the price tag that matches the specified ID, including its configured details.",
"x-internal-id":"priceTag-{id}-get",
"x-filename-id":"pricetag-id-get"
},
"put":{
"tags":[
"Price Tags"
],
"summary":"Create or update a price tag",
"operationId":"putPriceTag",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PriceTagOracle"
}
}
},
"description":"The request payload for creating or updating a price tag."
},
"responses":{
"200":{
"description":"The price tag was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PriceTagOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Creates or updates the price tag with the specified ID.",
"x-internal-id":"priceTag-{id}-put",
"x-filename-id":"pricetag-id-put"
},
"patch":{
"tags":[
"Price Tags"
],
"summary":"Update a price tag",
"operationId":"patchPriceTag",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PriceTagOracle"
}
}
},
"description":"The request payload for updating a price tag."
},
"responses":{
"200":{
"description":"The price tag was updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PriceTagOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Updates the price tag that matches the specified ID using the supplied request payload.",
"x-internal-id":"priceTag-{id}-patch",
"x-filename-id":"pricetag-id-patch"
},
"delete":{
"tags":[
"Price Tags"
],
"summary":"Delete a price tag",
"operationId":"deletePriceTag",
"parameters":[
{
"$ref":"#/components/parameters/id"
}
],
"responses":{
"204":{
"$ref":"#/components/responses/204"
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Deletes the price tag that matches the specified ID from the catalog configuration.",
"x-internal-id":"priceTag-{id}-delete",
"x-filename-id":"pricetag-id-delete"
}
},
"/entitlement":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1"
}
],
"get":{
"tags":[
"Entitlements"
],
"summary":"Get all entitlements",
"operationId":"listEntitlements",
"parameters":[
{
"$ref":"#/components/parameters/limit"
},
{
"$ref":"#/components/parameters/offset"
},
{
"$ref":"#/components/parameters/idQueryParam"
},
{
"$ref":"#/components/parameters/name"
},
{
"$ref":"#/components/parameters/description"
},
{
"$ref":"#/components/parameters/lifecycleStatus"
},
{
"$ref":"#/components/parameters/fields"
},
{
"$ref":"#/components/parameters/project.id"
},
{
"$ref":"#/components/parameters/project.version"
},
{
"$ref":"#/components/parameters/validFor.startDateTime"
},
{
"$ref":"#/components/parameters/validFor.endDateTime"
},
{
"$ref":"#/components/parameters/lastUpdate"
}
],
"responses":{
"200":{
"description":"The list of entitlements was returned successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/EntitlementOracle"
}
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-export-filter":true,
"description":"Returns a list of entitlements that match the search criteria.",
"x-internal-id":"entitlement-get",
"x-filename-id":"entitlement-get"
},
"post":{
"tags":[
"Entitlements"
],
"summary":"Create an entitlement",
"operationId":"createEntitlement",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/EntitlementOracle"
}
}
},
"description":"The request payload for creating an entitlement."
},
"responses":{
"201":{
"description":"The entitlement was created successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/EntitlementOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Creates a new entitlement using the supplied request payload and returns the created resource.",
"x-internal-id":"entitlement-post",
"x-filename-id":"entitlement-post"
}
},
"/entitlement/{id}":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1"
}
],
"parameters":[
{
"$ref":"#/components/parameters/id"
}
],
"get":{
"tags":[
"Entitlements"
],
"summary":"Get an entitlement",
"operationId":"retrieveEntitlement",
"parameters":[
{
"$ref":"#/components/parameters/fields"
}
],
"responses":{
"200":{
"description":"The entitlement was returned successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/EntitlementOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Returns the n entitlement that matches the specified ID, including its configured details.",
"x-internal-id":"entitlement-{id}-get",
"x-filename-id":"entitlement-id-get"
},
"put":{
"tags":[
"Entitlements"
],
"summary":"Create or update an entitlement",
"operationId":"putEntitlement",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/EntitlementOracle"
}
}
},
"description":"The request payload for creating or updating an entitlement."
},
"responses":{
"200":{
"description":"The entitlement was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/EntitlementOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Creates or updates the entitlement with the specified ID.",
"x-internal-id":"entitlement-{id}-put",
"x-filename-id":"entitlement-id-put"
},
"patch":{
"tags":[
"Entitlements"
],
"summary":"Update an entitlement",
"operationId":"patchEntitlement",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/EntitlementOracle"
}
}
},
"description":"The request payload for updating an entitlement."
},
"responses":{
"200":{
"description":"The entitlement was updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/EntitlementOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Updates the n entitlement that matches the specified ID using the supplied request payload.",
"x-internal-id":"entitlement-{id}-patch",
"x-filename-id":"entitlement-id-patch"
},
"delete":{
"tags":[
"Entitlements"
],
"summary":"Delete an entitlement",
"operationId":"deleteEntitlement",
"responses":{
"204":{
"$ref":"#/components/responses/204"
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Deletes the n entitlement that matches the specified ID from the catalog configuration.",
"x-internal-id":"entitlement-{id}-delete",
"x-filename-id":"entitlement-id-delete"
}
},
"/publishingAcknowledgement":{
"servers":[
{
"url":"http://{PublishServerHost}/api/productCatalogManagement/v1/"
}
],
"post":{
"operationId":"publishingAcknowledgement",
"summary":"Create a publishing acknowledgement",
"description":"Receives the acknowledgment from spoke system and update the publishing status corresponding to the spoke system.",
"tags":[
"Publishing Acknowledgements"
],
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PublishingAcknowledgement"
}
}
},
"description":"The request payload for creating a publishing acknowledgement."
},
"responses":{
"201":{
"description":"The publishing acknowledgement was created successfully."
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"409":{
"$ref":"#/components/responses/409"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"publishingAcknowledgement-post",
"x-filename-id":"publishingacknowledgement-post"
}
},
"/projectPublishEvent":{
"servers":[
{
"url":"http://{PublishServerHost}/api/productCatalogManagement/v1/"
}
],
"post":{
"operationId":"listenToProjectPublishEvent",
"summary":"Create a project publish event",
"description":"Example of a client listener for receiving the notification ProjectPublishEvent.",
"tags":[
"Notification Listeners"
],
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ProjectPublishEvent"
}
}
},
"description":"The request payload for creating a project publish event."
},
"responses":{
"201":{
"description":"The project publish event was created successfully."
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"409":{
"$ref":"#/components/responses/409"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"projectPublishEvent-post",
"x-filename-id":"projectpublishevent-post"
}
},
"/publishJob":{
"servers":[
{
"url":"http://{PublishServerHost}/api/productCatalogManagement/v1/"
}
],
"post":{
"operationId":"publishJob",
"summary":"Create a publish job",
"description":"Creates a publish job using the supplied request payload and starts the publication process.",
"tags":[
"Publish Jobs"
],
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PublishJob_Create"
}
}
},
"description":"The request payload for creating a publish job."
},
"responses":{
"201":{
"description":"The publish job was created successfully."
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"409":{
"$ref":"#/components/responses/409"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"publishJob-post",
"x-filename-id":"publishjob-post"
}
},
"/importJob":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5"
}
],
"post":{
"tags":[
"Import Jobs"
],
"summary":"Create an import job",
"description":"Creates an import job using the supplied request payload and starts the import process.",
"operationId":"createImportJob",
"responses":{
"201":{
"$ref":"#/components/responses/importjob-post-response"
},
"400":{
"$ref":"#/components/responses/400"
}
},
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/importjob-post-request"
}
}
},
"description":"The request payload for creating an import job."
},
"x-internal-id":"importJob-post",
"x-filename-id":"importjob-post"
},
"get":{
"tags":[
"Import Jobs"
],
"summary":"Get all import job",
"description":"Returns a list of import jobs that match the search criteria.",
"operationId":"listImportJob",
"parameters":[
{
"$ref":"#/components/parameters/limit"
},
{
"$ref":"#/components/parameters/offset"
},
{
"$ref":"#/components/parameters/idQueryParam"
},
{
"$ref":"#/components/parameters/fileName"
},
{
"$ref":"#/components/parameters/createdBy"
},
{
"$ref":"#/components/parameters/fields"
}
],
"responses":{
"200":{
"description":"The list of import jobs was returned successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ImportJobOracle"
}
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"500":{
"$ref":"#/components/responses/500"
},
"501":{
"$ref":"#/components/responses/501"
}
},
"x-internal-id":"importJob-get",
"x-filename-id":"importjob-get"
}
},
"/importJob/{id}":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5"
}
],
"get":{
"tags":[
"Import Jobs"
],
"summary":"Get an import job",
"description":"Returns the import job that matches the specified ID, including its current status and details.",
"operationId":"retrieveImportJob",
"parameters":[
{
"$ref":"#/components/parameters/id"
},
{
"$ref":"#/components/parameters/fields"
}
],
"responses":{
"200":{
"description":"The import job was returned successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ImportJobOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"500":{
"$ref":"#/components/responses/500"
},
"501":{
"$ref":"#/components/responses/501"
}
},
"x-internal-id":"importJob-{id}-get",
"x-filename-id":"importjob-id-get"
}
},
"/exportJob":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5"
}
],
"get":{
"tags":[
"Export Job"
],
"summary":"Get all export jobs",
"description":"Returns a list of export jobs that match the search criteria.",
"operationId":"listExportJob",
"parameters":[
{
"$ref":"#/components/parameters/limit"
},
{
"$ref":"#/components/parameters/offset"
},
{
"$ref":"#/components/parameters/idQueryParam"
},
{
"$ref":"#/components/parameters/createdBy"
},
{
"$ref":"#/components/parameters/filenamePrefix"
},
{
"$ref":"#/components/parameters/fields"
}
],
"responses":{
"200":{
"description":"The list of export jobs was returned successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ExportJobOracle"
}
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"500":{
"$ref":"#/components/responses/500"
},
"501":{
"$ref":"#/components/responses/501"
}
},
"x-internal-id":"exportJob-get",
"x-filename-id":"exportjob-get"
},
"post":{
"tags":[
"Export Job"
],
"summary":"Create an export job",
"description":"Creates an export job using the supplied request payload and starts the export process.",
"operationId":"createExportJob",
"responses":{
"201":{
"description":"The export job was created successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ExportJobOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ExportJobOracle"
}
}
},
"description":"The request payload for creating an export job."
},
"x-internal-id":"exportJob-post",
"x-filename-id":"exportjob-post"
}
},
"/exportJob/{id}":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5"
}
],
"parameters":[
{
"$ref":"#/components/parameters/id"
}
],
"get":{
"tags":[
"Export Job"
],
"summary":"Get an export job",
"description":"Returns the export job that matches the specified ID, including its current status and details.",
"operationId":"retrieveExportJob",
"parameters":[
{
"$ref":"#/components/parameters/fields"
}
],
"responses":{
"200":{
"description":"The export job was returned successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ExportJobOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"500":{
"$ref":"#/components/responses/500"
},
"501":{
"$ref":"#/components/responses/501"
}
},
"x-internal-id":"exportJob-{id}-get",
"x-filename-id":"exportjob-id-get"
},
"put":{
"tags":[
"Export Job"
],
"summary":"Create or update an export job",
"description":"Creates or updates the export job with the specified ID.",
"operationId":"putExportJob",
"responses":{
"200":{
"description":"The export job was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ExportJobOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ExportJobOracle"
}
}
},
"description":"The request payload for updating an export job."
},
"x-internal-id":"exportJob-{id}-put",
"x-filename-id":"exportjob-id-put"
},
"patch":{
"tags":[
"Export Job"
],
"summary":"Update an export job",
"description":"Updates the export job that matches the specified ID using the supplied request payload.",
"operationId":"patchExportJob",
"responses":{
"200":{
"description":"The export job was updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ExportJobOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ExportJobOracle"
}
}
},
"description":"The request payload for patching an export job."
},
"x-internal-id":"exportJob-{id}-patch",
"x-filename-id":"exportjob-id-patch"
}
},
"/serviceSpecification":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/serviceCatalogManagement/v3"
}
],
"get":{
"tags":[
"Service Specification"
],
"summary":"Get all service specifications",
"operationId":"listServiceSpecification",
"parameters":[
{
"$ref":"#/components/parameters/limit"
},
{
"$ref":"#/components/parameters/offset"
},
{
"$ref":"#/components/parameters/idQueryParam"
},
{
"$ref":"#/components/parameters/name"
},
{
"$ref":"#/components/parameters/description"
},
{
"$ref":"#/components/parameters/version"
},
{
"$ref":"#/components/parameters/lifecycleStatus"
},
{
"$ref":"#/components/parameters/fields"
},
{
"$ref":"#/components/parameters/eligibleForProject"
},
{
"$ref":"#/components/parameters/whereUsed"
},
{
"$ref":"#/components/parameters/project.id"
},
{
"$ref":"#/components/parameters/project.version"
},
{
"$ref":"#/components/parameters/validFor.startDateTime"
},
{
"$ref":"#/components/parameters/validFor.endDateTime"
},
{
"$ref":"#/components/parameters/lastUpdate"
}
],
"responses":{
"200":{
"description":"The list of service specifications was returned successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ServiceSpecificationOracle"
}
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"serviceSpecification-get",
"x-filename-id":"servicespecification-get",
"x-export-filter":true,
"description":"Returns a list of service specifications that match the search criteria."
},
"post":{
"tags":[
"Service Specification"
],
"summary":"Create a service specification",
"operationId":"createServiceSpecification",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ServiceSpecificationOracle"
}
}
},
"description":"The request payload for creating a service specification."
},
"responses":{
"201":{
"description":"The service specification was created successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ServiceSpecificationOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"serviceSpecification-post",
"x-filename-id":"servicespecification-post",
"description":"Creates a new service specification using the supplied request payload and returns the created resource."
}
},
"/serviceSpecification/{id}":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/serviceCatalogManagement/v3"
}
],
"get":{
"tags":[
"Service Specification"
],
"summary":"Get a service specification",
"operationId":"retrieveServiceSpecification",
"parameters":[
{
"$ref":"#/components/parameters/id"
},
{
"$ref":"#/components/parameters/fields"
},
{
"$ref":"#/components/parameters/eligibleVersionForProject"
}
],
"responses":{
"200":{
"description":"The service specification was returned successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ServiceSpecificationOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"serviceSpecification-{id}-get",
"x-filename-id":"servicespecification-id-get",
"description":"Returns the service specification that matches the specified ID, including its configured details."
},
"patch":{
"tags":[
"Service Specification"
],
"summary":"Update a service specification",
"operationId":"patchServiceSpecification",
"parameters":[
{
"$ref":"#/components/parameters/id"
}
],
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ServiceSpecificationOracle"
}
}
},
"description":"The request payload for updating a service specification."
},
"responses":{
"200":{
"description":"The service specification was updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ServiceSpecificationOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"serviceSpecification-{id}-patch",
"x-filename-id":"servicespecification-id-patch",
"description":"Updates the service specification that matches the specified ID using the supplied request payload."
},
"put":{
"tags":[
"Service Specification"
],
"summary":"Create or update a service specification",
"operationId":"putServiceSpecification",
"parameters":[
{
"$ref":"#/components/parameters/id"
}
],
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ServiceSpecificationOracle"
}
}
},
"description":"The request payload for creating or updating a service specification."
},
"responses":{
"200":{
"description":"The service specification was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ServiceSpecificationOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"serviceSpecification-{id}-put",
"x-filename-id":"servicespecification-id-put",
"description":"Creates or updates the service specification with the specified ID."
},
"delete":{
"tags":[
"Service Specification"
],
"summary":"Delete a service specification",
"operationId":"deleteServiceSpecification",
"parameters":[
{
"$ref":"#/components/parameters/id"
}
],
"responses":{
"204":{
"$ref":"#/components/responses/204"
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"serviceSpecification-{id}-delete",
"x-filename-id":"servicespecification-id-delete",
"description":"Deletes the service specification that matches the specified ID from the catalog configuration."
}
},
"/usageSpecification":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/usageManagement/v2"
}
],
"get":{
"tags":[
"Usage Specification"
],
"summary":"Get all usage specifications",
"operationId":"listUsageSpecification",
"parameters":[
{
"$ref":"#/components/parameters/limit"
},
{
"$ref":"#/components/parameters/offset"
},
{
"$ref":"#/components/parameters/idQueryParam"
},
{
"$ref":"#/components/parameters/name"
},
{
"$ref":"#/components/parameters/description"
},
{
"$ref":"#/components/parameters/version"
},
{
"$ref":"#/components/parameters/lifecycleStatus"
},
{
"$ref":"#/components/parameters/fields"
},
{
"$ref":"#/components/parameters/eligibleForProject"
},
{
"$ref":"#/components/parameters/whereUsed"
},
{
"$ref":"#/components/parameters/project.id"
},
{
"$ref":"#/components/parameters/project.version"
},
{
"$ref":"#/components/parameters/validFor.startDateTime"
},
{
"$ref":"#/components/parameters/validFor.endDateTime"
},
{
"$ref":"#/components/parameters/lastUpdate"
}
],
"responses":{
"200":{
"description":"The list of usage specifications was returned successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/UsageSpecificationOracle"
}
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"usageSpecification-get",
"x-filename-id":"usagespecification-get",
"x-export-filter":true,
"description":"Returns a list of usage specifications that match the search criteria."
},
"post":{
"tags":[
"Usage Specification"
],
"summary":"Create a usage specification",
"operationId":"createUsageSpecification",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/UsageSpecificationOracle"
}
}
},
"description":"The request payload for creating a usage specification."
},
"responses":{
"201":{
"description":"The usage specification was created successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/UsageSpecificationOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"usageSpecification-post",
"x-filename-id":"usagespecification-post",
"description":"Creates a new usage specification using the supplied request payload and returns the created resource."
}
},
"/usageSpecification/{id}":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/usageManagement/v2"
}
],
"parameters":[
{
"$ref":"#/components/parameters/id"
}
],
"get":{
"tags":[
"Usage Specification"
],
"summary":"Get a usage specification",
"operationId":"retrieveUsageSpecification",
"parameters":[
{
"$ref":"#/components/parameters/fields"
},
{
"$ref":"#/components/parameters/eligibleVersionForProject"
}
],
"responses":{
"200":{
"description":"The usage specification was returned successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/UsageSpecificationOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"usageSpecification-{id}-get",
"x-filename-id":"usagespecification-id-get",
"description":"Returns the usage specification that matches the specified ID, including its configured details."
},
"patch":{
"tags":[
"Usage Specification"
],
"summary":"Update a usage specification",
"operationId":"patchUsageSpecification",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/UsageSpecificationOracle"
}
}
},
"description":"The request payload for updating a usage specification."
},
"responses":{
"200":{
"description":"The usage specification was updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/UsageSpecificationOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"usageSpecification-{id}-patch",
"x-filename-id":"usagespecification-id-patch",
"description":"Updates the usage specification that matches the specified ID using the supplied request payload."
},
"put":{
"tags":[
"Usage Specification"
],
"summary":"Create or update a usage specification",
"operationId":"putUsageSpecification",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/UsageSpecificationOracle"
}
}
},
"description":"The request payload for creating or updating a usage specification."
},
"responses":{
"200":{
"description":"The usage specification was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/UsageSpecificationOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"usageSpecification-{id}-put",
"x-filename-id":"usagespecification-id-put",
"description":"Creates or updates the usage specification with the specified ID."
},
"delete":{
"tags":[
"Usage Specification"
],
"summary":"Delete a usage specification",
"operationId":"deleteUsageSpecification",
"responses":{
"204":{
"$ref":"#/components/responses/204"
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"usageSpecification-{id}-delete",
"x-filename-id":"usagespecification-id-delete",
"description":"Deletes the usage specification that matches the specified ID from the catalog configuration."
}
},
"/taxServiceProvider":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1"
}
],
"get":{
"tags":[
"Tax Service Provider"
],
"summary":"Get all tax service providers",
"operationId":"listTaxServiceProvider",
"parameters":[
{
"$ref":"#/components/parameters/limit"
},
{
"$ref":"#/components/parameters/offset"
},
{
"$ref":"#/components/parameters/idQueryParam"
},
{
"$ref":"#/components/parameters/name"
},
{
"$ref":"#/components/parameters/description"
},
{
"$ref":"#/components/parameters/fields"
},
{
"$ref":"#/components/parameters/taxCodes.taxCode"
},
{
"$ref":"#/components/parameters/eligibleForProject"
},
{
"$ref":"#/components/parameters/project.id"
},
{
"$ref":"#/components/parameters/project.version"
},
{
"$ref":"#/components/parameters/validFor.startDateTime"
},
{
"$ref":"#/components/parameters/validFor.endDateTime"
},
{
"$ref":"#/components/parameters/version"
},
{
"$ref":"#/components/parameters/lifecycleStatus"
},
{
"$ref":"#/components/parameters/lastUpdate"
}
],
"responses":{
"200":{
"description":"The list of tax service providers was returned successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/TaxServiceProviderOracle"
}
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"taxServiceProvider-get",
"x-filename-id":"taxserviceprovider-get",
"x-export-filter":true,
"description":"Returns a list of tax service providers that match the search criteria."
},
"post":{
"tags":[
"Tax Service Provider"
],
"summary":"Create a tax service provider",
"operationId":"createTaxServiceProvider",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/TaxServiceProviderOracle"
}
}
},
"description":"The request payload for creating a tax service provider."
},
"responses":{
"201":{
"description":"The tax service provider was created successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/TaxServiceProviderOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"taxServiceProvider-post",
"x-filename-id":"taxserviceprovider-post",
"description":"Creates a new tax service provider using the supplied request payload and returns the created resource."
}
},
"/taxServiceProvider/{id}":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1"
}
],
"parameters":[
{
"$ref":"#/components/parameters/id"
}
],
"get":{
"tags":[
"Tax Service Provider"
],
"summary":"Get a tax service provider",
"operationId":"retrieveTaxServiceProvider",
"parameters":[
{
"$ref":"#/components/parameters/fields"
},
{
"$ref":"#/components/parameters/eligibleVersionForProject"
}
],
"responses":{
"200":{
"description":"The tax service provider was returned successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/TaxServiceProviderOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"taxServiceProvider-{id}-get",
"x-filename-id":"taxserviceprovider-id-get",
"description":"Returns the tax service provider with the specified ID."
},
"patch":{
"tags":[
"Tax Service Provider"
],
"summary":"Update a tax service provider",
"operationId":"patchTaxServiceProvider",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/TaxServiceProviderOracle"
}
}
},
"description":"The request payload for updating a tax service provider."
},
"responses":{
"200":{
"description":"The tax service provider was updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/TaxServiceProviderOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"taxServiceProvider-{id}-patch",
"x-filename-id":"taxserviceprovider-id-patch",
"description":"Updates the tax service provider with the specified ID."
},
"put":{
"tags":[
"Tax Service Provider"
],
"summary":"Create or update a tax service provider",
"operationId":"putTaxServiceProvider",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/TaxServiceProviderOracle"
}
}
},
"description":"The request payload for creating or updating a tax service provider."
},
"responses":{
"200":{
"description":"The tax service provider was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/TaxServiceProviderOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"taxServiceProvider-{id}-put",
"x-filename-id":"taxserviceprovider-id-put",
"description":"Creates or updates the tax service provider with the specified ID."
},
"delete":{
"tags":[
"Tax Service Provider"
],
"summary":"Delete a tax service provider",
"operationId":"deleteTaxServiceProvider",
"responses":{
"204":{
"$ref":"#/components/responses/204"
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"taxServiceProvider-{id}-delete",
"x-filename-id":"taxserviceprovider-id-delete",
"description":"Deletes the tax service provider with the specified ID."
}
},
"/customerProfileSpecification":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1"
}
],
"get":{
"tags":[
"Customer Profile Specification"
],
"summary":"Get all customer profile specifications",
"operationId":"listCustomerProfileSpecification",
"parameters":[
{
"$ref":"#/components/parameters/limit"
},
{
"$ref":"#/components/parameters/offset"
},
{
"$ref":"#/components/parameters/idQueryParam"
},
{
"$ref":"#/components/parameters/name"
},
{
"$ref":"#/components/parameters/description"
},
{
"$ref":"#/components/parameters/version"
},
{
"$ref":"#/components/parameters/lifecycleStatus"
},
{
"$ref":"#/components/parameters/fields"
},
{
"$ref":"#/components/parameters/profileType"
},
{
"$ref":"#/components/parameters/eligibleForProject"
},
{
"$ref":"#/components/parameters/project.id"
},
{
"$ref":"#/components/parameters/project.version"
},
{
"$ref":"#/components/parameters/validFor.startDateTime"
},
{
"$ref":"#/components/parameters/validFor.endDateTime"
},
{
"$ref":"#/components/parameters/lastUpdate"
}
],
"responses":{
"200":{
"description":"The list of customer profile specifications was returned successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CustomerProfileSpecificationOracle"
}
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"customerProfileSpecification-get",
"x-filename-id":"customerprofilespecification-get",
"x-export-filter":true,
"description":"Returns a list of customer profile specifications that match the search criteria."
},
"post":{
"tags":[
"Customer Profile Specification"
],
"summary":"Create a customer profile specification",
"operationId":"createCustomerProfileSpecification",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/CustomerProfileSpecificationOracle"
}
}
},
"description":"The request payload for creating a customer profile specification."
},
"responses":{
"201":{
"description":"The customer profile specification was created successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CustomerProfileSpecificationOracle"
}
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"customerProfileSpecification-post",
"x-filename-id":"customerprofilespecification-post",
"description":"Creates a new customer profile specification using the supplied request payload and returns the created resource."
}
},
"/customerProfileSpecification/{id}":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1"
}
],
"get":{
"tags":[
"Customer Profile Specification"
],
"summary":"Get a customer profile specification",
"operationId":"retrieveCustomerProfileSpecification",
"parameters":[
{
"$ref":"#/components/parameters/id"
},
{
"$ref":"#/components/parameters/fields"
},
{
"$ref":"#/components/parameters/eligibleVersionForProject"
}
],
"responses":{
"200":{
"description":"The customer profile specification was returned successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/CustomerProfileSpecificationOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"customerProfileSpecification-{id}-get",
"x-filename-id":"customerprofilespecification-id-get",
"description":"Returns the customer profile specification with the specified ID."
},
"patch":{
"tags":[
"Customer Profile Specification"
],
"summary":"Update a customer profile specification",
"operationId":"patchCustomerProfileSpecification",
"parameters":[
{
"$ref":"#/components/parameters/id"
}
],
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/CustomerProfileSpecificationOracle"
}
}
},
"description":"The request payload for updating a customer profile specification."
},
"responses":{
"200":{
"description":"The customer profile specification was updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/CustomerProfileSpecificationOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"customerProfileSpecification-{id}-patch",
"x-filename-id":"customerprofilespecification-id-patch",
"description":"Updates the customer profile specification with the specified ID."
},
"put":{
"tags":[
"Customer Profile Specification"
],
"summary":"Create or update a customer profile specification",
"operationId":"putCustomerProfileSpecification",
"parameters":[
{
"$ref":"#/components/parameters/id"
}
],
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/CustomerProfileSpecificationOracle"
}
}
},
"description":"The request payload for creating or updating a customer profile specification."
},
"responses":{
"200":{
"description":"The customer profile specification was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/CustomerProfileSpecificationOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"customerProfileSpecification-{id}-put",
"x-filename-id":"customerprofilespecification-id-put",
"description":"Creates or updates the customer profile specification with the specified ID."
},
"delete":{
"tags":[
"Customer Profile Specification"
],
"summary":"Delete a customer profile specification",
"operationId":"deleteCustomerProfileSpecification",
"parameters":[
{
"$ref":"#/components/parameters/id"
}
],
"responses":{
"204":{
"$ref":"#/components/responses/204"
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"customerProfileSpecification-{id}-delete",
"x-filename-id":"customerprofilespecification-id-delete",
"description":"Deletes the customer profile specification with the specified ID."
}
},
"/publishDestination":{
"servers":[
{
"description":"The aDF REST Server.",
"url":"https://{FusionAppsHost}/crmRestApi/resources/11.13.18.05/PublishingAPI/"
}
],
"get":{
"tags":[
"Destinations"
],
"summary":"Get all destinations",
"operationId":"listPublishDestination",
"parameters":[
{
"$ref":"#/components/parameters/limit"
},
{
"$ref":"#/components/parameters/offset"
},
{
"$ref":"#/components/parameters/name"
}
],
"responses":{
"200":{
"description":"The list of publish destinations was returned successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/PublishDestinationOracle"
}
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"publishDestination-get",
"x-filename-id":"publishdestination-get",
"x-export-filter":true,
"description":"Returns a list of publish destinations that match the search criteria."
},
"post":{
"tags":[
"Destinations"
],
"summary":"Create a destination",
"operationId":"createPublishDestination",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PublishDestinationOracle"
}
}
},
"description":"The request payload for creating a destination."
},
"responses":{
"201":{
"description":"The publish destination was created successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PublishDestinationOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"publishDestination-post",
"x-filename-id":"publishdestination-post",
"description":"Creates a new destination using the supplied request payload and returns the created resource."
}
},
"/publishDestination/{id}":{
"servers":[
{
"description":"The aDF REST Server.",
"url":"https://{FusionAppsHost}/crmRestApi/resources/11.13.18.05/PublishingAPI/"
}
],
"parameters":[
{
"$ref":"#/components/parameters/id"
}
],
"get":{
"tags":[
"Destinations"
],
"summary":"Get a destination",
"operationId":"retrievePublishDestination",
"responses":{
"200":{
"description":"The publish destination was returned successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PublishDestinationOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"publishDestination-{id}-get",
"x-filename-id":"publishdestination-id-get",
"description":"Returns the destination that matches the specified ID, including its configured details."
},
"patch":{
"tags":[
"Destinations"
],
"summary":"Update a destination",
"operationId":"patchDestination",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PublishDestinationOracle"
}
}
},
"description":"The request payload for updating a destination."
},
"responses":{
"200":{
"description":"The publish destination was updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PublishDestinationOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"publishDestination-{id}-patch",
"x-filename-id":"publishdestination-id-patch",
"description":"Updates the destination that matches the specified ID using the supplied request payload."
},
"put":{
"tags":[
"Destinations"
],
"summary":"Create or update a destination",
"operationId":"putPublishDestination",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PublishDestinationOracle"
}
}
},
"description":"The request payload for creating or updating a destination."
},
"responses":{
"200":{
"description":"The publish destination was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PublishDestinationOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"publishDestination-{id}-put",
"x-filename-id":"publishdestination-id-put",
"description":"Creates or updates the publish destination with the specified ID."
},
"delete":{
"tags":[
"Destinations"
],
"summary":"Delete a destination",
"operationId":"deletePublishDestination",
"responses":{
"204":{
"$ref":"#/components/responses/204"
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"publishDestination-{id}-delete",
"x-filename-id":"publishdestination-id-delete",
"description":"Deletes the destination that matches the specified ID from the catalog configuration."
}
},
"/pricelist":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1"
}
],
"get":{
"tags":[
"Pricelist"
],
"summary":"Get all pricelists",
"operationId":"listPricelist",
"parameters":[
{
"$ref":"#/components/parameters/limit"
},
{
"$ref":"#/components/parameters/offset"
},
{
"$ref":"#/components/parameters/idQueryParam"
},
{
"$ref":"#/components/parameters/name"
},
{
"$ref":"#/components/parameters/description"
},
{
"$ref":"#/components/parameters/fields"
},
{
"$ref":"#/components/parameters/eligibleForProject"
},
{
"$ref":"#/components/parameters/lifecycleStatus"
},
{
"$ref":"#/components/parameters/whereUsed"
},
{
"$ref":"#/components/parameters/project.id"
},
{
"$ref":"#/components/parameters/project.version"
},
{
"$ref":"#/components/parameters/validFor.startDateTime"
},
{
"$ref":"#/components/parameters/validFor.endDateTime"
},
{
"$ref":"#/components/parameters/lastUpdate"
}
],
"responses":{
"200":{
"description":"The list of pricelists was returned successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/PricelistOracle"
}
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-export-filter":true,
"description":"Returns a list of pricelists that match the search criteria.",
"x-internal-id":"pricelist-get",
"x-filename-id":"pricelist-get"
},
"post":{
"tags":[
"Pricelist"
],
"summary":"Create a pricelist",
"operationId":"createPricelist",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PricelistOracle_Create"
}
}
},
"description":"The request payload for creating a price list."
},
"responses":{
"201":{
"description":"The pricelist was created successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PricelistOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Creates a new pricelist using the supplied request payload and returns the created resource.",
"x-internal-id":"pricelist-post",
"x-filename-id":"pricelist-post"
}
},
"/pricelist/{id}":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1"
}
],
"parameters":[
{
"$ref":"#/components/parameters/id"
}
],
"get":{
"tags":[
"Pricelist"
],
"summary":"Get a pricelist",
"operationId":"retrievePricelist",
"parameters":[
{
"$ref":"#/components/parameters/fields"
},
{
"$ref":"#/components/parameters/eligibleVersionForProject"
}
],
"responses":{
"200":{
"description":"The pricelist was returned successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PricelistOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Returns the pricelist that matches the specified ID, including its configured details.",
"x-internal-id":"pricelist-{id}-get",
"x-filename-id":"pricelist-id-get"
},
"patch":{
"tags":[
"Pricelist"
],
"summary":"Update a pricelist",
"operationId":"patchPricelist",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PricelistOracle_Create"
}
}
},
"description":"The request payload for updating a pricelist."
},
"responses":{
"200":{
"description":"The pricelist was updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PricelistOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Updates the pricelist that matches the specified ID using the supplied request payload.",
"x-internal-id":"pricelist-{id}-patch",
"x-filename-id":"pricelist-id-patch"
},
"put":{
"tags":[
"Pricelist"
],
"summary":"Create or update a pricelist",
"operationId":"putPricelist",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PricelistOracle_Create"
}
}
},
"description":"The request payload for creating or updating a pricelist."
},
"responses":{
"200":{
"description":"The pricelist was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PricelistOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Creates or updates the pricelist with the specified ID.",
"x-internal-id":"pricelist-{id}-put",
"x-filename-id":"pricelist-id-put"
},
"delete":{
"tags":[
"Pricelist"
],
"summary":"Delete a pricelist",
"operationId":"deletePricelist",
"responses":{
"204":{
"$ref":"#/components/responses/204"
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Deletes the pricelist that matches the specified ID from the catalog configuration.",
"x-internal-id":"pricelist-{id}-delete",
"x-filename-id":"pricelist-id-delete"
}
},
"/customProfileSpecification":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1"
}
],
"get":{
"tags":[
"Custom Profile Specification"
],
"summary":"Get all custom profile specifications",
"operationId":"listCustomProfileSpecification",
"parameters":[
{
"$ref":"#/components/parameters/limit"
},
{
"$ref":"#/components/parameters/offset"
},
{
"$ref":"#/components/parameters/idQueryParam"
},
{
"$ref":"#/components/parameters/name"
},
{
"$ref":"#/components/parameters/description"
},
{
"$ref":"#/components/parameters/fields"
},
{
"$ref":"#/components/parameters/eligibleForProject"
},
{
"$ref":"#/components/parameters/lifecycleStatus"
},
{
"$ref":"#/components/parameters/whereUsed"
},
{
"$ref":"#/components/parameters/project.id"
},
{
"$ref":"#/components/parameters/project.version"
},
{
"$ref":"#/components/parameters/validFor.startDateTime"
},
{
"$ref":"#/components/parameters/validFor.endDateTime"
},
{
"$ref":"#/components/parameters/lastUpdate"
}
],
"responses":{
"200":{
"description":"The list of custom profile specifications was returned successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CustomProfileSpecificationOracle"
}
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-export-filter":true,
"description":"Returns a list of custom profile specifications that match the search criteria.",
"x-internal-id":"customProfileSpecification-get",
"x-filename-id":"customprofilespecification-get"
},
"post":{
"tags":[
"Custom Profile Specification"
],
"summary":"Create a custom profile specification",
"operationId":"createCustomProfileSpecification",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/CustomProfileSpecificationOracle"
}
}
},
"description":"The request payload for creating a custom profile specification."
},
"responses":{
"201":{
"description":"The custom profile specification was created successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/CustomProfileSpecificationOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Creates a new custom profile specification using the supplied request payload and returns the created resource.",
"x-internal-id":"customProfileSpecification-post",
"x-filename-id":"customprofilespecification-post"
}
},
"/customProfileSpecification/{id}":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1"
}
],
"parameters":[
{
"$ref":"#/components/parameters/id"
}
],
"get":{
"tags":[
"Custom Profile Specification"
],
"summary":"Get a custom profile specification",
"operationId":"retrieveCustomProfileSpecification",
"parameters":[
{
"$ref":"#/components/parameters/fields"
},
{
"$ref":"#/components/parameters/eligibleVersionForProject"
}
],
"responses":{
"200":{
"description":"The custom profile specification was returned successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/CustomProfileSpecificationOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Returns the custom profile specification with the specified ID.",
"x-internal-id":"customProfileSpecification-{id}-get",
"x-filename-id":"customprofilespecification-id-get"
},
"patch":{
"tags":[
"Custom Profile Specification"
],
"summary":"Update a custom profile specification",
"operationId":"patchCustomProfileSpecification",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/CustomProfileSpecificationOracle"
}
}
},
"description":"The request payload for updating a custom profile specification."
},
"responses":{
"200":{
"description":"The custom profile specification was updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/CustomProfileSpecificationOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Updates the custom profile specification with the specified ID.",
"x-internal-id":"customProfileSpecification-{id}-patch",
"x-filename-id":"customprofilespecification-id-patch"
},
"put":{
"tags":[
"Custom Profile Specification"
],
"summary":"Create or updates a custom profile specification",
"operationId":"putCustomProfileSpecification",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/CustomProfileSpecificationOracle"
}
}
},
"description":"The request payload for creating or updating a custom profile specification."
},
"responses":{
"200":{
"description":"The custom profile specification was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/CustomProfileSpecificationOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Creates or updates the custom profile specification with the specified ID.",
"x-internal-id":"customProfileSpecification-{id}-put",
"x-filename-id":"customprofilespecification-id-put"
},
"delete":{
"tags":[
"Custom Profile Specification"
],
"summary":"Delete a custom profile speicification",
"operationId":"deleteCustomProfileSpecification",
"responses":{
"204":{
"$ref":"#/components/responses/204"
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Deletes the custom profile specification with the specified ID.",
"x-internal-id":"customProfileSpecification-{id}-delete",
"x-filename-id":"customprofilespecification-id-delete"
}
},
"/balanceElement":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1"
}
],
"get":{
"tags":[
"Balance Element"
],
"summary":"Get all balance elements",
"operationId":"listBalanceElement",
"parameters":[
{
"$ref":"#/components/parameters/limit"
},
{
"$ref":"#/components/parameters/offset"
},
{
"$ref":"#/components/parameters/idQueryParam"
},
{
"$ref":"#/components/parameters/name"
},
{
"$ref":"#/components/parameters/description"
},
{
"$ref":"#/components/parameters/fields"
},
{
"$ref":"#/components/parameters/eligibleForProject"
},
{
"$ref":"#/components/parameters/balanceElementType"
},
{
"$ref":"#/components/parameters/lifecycleStatus"
},
{
"$ref":"#/components/parameters/project.id"
},
{
"$ref":"#/components/parameters/project.version"
},
{
"$ref":"#/components/parameters/validFor.startDateTime"
},
{
"$ref":"#/components/parameters/validFor.endDateTime"
},
{
"$ref":"#/components/parameters/lastUpdate"
}
],
"responses":{
"200":{
"description":"The list of balance elements was returned successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/BalanceElementOracle"
}
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-export-filter":true,
"description":"Returns a list of balance elements that match the search criteria.",
"x-internal-id":"balanceElement-get",
"x-filename-id":"balanceelement-get"
},
"post":{
"tags":[
"Balance Element"
],
"summary":"Create a balance element",
"operationId":"createBalanceElement",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/BalanceElementOracle"
}
}
},
"description":"The request payload for creating a balance element."
},
"responses":{
"201":{
"description":"The balance element was created successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/BalanceElementOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Creates a new balance element using the supplied request payload and returns the created resource.",
"x-internal-id":"balanceElement-post",
"x-filename-id":"balanceelement-post"
}
},
"/balanceElement/{id}":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1"
}
],
"parameters":[
{
"$ref":"#/components/parameters/id"
}
],
"get":{
"tags":[
"Balance Element"
],
"summary":"Get a balance element",
"operationId":"retrieveBalanceElement",
"parameters":[
{
"$ref":"#/components/parameters/fields"
},
{
"$ref":"#/components/parameters/eligibleVersionForProject"
}
],
"responses":{
"200":{
"description":"The balance element was returned successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/BalanceElementOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Returns the balance element that matches the specified ID, including its configured details.",
"x-internal-id":"balanceElement-{id}-get",
"x-filename-id":"balanceelement-id-get"
},
"patch":{
"tags":[
"Balance Element"
],
"summary":"Update a balance element",
"operationId":"patchBalanceElement",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/BalanceElementOracle"
}
}
},
"description":"The request payload for updating a balance element."
},
"responses":{
"200":{
"description":"The balance element was updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/BalanceElementOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Updates the balance element that matches the specified ID using the supplied request payload.",
"x-internal-id":"balanceElement-{id}-patch",
"x-filename-id":"balanceelement-id-patch"
},
"put":{
"tags":[
"Balance Element"
],
"summary":"Create or update a balance element",
"operationId":"putBalanceElement",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/BalanceElementOracle"
}
}
},
"description":"The request payload for creating or updating a balance element."
},
"responses":{
"200":{
"description":"The balance element was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/BalanceElementOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Creates or updates the balance element with the specified ID.",
"x-internal-id":"balanceElement-{id}-put",
"x-filename-id":"balanceelement-id-put"
},
"delete":{
"tags":[
"Balance Element"
],
"summary":"Delete a balance element",
"operationId":"deleteBalanceElement",
"responses":{
"204":{
"$ref":"#/components/responses/204"
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Deletes the balance element that matches the specified ID from the catalog configuration.",
"x-internal-id":"balanceElement-{id}-delete",
"x-filename-id":"balanceelement-id-delete"
}
},
"/productRule":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1"
}
],
"get":{
"tags":[
"Product Rule"
],
"summary":"Get all product rules",
"operationId":"listProductRule",
"parameters":[
{
"$ref":"#/components/parameters/limit"
},
{
"$ref":"#/components/parameters/offset"
},
{
"$ref":"#/components/parameters/idQueryParam"
},
{
"$ref":"#/components/parameters/name"
},
{
"$ref":"#/components/parameters/description"
},
{
"$ref":"#/components/parameters/fields"
},
{
"$ref":"#/components/parameters/eligibleForProject"
},
{
"$ref":"#/components/parameters/lifecycleStatus"
},
{
"$ref":"#/components/parameters/subject.id"
},
{
"$ref":"#/components/parameters/subject.name"
},
{
"$ref":"#/components/parameters/subject.AtReferredType"
},
{
"$ref":"#/components/parameters/whereUsed"
},
{
"$ref":"#/components/parameters/project.id"
},
{
"$ref":"#/components/parameters/project.version"
},
{
"$ref":"#/components/parameters/lastUpdate"
}
],
"responses":{
"200":{
"description":"The list of product rules was returned successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ProductRuleOracle"
}
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-export-filter":true,
"description":"Returns a list of product rules that match the search criteria.",
"x-internal-id":"productRule-get",
"x-filename-id":"productrule-get"
},
"post":{
"tags":[
"Product Rule"
],
"summary":"Create a product rule",
"operationId":"createProductRule",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ProductRuleOracle"
}
}
},
"description":"The request payload for creating a product rule."
},
"responses":{
"201":{
"description":"The product rule was created successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ProductRuleOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Creates a new product rule using the supplied request payload and returns the created resource.",
"x-internal-id":"productRule-post",
"x-filename-id":"productrule-post"
}
},
"/productRule/{id}":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1"
}
],
"parameters":[
{
"$ref":"#/components/parameters/id"
}
],
"get":{
"tags":[
"Product Rule"
],
"summary":"Get a product rule",
"operationId":"retrieveProductRule",
"parameters":[
{
"$ref":"#/components/parameters/fields"
},
{
"$ref":"#/components/parameters/eligibleVersionForProject"
}
],
"responses":{
"200":{
"description":"The product rule was returned successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ProductRuleOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Returns the product rule that matches the specified ID, including its configured details.",
"x-internal-id":"productRule-{id}-get",
"x-filename-id":"productrule-id-get"
},
"patch":{
"tags":[
"Product Rule"
],
"summary":"Update a product rule",
"operationId":"patchProductRule",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ProductRuleOracle"
}
}
},
"description":"The request payload for updating a product rule."
},
"responses":{
"200":{
"description":"The product rule was updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ProductRuleOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Updates the product rule that matches the specified ID using the supplied request payload.",
"x-internal-id":"productRule-{id}-patch",
"x-filename-id":"productrule-id-patch"
},
"put":{
"tags":[
"Product Rule"
],
"summary":"Create or update a product rule",
"operationId":"putProductRule",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ProductRuleOracle"
}
}
},
"description":"The request payload for creating or updating a product rule."
},
"responses":{
"200":{
"description":"The product rule was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ProductRuleOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Creates or updates the product rule with the specified ID.",
"x-internal-id":"productRule-{id}-put",
"x-filename-id":"productrule-id-put"
},
"delete":{
"tags":[
"Product Rule"
],
"summary":"Delete a product rule",
"operationId":"deleteProductRule",
"responses":{
"204":{
"$ref":"#/components/responses/204"
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Deletes the product rule that matches the specified ID from the catalog configuration.",
"x-internal-id":"productRule-{id}-delete",
"x-filename-id":"productrule-id-delete"
}
},
"/lifecycleConfiguration":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1"
}
],
"get":{
"tags":[
"Lifecycle Configuration"
],
"summary":"Get all lifecycle configurations",
"operationId":"listLifecycleConfiguration",
"parameters":[
{
"$ref":"#/components/parameters/limit"
},
{
"$ref":"#/components/parameters/offset"
},
{
"$ref":"#/components/parameters/idQueryParam"
},
{
"$ref":"#/components/parameters/name"
},
{
"$ref":"#/components/parameters/description"
},
{
"$ref":"#/components/parameters/fields"
},
{
"$ref":"#/components/parameters/lifecycleStatus"
},
{
"$ref":"#/components/parameters/lastUpdate"
}
],
"responses":{
"200":{
"description":"The list of lifecycle configurations was returned successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/LifecycleConfigurationOracle"
}
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-export-filter":true,
"description":"Returns a list of lifecycle configurations that match the search criteria.",
"x-internal-id":"lifecycleConfiguration-get",
"x-filename-id":"lifecycleconfiguration-get"
},
"post":{
"tags":[
"Lifecycle Configuration"
],
"summary":"Create a lifecycle configuration",
"operationId":"createLifecycleConfiguration",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/LifecycleConfigurationOracle"
}
}
},
"description":"The request payload for creating a lifecycle configuration."
},
"responses":{
"201":{
"description":"The lifecycle configuration was created successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/LifecycleConfigurationOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Creates a new lifecycle configuration using the supplied request payload and returns the created resource.",
"x-internal-id":"lifecycleConfiguration-post",
"x-filename-id":"lifecycleconfiguration-post"
}
},
"/lifecycleConfiguration/{id}":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1"
}
],
"parameters":[
{
"$ref":"#/components/parameters/id"
}
],
"get":{
"tags":[
"Lifecycle Configuration"
],
"summary":"Get a lifecycle configuration",
"operationId":"retrieveLifecycleConfiguration",
"parameters":[
{
"$ref":"#/components/parameters/fields"
}
],
"responses":{
"200":{
"description":"The lifecycle configuration was returned successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/LifecycleConfigurationOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Returns the lifecycle configuration that matches the specified ID, including its configured details.",
"x-internal-id":"lifecycleConfiguration-{id}-get",
"x-filename-id":"lifecycleconfiguration-id-get"
},
"patch":{
"tags":[
"Lifecycle Configuration"
],
"summary":"Update a lifecycle configuration",
"operationId":"patchLifecycleConfiguration",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/LifecycleConfigurationOracle"
}
}
},
"description":"The request payload for updating a lifecycle configuration."
},
"responses":{
"200":{
"description":"The lifecycle configuration was updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/LifecycleConfigurationOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Updates the lifecycle configuration that matches the specified ID using the supplied request payload.",
"x-internal-id":"lifecycleConfiguration-{id}-patch",
"x-filename-id":"lifecycleconfiguration-id-patch"
},
"put":{
"tags":[
"Lifecycle Configuration"
],
"summary":"Create or update a lifecycle configuration",
"operationId":"putLifecycleConfiguration",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/LifecycleConfigurationOracle"
}
}
},
"description":"The request payload for creating or updating a lifecycle configuration."
},
"responses":{
"200":{
"description":"The lifecycle configuration was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/LifecycleConfigurationOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Creates or updates the lifecycle configuration with the specified ID.",
"x-internal-id":"lifecycleConfiguration-{id}-put",
"x-filename-id":"lifecycleconfiguration-id-put"
},
"delete":{
"tags":[
"Lifecycle Configuration"
],
"summary":"Delete a lifecycle configuration",
"operationId":"deleteLifecycleConfiguration",
"responses":{
"204":{
"$ref":"#/components/responses/204"
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Deletes the lifecycle configuration that matches the specified ID from the catalog configuration.",
"x-internal-id":"lifecycleConfiguration-{id}-delete",
"x-filename-id":"lifecycleconfiguration-id-delete"
}
},
"/promotion":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/promotionManagement/v4"
}
],
"get":{
"tags":[
"Promotion"
],
"summary":"Get all promotions",
"operationId":"listPromotion",
"parameters":[
{
"$ref":"#/components/parameters/limit"
},
{
"$ref":"#/components/parameters/offset"
},
{
"$ref":"#/components/parameters/idQueryParam"
},
{
"$ref":"#/components/parameters/name"
},
{
"$ref":"#/components/parameters/description"
},
{
"$ref":"#/components/parameters/fields"
},
{
"$ref":"#/components/parameters/eligibleForProject"
},
{
"$ref":"#/components/parameters/promotionType"
},
{
"$ref":"#/components/parameters/lifecycleStatus"
},
{
"$ref":"#/components/parameters/whereUsed"
},
{
"$ref":"#/components/parameters/project.id"
},
{
"$ref":"#/components/parameters/project.version"
},
{
"$ref":"#/components/parameters/validFor.startDateTime"
},
{
"$ref":"#/components/parameters/validFor.endDateTime"
},
{
"$ref":"#/components/parameters/lastUpdate"
}
],
"responses":{
"200":{
"description":"The list of promotions was returned successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/PromotionOracle"
}
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-export-filter":true,
"description":"Returns a list of promotions that match the search criteria.",
"x-internal-id":"promotion-get",
"x-filename-id":"promotion-get"
},
"post":{
"tags":[
"Promotion"
],
"summary":"Create a promotion",
"operationId":"createPromotion",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PromotionOracle"
}
}
},
"description":"The request payload for creating a promotion."
},
"responses":{
"201":{
"description":"The promotion was created successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PromotionOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Creates a new promotion using the supplied request payload and returns the created resource.",
"x-internal-id":"promotion-post",
"x-filename-id":"promotion-post"
}
},
"/promotion/{id}":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/promotionManagement/v4"
}
],
"parameters":[
{
"$ref":"#/components/parameters/id"
}
],
"get":{
"tags":[
"Promotion"
],
"summary":"Get a promotion",
"operationId":"retrievePromotion",
"parameters":[
{
"$ref":"#/components/parameters/fields"
},
{
"$ref":"#/components/parameters/eligibleVersionForProject"
}
],
"responses":{
"200":{
"description":"The promotion was returned successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PromotionOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Returns the promotion that matches the specified ID, including its configured details.",
"x-internal-id":"promotion-{id}-get",
"x-filename-id":"promotion-id-get"
},
"patch":{
"tags":[
"Promotion"
],
"summary":"Update a promotion",
"operationId":"patchPromotion",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PromotionOracle"
}
}
},
"description":"The request payload for updating a promotion."
},
"responses":{
"200":{
"description":"The promotion was updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PromotionOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Updates the promotion that matches the specified ID using the supplied request payload.",
"x-internal-id":"promotion-{id}-patch",
"x-filename-id":"promotion-id-patch"
},
"put":{
"tags":[
"Promotion"
],
"summary":"Create or update a promotion",
"operationId":"putPromotion",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PromotionOracle"
}
}
},
"description":"The request payload for creating or updating a promotion."
},
"responses":{
"200":{
"description":"The promotion was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PromotionOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Creates or updates the promotion with the specified ID.",
"x-internal-id":"promotion-{id}-put",
"x-filename-id":"promotion-id-put"
},
"delete":{
"tags":[
"Promotion"
],
"summary":"Delete a promotion",
"operationId":"deletePromotion",
"responses":{
"204":{
"$ref":"#/components/responses/204"
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Deletes the promotion that matches the specified ID from the catalog configuration.",
"x-internal-id":"promotion-{id}-delete",
"x-filename-id":"promotion-id-delete"
}
},
"/attribute":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1"
}
],
"get":{
"tags":[
"Attributes"
],
"summary":"Get all attributes",
"operationId":"listAttribute",
"parameters":[
{
"$ref":"#/components/parameters/limit"
},
{
"$ref":"#/components/parameters/offset"
},
{
"$ref":"#/components/parameters/idQueryParam"
},
{
"$ref":"#/components/parameters/name"
},
{
"$ref":"#/components/parameters/description"
},
{
"$ref":"#/components/parameters/version"
},
{
"$ref":"#/components/parameters/lifecycleStatus"
},
{
"$ref":"#/components/parameters/type"
},
{
"$ref":"#/components/parameters/baseType"
},
{
"$ref":"#/components/parameters/schemaLocation"
},
{
"$ref":"#/components/parameters/fields"
},
{
"$ref":"#/components/parameters/whereUsed"
},
{
"$ref":"#/components/parameters/eligibleForProject"
},
{
"$ref":"#/components/parameters/project.id"
},
{
"$ref":"#/components/parameters/project.version"
},
{
"$ref":"#/components/parameters/validFor.startDateTime"
},
{
"$ref":"#/components/parameters/validFor.endDateTime"
},
{
"$ref":"#/components/parameters/lastUpdate"
}
],
"responses":{
"200":{
"description":"The list of attributes was returned successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/AttributeOracle"
}
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"attribute-get",
"x-filename-id":"attribute-get",
"x-export-filter":true,
"description":"Returns a list of attributes that match the search criteria."
},
"post":{
"tags":[
"Attributes"
],
"summary":"Create an attribute",
"operationId":"createAttribute",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/AttributeOracle"
}
}
},
"description":"The request payload for creating an attribute."
},
"responses":{
"201":{
"description":"The attribute was created successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/AttributeOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"attribute-post",
"x-filename-id":"attribute-post",
"description":"Creates a new attribute using the supplied request payload and returns the created resource."
}
},
"/attribute/{id}":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1"
}
],
"get":{
"tags":[
"Attributes"
],
"summary":"Get an attribute",
"operationId":"retrieveAttribute",
"parameters":[
{
"$ref":"#/components/parameters/id"
},
{
"$ref":"#/components/parameters/fields"
},
{
"$ref":"#/components/parameters/eligibleVersionForProject"
}
],
"responses":{
"200":{
"description":"The attribute was returned successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/AttributeOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"attribute-{id}-get",
"x-filename-id":"attribute-id-get",
"description":"Returns the n attribute that matches the specified ID, including its configured details."
},
"patch":{
"tags":[
"Attributes"
],
"summary":"Update an attribute",
"operationId":"patchAttribute",
"parameters":[
{
"$ref":"#/components/parameters/id"
}
],
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/AttributeOracle"
}
}
},
"description":"The request payload for updating an attribute."
},
"responses":{
"200":{
"description":"The attribute was updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/AttributeOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"attribute-{id}-patch",
"x-filename-id":"attribute-id-patch",
"description":"Updates the n attribute that matches the specified ID using the supplied request payload."
},
"put":{
"tags":[
"Attributes"
],
"summary":"Create or update an attribute",
"operationId":"putAttribute",
"parameters":[
{
"$ref":"#/components/parameters/id"
}
],
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/AttributeOracle"
}
}
},
"description":"The request payload for creating or updating an attribute."
},
"responses":{
"200":{
"description":"The attribute was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/AttributeOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"attribute-{id}-put",
"x-filename-id":"attribute-id-put",
"description":"Creates or updates the attribute with the specified ID."
},
"delete":{
"tags":[
"Attributes"
],
"summary":"Delete an attribute",
"operationId":"deleteAttribute",
"parameters":[
{
"$ref":"#/components/parameters/id"
}
],
"responses":{
"204":{
"$ref":"#/components/responses/204"
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"attribute-{id}-delete",
"x-filename-id":"attribute-id-delete",
"description":"Deletes the n attribute that matches the specified ID from the catalog configuration."
}
},
"/channel":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1"
}
],
"get":{
"tags":[
"Channels"
],
"summary":"Get all channels",
"operationId":"listChannel",
"parameters":[
{
"$ref":"#/components/parameters/limit"
},
{
"$ref":"#/components/parameters/offset"
},
{
"$ref":"#/components/parameters/idQueryParam"
},
{
"$ref":"#/components/parameters/name"
},
{
"$ref":"#/components/parameters/description"
},
{
"$ref":"#/components/parameters/version"
},
{
"$ref":"#/components/parameters/lifecycleStatus"
},
{
"$ref":"#/components/parameters/fields"
},
{
"$ref":"#/components/parameters/eligibleForProject"
},
{
"$ref":"#/components/parameters/whereUsed"
},
{
"$ref":"#/components/parameters/project.id"
},
{
"$ref":"#/components/parameters/project.version"
},
{
"$ref":"#/components/parameters/validFor.startDateTime"
},
{
"$ref":"#/components/parameters/validFor.endDateTime"
},
{
"$ref":"#/components/parameters/lastUpdate"
}
],
"responses":{
"200":{
"description":"The list of channels was returned successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ChannelOracle"
}
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"channel-get",
"x-filename-id":"channel-get",
"x-export-filter":true,
"description":"Returns a list of channels that match the search criteria."
},
"post":{
"tags":[
"Channels"
],
"summary":"Create a channel",
"operationId":"createChannel",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ChannelOracle"
}
}
},
"description":"The request payload for creating a channel."
},
"responses":{
"201":{
"description":"Your request is successful and a new resource has been created.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ChannelOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"channel-post",
"x-filename-id":"channel-post",
"description":"Creates a new channel using the supplied request payload and returns the created resource."
}
},
"/channel/{id}":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1"
}
],
"parameters":[
{
"$ref":"#/components/parameters/id"
}
],
"get":{
"tags":[
"Channels"
],
"summary":"Get a channel",
"operationId":"retrieveChannel",
"parameters":[
{
"$ref":"#/components/parameters/fields"
},
{
"$ref":"#/components/parameters/eligibleVersionForProject"
}
],
"responses":{
"200":{
"description":"The channel was returned successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ChannelOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"channel-{id}-get",
"x-filename-id":"channel-id-get",
"description":"Returns the channel that matches the specified ID, including its configured details."
},
"patch":{
"tags":[
"Channels"
],
"summary":"Update a channel",
"operationId":"patchChannel",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ChannelOracle"
}
}
},
"description":"The request payload for updating a channel."
},
"responses":{
"200":{
"description":"The channel was updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ChannelOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"channel-{id}-patch",
"x-filename-id":"channel-id-patch",
"description":"Updates the channel that matches the specified ID using the supplied request payload."
},
"put":{
"tags":[
"Channels"
],
"summary":"Create or update a channel",
"operationId":"putChannel",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ChannelOracle"
}
}
},
"description":"The request payload for creating or updating a channel."
},
"responses":{
"200":{
"description":"The channel was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ChannelOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"channel-{id}-put",
"x-filename-id":"channel-id-put",
"description":"Creates or updates the channel with the specified ID."
},
"delete":{
"tags":[
"Channels"
],
"summary":"Delete a channel",
"operationId":"deleteChannel",
"responses":{
"204":{
"$ref":"#/components/responses/204"
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"channel-{id}-delete",
"x-filename-id":"channel-id-delete",
"description":"Deletes the channel that matches the specified ID from the catalog configuration."
}
},
"/productSpecifications":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1"
}
],
"put":{
"tags":[
"Product Specifications"
],
"summary":"Create or update an array of product specifications",
"operationId":"putProductSpecifications",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ProductSpecifications"
}
}
},
"description":"The request payload for creating or updating a list of product specifications."
},
"responses":{
"200":{
"description":"The list of product specifications was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ProductSpecificationOracle"
}
}
}
}
},
"400":{
"description":"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.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"anyOf":[
{
"$ref":"#/components/schemas/Error"
},
{
"$ref":"#/components/schemas/BulkError"
}
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"Error":"#/components/schemas/Error",
"BulkError":"#/components/schemas/BulkError"
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Creates or updates the supplied array of product specifications in a single request.",
"x-internal-id":"productSpecifications-put",
"x-filename-id":"productspecifications-put"
}
},
"/productOfferings":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1"
}
],
"put":{
"tags":[
"Product Offerings"
],
"summary":"Create or update an array of product offerings",
"operationId":"putProductOfferings",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ProductOfferings"
}
}
},
"description":"The request payload for creating or updating a list of product offerings."
},
"responses":{
"200":{
"description":"The list of product offerings was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ProductOfferingOracle"
}
}
}
}
},
"400":{
"description":"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.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"anyOf":[
{
"$ref":"#/components/schemas/Error"
},
{
"$ref":"#/components/schemas/BulkError"
}
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"Error":"#/components/schemas/Error",
"BulkError":"#/components/schemas/BulkError"
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Creates or updates the supplied array of product offerings in a single request.",
"x-internal-id":"productOfferings-put",
"x-filename-id":"productofferings-put"
}
},
"/productOfferingPrices":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1"
}
],
"put":{
"tags":[
"Product Offering Prices"
],
"summary":"Create or update an array of product offering prices",
"operationId":"putProductOfferingPrices",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ProductOfferingPrices"
}
}
},
"description":"The request payload for creating or updating a list of product offering prices."
},
"responses":{
"200":{
"description":"The list of product offering prices was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ProductOfferingPriceOracle"
}
}
}
}
},
"400":{
"description":"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.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"anyOf":[
{
"$ref":"#/components/schemas/Error"
},
{
"$ref":"#/components/schemas/BulkError"
}
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"Error":"#/components/schemas/Error",
"BulkError":"#/components/schemas/BulkError"
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Creates or updates one or more product offering prices.",
"x-internal-id":"productOfferingPrices-put",
"x-filename-id":"productofferingprices-put"
}
},
"/productLines":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1"
}
],
"put":{
"tags":[
"Product Lines"
],
"summary":"Create or update an array of product lines",
"operationId":"putProductLines",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ProductLines"
}
}
},
"description":"The request payload for creating or updating a list of product lines."
},
"responses":{
"200":{
"description":"The list of product lines was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ProductLineOracle"
}
}
}
}
},
"400":{
"description":"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.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"anyOf":[
{
"$ref":"#/components/schemas/Error"
},
{
"$ref":"#/components/schemas/BulkError"
}
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"Error":"#/components/schemas/Error",
"BulkError":"#/components/schemas/BulkError"
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Creates or updates the supplied array of product lines in a single request.",
"x-internal-id":"productLines-put",
"x-filename-id":"productlines-put"
}
},
"/catalogs":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1"
}
],
"put":{
"tags":[
"Catalogs"
],
"summary":"Create or update an array of catalogs",
"operationId":"putCatalogs",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Catalogs"
}
}
},
"description":"The request payload for creating or updating a list of catalogs."
},
"responses":{
"200":{
"description":"The list of catalogs was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CatalogOracle"
}
}
}
}
},
"400":{
"description":"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.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"anyOf":[
{
"$ref":"#/components/schemas/Error"
},
{
"$ref":"#/components/schemas/BulkError"
}
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"Error":"#/components/schemas/Error",
"BulkError":"#/components/schemas/BulkError"
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Creates or updates the supplied array of catalogs in a single request.",
"x-internal-id":"catalogs-put",
"x-filename-id":"catalogs-put"
}
},
"/categories":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1"
}
],
"put":{
"tags":[
"Categories"
],
"summary":"Create or update an array of categories",
"operationId":"putCategories",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Categories"
}
}
},
"description":"The request payload for creating or updating a list of categories."
},
"responses":{
"200":{
"description":"The list of categories was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CategoryOracle"
}
}
}
}
},
"400":{
"description":"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.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"anyOf":[
{
"$ref":"#/components/schemas/Error"
},
{
"$ref":"#/components/schemas/BulkError"
}
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"Error":"#/components/schemas/Error",
"BulkError":"#/components/schemas/BulkError"
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Creates or updates the supplied array of categories in a single request.",
"x-internal-id":"categories-put",
"x-filename-id":"categories-put"
}
},
"/pricingLogicAlgorithms":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1"
}
],
"put":{
"tags":[
"Pricing Logic Algorithms"
],
"summary":"Create or update an array of pricing logic algorithms",
"operationId":"putPlas",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PLAs"
}
}
},
"description":"The request payload for creating or updating a list of pricing logic algorithms."
},
"responses":{
"200":{
"description":"The list of pricing logic algorithms was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/PlaQuantityRangeOracle"
}
}
}
}
},
"400":{
"description":"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.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"anyOf":[
{
"$ref":"#/components/schemas/Error"
},
{
"$ref":"#/components/schemas/BulkError"
}
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"Error":"#/components/schemas/Error",
"BulkError":"#/components/schemas/BulkError"
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Creates or updates one or more pricing logic algorithms.",
"x-internal-id":"pricingLogicAlgorithms-put",
"x-filename-id":"pricinglogicalgorithms-put"
}
},
"/pricingLogicAlgorithmSpecifications":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1"
}
],
"put":{
"tags":[
"Pricing Logic Algorithm Specifications"
],
"summary":"Create or update an array of pricing logic algorithm specifications",
"operationId":"putPlaSpecifications",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PricingLogicAlgorithmSpecifications"
}
}
},
"description":"The request payload for creating or updating a list of pricing logic algorithm specifications."
},
"responses":{
"200":{
"description":"The list of pricing logic algorithm specifications was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/PricingLogicAlgorithmSpecificationOracle"
}
}
}
}
},
"400":{
"description":"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.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"anyOf":[
{
"$ref":"#/components/schemas/Error"
},
{
"$ref":"#/components/schemas/BulkError"
}
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"Error":"#/components/schemas/Error",
"BulkError":"#/components/schemas/BulkError"
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Creates or updates one or more pricing logic algorithm specifications.",
"x-internal-id":"pricingLogicAlgorithmSpecifications-put",
"x-filename-id":"pricinglogicalgorithmspecifications-put"
}
},
"/balanceElements":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1"
}
],
"put":{
"tags":[
"Balance Element"
],
"summary":"Create or update an array of balance elements",
"operationId":"putBalanceElements",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/BalanceElements"
}
}
},
"description":"The request payload for creating or updating a list of balance elements."
},
"responses":{
"200":{
"description":"The list of balance elements was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/BalanceElementOracle"
}
}
}
}
},
"400":{
"description":"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.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"anyOf":[
{
"$ref":"#/components/schemas/Error"
},
{
"$ref":"#/components/schemas/BulkError"
}
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"Error":"#/components/schemas/Error",
"BulkError":"#/components/schemas/BulkError"
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Creates or updates the supplied array of balance elements in a single request.",
"x-internal-id":"balanceElements-put",
"x-filename-id":"balanceelements-put"
}
},
"/pricelists":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1"
}
],
"put":{
"tags":[
"Pricelist"
],
"summary":"Create or update an array of pricelists",
"operationId":"putPricelists",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PriceLists"
}
}
},
"description":"The request payload for creating or updating a list of pricelists."
},
"responses":{
"200":{
"description":"The list of pricelists was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/PricelistOracle"
}
}
}
}
},
"400":{
"description":"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.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"anyOf":[
{
"$ref":"#/components/schemas/Error"
},
{
"$ref":"#/components/schemas/BulkError"
}
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"Error":"#/components/schemas/Error",
"BulkError":"#/components/schemas/BulkError"
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Creates or updates the supplied array of pricelists in a single request.",
"x-internal-id":"pricelists-put",
"x-filename-id":"pricelists-put"
}
},
"/customerProfileSpecifications":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1"
}
],
"put":{
"tags":[
"Customer Profile Specification"
],
"summary":"Create or update an array of customer profile specifications",
"operationId":"putCustomerProfileSpecifications",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/CustomerProfileSpecifications"
}
}
},
"description":"The request payload for creating or updating a list of customer profile specifications."
},
"responses":{
"200":{
"description":"The list of customer profile specifications was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CustomerProfileSpecificationOracle"
}
}
}
}
},
"400":{
"description":"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.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"anyOf":[
{
"$ref":"#/components/schemas/Error"
},
{
"$ref":"#/components/schemas/BulkError"
}
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"Error":"#/components/schemas/Error",
"BulkError":"#/components/schemas/BulkError"
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Creates or updates one or more customer profile specifications.",
"x-internal-id":"customerProfileSpecifications-put",
"x-filename-id":"customerprofilespecifications-put"
}
},
"/customProfileSpecifications":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1"
}
],
"put":{
"tags":[
"Custom Profile Specification"
],
"summary":"Create or update an array of custom profile specifications",
"operationId":"putCustomProfileSpecifications",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/CustomProfileSpecifications"
}
}
},
"description":"The request payload for creating or updating a list of custom profile specifications."
},
"responses":{
"200":{
"description":"The list of custom profile specifications was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/CustomProfileSpecificationOracle"
}
}
}
}
},
"400":{
"description":"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.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"anyOf":[
{
"$ref":"#/components/schemas/Error"
},
{
"$ref":"#/components/schemas/BulkError"
}
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"Error":"#/components/schemas/Error",
"BulkError":"#/components/schemas/BulkError"
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Creates or updates one or more custom profile specifications.",
"x-internal-id":"customProfileSpecifications-put",
"x-filename-id":"customprofilespecifications-put"
}
},
"/promotions":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1"
}
],
"put":{
"tags":[
"Promotion"
],
"summary":"Create or update an array of promotions",
"operationId":"putPromotions",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Promotions"
}
}
},
"description":"The request payload for creating or updating a list of promotions."
},
"responses":{
"200":{
"description":"The list of promotions was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/PromotionOracle"
}
}
}
}
},
"400":{
"description":"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.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"anyOf":[
{
"$ref":"#/components/schemas/Error"
},
{
"$ref":"#/components/schemas/BulkError"
}
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"Error":"#/components/schemas/Error",
"BulkError":"#/components/schemas/BulkError"
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Creates or updates the supplied array of promotions in a single request.",
"x-internal-id":"promotions-put",
"x-filename-id":"promotions-put"
}
},
"/entitlements":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1"
}
],
"put":{
"tags":[
"Entitlements"
],
"summary":"Create or update an array of entitlements",
"operationId":"putEntitlements",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Entitlements"
}
}
},
"description":"The request payload for creating or updating a list of entitlements."
},
"responses":{
"200":{
"description":"The list of entitlements was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/EntitlementOracle"
}
}
}
}
},
"400":{
"description":"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.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"anyOf":[
{
"$ref":"#/components/schemas/Error"
},
{
"$ref":"#/components/schemas/BulkError"
}
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"Error":"#/components/schemas/Error",
"BulkError":"#/components/schemas/BulkError"
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Creates or updates the supplied array of entitlements in a single request.",
"x-internal-id":"entitlements-put",
"x-filename-id":"entitlements-put"
}
},
"/priceTags":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1"
}
],
"put":{
"tags":[
"Price Tags"
],
"summary":"Create or update an array of price tags",
"operationId":"putPriceTags",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PriceTags"
}
}
},
"description":"The request payload for creating or updating a list of price tags."
},
"responses":{
"200":{
"description":"The list of price tags was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/PriceTagOracle"
}
}
}
}
},
"400":{
"description":"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.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"anyOf":[
{
"$ref":"#/components/schemas/Error"
},
{
"$ref":"#/components/schemas/BulkError"
}
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"Error":"#/components/schemas/Error",
"BulkError":"#/components/schemas/BulkError"
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Creates or updates the supplied array of price tags in a single request.",
"x-internal-id":"priceTags-put",
"x-filename-id":"pricetags-put"
}
},
"/usageSpecifications":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1"
}
],
"put":{
"tags":[
"Usage Specification"
],
"summary":"Create or update an array of usage specifications",
"operationId":"putUsageSpecifications",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/UsageSpecifications"
}
}
},
"description":"The request payload for creating or updating a list of usage specifications."
},
"responses":{
"200":{
"description":"The list of usage specifications was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/UsageSpecificationOracle"
}
}
}
}
},
"400":{
"description":"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.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"anyOf":[
{
"$ref":"#/components/schemas/Error"
},
{
"$ref":"#/components/schemas/BulkError"
}
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"Error":"#/components/schemas/Error",
"BulkError":"#/components/schemas/BulkError"
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Creates or updates the supplied array of usage specifications in a single request.",
"x-internal-id":"usageSpecifications-put",
"x-filename-id":"usagespecifications-put"
}
},
"/serviceSpecifications":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1"
}
],
"put":{
"tags":[
"Service Specification"
],
"summary":"Create or update an array of service specifications",
"operationId":"putServiceSpecifications",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ServiceSpecifications"
}
}
},
"description":"The request payload for creating or updating a list of service specifications."
},
"responses":{
"200":{
"description":"The list of service specifications was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ServiceSpecificationOracle"
}
}
}
}
},
"400":{
"description":"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.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"anyOf":[
{
"$ref":"#/components/schemas/Error"
},
{
"$ref":"#/components/schemas/BulkError"
}
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"Error":"#/components/schemas/Error",
"BulkError":"#/components/schemas/BulkError"
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Creates or updates the supplied array of service specifications in a single request.",
"x-internal-id":"serviceSpecifications-put",
"x-filename-id":"servicespecifications-put"
}
},
"/policyRules":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1"
}
],
"put":{
"tags":[
"Policy Rule"
],
"summary":"Create or update an array of policy rules",
"operationId":"putPolicyRules",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/PolicyRules"
}
}
},
"description":"The request payload for creating or updating a list of policy rules."
},
"responses":{
"200":{
"description":"The list of policy rules was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/PolicyRuleOracle"
}
}
}
}
},
"400":{
"description":"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.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"anyOf":[
{
"$ref":"#/components/schemas/Error"
},
{
"$ref":"#/components/schemas/BulkError"
}
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"Error":"#/components/schemas/Error",
"BulkError":"#/components/schemas/BulkError"
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Creates or updates the supplied array of policy rules in a single request.",
"x-internal-id":"policyRules-put",
"x-filename-id":"policyrules-put"
}
},
"/taxServiceProviders":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1"
}
],
"put":{
"tags":[
"Tax Service Provider"
],
"summary":"Create or update an array of tax service providers",
"operationId":"putTaxServiceProviders",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/TaxServiceProviders"
}
}
},
"description":"The request payload for creating or updating a list of tax service providers."
},
"responses":{
"200":{
"description":"The list of tax service providers was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/TaxServiceProviderOracle"
}
}
}
}
},
"400":{
"description":"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.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"anyOf":[
{
"$ref":"#/components/schemas/Error"
},
{
"$ref":"#/components/schemas/BulkError"
}
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"Error":"#/components/schemas/Error",
"BulkError":"#/components/schemas/BulkError"
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Creates or updates one or more tax service providers.",
"x-internal-id":"taxServiceProviders-put",
"x-filename-id":"taxserviceproviders-put"
}
},
"/productRules":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1"
}
],
"put":{
"tags":[
"Product Rule"
],
"summary":"Create or update an array of product rules",
"operationId":"putProductRules",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ProductRules"
}
}
},
"description":"The request payload for creating or updating a list of product rules."
},
"responses":{
"200":{
"description":"The list of product rules was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ProductRuleOracle"
}
}
}
}
},
"400":{
"description":"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.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"anyOf":[
{
"$ref":"#/components/schemas/Error"
},
{
"$ref":"#/components/schemas/BulkError"
}
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"Error":"#/components/schemas/Error",
"BulkError":"#/components/schemas/BulkError"
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Creates or updates the supplied array of product rules in a single request.",
"x-internal-id":"productRules-put",
"x-filename-id":"productrules-put"
}
},
"/Attributes":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1"
}
],
"put":{
"tags":[
"Attributes"
],
"summary":"Create or update an array of attributes",
"operationId":"putAttributes",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Attributes"
}
}
},
"description":"The request payload for creating or updating a list of attributes."
},
"responses":{
"200":{
"description":"The list of attributes was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/AttributeOracle"
}
}
}
}
},
"400":{
"description":"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.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"anyOf":[
{
"$ref":"#/components/schemas/Error"
},
{
"$ref":"#/components/schemas/BulkError"
}
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"Error":"#/components/schemas/Error",
"BulkError":"#/components/schemas/BulkError"
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Creates or updates the supplied array of attributes in a single request.",
"x-internal-id":"Attributes-put",
"x-filename-id":"attributes-put"
}
},
"/channels":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1"
}
],
"put":{
"tags":[
"Channels"
],
"summary":"Create or update an array of channels",
"operationId":"putChannels",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Channels"
}
}
},
"description":"The request payload for creating or updating a list of channels."
},
"responses":{
"200":{
"description":"The list of channels was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/ChannelOracle"
}
}
}
}
},
"400":{
"description":"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.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"anyOf":[
{
"$ref":"#/components/schemas/Error"
},
{
"$ref":"#/components/schemas/BulkError"
}
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"Error":"#/components/schemas/Error",
"BulkError":"#/components/schemas/BulkError"
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Creates or updates the supplied array of channels in a single request.",
"x-internal-id":"channels-put",
"x-filename-id":"channels-put"
}
},
"/places":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1"
}
],
"put":{
"tags":[
"Places"
],
"summary":"Create or update an array of places",
"operationId":"putPlaces",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/Places"
}
}
},
"description":"The request payload for creating or updating a list of places."
},
"responses":{
"200":{
"description":"The list of places was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/PlaceOracle"
}
}
}
}
},
"400":{
"description":"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.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"anyOf":[
{
"$ref":"#/components/schemas/Error"
},
{
"$ref":"#/components/schemas/BulkError"
}
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"Error":"#/components/schemas/Error",
"BulkError":"#/components/schemas/BulkError"
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Creates or updates the supplied array of places in a single request.",
"x-internal-id":"places-put",
"x-filename-id":"places-put"
}
},
"/marketSegments":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1"
}
],
"put":{
"tags":[
"MarketSegments"
],
"summary":"Create or update an array of market segments",
"operationId":"putMarketSegments",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/MarketSegments"
}
}
},
"description":"The request payload for creating or updating a list of market segments."
},
"responses":{
"200":{
"description":"The list of market segments was created or updated successfully.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/MarketSegmentOracle"
}
}
}
}
},
"400":{
"description":"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.",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"anyOf":[
{
"$ref":"#/components/schemas/Error"
},
{
"$ref":"#/components/schemas/BulkError"
}
],
"discriminator":{
"propertyName":"@type",
"mapping":{
"Error":"#/components/schemas/Error",
"BulkError":"#/components/schemas/BulkError"
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Creates or updates the supplied array of market segments in a single request.",
"x-internal-id":"marketSegments-put",
"x-filename-id":"marketsegments-put"
}
},
"/geographyStructure/{countryCode}":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1"
}
],
"parameters":[
{
"name":"countryCode",
"in":"path",
"description":"The country code for which the geography structure is needed.",
"schema":{
"type":"string"
},
"required":true
}
],
"get":{
"tags":[
"Geography Structure"
],
"operationId":"getGeographyStructure",
"summary":"Get geography structure for the country",
"responses":{
"200":{
"description":"The list of geography structures was returned successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/GeographyStructureOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Returns a list of geography structures that match the search criteria.",
"x-internal-id":"geographyStructure-{countryCode}-get",
"x-filename-id":"geographystructure-countrycode-get"
}
},
"/retire/{resourceName}":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1"
}
],
"parameters":[
{
"name":"resourceName",
"in":"path",
"description":"The entity for which retire is initiated.",
"schema":{
"type":"string"
},
"required":true
}
],
"post":{
"tags":[
"Retire Entity"
],
"operationId":"retireEntity",
"summary":"Retire an entity",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/RetireSchemaOracle"
}
}
},
"description":"The request payload for retiring an entity."
},
"responses":{
"201":{
"description":"Your request is successful and a new resource has been created."
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Retires the specified entity using the request payload and the resource name path parameter.",
"x-internal-id":"retire-{resourceName}-post",
"x-filename-id":"retire-resourcename-post"
}
},
"/obsolete/{resourceName}":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1"
}
],
"parameters":[
{
"name":"resourceName",
"in":"path",
"description":"The entity for which obsolete is initiated.",
"schema":{
"type":"string"
},
"required":true
}
],
"put":{
"tags":[
"Obsolete Entity"
],
"operationId":"obsoleteEntity",
"summary":"Obsolete an entity",
"requestBody":{
"required":true,
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ObsoleteSchemaOracle"
}
}
},
"description":"The request payload for obsoleting an entity."
},
"responses":{
"200":{
"description":"The list of obsoletes was created or updated successfully."
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Marks the specified entity as obsolete using the request payload and the resource name path parameter.",
"x-internal-id":"obsolete-{resourceName}-put",
"x-filename-id":"obsolete-resourcename-put"
}
},
"/folder/{name}":{
"servers":[
{
"description":"The launch REST Server.",
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1"
}
],
"get":{
"tags":[
"Content Management"
],
"summary":"Get folder contents",
"operationId":"retrieveFolder",
"parameters":[
{
"name":"name",
"in":"path",
"description":"The name of the parent folder to search content.",
"schema":{
"type":"string"
},
"required":true
},
{
"name":"path",
"in":"query",
"description":"The name of the subfolder to fetch the filelist.",
"schema":{
"type":"string"
},
"required":true
},
{
"name":"fileName.sw",
"in":"query",
"description":"The starting name of the file to fetch the filelist.",
"schema":{
"type":"string"
},
"required":true
},
{
"name":"fileName.ew",
"in":"query",
"description":"The ending name of the file to fetch the filelist.",
"schema":{
"type":"string"
},
"required":true
}
],
"responses":{
"200":{
"description":"The list of folders was returned successfully.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/FolderOracle"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"x-internal-id":"folder-{name}-get",
"x-filename-id":"folder-name-get",
"description":"Returns a list of folders that match the search criteria."
}
},
"/swagger/ThirdPartyCMSSwagger":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1"
}
],
"get":{
"tags":[
"Third Party CMS Swagger"
],
"operationId":"getThirdPartyCMSSwagger",
"summary":"Get the third party CMS swagger",
"responses":{
"200":{
"description":"The list of third party CMS swaggers was returned successfully.",
"content":{
"application/json":{
"schema":{
"type":"object"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Returns a list of third party CMS swaggers that match the search criteria.",
"x-internal-id":"swagger-ThirdPartyCMSSwagger-get",
"x-filename-id":"swagger-thirdpartycmsswagger-get"
}
},
"/swagger/ExternalFunctionSwagger":{
"servers":[
{
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1"
}
],
"get":{
"tags":[
"External Function Swagger"
],
"operationId":"getExternalFunctionSwagger",
"summary":"Get the external function swagger for mapping file",
"responses":{
"200":{
"description":"The list of external function swaggers was returned successfully.",
"content":{
"application/json":{
"schema":{
"type":"object"
}
}
}
},
"400":{
"$ref":"#/components/responses/400"
},
"401":{
"$ref":"#/components/responses/401"
},
"404":{
"$ref":"#/components/responses/404"
},
"405":{
"$ref":"#/components/responses/405"
},
"500":{
"$ref":"#/components/responses/500"
}
},
"description":"Returns a list of external function swaggers that match the search criteria.",
"x-internal-id":"swagger-ExternalFunctionSwagger-get",
"x-filename-id":"swagger-externalfunctionswagger-get"
}
}
},
"security":[
{
"BasicAuthentication":[
]
}
],
"servers":[
{
"description":"TMF 620 Product Catalog Management Fusion Server",
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5"
},
{
"description":"TMF 633 Service Catalog Management Fusion Server",
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/serviceCatalogManagement/v3"
},
{
"description":"TMF 635 Usage Management Fusion Server",
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/usageManagement/v2"
},
{
"description":"TMF 671 Promotion Fusion Server",
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/promotion/v2"
},
{
"description":"TMF 671 Promotion Fusion Server",
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/promotionManagement/v4"
},
{
"description":"TMF 723 Policy Fusion Server",
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/policyManagement/v5"
},
{
"description":"Launch Non TMF Server",
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/"
},
{
"description":"Publish Server",
"url":"http://{PublishServerHost}/api/productCatalogManagement/v1/"
},
{
"description":"Launch Reference Management Service",
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1"
},
{
"description":"Launch REST Server",
"url":"https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1"
},
{
"description":"ADF REST Server",
"url":"https://{FusionAppsHost}/crmRestApi/resources/11.13.18.05/"
}
],
"tags":[
{
"name":"Attributes",
"description":"The Attributes resource lets you view, create, update, and delete attributes."
},
{
"name":"Balance Element",
"description":"The Balance Element resource lets you view, create, update, and delete balance elements."
},
{
"name":"Catalogs",
"description":"The Catalogs resource lets you view, create, update, and delete catalogs. A catalog is a logical container of categories. The product catalog is a collection of product offers and catalog categories. Each product offering in a product catalog combines pricing and availability information with product specifications that describe the relationships between products, the services that realize the products, and the resources they require."
},
{
"name":"Categories",
"description":"The Categories resource lets you view, create, update, and delete categories. A category groups product offerings in logical containers. A product category can contain other categories."
},
{
"name":"Channels",
"description":"The Channels resource lets you view, create, update, and delete channels."
},
{
"name":"Content Management",
"description":"The Content Management resource lets you upload, download, and manage catalog content files."
},
{
"name":"Custom Profile Specification",
"description":"The Custom Profile Specification resource lets you view, create, update, and delete custom profile specifications."
},
{
"name":"Customer Profile Specification",
"description":"The Customer Profile Specification resource lets you view, create, update, and delete customer profile specifications."
},
{
"name":"Destinations",
"description":"The Destination resource lets you view, create, update, and delete destinations. A destination is an end-system to which the catalog entity definition is published from the central enterprise product catalog."
},
{
"name":"Entitlements",
"description":"The Entitlements resource lets you view, create, update, and delete entitlements."
},
{
"name":"Export Job",
"description":"The Export Job resource lets you view and create export activities. An export job exports catalog entities to a file."
},
{
"name":"External Function Swagger",
"description":"The External Function Swagger resource defines the contract for external functions used for transformations in mapping files."
},
{
"name":"Geography Structure",
"description":"The Geography Structure resource lets you retrieve geography types for a country."
},
{
"name":"Import Jobs",
"description":"The Import Jobs resource lets you view and create import activities. An Import Job lets you import catalog entities from a JSON file (in TMF format) into a catalog."
},
{
"name":"Lifecycle Configuration",
"description":"The Lifecycle Configuration resource lets you view, create, update, and delete lifecycle configurations."
},
{
"name":"MarketSegments",
"description":"The MarketSegments resource lets you tailor and manage offer modeling and distribution for specific market segments."
},
{
"name":"Notification Listeners",
"description":"The Notification Listeners resource lets you create a project publishing event, and is implemented on the client side."
},
{
"name":"Obsolete Entity",
"description":"The Obsolete Entity resource lets you mark an entity as obsolete."
},
{
"name":"Places",
"description":"The Place resource lets you tailor and manage the modeling of offers and their distribution to various runtime applications, making an offer available to specific geographic or physical locations, or sets of locations, which is especially critical in B2B scenarios."
},
{
"name":"Policy Rule",
"description":"The Policy Rule resource lets you view, create, update, and delete policy rules."
},
{
"name":"Price Tags",
"description":"The Price Tags resource lets you view, create, update, and delete price tags."
},
{
"name":"Pricelist",
"description":"The Pricelist resource lets you view, create, update, and delete price lists for offerings and customer segments."
},
{
"name":"Pricing Logic Algorithm Specifications",
"description":"The Pricing Logic Algorithm Specifications (PLA Specifications) resource lets you view, create, update, and delete PLA specifications. PLA specifications support parameterized black-box pricing algorithms, including OneTimePLASpec, RecurringPLASpec, and UsagePLASpec."
},
{
"name":"Pricing Logic Algorithms",
"description":"The Price Logic Algorithms (PLA) resource lets you view, create, update, and delete PLAs. The PLA is an instance of Pricing Logic Algorithm specifications and uses some black-box pricing algorithm parameter values to calculate the final price of the product."
},
{
"name":"Product Lines",
"description":"The Product Lines resource lets you view, create, update, and delete product lines. A product line groups related product offers together."
},
{
"name":"Product Offering Prices",
"description":"The Product Offering Prices resource lets you view, create, update, and delete product offering prices. A product offering includes prices of product offerings and supports one time, recurring, usage price types, and advanced pricing schemes. These are the different pricing schemes that you associate with the product offer. For example a one-time, recurring, or usage fees."
},
{
"name":"Product Offerings",
"description":"The Product Offerings resource lets you view, create, update, and delete product offerings. A product offering is an item that can be sold, ordered, or tracked as an asset. A product offering can be a simple offer or a bundle offer."
},
{
"name":"Product Rule",
"description":"The Product Rule resource lets you view, create, update, and delete product rules."
},
{
"name":"Product Specifications",
"description":"The Product Specifications resource lets you view, create, update, and delete product specifications. A product specification describes the technical characteristics and relationships of a product offered to customers."
},
{
"name":"Projects",
"description":"The Projects resource lets you view, create, update, and delete projects. It lets you group entities for a release to market."
},
{
"name":"Promotion",
"description":"The Promotion resource lets you view, create, update, and delete promotions. A promotion provides discounts, vouchers, bonuses, or gifts to customers who meet predefined criteria."
},
{
"name":"Publish Jobs",
"description":"The Publish Jobs resource lets you create a publishing job."
},
{
"name":"Publishing Acknowledgements",
"description":"The Publishing Acknowledgements resource creates publishing acknowledgements that are sent after creating a publishing job."
},
{
"name":"Retire Entity",
"description":"The Retire Entity resource lets you retire an entity."
},
{
"name":"Service Specification",
"description":"The Service Specification resource lets you view, create, update, and delete service specifications. A service specification lets you capture information about a service such as the service level, resource, party, and so on."
},
{
"name":"Tax Service Provider",
"description":"The Tax Service Provider resource lets you view, create, update, and delete tax service providers. A tax service provider represents simple and vendor specific tax codes that are used in prices."
},
{
"name":"Third Party CMS Swagger",
"description":"The Third Party CMS Swagger resource defines operations for third-party content management system integration."
},
{
"name":"Usage Specification",
"description":"The Usage Specification resource lets you view, create, update, and delete usage specifications. A usage specification lets you capture information about a usage such as the usage specific characteristics and relationships."
}
]
}