Jump to

• Request
• Response
• Examples

Create a project publish event

post

http://{PublishServerHost}/api/productCatalogManagment/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

Request Body - application/json ()

Root Schema : ProjectPublishEvent

Type: object

Title: ProjectPublishEvent

The notification data structure

Show Source

• correlationId: string
  The correlation id for this event.
• description: string
  An explanatory of the event.
• domain: string
  The domain of the event.
• event: object ProjectPublishEventPayload
  Title: ProjectPublishEventPayload

  The event data structure
• eventId: string
  The identifier of the notification.
• eventTime: string (date-time)
  Time of the event occurrence.
• eventType: string
  The type of the notification.
• href: string
  Reference of the ProcessFlow
• id: string
  Identifier of the Process flow
• priority: string
  A priority.
• timeOcurred: string (date-time)
  The time the event occured.
• title: string
  The title of the event.

{
    "title":"ProjectPublishEvent",
    "type":"object",
    "description":"The notification data structure",
    "properties":{
        "id":{
            "type":"string",
            "description":"Identifier of the Process flow"
        },
        "href":{
            "type":"string",
            "description":"Reference of the ProcessFlow"
        },
        "eventId":{
            "type":"string",
            "description":"The identifier of the notification."
        },
        "eventTime":{
            "type":"string",
            "format":"date-time",
            "description":"Time of the event occurrence."
        },
        "eventType":{
            "type":"string",
            "description":"The type of the notification."
        },
        "correlationId":{
            "type":"string",
            "description":"The correlation id for this 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":"A priority."
        },
        "timeOcurred":{
            "type":"string",
            "format":"date-time",
            "description":"The time the event occured."
        },
        "event":{
            "$ref":"#/components/schemas/ProjectPublishEventPayload"
        }
    }
}

Nested Schema : ProjectPublishEventPayload

Type: object

Title: ProjectPublishEventPayload

The event data structure

Show Source

• project: object Publish_Job
  Title: Publish_Job

  Is a detailed description of a publish Project available externally in the form of a list of Project Items.

{
    "title":"ProjectPublishEventPayload",
    "type":"object",
    "description":"The event data structure",
    "properties":{
        "project":{
            "$ref":"#/components/schemas/Publish_Job"
        }
    }
}

Nested Schema : Publish_Job

Type: object

Title: Publish_Job

Is a detailed description of a publish Project available externally in the form of a list of Project Items.

Show Source

• @referredType: string
  When sub-classing, this defines the sub-class entity name
• acknowledgementUrl: string
  call back url for acknowledgement
• href: string
  Reference of the Project
• id(required): string
  Unique identifier of the Project
• lifecycleStatus(required): string
  Used to indicate the current lifecycle status
• name: string
  Name of the project
• projectItems(required): array projectItems
  Contains the list of Project Items that are part of the publish

{
    "title":"Publish_Job",
    "type":"object",
    "description":"Is a detailed description of a publish Project available externally in the form of a list of Project Items.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the Project"
        },
        "href":{
            "type":"string",
            "description":"Reference of the Project"
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"Used to indicate the current lifecycle status"
        },
        "name":{
            "type":"string",
            "description":"Name of the project"
        },
        "acknowledgementUrl":{
            "type":"string",
            "description":"call back url for acknowledgement"
        },
        "@referredType":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name"
        },
        "projectItems":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProjectItemRef"
            },
            "description":"Contains the list of Project Items that are part of the publish"
        }
    },
    "required":[
        "id",
        "lifecycleStatus",
        "projectItems"
    ]
}

Nested Schema : projectItems

Type: array

Contains the list of Project Items that are part of the publish

Show Source

• Array of: object ProjectItemRef
  Title: ProjectItemRef

  Project Item reference. A project Item ref represents entities that can be ProductOffering or ProductOfferingSpecification or ProductOfferingPrice etc..

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProjectItemRef"
    },
    "description":"Contains the list of Project Items that are part of the publish"
}

Nested Schema : ProjectItemRef

Type: object

Title: ProjectItemRef

Project Item reference. A project Item ref represents entities that can be ProductOffering or ProductOfferingSpecification or ProductOfferingPrice etc..

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.
• context: array context
• entitlementType: string
  Allowed Values: [ "ENTITLEMENT_PRICING", "ENTITLEMENT_SERVICE" ]

  entitlememt type
• href: string
  Reference of the related entity.
• id(required): string
  Unique identifier of a related entity.
• lifecycleStatus: string
  The lifecycleStatus of the related entity.
• name: string
  Name of the related entity.
• 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" ]

  Describes the price, such as recurring, discount, allowance, penalty, and so forth
• productType: string
  Allowed Values: [ "PACKAGE", "COMMERCIAL_BUNDLE", "SERVICE_BUNDLE", "SERVICE", "DEVICE", "ACCESSORY", "CHOICE", "AGGREGATION", "SYSTEM_OFFER" ]

  Used to indicate the type of product.
• 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" ]

  type of the profile
• promotionType: string
  Allowed Values: [ "AWARD", "DISCOUNT", "TRADE_IN", "CROSS_PRODUCT_DISCOUNT" ]

  Comma seperated promotion tags/type
• ruleType: string
  Allowed Values: [ "COMPATIBILITY", "ELIGIBILITY", "MIGRATION", "RECOMMENDATION", "CONSTRAINT" ]
• version: string
  Version of the object

{
    "title":"ProjectItemRef",
    "type":"object",
    "description":"Project Item reference. A project Item ref represents entities that can be ProductOffering or ProductOfferingSpecification or ProductOfferingPrice etc..",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of a related entity."
        },
        "href":{
            "type":"string",
            "description":"Reference of the related entity."
        },
        "name":{
            "type":"string",
            "description":"Name of the related entity."
        },
        "version":{
            "type":"string",
            "description":"Version of the object"
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"The lifecycleStatus of the related entity."
        },
        "context":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProjectItemContextsOracle"
            }
        },
        "@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":"Describes the price, such as recurring, discount, allowance, penalty, and so forth",
            "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"
            ]
        },
        "entitlementType":{
            "type":"string",
            "description":"entitlememt type",
            "enum":[
                "ENTITLEMENT_PRICING",
                "ENTITLEMENT_SERVICE"
            ]
        },
        "promotionType":{
            "type":"string",
            "description":"Comma seperated promotion tags/type",
            "enum":[
                "AWARD",
                "DISCOUNT",
                "TRADE_IN",
                "CROSS_PRODUCT_DISCOUNT"
            ]
        },
        "profileType":{
            "type":"string",
            "description":"type of the profile",
            "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":"Used to indicate the type of product.",
            "enum":[
                "PACKAGE",
                "COMMERCIAL_BUNDLE",
                "SERVICE_BUNDLE",
                "SERVICE",
                "DEVICE",
                "ACCESSORY",
                "CHOICE",
                "AGGREGATION",
                "SYSTEM_OFFER"
            ]
        }
    },
    "required":[
        "id",
        "@referredType"
    ]
}

Nested Schema : context

Type: array

Show Source

• Array of: object ProjectItemContextsOracle
  Title: ProjectItemContextsOracle

  Project item context objects which holds the KPI parameters

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

Nested Schema : ProjectItemContextsOracle

Type: object

Title: ProjectItemContextsOracle

Project item context objects which holds the KPI parameters

Show Source

• params(required): array params
• type(required): string
  Allowed Values: [ "ACQUISITION", "RETENTION" ]

  Used to indicate the context type

{
    "title":"ProjectItemContextsOracle",
    "type":"object",
    "description":"Project item context objects which holds the KPI parameters",
    "properties":{
        "type":{
            "type":"string",
            "description":"Used to indicate the context type",
            "enum":[
                "ACQUISITION",
                "RETENTION"
            ]
        },
        "params":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProjectItemContextParamsOracle"
            }
        }
    },
    "required":[
        "type",
        "params"
    ]
}

Nested Schema : params

Type: array

Show Source

• Array of: object ProjectItemContextParamsOracle
  Title: ProjectItemContextParamsOracle

  Project item context KPI parameters

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

Nested Schema : ProjectItemContextParamsOracle

Type: object

Title: ProjectItemContextParamsOracle

Project item context KPI parameters

Show Source

• key(required): string
  Key of the context parameter.
• name(required): string
  Name of the context parameter.
• value(required): string
  Value of the context parameter.

{
    "title":"ProjectItemContextParamsOracle",
    "type":"object",
    "description":"Project item context KPI parameters ",
    "properties":{
        "key":{
            "type":"string",
            "description":"Key of the context parameter."
        },
        "value":{
            "type":"string",
            "description":"Value of the context parameter."
        },
        "name":{
            "type":"string",
            "description":"Name of the context parameter."
        }
    },
    "required":[
        "key",
        "value",
        "name"
    ]
}

Back to Top

Response

201 Response

Your request is processed 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

Show Source

• @schemaLocation: string
  it provides a link to the schema describing a REST resource.
• @type: string
  The class type of a REST resource.
• code(required): string
  Application related code (as defined in the API or from a common list)
• message: string
  Text that provide more details and corrective actions related to the error. This can be shown to a client user.
• reason(required): string
  Text that explains the reason for error. This can be shown to a client user.
• referenceError: string
  url pointing to documentation describing the error
• status: string
  http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"it provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

401 Response

Your request isn't authorized. The authentication credentials included with this request are missing or invalid.

Body ()

Root Schema : Error

Type: object

Title: Error

Show Source

• @schemaLocation: string
  it provides a link to the schema describing a REST resource.
• @type: string
  The class type of a REST resource.
• code(required): string
  Application related code (as defined in the API or from a common list)
• message: string
  Text that provide more details and corrective actions related to the error. This can be shown to a client user.
• reason(required): string
  Text that explains the reason for error. This can be shown to a client user.
• referenceError: string
  url pointing to documentation describing the error
• status: string
  http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"it provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

404 Response

Your request includes a resource URI that doesn't exist.

Body ()

Root Schema : Error

Type: object

Title: Error

Show Source

• @schemaLocation: string
  it provides a link to the schema describing a REST resource.
• @type: string
  The class type of a REST resource.
• code(required): string
  Application related code (as defined in the API or from a common list)
• message: string
  Text that provide more details and corrective actions related to the error. This can be shown to a client user.
• reason(required): string
  Text that explains the reason for error. This can be shown to a client user.
• referenceError: string
  url pointing to documentation describing the error
• status: string
  http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"it provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

405 Response

HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.

Body ()

Root Schema : Error

Type: object

Title: Error

Show Source

• @schemaLocation: string
  it provides a link to the schema describing a REST resource.
• @type: string
  The class type of a REST resource.
• code(required): string
  Application related code (as defined in the API or from a common list)
• message: string
  Text that provide more details and corrective actions related to the error. This can be shown to a client user.
• reason(required): string
  Text that explains the reason for error. This can be shown to a client user.
• referenceError: string
  url pointing to documentation describing the error
• status: string
  http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"it provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

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

Show Source

• @schemaLocation: string
  it provides a link to the schema describing a REST resource.
• @type: string
  The class type of a REST resource.
• code(required): string
  Application related code (as defined in the API or from a common list)
• message: string
  Text that provide more details and corrective actions related to the error. This can be shown to a client user.
• reason(required): string
  Text that explains the reason for error. This can be shown to a client user.
• referenceError: string
  url pointing to documentation describing the error
• status: string
  http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"it provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

500 Response

The server encountered something unexpected that prevented it from completing the request.

Body ()

Root Schema : Error

Type: object

Title: Error

Show Source

• @schemaLocation: string
  it provides a link to the schema describing a REST resource.
• @type: string
  The class type of a REST resource.
• code(required): string
  Application related code (as defined in the API or from a common list)
• message: string
  Text that provide more details and corrective actions related to the error. This can be shown to a client user.
• reason(required): string
  Text that explains the reason for error. This can be shown to a client user.
• referenceError: string
  url pointing to documentation describing the error
• status: string
  http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"it provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

Back to Top

Examples

The following example shows how to create 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