{ "swagger": "2.0", "info": { "title": "Risk Management", "description": "## TMF API Reference: TMF696 - Risk Assessment\n\n### Release : 20.0 - March 2020\n\nRisk Assessment API allows assessment of risks, such as party risk, risk associated with product offering, and risk associated with party role requesting a particular offering", "version": "4.0.0" }, "host": "serverRoot", "basePath": "/tmf-api/riskManagement/v4/", "schemes": [ "https" ], "consumes": [ "application/json;charset=utf-8" ], "produces": [ "application/json;charset=utf-8" ], "tags": [ { "name": "productOfferingRiskAssessment" }, { "name": "partyRoleRiskAssessment" }, { "name": "partyRoleProductOfferingRiskAssessment" }, { "name": "shoppingCartRiskAssessment" }, { "name": "productOrderRiskAssessment" }, { "name": "notification listeners (client side)" }, { "name": "events subscription" } ], "paths": { "/productOfferingRiskAssessment": { "get": { "operationId": "listProductOfferingRiskAssessment", "summary": "List or find ProductOfferingRiskAssessment objects", "description": "This operation list or find ProductOfferingRiskAssessment entities", "tags": [ "productOfferingRiskAssessment" ], "parameters": [ { "name": "fields", "description": "Comma-separated properties to be provided in response", "required": false, "in": "query", "type": "string" }, { "name": "offset", "description": "Requested index for start of resources to be provided in response", "required": false, "in": "query", "type": "integer" }, { "name": "limit", "description": "Requested number of resources to be provided in response", "required": false, "in": "query", "type": "integer" } ], "responses": { "200": { "description": "Success", "headers": { "X-Result-Count": { "description": "Actual number of items returned in the response body", "type": "integer" }, "X-Total-Count": { "description": "Total number of items matching criteria", "type": "integer" } }, "schema": { "type": "array", "items": { "$ref": "#/definitions/ProductOfferingRiskAssessment" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } }, "post": { "operationId": "createProductOfferingRiskAssessment", "summary": "Creates a ProductOfferingRiskAssessment", "description": "This operation creates a ProductOfferingRiskAssessment entity.", "tags": [ "productOfferingRiskAssessment" ], "parameters": [ { "name": "productOfferingRiskAssessment", "description": "The ProductOfferingRiskAssessment to be created", "required": true, "schema": { "$ref": "#/definitions/ProductOfferingRiskAssessment_Create" }, "in": "body" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/ProductOfferingRiskAssessment" } }, "201": { "description": "Created", "schema": { "$ref": "#/definitions/ProductOfferingRiskAssessment" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/productOfferingRiskAssessment/{id}": { "get": { "operationId": "retrieveProductOfferingRiskAssessment", "summary": "Retrieves a ProductOfferingRiskAssessment by ID", "description": "This operation retrieves a ProductOfferingRiskAssessment entity. Attribute selection is enabled for all first level attributes.", "tags": [ "productOfferingRiskAssessment" ], "parameters": [ { "name": "id", "description": "Identifier of the ProductOfferingRiskAssessment", "required": true, "type": "string", "in": "path" }, { "name": "fields", "description": "Comma-separated properties to provide in response", "required": false, "type": "string", "in": "query" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/ProductOfferingRiskAssessment" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "operationId": "deleteProductOfferingRiskAssessment", "summary": "Deletes a ProductOfferingRiskAssessment", "description": "This operation deletes a ProductOfferingRiskAssessment entity.", "tags": [ "productOfferingRiskAssessment" ], "parameters": [ { "name": "id", "description": "Identifier of the ProductOfferingRiskAssessment", "required": true, "type": "string", "in": "path" } ], "responses": { "204": { "description": "Deleted" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/partyRoleRiskAssessment": { "get": { "operationId": "listPartyRoleRiskAssessment", "summary": "List or find PartyRoleRiskAssessment objects", "description": "This operation list or find PartyRoleRiskAssessment entities", "tags": [ "partyRoleRiskAssessment" ], "parameters": [ { "name": "fields", "description": "Comma-separated properties to be provided in response", "required": false, "in": "query", "type": "string" }, { "name": "offset", "description": "Requested index for start of resources to be provided in response", "required": false, "in": "query", "type": "integer" }, { "name": "limit", "description": "Requested number of resources to be provided in response", "required": false, "in": "query", "type": "integer" } ], "responses": { "200": { "description": "Success", "headers": { "X-Result-Count": { "description": "Actual number of items returned in the response body", "type": "integer" }, "X-Total-Count": { "description": "Total number of items matching criteria", "type": "integer" } }, "schema": { "type": "array", "items": { "$ref": "#/definitions/PartyRoleRiskAssessment" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } }, "post": { "operationId": "createPartyRoleRiskAssessment", "summary": "Creates a PartyRoleRiskAssessment", "description": "This operation creates a PartyRoleRiskAssessment entity.", "tags": [ "partyRoleRiskAssessment" ], "parameters": [ { "name": "partyRoleRiskAssessment", "description": "The PartyRoleRiskAssessment to be created", "required": true, "schema": { "$ref": "#/definitions/PartyRoleRiskAssessment_Create" }, "in": "body" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/PartyRoleRiskAssessment" } }, "201": { "description": "Created", "schema": { "$ref": "#/definitions/PartyRoleRiskAssessment" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/partyRoleRiskAssessment/{id}": { "get": { "operationId": "retrievePartyRoleRiskAssessment", "summary": "Retrieves a PartyRoleRiskAssessment by ID", "description": "This operation retrieves a PartyRoleRiskAssessment entity. Attribute selection is enabled for all first level attributes.", "tags": [ "partyRoleRiskAssessment" ], "parameters": [ { "name": "id", "description": "Identifier of the PartyRoleRiskAssessment", "required": true, "type": "string", "in": "path" }, { "name": "fields", "description": "Comma-separated properties to provide in response", "required": false, "type": "string", "in": "query" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/PartyRoleRiskAssessment" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "operationId": "deletePartyRoleRiskAssessment", "summary": "Deletes a PartyRoleRiskAssessment", "description": "This operation deletes a PartyRoleRiskAssessment entity.", "tags": [ "partyRoleRiskAssessment" ], "parameters": [ { "name": "id", "description": "Identifier of the PartyRoleRiskAssessment", "required": true, "type": "string", "in": "path" } ], "responses": { "204": { "description": "Deleted" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/partyRoleProductOfferingRiskAssessment": { "get": { "operationId": "listPartyRoleProductOfferingRiskAssessment", "summary": "List or find PartyRoleProductOfferingRiskAssessment objects", "description": "This operation list or find PartyRoleProductOfferingRiskAssessment entities", "tags": [ "partyRoleProductOfferingRiskAssessment" ], "parameters": [ { "name": "fields", "description": "Comma-separated properties to be provided in response", "required": false, "in": "query", "type": "string" }, { "name": "offset", "description": "Requested index for start of resources to be provided in response", "required": false, "in": "query", "type": "integer" }, { "name": "limit", "description": "Requested number of resources to be provided in response", "required": false, "in": "query", "type": "integer" } ], "responses": { "200": { "description": "Success", "headers": { "X-Result-Count": { "description": "Actual number of items returned in the response body", "type": "integer" }, "X-Total-Count": { "description": "Total number of items matching criteria", "type": "integer" } }, "schema": { "type": "array", "items": { "$ref": "#/definitions/PartyRoleProductOfferingRiskAssessment" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } }, "post": { "operationId": "createPartyRoleProductOfferingRiskAssessment", "summary": "Creates a PartyRoleProductOfferingRiskAssessment", "description": "This operation creates a PartyRoleProductOfferingRiskAssessment entity.", "tags": [ "partyRoleProductOfferingRiskAssessment" ], "parameters": [ { "name": "partyRoleProductOfferingRiskAssessment", "description": "The PartyRoleProductOfferingRiskAssessment to be created", "required": true, "schema": { "$ref": "#/definitions/PartyRoleProductOfferingRiskAssessment_Create" }, "in": "body" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/PartyRoleProductOfferingRiskAssessment" } }, "201": { "description": "Created", "schema": { "$ref": "#/definitions/PartyRoleProductOfferingRiskAssessment" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/partyRoleProductOfferingRiskAssessment/{id}": { "get": { "operationId": "retrievePartyRoleProductOfferingRiskAssessment", "summary": "Retrieves a PartyRoleProductOfferingRiskAssessment by ID", "description": "This operation retrieves a PartyRoleProductOfferingRiskAssessment entity. Attribute selection is enabled for all first level attributes.", "tags": [ "partyRoleProductOfferingRiskAssessment" ], "parameters": [ { "name": "id", "description": "Identifier of the PartyRoleProductOfferingRiskAssessment", "required": true, "type": "string", "in": "path" }, { "name": "fields", "description": "Comma-separated properties to provide in response", "required": false, "type": "string", "in": "query" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/PartyRoleProductOfferingRiskAssessment" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "operationId": "deletePartyRoleProductOfferingRiskAssessment", "summary": "Deletes a PartyRoleProductOfferingRiskAssessment", "description": "This operation deletes a PartyRoleProductOfferingRiskAssessment entity.", "tags": [ "partyRoleProductOfferingRiskAssessment" ], "parameters": [ { "name": "id", "description": "Identifier of the PartyRoleProductOfferingRiskAssessment", "required": true, "type": "string", "in": "path" } ], "responses": { "204": { "description": "Deleted" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/shoppingCartRiskAssessment": { "get": { "operationId": "listShoppingCartRiskAssessment", "summary": "List or find ShoppingCartRiskAssessment objects", "description": "This operation list or find ShoppingCartRiskAssessment entities", "tags": [ "shoppingCartRiskAssessment" ], "parameters": [ { "name": "fields", "description": "Comma-separated properties to be provided in response", "required": false, "in": "query", "type": "string" }, { "name": "offset", "description": "Requested index for start of resources to be provided in response", "required": false, "in": "query", "type": "integer" }, { "name": "limit", "description": "Requested number of resources to be provided in response", "required": false, "in": "query", "type": "integer" } ], "responses": { "200": { "description": "Success", "headers": { "X-Result-Count": { "description": "Actual number of items returned in the response body", "type": "integer" }, "X-Total-Count": { "description": "Total number of items matching criteria", "type": "integer" } }, "schema": { "type": "array", "items": { "$ref": "#/definitions/ShoppingCartRiskAssessment" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } }, "post": { "operationId": "createShoppingCartRiskAssessment", "summary": "Creates a ShoppingCartRiskAssessment", "description": "This operation creates a ShoppingCartRiskAssessment entity.", "tags": [ "shoppingCartRiskAssessment" ], "parameters": [ { "name": "shoppingCartRiskAssessment", "description": "The ShoppingCartRiskAssessment to be created", "required": true, "schema": { "$ref": "#/definitions/ShoppingCartRiskAssessment_Create" }, "in": "body" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/ShoppingCartRiskAssessment" } }, "201": { "description": "Created", "schema": { "$ref": "#/definitions/ShoppingCartRiskAssessment" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/shoppingCartRiskAssessment/{id}": { "get": { "operationId": "retrieveShoppingCartRiskAssessment", "summary": "Retrieves a ShoppingCartRiskAssessment by ID", "description": "This operation retrieves a ShoppingCartRiskAssessment entity. Attribute selection is enabled for all first level attributes.", "tags": [ "shoppingCartRiskAssessment" ], "parameters": [ { "name": "id", "description": "Identifier of the ShoppingCartRiskAssessment", "required": true, "type": "string", "in": "path" }, { "name": "fields", "description": "Comma-separated properties to provide in response", "required": false, "type": "string", "in": "query" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/ShoppingCartRiskAssessment" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "operationId": "deleteShoppingCartRiskAssessment", "summary": "Deletes a ShoppingCartRiskAssessment", "description": "This operation deletes a ShoppingCartRiskAssessment entity.", "tags": [ "shoppingCartRiskAssessment" ], "parameters": [ { "name": "id", "description": "Identifier of the ShoppingCartRiskAssessment", "required": true, "type": "string", "in": "path" } ], "responses": { "204": { "description": "Deleted" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/productOrderRiskAssessment": { "get": { "operationId": "listProductOrderRiskAssessment", "summary": "List or find ProductOrderRiskAssessment objects", "description": "This operation list or find ProductOrderRiskAssessment entities", "tags": [ "productOrderRiskAssessment" ], "parameters": [ { "name": "fields", "description": "Comma-separated properties to be provided in response", "required": false, "in": "query", "type": "string" }, { "name": "offset", "description": "Requested index for start of resources to be provided in response", "required": false, "in": "query", "type": "integer" }, { "name": "limit", "description": "Requested number of resources to be provided in response", "required": false, "in": "query", "type": "integer" } ], "responses": { "200": { "description": "Success", "headers": { "X-Result-Count": { "description": "Actual number of items returned in the response body", "type": "integer" }, "X-Total-Count": { "description": "Total number of items matching criteria", "type": "integer" } }, "schema": { "type": "array", "items": { "$ref": "#/definitions/ProductOrderRiskAssessment" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } }, "post": { "operationId": "createProductOrderRiskAssessment", "summary": "Creates a ProductOrderRiskAssessment", "description": "This operation creates a ProductOrderRiskAssessment entity.", "tags": [ "productOrderRiskAssessment" ], "parameters": [ { "name": "productOrderRiskAssessment", "description": "The ProductOrderRiskAssessment to be created", "required": true, "schema": { "$ref": "#/definitions/ProductOrderRiskAssessment_Create" }, "in": "body" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/ProductOrderRiskAssessment" } }, "201": { "description": "Created", "schema": { "$ref": "#/definitions/ProductOrderRiskAssessment" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/productOrderRiskAssessment/{id}": { "get": { "operationId": "retrieveProductOrderRiskAssessment", "summary": "Retrieves a ProductOrderRiskAssessment by ID", "description": "This operation retrieves a ProductOrderRiskAssessment entity. Attribute selection is enabled for all first level attributes.", "tags": [ "productOrderRiskAssessment" ], "parameters": [ { "name": "id", "description": "Identifier of the ProductOrderRiskAssessment", "required": true, "type": "string", "in": "path" }, { "name": "fields", "description": "Comma-separated properties to provide in response", "required": false, "type": "string", "in": "query" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/ProductOrderRiskAssessment" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "operationId": "deleteProductOrderRiskAssessment", "summary": "Deletes a ProductOrderRiskAssessment", "description": "This operation deletes a ProductOrderRiskAssessment entity.", "tags": [ "productOrderRiskAssessment" ], "parameters": [ { "name": "id", "description": "Identifier of the ProductOrderRiskAssessment", "required": true, "type": "string", "in": "path" } ], "responses": { "204": { "description": "Deleted" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/hub": { "post": { "operationId": "registerListener", "summary": "Register a listener", "description": "Sets the communication endpoint address the service instance must use to deliver information about its health state, execution state, failures and metrics.", "tags": [ "events subscription" ], "parameters": [ { "name": "data", "schema": { "$ref": "#/definitions/EventSubscriptionInput" }, "required": true, "in": "body", "description": "Data containing the callback endpoint to deliver the information" } ], "responses": { "201": { "description": "Subscribed", "schema": { "$ref": "#/definitions/EventSubscription" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/hub/{id}": { "delete": { "operationId": "unregisterListener", "summary": "Unregister a listener", "description": "Resets the communication endpoint address the service instance must use to deliver information about its health state, execution state, failures and metrics.", "tags": [ "events subscription" ], "parameters": [ { "name": "id", "type": "string", "required": true, "in": "path", "description": "The id of the registered listener" } ], "responses": { "204": { "description": "Deleted" }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method not allowed", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/listener/productOfferingRiskAssessmentCreateEvent": { "post": { "operationId": "listenToProductOfferingRiskAssessmentCreateEvent", "summary": "Client listener for entity ProductOfferingRiskAssessmentCreateEvent", "description": "Example of a client listener for receiving the notification ProductOfferingRiskAssessmentCreateEvent", "tags": [ "notification listeners (client side)" ], "parameters": [ { "name": "data", "required": true, "in": "body", "description": "The event data", "schema": { "$ref": "#/definitions/ProductOfferingRiskAssessmentCreateEvent" } } ], "responses": { "201": { "description": "Notified", "schema": { "$ref": "#/definitions/EventSubscription" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/listener/productOfferingRiskAssessmentDeleteEvent": { "post": { "operationId": "listenToProductOfferingRiskAssessmentDeleteEvent", "summary": "Client listener for entity ProductOfferingRiskAssessmentDeleteEvent", "description": "Example of a client listener for receiving the notification ProductOfferingRiskAssessmentDeleteEvent", "tags": [ "notification listeners (client side)" ], "parameters": [ { "name": "data", "required": true, "in": "body", "description": "The event data", "schema": { "$ref": "#/definitions/ProductOfferingRiskAssessmentDeleteEvent" } } ], "responses": { "201": { "description": "Notified", "schema": { "$ref": "#/definitions/EventSubscription" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/listener/productOfferingRiskAssessmentStatusChangeEvent": { "post": { "operationId": "listenToProductOfferingRiskAssessmentStatusChangeEvent", "summary": "Client listener for entity ProductOfferingRiskAssessmentStatusChangeEvent", "description": "Example of a client listener for receiving the notification ProductOfferingRiskAssessmentStatusChangeEvent", "tags": [ "notification listeners (client side)" ], "parameters": [ { "name": "data", "required": true, "in": "body", "description": "The event data", "schema": { "$ref": "#/definitions/ProductOfferingRiskAssessmentStatusChangeEvent" } } ], "responses": { "201": { "description": "Notified", "schema": { "$ref": "#/definitions/EventSubscription" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/listener/partyRoleRiskAssessmentCreateEvent": { "post": { "operationId": "listenToPartyRoleRiskAssessmentCreateEvent", "summary": "Client listener for entity PartyRoleRiskAssessmentCreateEvent", "description": "Example of a client listener for receiving the notification PartyRoleRiskAssessmentCreateEvent", "tags": [ "notification listeners (client side)" ], "parameters": [ { "name": "data", "required": true, "in": "body", "description": "The event data", "schema": { "$ref": "#/definitions/PartyRoleRiskAssessmentCreateEvent" } } ], "responses": { "201": { "description": "Notified", "schema": { "$ref": "#/definitions/EventSubscription" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/listener/partyRoleRiskAssessmentDeleteEvent": { "post": { "operationId": "listenToPartyRoleRiskAssessmentDeleteEvent", "summary": "Client listener for entity PartyRoleRiskAssessmentDeleteEvent", "description": "Example of a client listener for receiving the notification PartyRoleRiskAssessmentDeleteEvent", "tags": [ "notification listeners (client side)" ], "parameters": [ { "name": "data", "required": true, "in": "body", "description": "The event data", "schema": { "$ref": "#/definitions/PartyRoleRiskAssessmentDeleteEvent" } } ], "responses": { "201": { "description": "Notified", "schema": { "$ref": "#/definitions/EventSubscription" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/listener/partyRoleRiskAssessmentStatusChangeEvent": { "post": { "operationId": "listenToPartyRoleRiskAssessmentStatusChangeEvent", "summary": "Client listener for entity PartyRoleRiskAssessmentStatusChangeEvent", "description": "Example of a client listener for receiving the notification PartyRoleRiskAssessmentStatusChangeEvent", "tags": [ "notification listeners (client side)" ], "parameters": [ { "name": "data", "required": true, "in": "body", "description": "The event data", "schema": { "$ref": "#/definitions/PartyRoleRiskAssessmentStatusChangeEvent" } } ], "responses": { "201": { "description": "Notified", "schema": { "$ref": "#/definitions/EventSubscription" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/listener/partyRoleProductOfferingRiskAssessmentCreateEvent": { "post": { "operationId": "listenToPartyRoleProductOfferingRiskAssessmentCreateEvent", "summary": "Client listener for entity PartyRoleProductOfferingRiskAssessmentCreateEvent", "description": "Example of a client listener for receiving the notification PartyRoleProductOfferingRiskAssessmentCreateEvent", "tags": [ "notification listeners (client side)" ], "parameters": [ { "name": "data", "required": true, "in": "body", "description": "The event data", "schema": { "$ref": "#/definitions/PartyRoleProductOfferingRiskAssessmentCreateEvent" } } ], "responses": { "201": { "description": "Notified", "schema": { "$ref": "#/definitions/EventSubscription" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/listener/partyRoleProductOfferingRiskAssessmentDeleteEvent": { "post": { "operationId": "listenToPartyRoleProductOfferingRiskAssessmentDeleteEvent", "summary": "Client listener for entity PartyRoleProductOfferingRiskAssessmentDeleteEvent", "description": "Example of a client listener for receiving the notification PartyRoleProductOfferingRiskAssessmentDeleteEvent", "tags": [ "notification listeners (client side)" ], "parameters": [ { "name": "data", "required": true, "in": "body", "description": "The event data", "schema": { "$ref": "#/definitions/PartyRoleProductOfferingRiskAssessmentDeleteEvent" } } ], "responses": { "201": { "description": "Notified", "schema": { "$ref": "#/definitions/EventSubscription" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/listener/partyRoleProductOfferingRiskAssessmentStatusChangeEvent": { "post": { "operationId": "listenToPartyRoleProductOfferingRiskAssessmentStatusChangeEvent", "summary": "Client listener for entity PartyRoleProductOfferingRiskAssessmentStatusChangeEvent", "description": "Example of a client listener for receiving the notification PartyRoleProductOfferingRiskAssessmentStatusChangeEvent", "tags": [ "notification listeners (client side)" ], "parameters": [ { "name": "data", "required": true, "in": "body", "description": "The event data", "schema": { "$ref": "#/definitions/PartyRoleProductOfferingRiskAssessmentStatusChangeEvent" } } ], "responses": { "201": { "description": "Notified", "schema": { "$ref": "#/definitions/EventSubscription" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/listener/shoppingCartRiskAssessmentCreateEvent": { "post": { "operationId": "listenToShoppingCartRiskAssessmentCreateEvent", "summary": "Client listener for entity ShoppingCartRiskAssessmentCreateEvent", "description": "Example of a client listener for receiving the notification ShoppingCartRiskAssessmentCreateEvent", "tags": [ "notification listeners (client side)" ], "parameters": [ { "name": "data", "required": true, "in": "body", "description": "The event data", "schema": { "$ref": "#/definitions/ShoppingCartRiskAssessmentCreateEvent" } } ], "responses": { "201": { "description": "Notified", "schema": { "$ref": "#/definitions/EventSubscription" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/listener/shoppingCartRiskAssessmentDeleteEvent": { "post": { "operationId": "listenToShoppingCartRiskAssessmentDeleteEvent", "summary": "Client listener for entity ShoppingCartRiskAssessmentDeleteEvent", "description": "Example of a client listener for receiving the notification ShoppingCartRiskAssessmentDeleteEvent", "tags": [ "notification listeners (client side)" ], "parameters": [ { "name": "data", "required": true, "in": "body", "description": "The event data", "schema": { "$ref": "#/definitions/ShoppingCartRiskAssessmentDeleteEvent" } } ], "responses": { "201": { "description": "Notified", "schema": { "$ref": "#/definitions/EventSubscription" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/listener/shoppingCartRiskAssessmentStatusChangeEvent": { "post": { "operationId": "listenToShoppingCartRiskAssessmentStatusChangeEvent", "summary": "Client listener for entity ShoppingCartRiskAssessmentStatusChangeEvent", "description": "Example of a client listener for receiving the notification ShoppingCartRiskAssessmentStatusChangeEvent", "tags": [ "notification listeners (client side)" ], "parameters": [ { "name": "data", "required": true, "in": "body", "description": "The event data", "schema": { "$ref": "#/definitions/ShoppingCartRiskAssessmentStatusChangeEvent" } } ], "responses": { "201": { "description": "Notified", "schema": { "$ref": "#/definitions/EventSubscription" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/listener/productOrderRiskAssessmentCreateEvent": { "post": { "operationId": "listenToProductOrderRiskAssessmentCreateEvent", "summary": "Client listener for entity ProductOrderRiskAssessmentCreateEvent", "description": "Example of a client listener for receiving the notification ProductOrderRiskAssessmentCreateEvent", "tags": [ "notification listeners (client side)" ], "parameters": [ { "name": "data", "required": true, "in": "body", "description": "The event data", "schema": { "$ref": "#/definitions/ProductOrderRiskAssessmentCreateEvent" } } ], "responses": { "201": { "description": "Notified", "schema": { "$ref": "#/definitions/EventSubscription" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/listener/productOrderRiskAssessmentDeleteEvent": { "post": { "operationId": "listenToProductOrderRiskAssessmentDeleteEvent", "summary": "Client listener for entity ProductOrderRiskAssessmentDeleteEvent", "description": "Example of a client listener for receiving the notification ProductOrderRiskAssessmentDeleteEvent", "tags": [ "notification listeners (client side)" ], "parameters": [ { "name": "data", "required": true, "in": "body", "description": "The event data", "schema": { "$ref": "#/definitions/ProductOrderRiskAssessmentDeleteEvent" } } ], "responses": { "201": { "description": "Notified", "schema": { "$ref": "#/definitions/EventSubscription" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/listener/productOrderRiskAssessmentStatusChangeEvent": { "post": { "operationId": "listenToProductOrderRiskAssessmentStatusChangeEvent", "summary": "Client listener for entity ProductOrderRiskAssessmentStatusChangeEvent", "description": "Example of a client listener for receiving the notification ProductOrderRiskAssessmentStatusChangeEvent", "tags": [ "notification listeners (client side)" ], "parameters": [ { "name": "data", "required": true, "in": "body", "description": "The event data", "schema": { "$ref": "#/definitions/ProductOrderRiskAssessmentStatusChangeEvent" } } ], "responses": { "201": { "description": "Notified", "schema": { "$ref": "#/definitions/EventSubscription" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } } }, "definitions": { "Addressable": { "type": "object", "description": "Base schema for adressable entities", "properties": { "id": { "type": "string", "description": "unique identifier" }, "href": { "type": "string", "format": "uri", "description": "Hyperlink reference" } } }, "Any": {}, "Characteristic": { "type": "object", "description": "Describes a given characteristic of an object or entity through a name/value pair.", "required": [ "name", "value" ], "properties": { "id": { "type": "string", "description": "Unique identifier of the characteristic" }, "name": { "type": "string", "description": "Name of the characteristic" }, "valueType": { "type": "string", "description": "Data type of the value of the characteristic" }, "characteristicRelationship": { "type": "array", "items": { "$ref": "#/definitions/CharacteristicRelationship" } }, "value": { "$ref": "#/definitions/Any", "description": "The value of the characteristic" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" } } }, "CharacteristicRelationship": { "type": "object", "description": "Another Characteristic that is related to the current Characteristic.", "properties": { "id": { "type": "string", "description": "Unique identifier of the characteristic" }, "href": { "type": "string", "format": "uri", "description": "Hyperlink reference" }, "relationshipType": { "type": "string", "description": "The type of relationship" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" } } }, "Entity": { "type": "object", "description": "Base entity schema for use in TMForum Open-APIs", "properties": { "id": { "type": "string", "description": "unique identifier" }, "href": { "type": "string", "format": "uri", "description": "Hyperlink reference" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" } } }, "EntityRef": { "type": "object", "description": "Entity reference schema to be use for all entityRef class.", "properties": { "id": { "type": "string", "description": "unique identifier" }, "href": { "type": "string", "format": "uri", "description": "Hyperlink reference" }, "name": { "type": "string", "description": "Name of the related entity." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "required": [ "id" ] }, "Extensible": { "type": "object", "description": "Base Extensible schema for use in TMForum Open-APIs", "properties": { "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" } } }, "PartyRoleProductOfferingRiskAssessment": { "type": "object", "description": "This is a task resource allowing assessment of the risks associated with a party or party role that considers acquiring a specific product offering", "required": [ "partyRole", "productOffering" ], "properties": { "id": { "type": "string", "description": "unique identifier" }, "href": { "type": "string", "format": "uri", "description": "Hyperlink reference" }, "status": { "type": "string", "description": "The status of the risk assessment, such as Succeeded, In Progress, Failed, output from the task" }, "characteristic": { "type": "array", "items": { "$ref": "#/definitions/Characteristic" }, "description": "Additional characteristics for which the risk might be assessed, optional input to the task" }, "partyRole": { "$ref": "#/definitions/RelatedParty", "description": "The party or party role for which the assessment is to be carried out, must be supplied as input to the task, with the attribute id populated" }, "place": { "$ref": "#/definitions/RelatedPlace", "description": "The place for which the risk is assessed, this is optional input to the task" }, "productOffering": { "$ref": "#/definitions/ProductOfferingRef", "description": "The product offering for which the assessment is to be carried out, must be supplied as input to the task, with the attribute id populated" }, "riskAssessmentResult": { "$ref": "#/definitions/RiskAssessmentResult", "description": "The result of the risk assessment, output from the task" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" } } }, "PartyRoleProductOfferingRiskAssessment_Create": { "type": "object", "description": "This is a task resource allowing assessment of the risks associated with a party or party role that considers acquiring a specific product offering\nSkipped properties: id,href", "required": [ "partyRole", "productOffering" ], "properties": { "status": { "type": "string", "description": "The status of the risk assessment, such as Succeeded, In Progress, Failed, output from the task" }, "characteristic": { "type": "array", "items": { "$ref": "#/definitions/Characteristic" }, "description": "Additional characteristics for which the risk might be assessed, optional input to the task" }, "partyRole": { "$ref": "#/definitions/RelatedParty", "description": "The party or party role for which the assessment is to be carried out, must be supplied as input to the task, with the attribute id populated" }, "place": { "$ref": "#/definitions/RelatedPlace", "description": "The place for which the risk is assessed, this is optional input to the task" }, "productOffering": { "$ref": "#/definitions/ProductOfferingRef", "description": "The product offering for which the assessment is to be carried out, must be supplied as input to the task, with the attribute id populated" }, "riskAssessmentResult": { "$ref": "#/definitions/RiskAssessmentResult", "description": "The result of the risk assessment, output from the task" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" } } }, "PartyRoleRiskAssessment": { "type": "object", "description": "This is a task resource allowing assessment of the risks associated with a party role", "required": [ "partyRole" ], "properties": { "id": { "type": "string", "description": "unique identifier" }, "href": { "type": "string", "format": "uri", "description": "Hyperlink reference" }, "status": { "type": "string", "description": "The status of the risk assessment, such as Succeeded, In Progress, Failed, output from the task" }, "characteristic": { "type": "array", "items": { "$ref": "#/definitions/Characteristic" }, "description": "Additional characteristics for which the risk might be assessed, optional input to the task" }, "partyRole": { "$ref": "#/definitions/RelatedParty", "description": "The party role for which the assessment is to be carried out, must be supplied as input to the task, with the attribute id populated" }, "place": { "$ref": "#/definitions/RelatedPlace", "description": "The place for which the risk is assessed, this is optional input to the task" }, "riskAssessmentResult": { "$ref": "#/definitions/RiskAssessmentResult", "description": "The result of the risk assessment, output from the task" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" } } }, "PartyRoleRiskAssessment_Create": { "type": "object", "description": "This is a task resource allowing assessment of the risks associated with a party role\nSkipped properties: id,href", "required": [ "partyRole" ], "properties": { "status": { "type": "string", "description": "The status of the risk assessment, such as Succeeded, In Progress, Failed, output from the task" }, "characteristic": { "type": "array", "items": { "$ref": "#/definitions/Characteristic" }, "description": "Additional characteristics for which the risk might be assessed, optional input to the task" }, "partyRole": { "$ref": "#/definitions/RelatedParty", "description": "The party role for which the assessment is to be carried out, must be supplied as input to the task, with the attribute id populated" }, "place": { "$ref": "#/definitions/RelatedPlace", "description": "The place for which the risk is assessed, this is optional input to the task" }, "riskAssessmentResult": { "$ref": "#/definitions/RiskAssessmentResult", "description": "The result of the risk assessment, output from the task" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" } } }, "ProductOfferingRef": { "type": "object", "description": "ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.", "properties": { "id": { "type": "string", "description": "unique identifier" }, "href": { "type": "string", "format": "uri", "description": "Hyperlink reference" }, "name": { "type": "string", "description": "Name of the related entity." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "required": [ "id" ] }, "ProductOfferingRiskAssessment": { "type": "object", "description": "This is a task resource allowing assessment of the risks associated with a product offering. For example, the risk associated with iPhone X will probably be higher than the risk for a battery", "required": [ "productOffering" ], "properties": { "id": { "type": "string", "description": "unique identifier" }, "href": { "type": "string", "format": "uri", "description": "Hyperlink reference" }, "status": { "type": "string", "description": "The status of the risk assessment, such as Succeeded, In Progress, Failed, output from the task" }, "characteristic": { "type": "array", "items": { "$ref": "#/definitions/Characteristic" }, "description": "Additional characteristics for which the risk might be assessed, optional input to the task" }, "place": { "$ref": "#/definitions/RelatedPlace", "description": "The place for which the risk is assessed, this is optional input to the task" }, "productOffering": { "$ref": "#/definitions/ProductOfferingRef", "description": "The product offering for which the assessment is to be carried out, must be supplied as input to the task, with the attribute id populated" }, "riskAssessmentResult": { "$ref": "#/definitions/RiskAssessmentResult", "description": "The result of the risk assessment, output from the task" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" } } }, "ProductOfferingRiskAssessment_Create": { "type": "object", "description": "This is a task resource allowing assessment of the risks associated with a product offering. For example, the risk associated with iPhone X will probably be higher than the risk for a battery\nSkipped properties: id,href", "required": [ "productOffering" ], "properties": { "status": { "type": "string", "description": "The status of the risk assessment, such as Succeeded, In Progress, Failed, output from the task" }, "characteristic": { "type": "array", "items": { "$ref": "#/definitions/Characteristic" }, "description": "Additional characteristics for which the risk might be assessed, optional input to the task" }, "place": { "$ref": "#/definitions/RelatedPlace", "description": "The place for which the risk is assessed, this is optional input to the task" }, "productOffering": { "$ref": "#/definitions/ProductOfferingRef", "description": "The product offering for which the assessment is to be carried out, must be supplied as input to the task, with the attribute id populated" }, "riskAssessmentResult": { "$ref": "#/definitions/RiskAssessmentResult", "description": "The result of the risk assessment, output from the task" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" } } }, "ProductOrderRef": { "type": "object", "description": "ProductOrder (ProductOrder) .The product order which the recommendation is related with.", "properties": { "id": { "type": "string", "description": "unique identifier" }, "href": { "type": "string", "format": "uri", "description": "Hyperlink reference" }, "name": { "type": "string", "description": "Name of the related entity." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "required": [ "id" ] }, "ProductOrderRiskAssessment": { "type": "object", "description": "This is a task resource allowing assessment of the risks associated with a product order - presumably submitted by a party role and containing one or more product offerings", "required": [ "productOrder" ], "properties": { "id": { "type": "string", "description": "unique identifier" }, "href": { "type": "string", "format": "uri", "description": "Hyperlink reference" }, "status": { "type": "string", "description": "The status of the risk assessment, such as Succeeded, In Progress, Failed, output from the task" }, "characteristic": { "type": "array", "items": { "$ref": "#/definitions/Characteristic" }, "description": "Additional characteristics for which the risk might be assessed, optional input to the task" }, "place": { "$ref": "#/definitions/RelatedPlace", "description": "The place for which the risk is assessed, this is optional input to the task" }, "productOrder": { "$ref": "#/definitions/ProductOrderRef", "description": "The product order for which the assessment is to be carried out, must be supplied as input to the task, with the attribute id populated" }, "riskAssessmentResult": { "$ref": "#/definitions/RiskAssessmentResult", "description": "The result of the risk assessment, output from the task" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" } } }, "ProductOrderRiskAssessment_Create": { "type": "object", "description": "This is a task resource allowing assessment of the risks associated with a product order - presumably submitted by a party role and containing one or more product offerings\nSkipped properties: id,href", "required": [ "productOrder" ], "properties": { "status": { "type": "string", "description": "The status of the risk assessment, such as Succeeded, In Progress, Failed, output from the task" }, "characteristic": { "type": "array", "items": { "$ref": "#/definitions/Characteristic" }, "description": "Additional characteristics for which the risk might be assessed, optional input to the task" }, "place": { "$ref": "#/definitions/RelatedPlace", "description": "The place for which the risk is assessed, this is optional input to the task" }, "productOrder": { "$ref": "#/definitions/ProductOrderRef", "description": "The product order for which the assessment is to be carried out, must be supplied as input to the task, with the attribute id populated" }, "riskAssessmentResult": { "$ref": "#/definitions/RiskAssessmentResult", "description": "The result of the risk assessment, output from the task" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" } } }, "RelatedParty": { "type": "object", "description": "Related Entity reference. A related party defines party or party role linked to a specific entity.", "required": [ "@referredType", "id" ], "properties": { "id": { "type": "string", "description": "unique identifier" }, "href": { "type": "string", "format": "uri", "description": "Hyperlink reference" }, "name": { "type": "string", "description": "Name of the related entity." }, "role": { "type": "string", "description": "Role played by the related party" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } } }, "RelatedPlace": { "type": "object", "description": "A Place and an associated role as installation adress, delivery address, etc....", "properties": { "id": { "type": "string", "description": "Unique identifier of the place" }, "href": { "type": "string", "description": "Unique reference of the place" }, "name": { "type": "string", "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]" }, "role": { "type": "string", "description": "Role of the place, such as: [home delivery], [shop retrieval])" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } } }, "RiskAssessment": { "type": "object", "description": "This is a generalized task resource allowing assessment of risks - it is expected that the resource will be specialized to reflect specific risks, such as risks associated with a party, or with an order, etc.", "properties": { "id": { "type": "string", "description": "unique identifier" }, "href": { "type": "string", "format": "uri", "description": "Hyperlink reference" }, "status": { "type": "string", "description": "The status of the risk assessment, such as Succeeded, In Progress, Failed, output from the task" }, "characteristic": { "type": "array", "items": { "$ref": "#/definitions/Characteristic" }, "description": "Additional characteristics for which the risk might be assessed, optional input to the task" }, "place": { "$ref": "#/definitions/RelatedPlace", "description": "The place for which the risk is assessed, this is optional input to the task" }, "riskAssessmentResult": { "$ref": "#/definitions/RiskAssessmentResult", "description": "The result of the risk assessment, output from the task" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" } } }, "RiskAssessmentResult": { "type": "object", "description": "This resource reflects the risk assessment", "properties": { "overallScore": { "type": "number", "format": "float", "description": "An overall assessment of the risk, composed from the individual scores" }, "score": { "type": "array", "items": { "$ref": "#/definitions/RiskScore" }, "description": "Additional characteristics for which the risk might be assessed, optional input to the task" }, "validFor": { "$ref": "#/definitions/TimePeriod", "description": "Period for which this result is considered valid and not stale" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" } } }, "RiskScore": { "type": "object", "description": "This resource reflects a score for a specific risk", "properties": { "score": { "type": "number", "format": "float", "description": "The risk score" }, "riskName": { "$ref": "#/definitions/RiskType", "description": "The name of the risk" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" } } }, "RiskType": { "type": "string", "description": "Types of risk that can be assessed", "enum": [ "FraudRisk", "BadPaymentRisk", "CreditGamingRisk", "IDConfidenceRisk", "PaymentMethodRisk" ] }, "ShoppingCartRef": { "type": "object", "description": "ShoppingCart (ShoppingCartRef) . The shopping cart which the recommendation is related with.", "properties": { "id": { "type": "string", "description": "Unique identifier of shopping cart" }, "href": { "type": "string", "description": "Hypertext Reference of the shopping cart." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "required": [ "id" ] }, "ShoppingCartRiskAssessment": { "type": "object", "description": "This is a task resource allowing assessment of the risks associated with a shopping cart - presumably created by a party role and containing one or more product offerings", "required": [ "shoppingCart" ], "properties": { "id": { "type": "string", "description": "unique identifier" }, "href": { "type": "string", "format": "uri", "description": "Hyperlink reference" }, "status": { "type": "string", "description": "The status of the risk assessment, such as Succeeded, In Progress, Failed, output from the task" }, "characteristic": { "type": "array", "items": { "$ref": "#/definitions/Characteristic" }, "description": "Additional characteristics for which the risk might be assessed, optional input to the task" }, "place": { "$ref": "#/definitions/RelatedPlace", "description": "The place for which the risk is assessed, this is optional input to the task" }, "riskAssessmentResult": { "$ref": "#/definitions/RiskAssessmentResult", "description": "The result of the risk assessment, output from the task" }, "shoppingCart": { "$ref": "#/definitions/ShoppingCartRef", "description": "The shopping cart for which the assessment is to be carried out, must be supplied as input to the task, with the attribute id populated" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" } } }, "ShoppingCartRiskAssessment_Create": { "type": "object", "description": "This is a task resource allowing assessment of the risks associated with a shopping cart - presumably created by a party role and containing one or more product offerings\nSkipped properties: id,href", "required": [ "shoppingCart" ], "properties": { "status": { "type": "string", "description": "The status of the risk assessment, such as Succeeded, In Progress, Failed, output from the task" }, "characteristic": { "type": "array", "items": { "$ref": "#/definitions/Characteristic" }, "description": "Additional characteristics for which the risk might be assessed, optional input to the task" }, "place": { "$ref": "#/definitions/RelatedPlace", "description": "The place for which the risk is assessed, this is optional input to the task" }, "riskAssessmentResult": { "$ref": "#/definitions/RiskAssessmentResult", "description": "The result of the risk assessment, output from the task" }, "shoppingCart": { "$ref": "#/definitions/ShoppingCartRef", "description": "The shopping cart for which the assessment is to be carried out, must be supplied as input to the task, with the attribute id populated" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" } } }, "TimePeriod": { "type": "object", "description": "A period of time, either as a deadline (endDateTime only) a startDateTime only, or both", "properties": { "endDateTime": { "example": "1985-04-12T23:20:50.52Z", "type": "string", "format": "date-time", "description": "End of the time period, using IETC-RFC-3339 format" }, "startDateTime": { "example": "1985-04-12T23:20:50.52Z", "type": "string", "format": "date-time", "description": "Start of the time period, using IETC-RFC-3339 format" } } }, "EventSubscription": { "type": "object", "description": "Sets the communication endpoint address the service instance must use to deliver notification information", "required": [ "id", "callback" ], "properties": { "id": { "type": "string", "description": "Id of the listener" }, "callback": { "type": "string", "description": "The callback being registered." }, "query": { "type": "string", "description": "additional data to be passed" } } }, "EventSubscriptionInput": { "type": "object", "description": "Sets the communication endpoint address the service instance must use to deliver notification information", "required": [ "callback" ], "properties": { "callback": { "type": "string", "description": "The callback being registered." }, "query": { "type": "string", "description": "additional data to be passed" } } }, "ProductOfferingRiskAssessmentCreateEvent": { "type": "object", "description": "The notification data structure", "properties": { "event": { "description": "The event payload linked to the involved resource object", "$ref": "#/definitions/ProductOfferingRiskAssessmentCreateEventPayload" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time", "description": "The time the event occured." } } }, "ProductOfferingRiskAssessmentCreateEventPayload": { "type": "object", "description": "The event data structure", "properties": { "productOfferingRiskAssessment": { "description": "The involved resource data for the event", "$ref": "#/definitions/ProductOfferingRiskAssessment" } } }, "ProductOfferingRiskAssessmentDeleteEvent": { "type": "object", "description": "The notification data structure", "properties": { "event": { "description": "The event payload linked to the involved resource object", "$ref": "#/definitions/ProductOfferingRiskAssessmentDeleteEventPayload" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time", "description": "The time the event occured." } } }, "ProductOfferingRiskAssessmentDeleteEventPayload": { "type": "object", "description": "The event data structure", "properties": { "productOfferingRiskAssessment": { "description": "The involved resource data for the event", "$ref": "#/definitions/ProductOfferingRiskAssessment" } } }, "ProductOfferingRiskAssessmentStatusChangeEvent": { "type": "object", "description": "The notification data structure", "properties": { "event": { "description": "The event payload linked to the involved resource object", "$ref": "#/definitions/ProductOfferingRiskAssessmentStatusChangeEventPayload" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time", "description": "The time the event occured." } } }, "ProductOfferingRiskAssessmentStatusChangeEventPayload": { "type": "object", "description": "The event data structure", "properties": { "productOfferingRiskAssessment": { "description": "The involved resource data for the event", "$ref": "#/definitions/ProductOfferingRiskAssessment" } } }, "PartyRoleRiskAssessmentCreateEvent": { "type": "object", "description": "The notification data structure", "properties": { "event": { "description": "The event payload linked to the involved resource object", "$ref": "#/definitions/PartyRoleRiskAssessmentCreateEventPayload" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time", "description": "The time the event occured." } } }, "PartyRoleRiskAssessmentCreateEventPayload": { "type": "object", "description": "The event data structure", "properties": { "partyRoleRiskAssessment": { "description": "The involved resource data for the event", "$ref": "#/definitions/PartyRoleRiskAssessment" } } }, "PartyRoleRiskAssessmentDeleteEvent": { "type": "object", "description": "The notification data structure", "properties": { "event": { "description": "The event payload linked to the involved resource object", "$ref": "#/definitions/PartyRoleRiskAssessmentDeleteEventPayload" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time", "description": "The time the event occured." } } }, "PartyRoleRiskAssessmentDeleteEventPayload": { "type": "object", "description": "The event data structure", "properties": { "partyRoleRiskAssessment": { "description": "The involved resource data for the event", "$ref": "#/definitions/PartyRoleRiskAssessment" } } }, "PartyRoleRiskAssessmentStatusChangeEvent": { "type": "object", "description": "The notification data structure", "properties": { "event": { "description": "The event payload linked to the involved resource object", "$ref": "#/definitions/PartyRoleRiskAssessmentStatusChangeEventPayload" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time", "description": "The time the event occured." } } }, "PartyRoleRiskAssessmentStatusChangeEventPayload": { "type": "object", "description": "The event data structure", "properties": { "partyRoleRiskAssessment": { "description": "The involved resource data for the event", "$ref": "#/definitions/PartyRoleRiskAssessment" } } }, "PartyRoleProductOfferingRiskAssessmentCreateEvent": { "type": "object", "description": "The notification data structure", "properties": { "event": { "description": "The event payload linked to the involved resource object", "$ref": "#/definitions/PartyRoleProductOfferingRiskAssessmentCreateEventPayload" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time", "description": "The time the event occured." } } }, "PartyRoleProductOfferingRiskAssessmentCreateEventPayload": { "type": "object", "description": "The event data structure", "properties": { "partyRoleProductOfferingRiskAssessment": { "description": "The involved resource data for the event", "$ref": "#/definitions/PartyRoleProductOfferingRiskAssessment" } } }, "PartyRoleProductOfferingRiskAssessmentDeleteEvent": { "type": "object", "description": "The notification data structure", "properties": { "event": { "description": "The event payload linked to the involved resource object", "$ref": "#/definitions/PartyRoleProductOfferingRiskAssessmentDeleteEventPayload" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time", "description": "The time the event occured." } } }, "PartyRoleProductOfferingRiskAssessmentDeleteEventPayload": { "type": "object", "description": "The event data structure", "properties": { "partyRoleProductOfferingRiskAssessment": { "description": "The involved resource data for the event", "$ref": "#/definitions/PartyRoleProductOfferingRiskAssessment" } } }, "PartyRoleProductOfferingRiskAssessmentStatusChangeEvent": { "type": "object", "description": "The notification data structure", "properties": { "event": { "description": "The event payload linked to the involved resource object", "$ref": "#/definitions/PartyRoleProductOfferingRiskAssessmentStatusChangeEventPayload" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time", "description": "The time the event occured." } } }, "PartyRoleProductOfferingRiskAssessmentStatusChangeEventPayload": { "type": "object", "description": "The event data structure", "properties": { "partyRoleProductOfferingRiskAssessment": { "description": "The involved resource data for the event", "$ref": "#/definitions/PartyRoleProductOfferingRiskAssessment" } } }, "ShoppingCartRiskAssessmentCreateEvent": { "type": "object", "description": "The notification data structure", "properties": { "event": { "description": "The event payload linked to the involved resource object", "$ref": "#/definitions/ShoppingCartRiskAssessmentCreateEventPayload" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time", "description": "The time the event occured." } } }, "ShoppingCartRiskAssessmentCreateEventPayload": { "type": "object", "description": "The event data structure", "properties": { "shoppingCartRiskAssessment": { "description": "The involved resource data for the event", "$ref": "#/definitions/ShoppingCartRiskAssessment" } } }, "ShoppingCartRiskAssessmentDeleteEvent": { "type": "object", "description": "The notification data structure", "properties": { "event": { "description": "The event payload linked to the involved resource object", "$ref": "#/definitions/ShoppingCartRiskAssessmentDeleteEventPayload" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time", "description": "The time the event occured." } } }, "ShoppingCartRiskAssessmentDeleteEventPayload": { "type": "object", "description": "The event data structure", "properties": { "shoppingCartRiskAssessment": { "description": "The involved resource data for the event", "$ref": "#/definitions/ShoppingCartRiskAssessment" } } }, "ShoppingCartRiskAssessmentStatusChangeEvent": { "type": "object", "description": "The notification data structure", "properties": { "event": { "description": "The event payload linked to the involved resource object", "$ref": "#/definitions/ShoppingCartRiskAssessmentStatusChangeEventPayload" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time", "description": "The time the event occured." } } }, "ShoppingCartRiskAssessmentStatusChangeEventPayload": { "type": "object", "description": "The event data structure", "properties": { "shoppingCartRiskAssessment": { "description": "The involved resource data for the event", "$ref": "#/definitions/ShoppingCartRiskAssessment" } } }, "ProductOrderRiskAssessmentCreateEvent": { "type": "object", "description": "The notification data structure", "properties": { "event": { "description": "The event payload linked to the involved resource object", "$ref": "#/definitions/ProductOrderRiskAssessmentCreateEventPayload" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time", "description": "The time the event occured." } } }, "ProductOrderRiskAssessmentCreateEventPayload": { "type": "object", "description": "The event data structure", "properties": { "productOrderRiskAssessment": { "description": "The involved resource data for the event", "$ref": "#/definitions/ProductOrderRiskAssessment" } } }, "ProductOrderRiskAssessmentDeleteEvent": { "type": "object", "description": "The notification data structure", "properties": { "event": { "description": "The event payload linked to the involved resource object", "$ref": "#/definitions/ProductOrderRiskAssessmentDeleteEventPayload" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time", "description": "The time the event occured." } } }, "ProductOrderRiskAssessmentDeleteEventPayload": { "type": "object", "description": "The event data structure", "properties": { "productOrderRiskAssessment": { "description": "The involved resource data for the event", "$ref": "#/definitions/ProductOrderRiskAssessment" } } }, "ProductOrderRiskAssessmentStatusChangeEvent": { "type": "object", "description": "The notification data structure", "properties": { "event": { "description": "The event payload linked to the involved resource object", "$ref": "#/definitions/ProductOrderRiskAssessmentStatusChangeEventPayload" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time", "description": "The time the event occured." } } }, "ProductOrderRiskAssessmentStatusChangeEventPayload": { "type": "object", "description": "The event data structure", "properties": { "productOrderRiskAssessment": { "description": "The involved resource data for the event", "$ref": "#/definitions/ProductOrderRiskAssessment" } } }, "Error": { "description": "Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)", "type": "object", "required": [ "code", "reason" ], "properties": { "code": { "type": "string", "description": "Application relevant detail, defined in the API or a common list." }, "reason": { "type": "string", "description": "Explanation of the reason for the error which can be shown to a client user." }, "message": { "type": "string", "description": "More details and corrective actions related to the error which can be shown to a client user." }, "status": { "type": "string", "description": "HTTP Error code extension" }, "referenceError": { "type": "string", "format": "uri", "description": "URI of documentation describing the error." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class." }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name." } } } } }