# Transactional Service
{% hint style="info" %}
**API SUBPATH**: eva-transactional-service
{% endhint %}
### Pagination and Listing
{% openapi src="/files/PNy9VY4IK1HYpSnd7pgP" path="/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/services/pagination" method="get" %}
[eva-transactional-service-4.7.0.yaml](https://4008706377-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fn6zS4HeuuVpRHZEvDiFU%2Fuploads%2FWUdcH785c6mMpykca9N4%2Feva-transactional-service-4.7.0.yaml?alt=media\&token=45f7f7e0-ecfc-41f7-947b-ef273bac8ce3)
{% endopenapi %}
## GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/services/quicksearch
> Searches (greedily) for any Transaction Service names that exists in\
> a bot, matching the typed term, left-to-right, and returns a list of\
> up to 6 Strings, ordered alphabetically.
```json
{"openapi":"3.0.1","info":{"title":"eva-transactional-service API Documentation","version":"4.8.0"},"tags":[{"name":"Transactional Services","description":"Management for creating, listing, finding, updating and deleting Transactional services"}],"paths":{"/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/services/quicksearch":{"get":{"tags":["Transactional Services"],"summary":"Searches (greedily) for any Transaction Service names that exists in\na bot, matching the typed term, left-to-right, and returns a list of\nup to 6 Strings, ordered alphabetically.\n","operationId":"quicksearch","parameters":[{"name":"orgUUID","in":"path","description":"A valid organization Uuid","required":true,"schema":{"type":"string"}},{"name":"envUUID","in":"path","description":"A valid environment Uuid","required":true,"schema":{"type":"string"}},{"name":"botUUID","in":"path","description":"A valid bot Uuid","required":true,"schema":{"type":"string"}},{"name":"searchTerm","in":"query","description":"Word or part of word to get suggestion names of transactional services","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"The limit of suggestions names in the response. The default value is 6","required":false,"schema":{"type":"integer","format":"int64","default":6}}],"responses":{"200":{"description":"Ok","content":{"*/*":{"schema":{"type":"array","items":{"type":"string"}}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"408":{"description":"Request Timeout","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"409":{"description":"Conflict","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"422":{"description":"Unprocessable Entity","content":{"*/*":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ValidationError"},{"$ref":"#/components/schemas/StandardError"}]}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}}}}}},"components":{"schemas":{"StandardError":{"type":"object","properties":{"timestamp":{"type":"integer","format":"int64"},"errorCode":{"type":"string"},"errorType":{"type":"string","enum":["API_ERROR","API_INFO","USER_ERROR"]},"message":{"type":"string"},"path":{"type":"string"}}},"ValidationError":{"type":"object","properties":{"timestamp":{"type":"integer","format":"int64"},"errorCode":{"type":"string"},"errorType":{"type":"string","enum":["API_ERROR","API_INFO","USER_ERROR"]},"message":{"type":"string"},"path":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/FieldMessage"}}}},"FieldMessage":{"type":"object","properties":{"fieldName":{"type":"string"},"message":{"type":"string"},"errorCode":{"type":"string"}}}}}}
```
## GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/services/list
> Retrieves a list containing all Transactional Services from a Bot.
```json
{"openapi":"3.0.1","info":{"title":"eva-transactional-service API Documentation","version":"4.8.0"},"tags":[{"name":"Transactional Services","description":"Management for creating, listing, finding, updating and deleting Transactional services"}],"paths":{"/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/services/list":{"get":{"tags":["Transactional Services"],"summary":"Retrieves a list containing all Transactional Services from a Bot.","operationId":"list","parameters":[{"name":"orgUUID","in":"path","description":"A valid organization Uuid","required":true,"schema":{"type":"string"}},{"name":"envUUID","in":"path","description":"A valid environment Uuid","required":true,"schema":{"type":"string"}},{"name":"botUUID","in":"path","description":"A valid bot Uuid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"*/*":{"schema":{"$ref":"#/components/schemas/TransactionalServiceListDTO"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"408":{"description":"Request Timeout","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"409":{"description":"Conflict","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"422":{"description":"Unprocessable Entity","content":{"*/*":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ValidationError"},{"$ref":"#/components/schemas/StandardError"}]}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}}}}}},"components":{"schemas":{"TransactionalServiceListDTO":{"type":"object","properties":{"data":{"type":"array","description":"List with of transactional service","items":{"$ref":"#/components/schemas/TransactionalServiceContentListDTO"}}},"description":"DTO response with transactional service list"},"TransactionalServiceContentListDTO":{"type":"object","properties":{"uuid":{"type":"string","description":"UUID of the transactional service"},"name":{"type":"string","description":"Name of transactional service"},"content":{"type":"array","description":"Content of transactional service","items":{"$ref":"#/components/schemas/ContentDTO"}},"tags":{"type":"array","description":"Tags of transactional service","items":{"$ref":"#/components/schemas/TagDTO"}}},"description":"DTO response of one transactional service in the list"},"ContentDTO":{"required":["buttonText","buttonType","buttonUrl","cockpitUUID","connectedTo","expressionCode","id","option","urlRedirect"],"type":"object","properties":{"id":{"type":"string","description":"Id of content in the transactional service"},"option":{"type":"string","description":"Option of content in the transactional service"},"expressionCode":{"type":"string","description":"ExpressionCode of content in the transactional service"},"connectedTo":{"type":"string","description":"ConnectedTo of content in the transactional service"},"buttonText":{"type":"string","description":"ButtonText of content in the transactional service"},"buttonType":{"type":"string","description":"ButtonType of content in the transactional service"},"urlRedirect":{"type":"boolean","description":"UrlRedirect of content in the transactional service"},"buttonUrl":{"type":"string","description":"ButtonUrl of content in the transactional service"},"cockpitUUID":{"type":"string","description":"CockpitUUID of content in the transactional service"}},"description":"DTO user to request create or update of contents of transactional service and response with this data"},"TagDTO":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"Name of tag"}},"description":"DTO user to request create or update of tags of transactional service and response with this data"},"StandardError":{"type":"object","properties":{"timestamp":{"type":"integer","format":"int64"},"errorCode":{"type":"string"},"errorType":{"type":"string","enum":["API_ERROR","API_INFO","USER_ERROR"]},"message":{"type":"string"},"path":{"type":"string"}}},"ValidationError":{"type":"object","properties":{"timestamp":{"type":"integer","format":"int64"},"errorCode":{"type":"string"},"errorType":{"type":"string","enum":["API_ERROR","API_INFO","USER_ERROR"]},"message":{"type":"string"},"path":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/FieldMessage"}}}},"FieldMessage":{"type":"object","properties":{"fieldName":{"type":"string"},"message":{"type":"string"},"errorCode":{"type":"string"}}}}}}
```
### CRUD Operations
{% openapi src="/files/L0e2BA4QuGzqbIyYsOUD" path="/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/services" method="post" %}
[eva-transactional-service-4.7.1.yaml](https://4008706377-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fn6zS4HeuuVpRHZEvDiFU%2Fuploads%2FZJay6cFDC9HdVtftxkAb%2Feva-transactional-service-4.7.1.yaml?alt=media\&token=75b0d3f7-6333-4a4a-96b1-ecf693410fc9)
{% endopenapi %}
## GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/services/{serviceUUID}
> Retrieves detailed information from a service.
```json
{"openapi":"3.0.1","info":{"title":"eva-transactional-service API Documentation","version":"4.8.0"},"tags":[{"name":"Transactional Services","description":"Management for creating, listing, finding, updating and deleting Transactional services"}],"paths":{"/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/services/{serviceUUID}":{"get":{"tags":["Transactional Services"],"summary":"Retrieves detailed information from a service.","operationId":"fetch","parameters":[{"name":"orgUUID","in":"path","description":"A valid organization Uuid","required":true,"schema":{"type":"string"}},{"name":"envUUID","in":"path","description":"A valid environment Uuid","required":true,"schema":{"type":"string"}},{"name":"botUUID","in":"path","description":"A valid bot Uuid","required":true,"schema":{"type":"string"}},{"name":"serviceUUID","in":"path","description":"A valid service Uuid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok","content":{"*/*":{"schema":{"$ref":"#/components/schemas/TransactionalServiceDataDTO"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"408":{"description":"Request Timeout","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"409":{"description":"Conflict","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"422":{"description":"Unprocessable Entity","content":{"*/*":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ValidationError"},{"$ref":"#/components/schemas/StandardError"}]}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}}}}}},"components":{"schemas":{"TransactionalServiceDataDTO":{"required":["content","name","webhook"],"type":"object","properties":{"name":{"type":"string","description":"Name of the transactional service"},"description":{"type":"string","description":"Description of the transactional service"},"webhook":{"type":"string","description":"Webhook of the transactional service"},"headers":{"type":"array","description":"Headers of the transactional service","items":{"$ref":"#/components/schemas/HeaderDTO"}},"content":{"type":"array","description":"Content of the transactional service","items":{"$ref":"#/components/schemas/ContentDTO"}},"tags":{"type":"array","description":"Tags of the transactional service","items":{"$ref":"#/components/schemas/TagDTO"}},"authType":{"$ref":"#/components/schemas/AuthTypeEnum"},"basicToken":{"type":"string","description":"Basic Token for Basic Auth Header"},"bearerToken":{"type":"string","description":"Bearer Token for Bearer Token Auth Header"},"oauthUrl":{"type":"string","description":"URL for authentication with oAuth Method"},"grantType":{"$ref":"#/components/schemas/GrantTypeEnum"},"clientId":{"type":"string","description":"Client Id to be used with oAuth Method"},"clientSecret":{"type":"string","description":"Client Secret to be used with oAuth Method and grant type 'client_credentials'"},"authUsername":{"type":"string","description":"Username to be used with oAuth Method and grant type 'password'"},"authPassword":{"type":"string","description":"Password to be used with oAuth Method and grant type 'password'"},"uuid":{"type":"string","description":"UUID of the transactional service"},"flows":{"type":"array","description":"Flows when the transactional service is used","items":{"$ref":"#/components/schemas/FlowDTO"}},"updatedAt":{"type":"string","description":"Datetime of last transactional service update","format":"date-time"},"updatedBy":{"type":"string","description":"User uuid of last transactional service update"}},"description":"DTO response when fetch successfully a transactional service"},"HeaderDTO":{"required":["header","value"],"type":"object","properties":{"header":{"type":"string","description":"Name of the header of the transactional service"},"value":{"type":"string","description":"Name of the value of header of the transactional service"}},"description":"DTO user to request create or update of headers of transactional service and response with this data"},"ContentDTO":{"required":["buttonText","buttonType","buttonUrl","cockpitUUID","connectedTo","expressionCode","id","option","urlRedirect"],"type":"object","properties":{"id":{"type":"string","description":"Id of content in the transactional service"},"option":{"type":"string","description":"Option of content in the transactional service"},"expressionCode":{"type":"string","description":"ExpressionCode of content in the transactional service"},"connectedTo":{"type":"string","description":"ConnectedTo of content in the transactional service"},"buttonText":{"type":"string","description":"ButtonText of content in the transactional service"},"buttonType":{"type":"string","description":"ButtonType of content in the transactional service"},"urlRedirect":{"type":"boolean","description":"UrlRedirect of content in the transactional service"},"buttonUrl":{"type":"string","description":"ButtonUrl of content in the transactional service"},"cockpitUUID":{"type":"string","description":"CockpitUUID of content in the transactional service"}},"description":"DTO user to request create or update of contents of transactional service and response with this data"},"TagDTO":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"Name of tag"}},"description":"DTO user to request create or update of tags of transactional service and response with this data"},"AuthTypeEnum":{"type":"string","description":"Enum describing if cell uses an auth method, and which.","enum":["AUTH_NONE","AUTH_BASIC","AUTH_BEARER","AUTH_OAUTH"]},"GrantTypeEnum":{"type":"string","description":"Grant type to be used with oAuth Method","enum":["CLIENT_CREDENTIALS","PASSWORD","REFRESH_TOKEN"]},"FlowDTO":{"type":"object","properties":{"uuid":{"type":"string","description":"UUID of the flow"},"name":{"type":"string","description":"Name of the flow"}},"description":"DTO with uuid and name of flow"},"StandardError":{"type":"object","properties":{"timestamp":{"type":"integer","format":"int64"},"errorCode":{"type":"string"},"errorType":{"type":"string","enum":["API_ERROR","API_INFO","USER_ERROR"]},"message":{"type":"string"},"path":{"type":"string"}}},"ValidationError":{"type":"object","properties":{"timestamp":{"type":"integer","format":"int64"},"errorCode":{"type":"string"},"errorType":{"type":"string","enum":["API_ERROR","API_INFO","USER_ERROR"]},"message":{"type":"string"},"path":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/FieldMessage"}}}},"FieldMessage":{"type":"object","properties":{"fieldName":{"type":"string"},"message":{"type":"string"},"errorCode":{"type":"string"}}}}}}
```
## PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/services/{serviceUUID}
> Updates an existing Service.
```json
{"openapi":"3.0.1","info":{"title":"eva-transactional-service API Documentation","version":"4.8.0"},"tags":[{"name":"Transactional Services","description":"Management for creating, listing, finding, updating and deleting Transactional services"}],"paths":{"/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/services/{serviceUUID}":{"put":{"tags":["Transactional Services"],"summary":"Updates an existing Service.","operationId":"update","parameters":[{"name":"orgUUID","in":"path","description":"A valid organization Uuid","required":true,"schema":{"type":"string"}},{"name":"envUUID","in":"path","description":"A valid environment Uuid","required":true,"schema":{"type":"string"}},{"name":"botUUID","in":"path","description":"A valid bot Uuid","required":true,"schema":{"type":"string"}},{"name":"serviceUUID","in":"path","description":"A valid service Uuid","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionalServiceRequestDTO"}}},"required":true},"responses":{"200":{"description":"Ok","content":{"*/*":{"schema":{"$ref":"#/components/schemas/TransactionalServiceUpdatedDTO"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"408":{"description":"Request Timeout","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"409":{"description":"Conflict","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"422":{"description":"Unprocessable Entity","content":{"*/*":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ValidationError"},{"$ref":"#/components/schemas/StandardError"}]}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}}}}}},"components":{"schemas":{"TransactionalServiceRequestDTO":{"required":["content","name","webhook"],"type":"object","properties":{"name":{"type":"string","description":"Name of the transactional service"},"description":{"type":"string","description":"Description of the transactional service"},"webhook":{"type":"string","description":"Webhook of the transactional service"},"headers":{"type":"array","description":"Headers of the transactional service","items":{"$ref":"#/components/schemas/HeaderDTO"}},"content":{"type":"array","description":"Content of the transactional service","items":{"$ref":"#/components/schemas/ContentDTO"}},"tags":{"type":"array","description":"Tags of the transactional service","items":{"$ref":"#/components/schemas/TagDTO"}},"authType":{"$ref":"#/components/schemas/AuthTypeEnum"},"basicToken":{"type":"string","description":"Basic Token for Basic Auth Header"},"bearerToken":{"type":"string","description":"Bearer Token for Bearer Token Auth Header"},"oauthUrl":{"type":"string","description":"URL for authentication with oAuth Method"},"grantType":{"$ref":"#/components/schemas/GrantTypeEnum"},"clientId":{"type":"string","description":"Client Id to be used with oAuth Method"},"clientSecret":{"type":"string","description":"Client Secret to be used with oAuth Method and grant type 'client_credentials'"},"authUsername":{"type":"string","description":"Username to be used with oAuth Method and grant type 'password'"},"authPassword":{"type":"string","description":"Password to be used with oAuth Method and grant type 'password'"}},"description":"A body containing all necessary data to create a new Transactional Service"},"HeaderDTO":{"required":["header","value"],"type":"object","properties":{"header":{"type":"string","description":"Name of the header of the transactional service"},"value":{"type":"string","description":"Name of the value of header of the transactional service"}},"description":"DTO user to request create or update of headers of transactional service and response with this data"},"ContentDTO":{"required":["buttonText","buttonType","buttonUrl","cockpitUUID","connectedTo","expressionCode","id","option","urlRedirect"],"type":"object","properties":{"id":{"type":"string","description":"Id of content in the transactional service"},"option":{"type":"string","description":"Option of content in the transactional service"},"expressionCode":{"type":"string","description":"ExpressionCode of content in the transactional service"},"connectedTo":{"type":"string","description":"ConnectedTo of content in the transactional service"},"buttonText":{"type":"string","description":"ButtonText of content in the transactional service"},"buttonType":{"type":"string","description":"ButtonType of content in the transactional service"},"urlRedirect":{"type":"boolean","description":"UrlRedirect of content in the transactional service"},"buttonUrl":{"type":"string","description":"ButtonUrl of content in the transactional service"},"cockpitUUID":{"type":"string","description":"CockpitUUID of content in the transactional service"}},"description":"DTO user to request create or update of contents of transactional service and response with this data"},"TagDTO":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"Name of tag"}},"description":"DTO user to request create or update of tags of transactional service and response with this data"},"AuthTypeEnum":{"type":"string","description":"Enum describing if cell uses an auth method, and which.","enum":["AUTH_NONE","AUTH_BASIC","AUTH_BEARER","AUTH_OAUTH"]},"GrantTypeEnum":{"type":"string","description":"Grant type to be used with oAuth Method","enum":["CLIENT_CREDENTIALS","PASSWORD","REFRESH_TOKEN"]},"TransactionalServiceUpdatedDTO":{"type":"object","properties":{"message":{"type":"string","description":"Message 'OK'"},"data":{"type":"string","description":"Message 'Service Updated'"}},"description":"DTO response when update successfully transactional service with ok message"},"StandardError":{"type":"object","properties":{"timestamp":{"type":"integer","format":"int64"},"errorCode":{"type":"string"},"errorType":{"type":"string","enum":["API_ERROR","API_INFO","USER_ERROR"]},"message":{"type":"string"},"path":{"type":"string"}}},"ValidationError":{"type":"object","properties":{"timestamp":{"type":"integer","format":"int64"},"errorCode":{"type":"string"},"errorType":{"type":"string","enum":["API_ERROR","API_INFO","USER_ERROR"]},"message":{"type":"string"},"path":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/FieldMessage"}}}},"FieldMessage":{"type":"object","properties":{"fieldName":{"type":"string"},"message":{"type":"string"},"errorCode":{"type":"string"}}}}}}
```
## DELETE /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/services/{serviceUUID}
> Removes an existing Service.
```json
{"openapi":"3.0.1","info":{"title":"eva-transactional-service API Documentation","version":"4.8.0"},"tags":[{"name":"Transactional Services","description":"Management for creating, listing, finding, updating and deleting Transactional services"}],"paths":{"/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/services/{serviceUUID}":{"delete":{"tags":["Transactional Services"],"summary":"Removes an existing Service.","operationId":"remove","parameters":[{"name":"orgUUID","in":"path","description":"A valid organization Uuid","required":true,"schema":{"type":"string"}},{"name":"envUUID","in":"path","description":"A valid environment Uuid","required":true,"schema":{"type":"string"}},{"name":"botUUID","in":"path","description":"A valid bot Uuid","required":true,"schema":{"type":"string"}},{"name":"serviceUUID","in":"path","description":"A valid service Uuid","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"408":{"description":"Request Timeout","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"409":{"description":"Conflict","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}},"422":{"description":"Unprocessable Entity","content":{"*/*":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ValidationError"},{"$ref":"#/components/schemas/StandardError"}]}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StandardError"}}}}}}}},"components":{"schemas":{"StandardError":{"type":"object","properties":{"timestamp":{"type":"integer","format":"int64"},"errorCode":{"type":"string"},"errorType":{"type":"string","enum":["API_ERROR","API_INFO","USER_ERROR"]},"message":{"type":"string"},"path":{"type":"string"}}},"ValidationError":{"type":"object","properties":{"timestamp":{"type":"integer","format":"int64"},"errorCode":{"type":"string"},"errorType":{"type":"string","enum":["API_ERROR","API_INFO","USER_ERROR"]},"message":{"type":"string"},"path":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/FieldMessage"}}}},"FieldMessage":{"type":"object","properties":{"fieldName":{"type":"string"},"message":{"type":"string"},"errorCode":{"type":"string"}}}}}}
```
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.conversational-ai.syntphony.com/user-guide/api-docs/api-guidelines/management-api/instance-api/transactional-service.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.