Create a project publish event
post
http://{PublishServerHost}/api/productCatalogManagement/v1/projectPublishEvent
Example of a client listener for receiving the notification ProjectPublishEvent.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : ProjectPublishEvent
Type:
objectTitle:
ProjectPublishEventThe project publish event resource.
Show Source
-
correlationId: string
The ID of the correlation associated with the project publish event.
-
description: string
An explanatory of the event.
-
domain: string
The domain of the event.
-
event: object
ProjectPublishEventPayload
Title:
ProjectPublishEventPayloadThe project publish event payload resource. -
eventId: string
The ID of the event associated with the project publish event.
-
eventTime: string
(date-time)
The date and time when the project publish event occurred.
-
eventType: string
The type of the notification.
-
href: string
The hyperlink reference to the project publish event.
-
id: string
The ID of the project publish event.
-
priority: string
The priority associated with the project publish event.
-
timeOcurred: string
(date-time)
The time the event occurred.
-
title: string
The title of the event.
Nested Schema : ProjectPublishEventPayload
Type:
objectTitle:
ProjectPublishEventPayloadThe project publish event payload resource.
Show Source
-
project: object
Publish_Job
Title:
Publish_JobA detailed description of a publish project available externally as a list of project items.
Nested Schema : Publish_Job
Type:
objectTitle:
Publish_JobA detailed description of a publish project available externally as a list of project items.
Show Source
-
@referredType: string
The type of the referred publish job.
-
acknowledgementUrl: string
The call back URL for acknowledgement.
-
href: string
The hyperlink reference to the publish job.
-
id(required): string
The ID of the publish job.
-
lifecycleStatus(required): string
The status of the publish job.
-
name: string
The name of the publish job.
-
projectItems(required): array
projectItems
A list of project items associated with the publish job.
Nested Schema : projectItems
Type:
arrayA list of project items associated with the publish job.
Show Source
-
Array of:
object ProjectItemRef
Title:
ProjectItemRefThe project Item reference. A project Item ref represents entities that can be ProductOffering or ProductOfferingSpecification or ProductOfferingPrice and so on.
Nested Schema : ProjectItemRef
Type:
objectTitle:
ProjectItemRefThe project Item reference. A project Item ref represents entities that can be ProductOffering or ProductOfferingSpecification or ProductOfferingPrice and so on.
Show Source
-
@refBaseType: string
The TMF base type of the target instance when needed for disambiguation.
-
@referredType(required): string
The actual type of the target instance when needed for disambiguation.
-
applicationName: string
The name of the application associated with the project item reference.
-
commercialName: string
The name of the commercial associated with the project item reference.
-
context: array
context
A list of contexts associated with the project item reference.
-
createdBy: string
The name of the person who created item.
-
endDateTime: string
(date-time)
The end date and time for the project item reference.
-
entitlementType: string
Allowed Values:
[ "ENTITLEMENT_PRICING", "ENTITLEMENT_SERVICE" ]The type or classification of the project item reference. Valid values are ENTITLEMENT_PRICING, and ENTITLEMENT_SERVICE. -
href: string
The hyperlink reference to the project item reference.
-
id(required): string
The ID of the project item reference.
-
isBundle: boolean
Whether the project item reference is bundle.
-
lifecycleStatus: string
The lifecycleStatus of the related entity.
-
name: string
The name of the project item reference.
-
priceType: string
Allowed Values:
[ "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" ]The type or classification of the project item reference. -
productType: string
Allowed Values:
[ "PACKAGE", "COMMERCIAL_BUNDLE", "SERVICE_BUNDLE", "SERVICE", "DEVICE", "ACCESSORY", "CHOICE", "AGGREGATION", "SYSTEM_OFFER", "OTHERS" ]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. -
profileType: string
Allowed Values:
[ "DEVICE_SPEC", "BUSINESS_CONFIG", "TRADE_IN", "CHARGING_TERM", "SUSPENSION_TERM", "RETURN_CHECKLIST", "ENTITY_PROFILE", "RENEWAL_TERM", "FINANCE_PLAN", "ZONE_VALUE_MAP" ]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. -
promotionType: string
Allowed Values:
[ "AWARD", "DISCOUNT", "TRADE_IN", "CROSS_PRODUCT_DISCOUNT" ]The type or classification of the project item reference. Valid values are AWARD, DISCOUNT, TRADE_IN, and CROSS_PRODUCT_DISCOUNT. -
ruleType: string
Allowed Values:
[ "COMPATIBILITY", "ELIGIBILITY", "MIGRATION", "RECOMMENDATION", "CONSTRAINT" ]The type or classification of the project item reference. Valid values are COMPATIBILITY, ELIGIBILITY, MIGRATION, RECOMMENDATION, and CONSTRAINT. -
startDateTime: string
(date-time)
The start date and time for the project item reference.
-
version: string
The version of the object.
Nested Schema : context
Type:
arrayA list of contexts associated with the project item reference.
Show Source
-
Array of:
object ProjectItemContextsOracle
Title:
ProjectItemContextsOracleThe project item context objects which holds the KPI parameters.
Nested Schema : ProjectItemContextsOracle
Type:
objectTitle:
ProjectItemContextsOracleThe project item context objects which holds the KPI parameters.
Show Source
-
params(required): array
params
A list of params associated with the project item context.
-
type(required): string
Allowed Values:
[ "ACQUISITION", "RETENTION" ]The type or classification of the project item context. Valid values are ACQUISITION, and RETENTION.
Nested Schema : params
Type:
arrayA list of params associated with the project item context.
Show Source
-
Array of:
object ProjectItemContextParamsOracle
Title:
ProjectItemContextParamsOracleThe project item context KPI parameters.
Nested Schema : ProjectItemContextParamsOracle
Type:
objectTitle:
ProjectItemContextParamsOracleThe project item context KPI parameters.
Show Source
-
key(required): string
The key of the context parameter.
-
name(required): string
The name of the project item context param.
-
value(required): string
The value assigned to the project item context param.
Response
201 Response
The project publish event was created successfully.
400 Response
Your request couldn't be processed because it contains missing or invalid information, such as a validation error on an input field, a missing required value, and so forth.
Root Schema : Error
Type:
objectTitle:
ErrorThe error resource.
Show Source
-
@schemaLocation: string
The URI of the schema that defines the error.
-
@type: string
The class type of a REST resource.
-
code(required): string
Application related code (as defined in the API or from a common list).
-
message: string
The text that provides more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
The text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
The URL pointing to documentation describing the error.
-
status: string
The status of the error.
401 Response
Your request isn't authorized. The authentication credentials included with this request are missing or invalid.
Root Schema : Error
Type:
objectTitle:
ErrorThe error resource.
Show Source
-
@schemaLocation: string
The URI of the schema that defines the error.
-
@type: string
The class type of a REST resource.
-
code(required): string
Application related code (as defined in the API or from a common list).
-
message: string
The text that provides more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
The text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
The URL pointing to documentation describing the error.
-
status: string
The status of the error.
404 Response
The resource with the specified URI couldn't be found.
Root Schema : Error
Type:
objectTitle:
ErrorThe error resource.
Show Source
-
@schemaLocation: string
The URI of the schema that defines the error.
-
@type: string
The class type of a REST resource.
-
code(required): string
Application related code (as defined in the API or from a common list).
-
message: string
The text that provides more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
The text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
The URL pointing to documentation describing the error.
-
status: string
The status of the error.
405 Response
HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.
Root Schema : Error
Type:
objectTitle:
ErrorThe error resource.
Show Source
-
@schemaLocation: string
The URI of the schema that defines the error.
-
@type: string
The class type of a REST resource.
-
code(required): string
Application related code (as defined in the API or from a common list).
-
message: string
The text that provides more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
The text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
The URL pointing to documentation describing the error.
-
status: string
The status of the error.
409 Response
The request can't be completed due to a conflict with the current state of the resource.
Root Schema : Error
Type:
objectTitle:
ErrorThe error resource.
Show Source
-
@schemaLocation: string
The URI of the schema that defines the error.
-
@type: string
The class type of a REST resource.
-
code(required): string
Application related code (as defined in the API or from a common list).
-
message: string
The text that provides more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
The text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
The URL pointing to documentation describing the error.
-
status: string
The status of the error.
500 Response
The server encountered something unexpected that prevented it from completing the request.
Root Schema : Error
Type:
objectTitle:
ErrorThe error resource.
Show Source
-
@schemaLocation: string
The URI of the schema that defines the error.
-
@type: string
The class type of a REST resource.
-
code(required): string
Application related code (as defined in the API or from a common list).
-
message: string
The text that provides more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
The text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
The URL pointing to documentation describing the error.
-
status: string
The status of the error.
Examples
The following example shows how to create a project publish event by submitting a POST request on the REST resource using cURL.
cURL Command
curl -u username:password -X POST https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/ -D @create_projectPublishEvent.json | json_ppExample of Request Body
The following shows the contents of the request body in JSON format.
{
"@type": "ProjectOracle",
"@baseType": "Project",
"name": "Delta Projects",
"version": "7.0",
"description": "Delta project publish event.",
"lifecycleStatus": "In design"
}
Example of Response Body
The following shows the contents of the response body in JSON format.
{
"@type": "ProjectOracle",
"@baseType": "Project",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/PJT300100192427135",
"lastUpdate": "2020-12-16T10:46:13.000Z",
"lastUpdatedBy": "booth",
"createdBy": "booth",
"created": "2020-12-16T10:46:13.000Z",
"lifecycleStatus": "In design",
"lifecycleConfiguration": {
"id": "DEFAULT_LC_STATUS_CONFIG_ID",
"name": "Default Lifecycle Status Configuration",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1/lifecycleConfiguration/DEFAULT_LC_STATUS_CONFIG_ID",
"version": "26.0",
"@referredType": "LifecycleConfigurationOracle"
},
"description": "Delta project publish event.",
"version": "7.0",
"action": "CREATE_OBJECT",
"name": "Delta Projects",
"id": "PJT300100192427135"
}