Abort a Dialog
Aborts an existing dialog. For more information on Pathway Dialog processing refer to HP NonStop TS/MP Pathsend and Server Programming Manual.
Path Components
CODE
DELETE /lightwave/api/v1/dialog/{dialog-id}| Name | Use | Description |
|---|---|---|
| dialog-id | required | A dialog ID returned from a previous request which had the Begin or Resume Dialog I/O Options selected. |
Parameters
Request
| Name | Use | Description |
|---|---|---|
| lw-correlation-id | optional | A caller supplied identifier to be copied to the response. |
| lw-suppress-status | optional | Use to indicate that the HTTP response status code should be "200 OK", regardless of the outcome of the operation. |
| lw-transaction-id | optional | The transaction ID of the transaction in which this request should be enlisted |
Response
| Name | Description |
|---|---|
| lw-correlation-id | The value of the correlationId supplied in the request, if any. |
| lw-dialog-id | The Dialog ID associated with the request. |
| lw-dialog-state | The current statue of the Dialog. |
| lw-error | If an error occurred, a description of the error. |
| lw-http-reason | The HTTP response reason. Present if lw-suppress-status was supplied in the request. |
| lw-http-status | The HTTP response status. Present if lw-suppress-status was supplied in the request. |
| lw-transaction-id | The transaction ID of the TMF transaction associated with the request, if any. |
| lw-transaction-state | The transaction state of the TMF transaction associated with the request, if any. |
Example
Request
TEXT
DELETE http://lightwave.example.com/lightwave/api/v1/dialog/0001000000000002 HTTP/1.1
Content-length: 0
Response
TEXT
HTTP/1.1 200 OK
Content-Length: 0
lw-dialog-id: 0001000000000002
lw-dialog-state: aborted