This page provides the list of events and associated payload for the Catalog microservice.
List of Events
| SL.# | NAME | DESCRIPTION | PUBLISH LOCATION | ROUTING KEY | DURABILITY | PAYLOAD TYPE |
|---|---|---|---|---|---|---|
| 1 | Project Submitted | This event is triggered when a project is updated to SUBMITTED state. | Topic: ecomm | catalog.project.updated | false | CatalogSubmittedProject |
| 2 | Project Approved | This event is triggered when a project is updated to APPROVED state. | Topic: ecomm | catalog.project.updated | false | CatalogSubmittedProject |
| 3 | Project Approval In-Progress | This event is triggered when a project is updated to APPROVAL_INPROGRESS state. | Topic: ecomm | catalog.project.updated | false | CatalogSubmittedProject |
| 4 | Project Failed | This event is triggered when a project is updated to APPROVAL_FAILED state. | Topic: ecomm | catalog.project.updated | false | CatalogSubmittedProject |
| 5 | Project Denied | This event is triggered when a project is updated to DENIED state. | Topic: ecomm | catalog.project.updated | false | CatalogSubmittedProject |
| 6 | Project Opened or Reopened | This event is triggered when a project is updated to OPEN state. | Topic: ecomm | catalog.project.updated | false | CatalogSubmittedProject |
Payload Model
Below is the payload for the Catalog microservice.
CatalogSubmittedProject
| PROPERTY | TYPE | DESCRIPTION | EXAMPLE |
|---|---|---|---|
projectId.collectionId | string | Indicates the collection ID of the project. | 1001 |
projectId.identifier | string | Indicates the identifier of the project. | 5ca5d845655160000d922a02 |
projectId.catalogId | string | Indicates the catalog ID of the project. | 3 |
name | string | Specifies the name of the project. | project name |
status | string | Specifies the status of the project, such as ACTIVE or INACTIVE. | ACTIVE |
description | string | Denotes the description of the project. | Project state is updated from OPEN to SUBMITTED. |
type | string | Indicates the type of the project, such as MASTER or SALE. | MASTER |
state | string | Indicates the state of the project, such as OPEN, SUBMITTED, APPROVAL_INPROGRESS, APPROVAL_FAILED, APPROVED, or DENIED. | SUBMITTED |
notes | string | Indicates the notes of the project. | Project state updated from OPEN to SUBMITTED. |
targetCompletionDate | LoclDateTime | Indicates the target completion date and time of the project, which is added by a user with appropriate privileges. | 2016-11-09T11:44:44.797+05:30 |
actualCompletionDate | LocalDateTime | Indicates the actual completion date and time of the project, which is added by a user with appropriate privileges. | 2016-11-09T11:44:44.797+05:30 |
createdBy | integer | Holds the ID of the user, who has created the project. | 0 |
createdOn | LocalDateTime | Holds the timestamp, when the project is created. | 2016-11-09T11:44:44.797+05:30 |
updatedBy | integer | Holds the ID of the user, who has updated the project. | 0 |
updatedOn | LocalDateTime | Specifies the timestamp, when the project is updated. | 2016-11-09T11:44:44.797+05:30 |
Revision History
2022-04-10 | JP – Fixed link and http issues.
2019-06-08 | PLK – Minor copyedits.
2019-05-17 | JP – Uploaded to a new table tool.
2019-04-05 | AN – Content updated for April 2019 release.
2019-01-21 | PLK – Page created and content uploaded.
