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
Request Body - application/json ()
Root Schema : ProjectPublishEvent
Type: object
Title: ProjectPublishEvent
The project publish event resource.
Show Source
Nested Schema : ProjectPublishEventPayload
Type: object
Title: ProjectPublishEventPayload
The project publish event payload resource.
Show Source
Nested Schema : Publish_Job
Type: object
Title: Publish_Job
A detailed description of a publish project available externally as a list of project items.
Show Source
Nested Schema : projectItems
Type: array
A list of project items associated with the publish job.
Show Source
  • ProjectItemRef
    Title: ProjectItemRef
    The project Item reference. A project Item ref represents entities that can be ProductOffering or ProductOfferingSpecification or ProductOfferingPrice and so on.
Nested Schema : ProjectItemRef
Type: object
Title: ProjectItemRef
The project Item reference. A project Item ref represents entities that can be ProductOffering or ProductOfferingSpecification or ProductOfferingPrice and so on.
Show Source
  • The TMF base type of the target instance when needed for disambiguation.
  • The actual type of the target instance when needed for disambiguation.
  • The name of the application associated with the project item reference.
  • The name of the commercial associated with the project item reference.
  • context
    A list of contexts associated with the project item reference.
  • The name of the person who created item.
  • The end date and time for the project item reference.
  • Allowed Values: [ "ENTITLEMENT_PRICING", "ENTITLEMENT_SERVICE" ]
    The type or classification of the project item reference. Valid values are ENTITLEMENT_PRICING, and ENTITLEMENT_SERVICE.
  • The hyperlink reference to the project item reference.
  • The ID of the project item reference.
  • Whether the project item reference is bundle.
  • The lifecycleStatus of the related entity.
  • The name of the project item reference.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • The start date and time for the project item reference.
  • The version of the object.
Nested Schema : context
Type: array
A list of contexts associated with the project item reference.
Show Source
Nested Schema : ProjectItemContextsOracle
Type: object
Title: ProjectItemContextsOracle
The project item context objects which holds the KPI parameters.
Show Source
Nested Schema : params
Type: array
A list of params associated with the project item context.
Show Source
Nested Schema : ProjectItemContextParamsOracle
Type: object
Title: ProjectItemContextParamsOracle
The project item context KPI parameters.
Show Source
Back to Top

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.
Body ()
Root Schema : Error
Type: object
Title: Error
The error resource.
Show Source

401 Response

Your request isn't authorized. The authentication credentials included with this request are missing or invalid.
Body ()
Root Schema : Error
Type: object
Title: Error
The error resource.
Show Source

404 Response

The resource with the specified URI couldn't be found.
Body ()
Root Schema : Error
Type: object
Title: Error
The error resource.
Show Source

405 Response

HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.
Body ()
Root Schema : Error
Type: object
Title: Error
The error resource.
Show Source

409 Response

The request can't be completed due to a conflict with the current state of the resource.
Body ()
Root Schema : Error
Type: object
Title: Error
The error resource.
Show Source

500 Response

The server encountered something unexpected that prevented it from completing the request.
Body ()
Root Schema : Error
Type: object
Title: Error
The error resource.
Show Source
Back to Top

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_pp

Example 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"
}
Back to Top