Update an event
PUT {{baseUrl}}/events/:eventId?includeShared=false
Update an existing event by ID.
\
If user wants to have history of an event, it can be done to use POST request having the same typeId
, correlationId
and entityId
in the payload.
\
!Restriction!
- PUT endpoint can only be used for content adjustments (corrections) but not for status changes (e.g. tickets use case). The time range for changes (updating an event by ID) might be limited in upcoming versions.
- Recommended usage for status changes is the update simulation based on an existing event's correlation ID and entity ID via POST endpoint.
- After successful response, it may take 100ms to make it visible to the user.
- The following fields are required and their value cannot be changed
- correlationId
- timestamp
- entityId
- typeId
cannot be changed, and is required for Custom events
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
includeShared | boolean | To specify if received event or eventTypes should be consider for the API operation. |
Request Body
{"timestamp"=>"<string>", "entityId"=>"<uuid>", "typeId"=>"<string>", "correlationId"=>"<uuid>"}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
If-Match | string | (Required) Used for optimistic concurrency control | |
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"id":"3d544287-5167-7a80-404c-34f684c8c1e0","typeId":"enim","correlationId":"urn:uuid:a73baf7d-b38e-1dd8-5dbe-e6bcd7a6a575","timestamp":"","entityId":"urn:uuid:4bad0e3c-d749-3c13-94ce-a89c58d861d2","etag":-23123621,"_links":{"self":{"href":"http://SEqOdoDqNgYGrPgyQSQXgqpjDzzSPaTiB.begsAr-QsAn37bjsykQNQsvhS0p--mjIYnxzeOFXQ,S1Y9DNC"}},"sharing":{"modes":["RECEIVER","DEFAULT"]}}