{ "openapi": "3.0.4", "info": { "title": "Fenergo Nebula Policy Providers Command", "description": "Policy Provider Command API is part of FenX eco-system to manage external providers. All the operations require valid access token obtained from Identity service.", "version": "1.0" }, "servers": [ { "url": "/policyproviderscommand" } ], "paths": { "/api/provider": { "post": { "tags": [ "PolicyProvider" ], "summary": "Create External Api Provider", "description": "

Required permissions:
Following permissions are required: PolicyConfigurationEdit", "operationId": "CreatePolicyProvider", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PolicyProviderDtoServiceRequest" } ] } } } }, "responses": { "201": { "description": "Success. PolicyProvider created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePolicyProviderResponseDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "409": { "description": "Conflict saving changes in expected version", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "There are conflicts that cannot be resolved automatically, get latest and apply your changes", "type": "Error", "errorCode": "CONFLICT" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/provider/{providerId}": { "put": { "tags": [ "PolicyProvider" ], "summary": "Update Policy External Api Provider", "description": "

Required permissions:
Following permissions are required: PolicyConfigurationEdit", "operationId": "UpdatePolicyProvider", "parameters": [ { "name": "providerId", "in": "path", "description": "PolicyProvider Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Update PolicyProvider request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdatePolicyProviderDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Success. PolicyProvider updated" }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. PolicyProvider with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } }, "delete": { "tags": [ "PolicyProvider" ], "summary": "Delete Policy Api Provider", "description": "\nDeletes an existing Policy External Api Provider.

Required permissions:
Following permissions are required: PolicyConfigurationDelete", "operationId": "DeleteProvider", "parameters": [ { "name": "providerId", "in": "path", "description": "PolicyProvider Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Success. PolicyProvider deleted" }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. PolicyProvider with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } } }, "components": { "schemas": { "AdditionalSearchFieldsConfigDto": { "type": "object", "properties": { "dataKey": { "type": "string", "description": "Data Key of Data Group field", "nullable": true, "example": "Address_Line1" } }, "additionalProperties": false, "description": "DTO which represents Additional Search Fields Configuration" }, "CreatePolicyProviderResponseDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of created Policy Api Provider", "format": "uuid", "example": "1bb44eba-d489-4138-8cfa-eee3d49250c9" } }, "additionalProperties": false }, "CreatePolicyProviderResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CreatePolicyProviderResponseDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ObjectServiceResponse": { "type": "object", "properties": { "data": { "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "PolicyProviderDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of PolicyProvider", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "name": { "type": "string", "description": "Name of Policy Api Provider", "nullable": true, "example": "Policy_api_provider_name" }, "serviceUrl": { "type": "string", "description": "Url of Policy Api Provider service", "nullable": true, "example": "https://TestProviderService.com" }, "encryptionKey": { "type": "string", "description": "Encryption key of Policy Api Provider", "nullable": true, "example": "MTIzNDU2Nzg5MTEyMzQ1Njc4OTExMjM0NTY3ODkxMTI=" }, "authenticationKey": { "type": "string", "description": "Authentication key of Policy Api Provider", "nullable": true, "example": "MTIzNDU2Nzg5MTEyMzQ1Njc4OTExMjM0NTY3ODkxMTI=" }, "type": { "type": "string", "description": "Type of Policy Api Provider\nAvailable options are: Search, Validation, DataGroupSearch, DataGroupValidation", "nullable": true, "example": "Search" }, "dataGroupId": { "type": "string", "description": "Id of selected data group. Required only for Types: DataGroupSearch and DataGroupValidation", "nullable": true, "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "searchFieldsConfigs": { "type": "array", "items": { "$ref": "#/components/schemas/SearchFieldsConfigDto" }, "description": "List of search field configuration. Required only for Type: DataGroupSearch", "nullable": true }, "resultFieldsConfig": { "type": "array", "items": { "$ref": "#/components/schemas/ResultFieldsConfigDto" }, "description": "List of result field configuration. Required only for Types: DataGroupSearch and DataGroupValidation", "nullable": true }, "additionalSearchFieldsConfigs": { "type": "array", "items": { "$ref": "#/components/schemas/AdditionalSearchFieldsConfigDto" }, "description": "List of data group fields sent as additional search context. Optional for Type: DataGroupSearch", "nullable": true }, "detailsUrl": { "type": "string", "description": "Url of getting details for selected option", "nullable": true, "example": "https://DetailsProviderService.com" }, "callIntegrationFlow": { "type": "boolean", "description": "The flag which indicates if Integration Flow should be called instead of ServiceUrl", "example": true }, "flowKey": { "type": "string", "description": "Integration Flow Key", "nullable": true, "example": "validationFlow" }, "detailsFlowKey": { "type": "string", "description": "Integration Flow Key of getting details for selected option", "nullable": true, "example": "validationFlowDetails" } }, "additionalProperties": false, "description": "Response DTO representing PolicyProvider" }, "PolicyProviderDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/PolicyProviderDto" } ], "description": "Response DTO representing PolicyProvider", "nullable": true } }, "additionalProperties": false }, "ResultFieldsConfigDto": { "type": "object", "properties": { "dataKey": { "type": "string", "description": "Data Key of Data Group field", "nullable": true, "example": "Address_Line1" } }, "additionalProperties": false, "description": "DTO which represents Result Field Configuration" }, "SearchFieldsConfigDto": { "type": "object", "properties": { "label": { "type": "string", "description": "Field label", "nullable": true, "example": "Full Address" }, "name": { "type": "string", "description": "Field Name which will be sent to adapter api", "nullable": true, "example": "FullAddress" } }, "additionalProperties": false, "description": "DTO which represents Search Field Configuration" }, "ServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ServiceResponseMessage": { "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "errorCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "StringServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "UpdatePolicyProviderDto": { "allOf": [ { "$ref": "#/components/schemas/PolicyProviderDto" }, { "type": "object", "properties": { "version": { "type": "integer", "description": "Current version of PolicyProvider aggregate where the changes needs to be applied. This parameter is required\nto guarantee consistency and conflicts detection. If it is not provided, it will save new changes\non top of latest without conflicts checking", "format": "int32", "default": -1, "example": -1 } }, "additionalProperties": false } ], "description": "Request DTO representing requirement metadata" }, "UpdatePolicyProviderDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/UpdatePolicyProviderDto" } ], "description": "Request DTO representing requirement metadata", "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "Please insert JWT with Bearer into field", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ] }