{ "openapi": "3.0.1", "info": { "title": "Venminder OpenApi", "version": "v1" }, "paths": { "/api/v1/BusinessUnitInformation/GetBusinessUnits": { "get": { "tags": [ "BusinessUnit" ], "summary": "Provides a list of business unit related informtion.", "description": "Provides a list of business units with their assigned products and users as well as a list of unassigned products and users.", "responses": { "200": { "description": "Returns list of Business Units and unassigned products and unassigned users", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.BusinessUnitInformation" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.BusinessUnitInformation" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } } } } }, "/api/v1/ClientInformation/GetClientInformation": { "get": { "tags": [ "ClientInformation" ], "summary": "Provides a list of basic vendor and product related information.", "description": "Provides high level client configuration information including a list of the vendors and the vendor's products, a list of the profile fields for each vendor, a list of all active contracts and the products with which they are associated, a list of oversight requirements and a list of users.", "parameters": [ { "name": "createdDate", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ClientInformation" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ClientInformation" } } } } } } }, "/api/v1/Contact/GetContactList": { "get": { "tags": [ "Contact" ], "summary": "Provides a list of internal and external contacts.", "description": "Provides a list of internal and external contacts. This includes name, email address, phone numbers, if contact is enrolled and active, and vendors and products the external contact is assigned to.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ContactListResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ContactListResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } } } } }, "/api/v1/Contracts/GetDetails": { "get": { "tags": [ "Contracts" ], "summary": "Provides detailed information concerning a specific contract.", "description": "Provides detailed information concerning a specific contract associated with a vendor. This will included both standard and custom metadata fields as well as a list of any modification to the contract.", "parameters": [ { "name": "contractKey", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ContractDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ContractDetails" } } } } } } }, "/api/v1/Contracts/GetHierarchy": { "get": { "tags": [ "Contracts" ], "summary": "Provides detailed contract hierarchy information for a vendor.", "description": "Provides detailed contract hierarchy including parent contracts, child contracts and modifications for a vendor.", "parameters": [ { "name": "vendorKey", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.Contracts.ContractHierarchyInformation" } } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Contracts.ContractHierarchyInformation" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } } } } }, "/api/v1/Contracts/GetContracts": { "get": { "tags": [ "Contracts" ], "summary": "Provides list of contracts for client or a specific vendor/product that is either in Ongoing or Offboarding.", "description": "Provides list of contracts for client or specific vendor/product that is in Ongoing or Offboarding, taking into consideration extra filters applied as well. This will include metadata and simple data for the contract and associated product(s).", "parameters": [ { "name": "vendorKey", "in": "query", "schema": { "type": "string" } }, { "name": "productKey", "in": "query", "schema": { "type": "string" } }, { "name": "statusID", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "includeArchived", "in": "query", "schema": { "type": "boolean" } }, { "name": "notificationDeadlineDateStart", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "notificationDeadlineDateEnd", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "expirationDateStart", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "expirationDateEnd", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ContractInformation" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ContractInformation" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } } } } }, "/api/v1/Contracts/GetDrafts": { "get": { "tags": [ "Contracts" ], "summary": "Provides contract drafts information for a vendor.", "description": "Provides list of contract drafts including notes for a vendor.", "parameters": [ { "name": "vendorKey", "in": "query", "schema": { "type": "string" } }, { "name": "relationshipKey", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.Contracts.ContractDraftInformation" } } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Contracts.ContractDraftInformation" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } } } } }, "/api/v1/Contracts/GetDraftDetails": { "get": { "tags": [ "Contracts" ], "summary": "Provides contract draft details for a contract draft.", "description": "Provides detailed information for contract draft including approvers, draft documents and timelines.", "parameters": [ { "name": "draftKey", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Contracts.ContractDraftDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Contracts.ContractDraftDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } } } } }, "/api/v1/Contracts/AddNoteToContractDraft": { "post": { "tags": [ "Contracts" ], "summary": "Adds a new note to an existing or new draft contract, given that FIVR and Onboarding Request pass validation and authorization checks.", "description": "Adds a new note to an existing or new draft contract, given that FIVR and Onboarding Request pass validation and authorization checks.", "parameters": [ { "name": "cultureCode", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Contracts.AddNoteToContractDraftRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Contracts.AddNoteToContractDraftRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Contracts.AddNoteToContractDraftRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Contracts.AddNoteToContractDraftRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Contracts.AddNoteToContractDraftRequest" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Contracts.AddNoteToContractDraftRequest" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Contracts.AddNoteToContractDraftRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Contracts.CreateDraftNoteResponseForAPI" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Contracts.CreateDraftNoteResponseForAPI" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } } } } }, "/api/v1/Contracts/EditContract": { "post": { "tags": [ "Contracts" ], "summary": "Modifies basic contract details provided in the request parameter.", "description": "Modifies basic contract details provided in the request parameter.", "parameters": [ { "name": "cultureCode", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Contracts.EditClientContractRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Contracts.EditClientContractRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Contracts.EditClientContractRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Contracts.EditClientContractRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Contracts.EditClientContractRequest" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Contracts.EditClientContractRequest" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Contracts.EditClientContractRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } } } } }, "/api/v1/Contracts/CreateContract": { "post": { "tags": [ "Contracts" ], "summary": "Creates a basic self-processed contract with details provided in the request parameter.", "description": "Creates a basic self-processed contract with details provided in the request parameter.", "parameters": [ { "name": "cultureCode", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Contracts.CreateClientContractRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Contracts.CreateClientContractRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Contracts.CreateClientContractRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Contracts.CreateClientContractRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Contracts.CreateClientContractRequest" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Contracts.CreateClientContractRequest" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Contracts.CreateClientContractRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } } } } }, "/api/v1/Contracts/EditContractCustomData": { "post": { "tags": [ "Contracts" ], "summary": "Updates existing custom data for the contract with the supplied contract's custom data key.", "description": "Updates existing custom data for the contract with the supplied contract's custom data key.", "parameters": [ { "name": "cultureCode", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Contracts.EditClientContractUserDataRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Contracts.EditClientContractUserDataRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Contracts.EditClientContractUserDataRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Contracts.EditClientContractUserDataRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Contracts.EditClientContractUserDataRequest" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Contracts.EditClientContractUserDataRequest" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Contracts.EditClientContractUserDataRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } } } } }, "/api/v1/Data/Countries": { "get": { "tags": [ "Data" ], "summary": "Provides a list of countries.", "description": "Provides a list of valid countries along with their abbreviations and dialing codes.", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.CountryResponse" } } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.CountryResponse" } } } } } } }, "/api/v1/Documents/{documentKey}": { "get": { "tags": [ "Documents" ], "summary": "Provides a service to download a document.", "description": "Provides a service to download a document stored in the Venminder platform to a local folder.", "parameters": [ { "name": "documentKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } } } } }, "/api/v1/Documents/GetDocumentsList": { "get": { "tags": [ "Documents" ], "summary": "Provides a list of documents stored in the Venminder platform.", "description": "Provides a list of documents stored in the Venminder platform filtered based on a high level category. Some of the properties will include the file name, the upload date, associated vendor product, tags…", "parameters": [ { "name": "documentCategory", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "documentTag", "in": "query", "schema": { "type": "string" } }, { "name": "documentName", "in": "query", "schema": { "type": "string" } }, { "name": "vendorKey", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.ApiDocument" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } } } } }, "/api/v1/Issues/GetAllIssues": { "get": { "tags": [ "Issues" ], "summary": "Provides a list of all issues in the system.", "description": "Provides a basic high level set of information about all issues in the system. With this information you can drill down further for more details with other API calls.", "parameters": [ { "name": "cultureCode", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Issues.GetAllIssuesResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Issues.GetAllIssuesResponse" } } } } } } }, "/api/v1/Issues/GetIssueDetails": { "get": { "tags": [ "Issues" ], "summary": "Provides details about a specific given issue.", "description": "Provides details about a specific given issue.", "parameters": [ { "name": "issueKey", "in": "query", "schema": { "type": "string" } }, { "name": "cultureCode", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Issues.IssueDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Issues.IssueDetails" } } } } } } }, "/api/v1/OversightRequirement/GetOversightRequirement": { "get": { "tags": [ "OversightRequirement" ], "summary": "Gets a specific Oversight Requirement by its key.", "parameters": [ { "name": "key", "in": "query", "description": "This represents the key of the Oversight Requirement to be retrieved.", "schema": { "type": "string" } }, { "name": "cultureCode", "in": "header", "description": "The culture code controls the language used in the response. Defaults to \"en-US\".", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Oversight.OpenApiOversightRequirement" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } }, "401": { "description": "Unauthorized" } } } }, "/api/v1/OversightRequirement/GetOversightRequirementList": { "post": { "tags": [ "OversightRequirement" ], "summary": "Get a list of all Oversight Requirments that fit the criteria provided in the request.", "parameters": [ { "name": "cultureCode", "in": "header", "description": "The culture code controls the language used in the response. Defaults to \"en-US\".", "schema": { "type": "string" } } ], "requestBody": { "description": "The request object contains multiple properties allowing for the filtering of returned oversight requirement objects.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Oversight.Request.GetOversightRequirementListRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Oversight.Request.GetOversightRequirementListRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Oversight.Request.GetOversightRequirementListRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Oversight.Request.GetOversightRequirementListRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Oversight.Request.GetOversightRequirementListRequest" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Oversight.Request.GetOversightRequirementListRequest" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Oversight.Request.GetOversightRequirementListRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.Oversight.OpenApiOversightRequirement" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } }, "401": { "description": "Unauthorized" } } } }, "/api/v1/OversightTask/GetOversightTask": { "get": { "tags": [ "OversightTask" ], "summary": "Gets a specific Oversight Task by its key.", "parameters": [ { "name": "key", "in": "query", "description": "This represents the key of the Oversight Task to be retrieved.", "schema": { "type": "string" } }, { "name": "cultureCode", "in": "header", "description": "The culture code controls the language used in the response. Defaults to \"en-US\".", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Oversight.OpenApiOversightTask" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } }, "401": { "description": "Unauthorized" } } } }, "/api/v1/OversightTask/GetOversightTaskList": { "post": { "tags": [ "OversightTask" ], "summary": "Get a list of all Oversight Tasks that fit the criteria provided in the request.", "parameters": [ { "name": "cultureCode", "in": "header", "description": "The culture code controls the language used in the response. Defaults to \"en-US\".", "schema": { "type": "string" } } ], "requestBody": { "description": "The request object contains multiple properties allowing for the filtering of returned oversight task objects.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Oversight.Request.GetOversightTaskListRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Oversight.Request.GetOversightTaskListRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Oversight.Request.GetOversightTaskListRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Oversight.Request.GetOversightTaskListRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Oversight.Request.GetOversightTaskListRequest" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Oversight.Request.GetOversightTaskListRequest" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Oversight.Request.GetOversightTaskListRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.Oversight.OpenApiOversightTask" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } }, "401": { "description": "Unauthorized" } } } }, "/api/v1/OversightTask/CreateOversightTask": { "post": { "tags": [ "OversightTask" ], "summary": "Creates an Oversight Task with the provided properties and defaults from the Oversight Requirement.", "parameters": [ { "name": "cultureCode", "in": "header", "description": "The culture code controls the language used in the response. Defaults to \"en-US\".", "schema": { "type": "string" } } ], "requestBody": { "description": "The request object containing multiple properties that gets used during task creation.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Oversight.Request.CreateOversightTaskRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Oversight.Request.CreateOversightTaskRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Oversight.Request.CreateOversightTaskRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Oversight.Request.CreateOversightTaskRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Oversight.Request.CreateOversightTaskRequest" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Oversight.Request.CreateOversightTaskRequest" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Oversight.Request.CreateOversightTaskRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } }, "401": { "description": "Unauthorized" } } } }, "/api/v1/OversightTask/UpdateOversightTask/{key}": { "patch": { "tags": [ "OversightTask" ], "summary": "Updates specific properties of an Oversight Task based on the provided PATCH operations.", "description": "This PATCH endpoint only supports \"replace\", \"add\", and \"remove\" operations.", "parameters": [ { "name": "key", "in": "path", "description": "Provides the key of the Oversight Task that should be updated.", "required": true, "schema": { "type": "string" } }, { "name": "cultureCode", "in": "header", "description": "The culture code controls the language used in the response. Defaults to \"en-US\".", "schema": { "type": "string" } } ], "requestBody": { "description": "A list of PATCH operations providing specific instructions on how to update the oversight task.", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.JsonPatch.Operations.Operation" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.JsonPatch.Operations.Operation" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.JsonPatch.Operations.Operation" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.JsonPatch.Operations.Operation" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } }, "401": { "description": "Unauthorized" } } } }, "/api/v1/Questionnaire/GetResponses": { "post": { "tags": [ "Questionnaire" ], "summary": "Provides a list of questionnaire responses.", "description": "Provides a list of questionnaire responses. The returned list can be limited based on the status, sent date, deadline, and/or completed date of the questionnaire response. Information will include vendor name, product name, status, date sent…", "parameters": [ { "name": "cultureCode", "in": "header", "description": "", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Questionnaire.QuestionnaireFilterJsonRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Questionnaire.QuestionnaireFilterJsonRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Questionnaire.QuestionnaireFilterJsonRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Questionnaire.QuestionnaireFilterJsonRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Questionnaire.QuestionnaireFilterJsonRequest" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Questionnaire.QuestionnaireFilterJsonRequest" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Questionnaire.QuestionnaireFilterJsonRequest" } } } }, "responses": { "200": { "description": "Returns list", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.Questionnaire.QuestionnaireResponse" } } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Questionnaire.QuestionnaireResponse" } } } }, "400": { "description": "If the filter request is invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } }, "403": { "description": "If API user's does not have read permission.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } } } } }, "/api/v1/Questionnaire/QuestionnaireLibrary": { "get": { "tags": [ "Questionnaire" ], "summary": "Provides a list of questionnaires in the library.", "description": "Provides a list of questionnaires in the questionnaire library.", "parameters": [ { "name": "cultureCode", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns list", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.Questionnaire.QuestionnaireLibraryData" } } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Questionnaire.QuestionnaireLibraryData" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } }, "403": { "description": "If Vendor Questionnaire feature is disabled for financial Instituion or API user does not have read permission.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } } } } }, "/api/v1/Questionnaire/Download": { "get": { "tags": [ "Questionnaire" ], "summary": "Provides a service to download a questionnaire.", "description": "Provides a service to download a questionnaire and documents attached to it as a zip to a local folder.", "parameters": [ { "name": "questionnaireRequestKey", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } } } } }, "/api/v1/Questionnaire/GetResponse": { "get": { "tags": [ "Questionnaire" ], "summary": "Provides detailed information about a specific questionnaire.", "description": "Provides detailed information about a specific questionnaire. This includes the vendor, product, recipient, questions, answers, scoring (if applicable),…", "parameters": [ { "name": "questionnaireRequestKey", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Questionnaire.QuestionnaireWithScore" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Questionnaire.QuestionnaireWithScore" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } } } } }, "/api/v1/Services/ListServices": { "post": { "tags": [ "Services" ], "summary": "Provides a list of purchased services.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Services.GetServicesRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Services.GetServicesRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Services.GetServicesRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Services.GetServicesRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Services.GetServicesRequest" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Services.GetServicesRequest" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Services.GetServicesRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.Services.Service" } } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Services.Service" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } } } } }, "/api/v1/Services/GetDetails": { "get": { "tags": [ "Services" ], "summary": "Details of a specific service.", "parameters": [ { "name": "serviceId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Services.ServiceDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Services.ServiceDetails" } } } } } } }, "/api/v1/Vendor/Onboarding/Requests": { "get": { "tags": [ "VendorOnboarding" ], "summary": "Provides a list of vendor onboarding requests.", "description": "Provides a list of vendor onboarding requests. The returned list can be limited based on the status of the request. Information will include vendor name, product name, status, section status…", "parameters": [ { "name": "statusID", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "requestedDateStart", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "requestedDateEnd", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "approvedOrDeclinedDateStart", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "approvedOrDeclinedDateEnd", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "deadlineDateStart", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "deadlineDateEnd", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorOnboardingRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorOnboardingRequest" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } } } } }, "/api/v1/Vendor/Onboarding/RequestDetails": { "get": { "tags": [ "VendorOnboarding" ], "summary": "Provides detailed information for a vendor onboarding request.", "description": "Provides details for a specific vendor onboarding request include requestor, vmo manager, status, vendor, product, criticality, and risk question….", "parameters": [ { "name": "relationshipKey", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorOnboardingRequestDetail" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorOnboardingRequestDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } } } } }, "/api/v1/Vendor/Onboarding/Information": { "get": { "tags": [ "VendorOnboarding" ], "summary": "Provides vendor onboarding configuration information.", "description": "Provides vendor onboarding configuration information. This includes the master form, custom forms and request reasons.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorOnboardingInformationResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorOnboardingInformationResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } } } } }, "/api/v1/Vendor/Onboarding/FormDetails": { "get": { "tags": [ "VendorOnboarding" ], "summary": "Provides the details for a specific vendor onboarding request form.", "description": "Provides the details for a specific vendor onboarding request form include vendor, product, criticality, and risk question.", "parameters": [ { "name": "formKey", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns Onboarding Form Questions", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.OnboardingFormDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.OnboardingFormDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } } } } }, "/api/v1/Vendor/Onboarding/Request": { "post": { "tags": [ "VendorOnboarding" ], "summary": "Creates a new or updates an existing onboarding request.", "description": "Creates a new or updates an existing onboarding request that is in a draft status.", "parameters": [ { "name": "cultureCode", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.OnboardingRequestData" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.OnboardingRequestData" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.OnboardingRequestData" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.OnboardingRequestData" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.OnboardingRequestData" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.OnboardingRequestData" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.OnboardingRequestData" } } } }, "responses": { "200": { "description": "Returns success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.OnboardingResponse" } } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.OnboardingResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } }, "403": { "description": "If relation api key does not belong to api user's client.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } } } } }, "/api/v1/Vendor/Onboarding/FormAnswers": { "get": { "tags": [ "VendorOnboarding" ], "summary": "Get expected answers for onboarding form Questions", "parameters": [ { "name": "formKey", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns list of expected answers of onboarding form Questions", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ProfileAnswers" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ProfileAnswers" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } } } } }, "/api/v1/Vendor/Onboarding/RequestAnswers": { "get": { "tags": [ "VendorOnboarding" ], "summary": "Get expected answers for onboarding form Questions", "parameters": [ { "name": "relationshipKey", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns list of expected answers of onboarding form Questions", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ProfileAnswers" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ProfileAnswers" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } } } } }, "/api/v1/Vendor/Onboarding/EditRequestAnswers": { "post": { "tags": [ "VendorOnboarding" ], "summary": "Creates a new or updates an existing onboarding request.", "description": "Creates a new or updates an existing onboarding request that is in a draft status.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.EditOnboardingRelationshipQuestionsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.EditOnboardingRelationshipQuestionsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.EditOnboardingRelationshipQuestionsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.EditOnboardingRelationshipQuestionsRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.EditOnboardingRelationshipQuestionsRequest" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.EditOnboardingRelationshipQuestionsRequest" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.EditOnboardingRelationshipQuestionsRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } } } } }, "/api/v1/Vendors/GetVendorProfile": { "get": { "tags": [ "Vendors" ], "summary": "Provides detailed information about a specific vendor.", "description": "Provide detailed information about a specific vendor. This includes vendor profile information, oversight requirements, a list of products, a list of contracts and much more.", "parameters": [ { "name": "vendorKey", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "cultureCode", "in": "header", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorProfile" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorProfile" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } } } } }, "/api/v1/Vendors/VendorProduct": { "post": { "tags": [ "Vendors" ], "summary": "Creates a new vendor and/or product.", "description": "Creates a new vendor and product or adds a new product to an existing vendor.", "parameters": [ { "name": "cultureCode", "in": "header", "description": "", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorProductRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorProductRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorProductRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorProductRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorProductRequest" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorProductRequest" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorProductRequest" } } } }, "responses": { "200": { "description": "Returns the success response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.CreateVendorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.CreateVendorResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } } } } }, "/api/v1/Vendors/VendorProfile": { "post": { "tags": [ "Vendors" ], "summary": "Updates an existing vendor's profile information.", "description": "Updates a vendor's profile information. This includes standard questions as well as custom question add to the Venminder platform. Validation based on results provided in the GET ProfileAnswers API.", "parameters": [ { "name": "cultureCode", "in": "header", "description": "", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.UpdateVendorProfileRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.UpdateVendorProfileRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.UpdateVendorProfileRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.UpdateVendorProfileRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.UpdateVendorProfileRequest" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.UpdateVendorProfileRequest" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.UpdateVendorProfileRequest" } } } }, "responses": { "200": { "description": "Returns success" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } }, "403": { "description": "If vendor api key does not belong to api user's client.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } } } } }, "/api/v1/Vendors/Relationships": { "post": { "tags": [ "Vendors" ], "summary": "Adds a third and/or a fourth party relationships to a vendor.", "description": "Adds a third and/or a fourth party relationships to a vendor.", "parameters": [ { "name": "cultureCode", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorRelationships" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorRelationships" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorRelationships" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorRelationships" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorRelationships" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorRelationships" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorRelationships" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } } } }, "delete": { "tags": [ "Vendors" ], "summary": "Deletes a third and/or a fourth party relationships from a vendor.", "description": "Deletes a third and/or a fourth party relationships from a vendor.", "parameters": [ { "name": "cultureCode", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.DeleteVendorRelationships" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.DeleteVendorRelationships" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.DeleteVendorRelationships" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.DeleteVendorRelationships" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.DeleteVendorRelationships" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.DeleteVendorRelationships" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.DeleteVendorRelationships" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } } } } }, "/api/v1/Vendors/Risk": { "post": { "tags": [ "Vendors" ], "summary": "Updates a product's risk level.", "description": "Updates a product's risk level given a Risk Assessment has not been performed.", "parameters": [ { "name": "cultureCode", "in": "header", "description": "", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.RiskLevels" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.RiskLevels" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.RiskLevels" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.RiskLevels" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.RiskLevels" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.RiskLevels" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.RiskLevels" } } } }, "responses": { "200": { "description": "Returns the success response" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } } } } }, "/api/v1/Vendors/SetVendorRisk": { "post": { "tags": [ "Vendors" ], "summary": "Updates a vendor's risk level.", "description": "Updates a vendor's risk level given a Product Risk Assessment has not been performed.", "parameters": [ { "name": "cultureCode", "in": "header", "description": "", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OpenApi.VendorRiskLevels" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.VendorRiskLevels" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OpenApi.VendorRiskLevels" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OpenApi.VendorRiskLevels" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.VendorRiskLevels" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.VendorRiskLevels" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/OpenApi.VendorRiskLevels" } } } }, "responses": { "200": { "description": "Returns the success response" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } } } } }, "/api/v1/Vendors/ProductProfile": { "post": { "tags": [ "Vendors" ], "summary": "Updates an existing product's profile information.", "description": "Updates a product's profile information. This includes standard questions as well as custom question add to the Venminder platform. Validation based on results provided in the GET ProfileAnswers API.", "parameters": [ { "name": "cultureCode", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.UpdateProductProfileRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.UpdateProductProfileRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.UpdateProductProfileRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.UpdateProductProfileRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.UpdateProductProfileRequest" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.UpdateProductProfileRequest" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.UpdateProductProfileRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } } } } }, "/api/v1/Vendors/ProductContact": { "post": { "tags": [ "Vendors" ], "summary": "Create a contact and assign them to a product.", "description": "Creates a contact and assigns them to a product. If the contact already exists, use the POST ProductProfile API to update the list of contacts for a product.", "parameters": [ { "name": "cultureCode", "in": "header", "description": "", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ProductContacts" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ProductContacts" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ProductContacts" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ProductContacts" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ProductContacts" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ProductContacts" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ProductContacts" } } } }, "responses": { "200": { "description": "Returns the success response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.CreateContactResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.CreateContactResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } } } } }, "/api/v1/Vendors/ProfileAnswers": { "get": { "tags": [ "Vendors" ], "summary": "Provides a list of answers for vendor and product profile questions.", "description": "Provides a list of expected answers for the vendor and product profile questions.", "parameters": [ { "name": "vendorKey", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns list of expected answers of Vendor and Product Profile Questions", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ProfileAnswers" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ProfileAnswers" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } } } } }, "/api/v1/Vendors/GetVendorQuestionKeys": { "get": { "tags": [ "Vendors" ], "summary": "Provides a list of question keys for vendor information.", "description": "Provides a list of question keys for vendor information.", "responses": { "200": { "description": "Returns a list of question keys for vendor information.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorProfileDataField" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorProfileDataField" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } } } } }, "/api/v1/SpendAnalysis/CreateBudget": { "post": { "tags": [ "VendorSpend" ], "summary": "Creates a vendor Budget", "parameters": [ { "name": "cultureCode", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorSpend.CreateBudgetRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorSpend.CreateBudgetRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorSpend.CreateBudgetRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorSpend.CreateBudgetRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorSpend.CreateBudgetRequest" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorSpend.CreateBudgetRequest" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorSpend.CreateBudgetRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorSpend.CreateBudgetResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } } } } }, "/api/v1/SpendAnalysis/CreateSpendItem": { "post": { "tags": [ "VendorSpend" ], "summary": "Creates a vendor spend item", "parameters": [ { "name": "cultureCode", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorSpend.CreateSpendRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorSpend.CreateSpendRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorSpend.CreateSpendRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorSpend.CreateSpendRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorSpend.CreateSpendRequest" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorSpend.CreateSpendRequest" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorSpend.CreateSpendRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorSpend.CreateSpendResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } } } } }, "/api/v1/SpendAnalysis/DeleteBudget": { "delete": { "tags": [ "VendorSpend" ], "summary": "Deletes a vendor budget and unlinks all spend items associated with the budget.", "parameters": [ { "name": "budgetKey", "in": "query", "schema": { "type": "string" } }, { "name": "cultureCode", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } } } } }, "/api/v1/SpendAnalysis/DeleteSpend": { "delete": { "tags": [ "VendorSpend" ], "summary": "Deletes a vendor spend.", "parameters": [ { "name": "spendKey", "in": "query", "schema": { "type": "string" } }, { "name": "cultureCode", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } } } } }, "/api/v1/SpendAnalysis/GetBudgets": { "get": { "tags": [ "VendorSpend" ], "summary": "Provides a list of active budgets for a particular vendor.", "description": "Provides a list of active budgets for a particular vendor. This includes the budget key, name, amount, start date, and end date.", "parameters": [ { "name": "vendorKey", "in": "query", "schema": { "type": "string" } }, { "name": "cultureCode", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorSpend.BudgetResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } } } } }, "/api/v1/SpendAnalysis/GetSpends": { "get": { "tags": [ "VendorSpend" ], "summary": "Gets all active spend items based on the vendor key.", "description": "Returns null for ProductKey if the spend is only linked to the vendor.", "parameters": [ { "name": "vendorKey", "in": "query", "schema": { "type": "string" } }, { "name": "cultureCode", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorSpend.GetSpendItemsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } } } } }, "/api/v1/SpendAnalysis/UpdateSpendItem": { "post": { "tags": [ "VendorSpend" ], "summary": "Updates a vendor spend item", "parameters": [ { "name": "cultureCode", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorSpend.UpdateSpendRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorSpend.UpdateSpendRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorSpend.UpdateSpendRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorSpend.UpdateSpendRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorSpend.UpdateSpendRequest" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorSpend.UpdateSpendRequest" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorSpend.UpdateSpendRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } } } } }, "/api/v1/SpendAnalysis/UpdateBudget": { "post": { "tags": [ "VendorSpend" ], "summary": "Updates a vendor spend budget", "parameters": [ { "name": "cultureCode", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorSpend.UpdateBudgetRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorSpend.UpdateBudgetRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorSpend.UpdateBudgetRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorSpend.UpdateBudgetRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorSpend.UpdateBudgetRequest" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorSpend.UpdateBudgetRequest" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.VendorSpend.UpdateBudgetRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } } } } }, "/api/v1/Venmonitor/GetVendorScore": { "get": { "tags": [ "Venmonitor" ], "parameters": [ { "name": "vendorKey", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.Venmonitor.GetVendorScoreResponse" } } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.Venmonitor.GetVendorScoreResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResponse" } } } } } } } }, "components": { "schemas": { "OpenApi.KeyManagement.AddUserLevelAPIKeyRequest": { "title": "OpenApi.KeyManagement.AddUserLevelAPIKeyRequest", "type": "object", "properties": { "userName": { "type": "string", "nullable": true }, "financialInstitutionID": { "type": "string", "format": "uuid" }, "apiKey": { "$ref": "#/components/schemas/OpenApi.KeyManagement.UserLevelAPIKeyDetails" } }, "additionalProperties": false, "xml": { "name": "OpenApi.KeyManagement.AddUserLevelAPIKeyRequest" } }, "OpenApi.KeyManagement.ManageAPIUserAddKeyRequest": { "title": "OpenApi.KeyManagement.ManageAPIUserAddKeyRequest", "type": "object", "properties": { "contactId": { "type": "string", "format": "uuid" }, "clientId": { "type": "string", "format": "uuid" }, "apiKey": { "$ref": "#/components/schemas/OpenApi.KeyManagement.UserLevelAPIKeyDetails" } }, "additionalProperties": false, "xml": { "name": "OpenApi.KeyManagement.ManageAPIUserAddKeyRequest" } }, "OpenApi.KeyManagement.ManageAPIUserEditUserNameRequest": { "title": "OpenApi.KeyManagement.ManageAPIUserEditUserNameRequest", "type": "object", "properties": { "contactId": { "type": "string", "format": "uuid" }, "clientId": { "type": "string", "format": "uuid" }, "userName": { "type": "string", "nullable": true } }, "additionalProperties": false, "xml": { "name": "OpenApi.KeyManagement.ManageAPIUserEditUserNameRequest" } }, "OpenApi.KeyManagement.ManageAPIUserRevokeKeyRequest": { "title": "OpenApi.KeyManagement.ManageAPIUserRevokeKeyRequest", "type": "object", "properties": { "contactKey": { "type": "string", "nullable": true }, "clientId": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "xml": { "name": "OpenApi.KeyManagement.ManageAPIUserRevokeKeyRequest" } }, "OpenApi.KeyManagement.UserLevelAPIKeyDetails": { "title": "OpenApi.KeyManagement.UserLevelAPIKeyDetails", "type": "object", "properties": { "description": { "type": "string", "nullable": true }, "expirationDate": { "type": "string", "format": "date-time", "nullable": true }, "canRead": { "type": "boolean" }, "canWrite": { "type": "boolean" }, "canDelete": { "type": "boolean" }, "isRevoked": { "type": "boolean" }, "createAccessToken": { "type": "boolean" } }, "additionalProperties": false, "xml": { "name": "OpenApi.KeyManagement.UserLevelAPIKeyDetails" } }, "OpenApi.VendorRiskLevels": { "title": "OpenApi.VendorRiskLevels", "type": "object", "properties": { "vendorKey": { "type": "string", "nullable": true }, "inherentRiskKey": { "type": "string", "nullable": true }, "residualRiskKey": { "type": "string", "nullable": true } }, "additionalProperties": false, "xml": { "name": "OpenApi.VendorRiskLevels" } }, "OpenApi.v1.AdditionalRelationships": { "title": "OpenApi.v1.AdditionalRelationships", "type": "object", "properties": { "vendorName": { "type": "string", "nullable": true }, "productName": { "type": "string", "nullable": true }, "relationshipKey": { "type": "string", "nullable": true } }, "additionalProperties": false, "xml": { "name": "AdditionalRelationships" } }, "OpenApi.v1.ApiDocument": { "title": "OpenApi.v1.ApiDocument", "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "fileName": { "type": "string", "nullable": true }, "uploadedDate": { "type": "string", "nullable": true }, "effectiveDate": { "type": "string", "nullable": true }, "expirationDate": { "type": "string", "nullable": true }, "vendorKey": { "type": "string", "nullable": true }, "isArchived": { "type": "boolean" }, "productKeys": { "type": "array", "items": { "type": "string" }, "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "ApiDocument" } }, "OpenApi.v1.BusinessUnit": { "title": "OpenApi.v1.BusinessUnit", "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false, "xml": { "name": "BusinessUnit" } }, "OpenApi.v1.BusinessUnitInfo": { "title": "OpenApi.v1.BusinessUnitInfo", "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "products": { "type": "array", "items": { "type": "string" }, "nullable": true }, "users": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "BusinessUnitInfo" } }, "OpenApi.v1.BusinessUnitInformation": { "title": "OpenApi.v1.BusinessUnitInformation", "type": "object", "properties": { "businessUnits": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.BusinessUnitInfo" }, "nullable": true }, "unassignedProducts": { "type": "array", "items": { "type": "string" }, "nullable": true }, "unassignedUsers": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "BusinessUnitInformation" } }, "OpenApi.v1.ChildQuestion": { "title": "OpenApi.v1.ChildQuestion", "type": "object", "properties": { "question": { "type": "string", "nullable": true }, "questionKey": { "type": "string", "nullable": true }, "questionResponsibility": { "type": "string", "nullable": true }, "questionType": { "type": "string", "nullable": true }, "parentSelectionName": { "type": "string", "nullable": true } }, "additionalProperties": false, "xml": { "name": "ChildQuestion" } }, "OpenApi.v1.ClientInformation": { "title": "OpenApi.v1.ClientInformation", "type": "object", "properties": { "vendors": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.Vendor" }, "nullable": true }, "vendorProfileDataFields": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.VendorProfileDataField" }, "nullable": true }, "productProfileDataFields": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.ProductProfileDataField" }, "nullable": true }, "oversightRequirements": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.OversightRequirement" }, "nullable": true }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.User" }, "nullable": true }, "businessUnits": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.BusinessUnit" }, "nullable": true }, "riskLevels": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.RiskLevel" }, "nullable": true }, "valueLists": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.ValueList" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "ClientInformation" } }, "OpenApi.v1.Contact": { "title": "OpenApi.v1.Contact", "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "contactKey": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "phoneNumbers": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.PhoneNumber" }, "nullable": true }, "emailAddress": { "type": "string", "nullable": true }, "isPrimary": { "type": "boolean" }, "isPrimaryQuestionnaires": { "type": "boolean" } }, "additionalProperties": false, "xml": { "name": "Contact" } }, "OpenApi.v1.ContactListResponse": { "title": "OpenApi.v1.ContactListResponse", "type": "object", "properties": { "internalContacts": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.InternalContact" }, "nullable": true }, "externalContacts": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.ExternalContact" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "ContactListResponse" } }, "OpenApi.v1.ContractData": { "title": "OpenApi.v1.ContractData", "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "sortOrder": { "type": "integer", "format": "int32", "nullable": true }, "type": { "type": "string", "nullable": true } }, "additionalProperties": false, "xml": { "name": "ContractData" } }, "OpenApi.v1.ContractDetails": { "title": "OpenApi.v1.ContractDetails", "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "uploadedByKey": { "type": "string", "nullable": true }, "uploadedDate": { "type": "string", "format": "date-time" }, "effectiveDate": { "type": "string", "format": "date-time", "nullable": true }, "term": { "type": "integer", "format": "int32", "nullable": true }, "expirationDate": { "type": "string", "format": "date-time", "nullable": true }, "autoRenewalNoticeDays": { "type": "integer", "format": "int32", "nullable": true }, "firstReminderDate": { "type": "string", "format": "date-time", "nullable": true }, "firstReminderOffset": { "type": "integer", "format": "int32" }, "renewalMonths": { "type": "integer", "format": "int32", "nullable": true }, "hasAutoRenewalClause": { "type": "boolean", "nullable": true }, "hasSla": { "type": "boolean", "nullable": true }, "hasNda": { "type": "boolean", "nullable": true }, "slas": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.ContractSla" }, "nullable": true }, "hasEqualOpportunityEmployment": { "type": "boolean", "nullable": true }, "vendorSignator": { "type": "string", "nullable": true }, "institutionSignator": { "type": "string", "nullable": true }, "dataItems": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.ContractData" }, "nullable": true }, "hasEarlyTerminationProvision": { "type": "boolean", "nullable": true }, "hasEarlyTerminationProvisionDescription": { "type": "string", "nullable": true }, "vendorKey": { "type": "string", "nullable": true }, "productKeys": { "type": "array", "items": { "type": "string" }, "nullable": true }, "pricings": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.ContractPricing" }, "nullable": true }, "status": { "type": "string", "nullable": true }, "active": { "type": "boolean" }, "cancellationEffectiveDate": { "type": "string", "format": "date-time", "nullable": true }, "documents": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.Document" }, "nullable": true }, "hasPricing": { "type": "boolean", "nullable": true }, "isPerpetual": { "type": "boolean" }, "contractName": { "type": "string", "nullable": true }, "requiredNotificationDeadline": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "modifications": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.ContractModification" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "ContractDetails" } }, "OpenApi.v1.ContractInformation": { "title": "OpenApi.v1.ContractInformation", "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "contractName": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "isPerpetual": { "type": "boolean" }, "effectiveDate": { "type": "string", "format": "date-time", "nullable": true }, "expirationDate": { "type": "string", "format": "date-time", "nullable": true }, "autoRenewalNoticeDays": { "type": "integer", "format": "int32", "nullable": true }, "requiredNotificationDeadline": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "archivedDate": { "type": "string", "format": "date-time", "nullable": true }, "vendorName": { "type": "string", "nullable": true }, "vendorKey": { "type": "string", "nullable": true }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.ContractProduct" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "ContractInformation" } }, "OpenApi.v1.ContractModification": { "title": "OpenApi.v1.ContractModification", "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "uploadedByKey": { "type": "string", "nullable": true }, "uploadedDate": { "type": "string", "format": "date-time" }, "createdDate": { "type": "string", "format": "date-time" }, "effectiveDate": { "type": "string", "format": "date-time", "nullable": true }, "description": { "type": "string", "nullable": true }, "documents": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.Document" }, "nullable": true }, "modifications": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.ModificationData" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "ContractModification" } }, "OpenApi.v1.ContractOverview": { "title": "OpenApi.v1.ContractOverview", "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "isPerpetual": { "type": "boolean" }, "effectiveDate": { "type": "string", "format": "date-time", "nullable": true }, "notificationDeadline": { "type": "string", "format": "date-time", "nullable": true }, "expirationDate": { "type": "string", "format": "date-time", "nullable": true }, "vendorKey": { "type": "string", "nullable": true }, "productKeys": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "ContractOverview" } }, "OpenApi.v1.ContractPricing": { "title": "OpenApi.v1.ContractPricing", "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "price": { "type": "number", "format": "double" }, "item": { "type": "string", "nullable": true }, "period": { "type": "string", "nullable": true }, "productKey": { "type": "string", "nullable": true }, "tieredPricingFrom": { "type": "integer", "format": "int32", "nullable": true }, "tieredPricingTo": { "type": "integer", "format": "int32", "nullable": true }, "tieredPricing": { "type": "string", "nullable": true }, "term": { "type": "string", "nullable": true }, "comments": { "type": "string", "nullable": true }, "sortOrder": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "xml": { "name": "ContractPricing" } }, "OpenApi.v1.ContractProduct": { "title": "OpenApi.v1.ContractProduct", "type": "object", "properties": { "productName": { "type": "string", "nullable": true }, "productStatus": { "type": "string", "nullable": true }, "productKey": { "type": "string", "nullable": true } }, "additionalProperties": false, "xml": { "name": "ContractProduct" } }, "OpenApi.v1.ContractSla": { "title": "OpenApi.v1.ContractSla", "type": "object", "properties": { "title": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false, "xml": { "name": "ContractSla" } }, "OpenApi.v1.Contracts.AddNoteToContractDraftRequest": { "title": "OpenApi.v1.Contracts.AddNoteToContractDraftRequest", "type": "object", "properties": { "draftKey": { "type": "string", "nullable": true }, "productKey": { "type": "string", "nullable": true }, "requestRelationshipKey": { "type": "string", "nullable": true }, "note": { "type": "string", "nullable": true } }, "additionalProperties": false, "xml": { "name": "Contracts.AddNoteToContractDraftRequest" } }, "OpenApi.v1.Contracts.ApproverContact": { "title": "OpenApi.v1.Contracts.ApproverContact", "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "emailAddress": { "type": "string", "nullable": true } }, "additionalProperties": false, "xml": { "name": "Contracts.ApproverContact" } }, "OpenApi.v1.Contracts.ContractDraftDetails": { "title": "OpenApi.v1.Contracts.ContractDraftDetails", "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "contractName": { "type": "string", "nullable": true }, "notes": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.Contracts.DraftNote" }, "nullable": true }, "draftApprovers": { "$ref": "#/components/schemas/OpenApi.v1.Contracts.DraftApprovers" }, "draftDocuments": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.Contracts.DraftDocument" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "Contracts.ContractDraftDetails" } }, "OpenApi.v1.Contracts.ContractDraftInformation": { "title": "OpenApi.v1.Contracts.ContractDraftInformation", "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "contractName": { "type": "string", "nullable": true }, "notes": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.Contracts.DraftNote" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "Contracts.ContractDraftInformation" } }, "OpenApi.v1.Contracts.ContractHierarchyInformation": { "title": "OpenApi.v1.Contracts.ContractHierarchyInformation", "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "contractName": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "expirationDate": { "type": "string", "format": "date-time", "nullable": true }, "firstReminderDate": { "type": "string", "format": "date-time" }, "cancellationEffectiveDate": { "type": "string", "format": "date-time", "nullable": true }, "isAddendumOrModification": { "type": "boolean" }, "isPerpetual": { "type": "boolean" }, "isExpiredContract": { "type": "boolean" }, "active": { "type": "boolean" }, "firstReminderOffset": { "type": "integer", "format": "int32" }, "autoRenewalNoticeDays": { "type": "integer", "format": "int32" }, "contractDocumentTypes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "products": { "type": "array", "items": { "type": "string" }, "nullable": true }, "childContracts": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.Contracts.ContractHierarchyInformation" }, "nullable": true }, "modifications": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.Contracts.ContractHierarchyInformation" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "Contracts.ContractHierarchyInformation" } }, "OpenApi.v1.Contracts.CreateClientContractRequest": { "title": "OpenApi.v1.Contracts.CreateClientContractRequest", "type": "object", "properties": { "contractName": { "type": "string", "nullable": true }, "contractDate": { "type": "string", "format": "date-time", "nullable": true }, "term": { "type": "integer", "format": "int32", "nullable": true }, "expirationDate": { "type": "string", "format": "date-time", "nullable": true }, "daysRequired": { "type": "integer", "format": "int32", "nullable": true }, "hasAutoRenewalClause": { "type": "boolean", "nullable": true }, "autoRenewalTerm": { "type": "integer", "format": "int32", "nullable": true }, "vendorKey": { "type": "string", "nullable": true }, "productKeys": { "type": "array", "items": { "type": "string" }, "nullable": true }, "isPerpetual": { "type": "boolean", "nullable": true }, "emailSchedule": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false, "xml": { "name": "Contracts.CreateClientContractRequest" } }, "OpenApi.v1.Contracts.CreateDraftNoteResponseForAPI": { "title": "OpenApi.v1.Contracts.CreateDraftNoteResponseForAPI", "type": "object", "properties": { "draftKey": { "type": "string", "nullable": true }, "productKey": { "type": "string", "nullable": true }, "requestRelationshipKey": { "type": "string", "nullable": true }, "note": { "type": "string", "nullable": true } }, "additionalProperties": false, "xml": { "name": "Contracts.CreateDraftNoteResponseForAPI" } }, "OpenApi.v1.Contracts.DraftApprovers": { "title": "OpenApi.v1.Contracts.DraftApprovers", "type": "object", "properties": { "approverContacts": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.Contracts.ApproverContact" }, "nullable": true }, "approverRoles": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "Contracts.DraftApprovers" } }, "OpenApi.v1.Contracts.DraftDocument": { "title": "OpenApi.v1.Contracts.DraftDocument", "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "timelines": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.Contracts.Timeline" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "Contracts.DraftDocument" } }, "OpenApi.v1.Contracts.DraftNote": { "title": "OpenApi.v1.Contracts.DraftNote", "type": "object", "properties": { "note": { "type": "string", "nullable": true }, "authorName": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "xml": { "name": "Contracts.DraftNote" } }, "OpenApi.v1.Contracts.EditClientContractRequest": { "title": "OpenApi.v1.Contracts.EditClientContractRequest", "type": "object", "properties": { "contractName": { "type": "string", "nullable": true }, "contractDate": { "type": "string", "format": "date-time", "nullable": true }, "term": { "type": "integer", "format": "int32", "nullable": true }, "expirationDate": { "type": "string", "format": "date-time", "nullable": true }, "daysRequired": { "type": "integer", "format": "int32", "nullable": true }, "hasAutoRenewalClause": { "type": "boolean", "nullable": true }, "autoRenewalTerm": { "type": "integer", "format": "int32", "nullable": true }, "key": { "type": "string", "nullable": true }, "hasNda": { "type": "boolean", "nullable": true }, "hasEarlyTerminationProvision": { "type": "boolean", "nullable": true }, "earlyTerminationProvisionDescription": { "type": "string", "nullable": true }, "isEqualOpportunityEmployer": { "type": "boolean", "nullable": true }, "vendorSignator": { "type": "string", "nullable": true }, "institutionSignator": { "type": "string", "nullable": true } }, "additionalProperties": false, "xml": { "name": "Contracts.EditClientContractRequest" } }, "OpenApi.v1.Contracts.EditClientContractUserDataRequest": { "title": "OpenApi.v1.Contracts.EditClientContractUserDataRequest", "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false, "xml": { "name": "Contracts.EditClientContractUserDataRequest" } }, "OpenApi.v1.Contracts.Timeline": { "title": "OpenApi.v1.Contracts.Timeline", "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "fileName": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "action": { "type": "string", "nullable": true }, "versionMajor": { "type": "integer", "format": "int32" }, "versionMinor": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "assignedTo": { "type": "string", "nullable": true }, "approverCustomRole": { "type": "string", "nullable": true }, "onBehalfOfUploadedBy": { "type": "string", "nullable": true }, "dueDate": { "type": "string", "format": "date-time", "nullable": true }, "completedDate": { "type": "string", "format": "date-time", "nullable": true }, "comment": { "type": "string", "nullable": true }, "active": { "type": "boolean" } }, "additionalProperties": false, "xml": { "name": "Contracts.Timeline" } }, "OpenApi.v1.CountryResponse": { "title": "OpenApi.v1.CountryResponse", "type": "object", "properties": { "abbreviation": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "dialingCode": { "type": "string", "nullable": true } }, "additionalProperties": false, "xml": { "name": "CountryResponse" } }, "OpenApi.v1.CreateContactResponse": { "title": "OpenApi.v1.CreateContactResponse", "type": "object", "properties": { "contactsKeys": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "CreateContactResponse" } }, "OpenApi.v1.CreateVendorResponse": { "title": "OpenApi.v1.CreateVendorResponse", "type": "object", "properties": { "vendorKey": { "type": "string", "nullable": true }, "productKey": { "type": "string", "nullable": true } }, "additionalProperties": false, "xml": { "name": "CreateVendorResponse" } }, "OpenApi.v1.DeleteVendorRelationships": { "title": "OpenApi.v1.DeleteVendorRelationships", "type": "object", "properties": { "vendorKey": { "type": "string", "nullable": true }, "thirdPartyVendorKeys": { "type": "array", "items": { "type": "string" }, "nullable": true }, "fourthPartyVendorKeys": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "DeleteVendorRelationships" } }, "OpenApi.v1.Document": { "title": "OpenApi.v1.Document", "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "fileName": { "type": "string", "nullable": true } }, "additionalProperties": false, "xml": { "name": "Document" } }, "OpenApi.v1.EditOnboardingRelationshipQuestionsRequest": { "title": "OpenApi.v1.EditOnboardingRelationshipQuestionsRequest", "type": "object", "properties": { "relationshipKey": { "type": "string", "nullable": true }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.UpdatedAnswers" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "EditOnboardingRelationshipQuestionsRequest" } }, "OpenApi.v1.ErrorResource": { "title": "OpenApi.v1.ErrorResource", "type": "object", "properties": { "resourceKey": { "type": "string", "nullable": true }, "resourceValue": { "type": "string", "nullable": true }, "field": { "type": "string", "nullable": true } }, "additionalProperties": false, "xml": { "name": "ErrorResource" } }, "OpenApi.v1.ErrorResponse": { "title": "OpenApi.v1.ErrorResponse", "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.ErrorResource" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "ErrorResponse" } }, "OpenApi.v1.ExternalContact": { "title": "OpenApi.v1.ExternalContact", "type": "object", "properties": { "addressBookKey": { "type": "string", "nullable": true }, "contactKey": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "fullName": { "type": "string", "nullable": true }, "emailAddress": { "type": "string", "nullable": true }, "isEnrolled": { "type": "boolean" }, "isActive": { "type": "boolean" }, "phoneNumbers": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.PhoneNumber" }, "nullable": true }, "vendorsAppliedTo": { "type": "array", "items": { "type": "string" }, "nullable": true }, "productsAppliedTo": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "ExternalContact" } }, "OpenApi.v1.InternalContact": { "title": "OpenApi.v1.InternalContact", "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "isEnrolled": { "type": "boolean" }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "emailAddress": { "type": "string", "nullable": true }, "fullName": { "type": "string", "nullable": true }, "phoneNumbers": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.PhoneNumber" }, "nullable": true }, "createdByUserKeyOrDescription": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time", "nullable": true }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.Role" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "InternalContact" } }, "OpenApi.v1.Issues.GetAllIssuesResponse": { "title": "OpenApi.v1.Issues.GetAllIssuesResponse", "type": "object", "properties": { "issues": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.Issues.Issue" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "Issues.GetAllIssuesResponse" } }, "OpenApi.v1.Issues.Issue": { "title": "OpenApi.v1.Issues.Issue", "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "vendor": { "type": "string", "nullable": true }, "vendorKey": { "type": "string", "nullable": true }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.Issues.IssueProduct" }, "nullable": true }, "owner": { "type": "string", "nullable": true }, "dateOpened": { "type": "string", "format": "date-time" }, "dateClosed": { "type": "string", "format": "date-time", "nullable": true }, "status": { "type": "string", "nullable": true }, "severity": { "type": "string", "nullable": true }, "severityKey": { "type": "string", "nullable": true } }, "additionalProperties": false, "xml": { "name": "Issues.Issue" } }, "OpenApi.v1.Issues.IssueAdditionalDetails": { "title": "OpenApi.v1.Issues.IssueAdditionalDetails", "type": "object", "properties": { "questionKey": { "type": "string", "nullable": true }, "question": { "type": "string", "nullable": true }, "answerKey": { "type": "string", "nullable": true }, "answer": { "type": "string", "nullable": true } }, "additionalProperties": false, "xml": { "name": "Issues.IssueAdditionalDetails" } }, "OpenApi.v1.Issues.IssueComment": { "title": "OpenApi.v1.Issues.IssueComment", "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "commentor": { "type": "string", "nullable": true }, "comment": { "type": "string", "nullable": true }, "commentDate": { "type": "string", "format": "date-time" }, "documents": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.Issues.IssueCommentDocument" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "Issues.IssueComment" } }, "OpenApi.v1.Issues.IssueCommentDocument": { "title": "OpenApi.v1.Issues.IssueCommentDocument", "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "fileName": { "type": "string", "nullable": true } }, "additionalProperties": false, "xml": { "name": "Issues.IssueCommentDocument" } }, "OpenApi.v1.Issues.IssueDetails": { "title": "OpenApi.v1.Issues.IssueDetails", "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "vendor": { "type": "string", "nullable": true }, "vendorKey": { "type": "string", "nullable": true }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.Issues.IssueProduct" }, "nullable": true }, "owner": { "type": "string", "nullable": true }, "dateOpened": { "type": "string", "format": "date-time" }, "dateClosed": { "type": "string", "format": "date-time", "nullable": true }, "status": { "type": "string", "nullable": true }, "originType": { "type": "string", "nullable": true }, "originTypeKey": { "type": "string", "nullable": true }, "originOfTheIssue": { "type": "string", "nullable": true }, "severity": { "type": "string", "nullable": true }, "severityKey": { "type": "string", "nullable": true }, "issueApprovalRequired": { "type": "boolean" }, "ownerAllowedToApprove": { "type": "boolean" }, "comments": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.Issues.IssueComment" }, "nullable": true }, "additionalDetails": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.Issues.IssueAdditionalDetails" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "Issues.IssueDetails" } }, "OpenApi.v1.Issues.IssueProduct": { "title": "OpenApi.v1.Issues.IssueProduct", "type": "object", "properties": { "product": { "type": "string", "nullable": true }, "key": { "type": "string", "nullable": true } }, "additionalProperties": false, "xml": { "name": "Issues.IssueProduct" } }, "OpenApi.v1.JsonPatch.JsonPatchDocument`1[[Venminder.OversightManagement.Business.Models.OversightRequirements.OversightRequirementLifecycle, Venminder.OversightManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "title": "OpenApi.v1.JsonPatch.JsonPatchDocument`1[[Venminder.OversightManagement.Business.Models.OversightRequirements.OversightRequirementLifecycle, Venminder.OversightManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]", "type": "object", "properties": { "operations": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.JsonPatch.Operations.Operation`1[[Venminder.OversightManagement.Business.Models.OversightRequirements.OversightRequirementLifecycle, Venminder.OversightManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" }, "nullable": true, "readOnly": true } }, "additionalProperties": false, "xml": { "name": "JsonPatch.JsonPatchDocument`1[[Venminder.OversightManagement.Business.Models.OversightRequirements.OversightRequirementLifecycle, Venminder.OversightManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "OpenApi.v1.JsonPatch.JsonPatchDocument`1[[Venminder.OversightManagement.Business.Models.OversightTasks.UpdateOversightTask, Venminder.OversightManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "title": "OpenApi.v1.JsonPatch.JsonPatchDocument`1[[Venminder.OversightManagement.Business.Models.OversightTasks.UpdateOversightTask, Venminder.OversightManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]", "type": "object", "properties": { "operations": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.JsonPatch.Operations.Operation`1[[Venminder.OversightManagement.Business.Models.OversightTasks.UpdateOversightTask, Venminder.OversightManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" }, "nullable": true, "readOnly": true } }, "additionalProperties": false, "xml": { "name": "JsonPatch.JsonPatchDocument`1[[Venminder.OversightManagement.Business.Models.OversightTasks.UpdateOversightTask, Venminder.OversightManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "OpenApi.v1.JsonPatch.Operations.Operation": { "title": "OpenApi.v1.JsonPatch.Operations.Operation", "type": "object", "properties": { "path": { "type": "string", "nullable": true }, "op": { "type": "string", "nullable": true }, "from": { "type": "string", "nullable": true }, "value": { "nullable": true } }, "additionalProperties": false, "xml": { "name": "JsonPatch.Operations.Operation" } }, "OpenApi.v1.JsonPatch.Operations.OperationType": { "title": "OpenApi.v1.JsonPatch.Operations.OperationType", "enum": [ 0, 1, 2, 3, 4, 5, 6 ], "type": "integer", "format": "int32", "xml": { "name": "JsonPatch.Operations.OperationType" } }, "OpenApi.v1.JsonPatch.Operations.Operation`1[[Venminder.OversightManagement.Business.Models.OversightRequirements.OversightRequirementLifecycle, Venminder.OversightManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "title": "OpenApi.v1.JsonPatch.Operations.Operation`1[[Venminder.OversightManagement.Business.Models.OversightRequirements.OversightRequirementLifecycle, Venminder.OversightManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]", "type": "object", "properties": { "path": { "type": "string", "nullable": true }, "op": { "type": "string", "nullable": true }, "from": { "type": "string", "nullable": true }, "value": { "nullable": true } }, "additionalProperties": false, "xml": { "name": "JsonPatch.Operations.Operation`1[[Venminder.OversightManagement.Business.Models.OversightRequirements.OversightRequirementLifecycle, Venminder.OversightManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "OpenApi.v1.JsonPatch.Operations.Operation`1[[Venminder.OversightManagement.Business.Models.OversightTasks.UpdateOversightTask, Venminder.OversightManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": { "title": "OpenApi.v1.JsonPatch.Operations.Operation`1[[Venminder.OversightManagement.Business.Models.OversightTasks.UpdateOversightTask, Venminder.OversightManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]", "type": "object", "properties": { "path": { "type": "string", "nullable": true }, "op": { "type": "string", "nullable": true }, "from": { "type": "string", "nullable": true }, "value": { "nullable": true } }, "additionalProperties": false, "xml": { "name": "JsonPatch.Operations.Operation`1[[Venminder.OversightManagement.Business.Models.OversightTasks.UpdateOversightTask, Venminder.OversightManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "OpenApi.v1.ModificationData": { "title": "OpenApi.v1.ModificationData", "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "fromValue": { "type": "string", "nullable": true }, "toValue": { "type": "string", "nullable": true }, "isUserData": { "type": "boolean" }, "sortOrder": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false, "xml": { "name": "ModificationData" } }, "OpenApi.v1.NewProductContact": { "title": "OpenApi.v1.NewProductContact", "type": "object", "properties": { "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "phoneNumbers": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.ProductContactPhoneNumber" }, "nullable": true }, "emailAddress": { "type": "string", "nullable": true }, "isPrimaryContact": { "type": "boolean" } }, "additionalProperties": false, "xml": { "name": "NewProductContact" } }, "OpenApi.v1.OnboardingDetailsTab": { "title": "OpenApi.v1.OnboardingDetailsTab", "type": "object", "properties": { "criticality": { "type": "string", "nullable": true }, "riskLevel": { "type": "string", "nullable": true }, "onboardingFormKey": { "type": "string", "nullable": true }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.OnboardingQuestionAnswer" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "OnboardingDetailsTab" } }, "OpenApi.v1.OnboardingFormDetails": { "title": "OpenApi.v1.OnboardingFormDetails", "type": "object", "properties": { "formKey": { "type": "string", "nullable": true }, "formName": { "type": "string", "nullable": true }, "vendorInformationQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.OnboardingQuestionWithChildren" }, "nullable": true }, "productInformationQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.OnboardingQuestionWithChildren" }, "nullable": true }, "pricingQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.OnboardingQuestion" }, "nullable": true }, "criticalityQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.OnboardingQuestion" }, "nullable": true }, "riskAssessmentQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.OnboardingRiskQuestion" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "OnboardingFormDetails" } }, "OpenApi.v1.OnboardingNote": { "title": "OpenApi.v1.OnboardingNote", "type": "object", "properties": { "date": { "type": "string", "format": "date-time" }, "author": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "isEditable": { "type": "boolean" } }, "additionalProperties": false, "xml": { "name": "OnboardingNote" } }, "OpenApi.v1.OnboardingQuestion": { "title": "OpenApi.v1.OnboardingQuestion", "type": "object", "properties": { "question": { "type": "string", "nullable": true }, "questionKey": { "type": "string", "nullable": true }, "questionResponsibility": { "type": "string", "nullable": true } }, "additionalProperties": false, "xml": { "name": "OnboardingQuestion" } }, "OpenApi.v1.OnboardingQuestionAnswer": { "title": "OpenApi.v1.OnboardingQuestionAnswer", "type": "object", "properties": { "question": { "type": "string", "nullable": true }, "questionKey": { "type": "string", "nullable": true }, "questionResponsibility": { "type": "string", "nullable": true }, "dataFieldKey": { "type": "string", "nullable": true }, "questionType": { "type": "string", "nullable": true }, "childQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.ChildQuestion" }, "nullable": true }, "answer": { "type": "string", "nullable": true }, "answers": { "type": "array", "items": { "type": "string" }, "nullable": true }, "profileQuestionType": { "type": "string", "nullable": true }, "isEditable": { "type": "boolean" } }, "additionalProperties": false, "xml": { "name": "OnboardingQuestionAnswer" } }, "OpenApi.v1.OnboardingQuestionWithChildren": { "title": "OpenApi.v1.OnboardingQuestionWithChildren", "type": "object", "properties": { "question": { "type": "string", "nullable": true }, "questionKey": { "type": "string", "nullable": true }, "questionResponsibility": { "type": "string", "nullable": true }, "dataFieldKey": { "type": "string", "nullable": true }, "questionType": { "type": "string", "nullable": true }, "childQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.ChildQuestion" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "OnboardingQuestionWithChildren" } }, "OpenApi.v1.OnboardingRelationships": { "title": "OpenApi.v1.OnboardingRelationships", "type": "object", "properties": { "relationshipKey": { "type": "string", "nullable": true }, "vendorInformation": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.OnboardingRequestDataWithChild" }, "nullable": true }, "productInformation": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.OnboardingRequestDataWithChild" }, "nullable": true }, "criticalityInformation": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.OnboardingRequestDataAnswer" }, "nullable": true }, "pricingInformation": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.OnboardingRequestDataAnswer" }, "nullable": true }, "riskInformation": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.OnboardingRequestDataAnswer" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "OnboardingRelationships" } }, "OpenApi.v1.OnboardingRequestData": { "title": "OpenApi.v1.OnboardingRequestData", "type": "object", "properties": { "category": { "type": "string", "nullable": true }, "reasonID": { "type": "integer", "format": "int32" }, "productType": { "type": "string", "nullable": true }, "deadline": { "type": "string", "nullable": true }, "requestorKey": { "type": "string", "nullable": true }, "isDraft": { "type": "boolean" }, "relationships": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.OnboardingRelationships" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "OnboardingRequestData" } }, "OpenApi.v1.OnboardingRequestDataAnswer": { "title": "OpenApi.v1.OnboardingRequestDataAnswer", "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "answers": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "OnboardingRequestDataAnswer" } }, "OpenApi.v1.OnboardingRequestDataWithChild": { "title": "OpenApi.v1.OnboardingRequestDataWithChild", "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "answers": { "type": "array", "items": { "type": "string" }, "nullable": true }, "tieredAnswers": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.OnboardingRequestDataAnswer" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "OnboardingRequestDataWithChild" } }, "OpenApi.v1.OnboardingRequestReason": { "title": "OpenApi.v1.OnboardingRequestReason", "type": "object", "properties": { "reasonID": { "type": "integer", "format": "int32" }, "reason": { "type": "string", "nullable": true }, "isCustomReason": { "type": "boolean" } }, "additionalProperties": false, "xml": { "name": "OnboardingRequestReason" } }, "OpenApi.v1.OnboardingResponse": { "title": "OpenApi.v1.OnboardingResponse", "type": "object", "properties": { "relationshipKey": { "type": "string", "nullable": true }, "vendorName": { "type": "string", "nullable": true }, "productName": { "type": "string", "nullable": true } }, "additionalProperties": false, "xml": { "name": "OnboardingResponse" } }, "OpenApi.v1.OnboardingRiskQuestion": { "title": "OpenApi.v1.OnboardingRiskQuestion", "type": "object", "properties": { "question": { "type": "string", "nullable": true }, "questionKey": { "type": "string", "nullable": true }, "questionResponsibility": { "type": "string", "nullable": true }, "isPrevailing": { "type": "boolean" } }, "additionalProperties": false, "xml": { "name": "OnboardingRiskQuestion" } }, "OpenApi.v1.OnboardingStatusDetails": { "title": "OpenApi.v1.OnboardingStatusDetails", "type": "object", "properties": { "isIncumbentVendor": { "type": "boolean" }, "currentProductManagerKey": { "type": "string", "nullable": true }, "request": { "$ref": "#/components/schemas/OpenApi.v1.ReqInfo" }, "vendorInformation": { "$ref": "#/components/schemas/OpenApi.v1.VendorInfoStatusDetails" }, "riskInformation": { "$ref": "#/components/schemas/OpenApi.v1.RiskInformation" }, "notes": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.OnboardingNote" }, "nullable": true }, "workflowDetails": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.WorkflowInformation" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "OnboardingStatusDetails" } }, "OpenApi.v1.Oversight.OpenApiOffboardingOversightTaskProperties": { "title": "OpenApi.v1.Oversight.OpenApiOffboardingOversightTaskProperties", "type": "object", "properties": { "requestKey": { "type": "string", "nullable": true } }, "additionalProperties": false, "xml": { "name": "Oversight.OpenApiOffboardingOversightTaskProperties" } }, "OpenApi.v1.Oversight.OpenApiOnboardingOversightTaskProperties": { "title": "OpenApi.v1.Oversight.OpenApiOnboardingOversightTaskProperties", "type": "object", "properties": { "requestRelationshipKey": { "type": "string", "nullable": true } }, "additionalProperties": false, "xml": { "name": "Oversight.OpenApiOnboardingOversightTaskProperties" } }, "OpenApi.v1.Oversight.OpenApiOversightContact": { "title": "OpenApi.v1.Oversight.OpenApiOversightContact", "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false, "xml": { "name": "Oversight.OpenApiOversightContact" } }, "OpenApi.v1.Oversight.OpenApiOversightRequirement": { "title": "OpenApi.v1.Oversight.OpenApiOversightRequirement", "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "shouldNotifyAdminWhenOverdue": { "type": "boolean" }, "taskDurationInDays": { "type": "integer", "format": "int32" }, "isOneTimeRequirement": { "type": "boolean" }, "oversightRequirementType": { "type": "string", "nullable": true }, "oversightRequirementCategory": { "type": "string", "nullable": true }, "oversightRequirementResultGroup": { "type": "string", "nullable": true }, "isSoc": { "type": "boolean" }, "onboardingLifecycle": { "$ref": "#/components/schemas/OpenApi.v1.Oversight.OpenApiOversightRequirementLifecycle" }, "offboardingLifecycle": { "$ref": "#/components/schemas/OpenApi.v1.Oversight.OpenApiOversightRequirementLifecycle" }, "ongoingLifecycle": { "$ref": "#/components/schemas/OpenApi.v1.Oversight.OpenApiOversightRequirementLifecycle" } }, "additionalProperties": false, "xml": { "name": "Oversight.OpenApiOversightRequirement" } }, "OpenApi.v1.Oversight.OpenApiOversightRequirementLifecycle": { "title": "OpenApi.v1.Oversight.OpenApiOversightRequirementLifecycle", "type": "object", "properties": { "isApprovalRequired": { "type": "boolean" }, "approverContact": { "$ref": "#/components/schemas/OpenApi.v1.Oversight.OpenApiOversightContact" }, "defaultTaskOwner": { "$ref": "#/components/schemas/OpenApi.v1.Oversight.OpenApiOversightTaskOwner" }, "isActive": { "type": "boolean" } }, "additionalProperties": false, "xml": { "name": "Oversight.OpenApiOversightRequirementLifecycle" } }, "OpenApi.v1.Oversight.OpenApiOversightTask": { "title": "OpenApi.v1.Oversight.OpenApiOversightTask", "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "requirementName": { "type": "string", "nullable": true }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "owner": { "$ref": "#/components/schemas/OpenApi.v1.Oversight.OpenApiOversightTaskOwner" }, "internalReviewer": { "$ref": "#/components/schemas/OpenApi.v1.Oversight.OpenApiOversightContact" }, "internalReviewerDate": { "type": "string", "format": "date-time", "nullable": true }, "externalReviewer": { "type": "string", "nullable": true }, "externalReviewerDate": { "type": "string", "format": "date-time", "nullable": true }, "taskStatus": { "type": "string", "nullable": true }, "approvalStatus": { "type": "string", "nullable": true }, "vendorKey": { "type": "string", "nullable": true }, "productKeys": { "type": "array", "items": { "type": "string" }, "nullable": true }, "lifecycle": { "type": "string", "nullable": true }, "socType": { "type": "string", "nullable": true }, "approver": { "$ref": "#/components/schemas/OpenApi.v1.Oversight.OpenApiOversightContact" }, "taskDocumentKeys": { "type": "array", "items": { "type": "string" }, "nullable": true }, "comments": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.Oversight.OpenApiOversightTaskComment" }, "nullable": true }, "reviewResult": { "type": "string", "nullable": true }, "requirementKey": { "type": "string", "nullable": true }, "completedDate": { "type": "string", "format": "date-time", "nullable": true }, "completedBy": { "$ref": "#/components/schemas/OpenApi.v1.Oversight.OpenApiOversightContact" }, "onboardingProperties": { "$ref": "#/components/schemas/OpenApi.v1.Oversight.OpenApiOnboardingOversightTaskProperties" }, "offboardingProperties": { "$ref": "#/components/schemas/OpenApi.v1.Oversight.OpenApiOffboardingOversightTaskProperties" } }, "additionalProperties": false, "xml": { "name": "Oversight.OpenApiOversightTask" } }, "OpenApi.v1.Oversight.OpenApiOversightTaskComment": { "title": "OpenApi.v1.Oversight.OpenApiOversightTaskComment", "type": "object", "properties": { "commentString": { "type": "string", "nullable": true } }, "additionalProperties": false, "xml": { "name": "Oversight.OpenApiOversightTaskComment" } }, "OpenApi.v1.Oversight.OpenApiOversightTaskOwner": { "title": "OpenApi.v1.Oversight.OpenApiOversightTaskOwner", "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true } }, "additionalProperties": false, "xml": { "name": "Oversight.OpenApiOversightTaskOwner" } }, "OpenApi.v1.Oversight.Request.CreateOversightTaskRequest": { "title": "OpenApi.v1.Oversight.Request.CreateOversightTaskRequest", "type": "object", "properties": { "oversightRequirementKey": { "type": "string", "nullable": true }, "ownerKey": { "type": "string", "nullable": true }, "ownerType": { "type": "string", "nullable": true }, "startDate": { "type": "string", "format": "date-time" }, "productsKeys": { "type": "array", "items": { "type": "string" }, "nullable": true }, "vendorKey": { "type": "string", "nullable": true }, "onboardingProperties": { "$ref": "#/components/schemas/OpenApi.v1.Oversight.OpenApiOnboardingOversightTaskProperties" }, "offboardingProperties": { "$ref": "#/components/schemas/OpenApi.v1.Oversight.OpenApiOffboardingOversightTaskProperties" } }, "additionalProperties": false, "xml": { "name": "Oversight.Request.CreateOversightTaskRequest" } }, "OpenApi.v1.Oversight.Request.GetOversightRequirementListRequest": { "title": "OpenApi.v1.Oversight.Request.GetOversightRequirementListRequest", "type": "object", "properties": { "lifecycles": { "type": "array", "items": { "type": "string" }, "nullable": true }, "defaultTaskOwnerKeys": { "type": "array", "items": { "type": "string" }, "nullable": true }, "defaultApproverKeys": { "type": "array", "items": { "type": "string" }, "nullable": true }, "keys": { "type": "array", "items": { "type": "string" }, "nullable": true }, "isOneTimeRequirement": { "type": "boolean", "nullable": true }, "isSoc": { "type": "boolean", "nullable": true }, "willNotifyAdminWhenOverdue": { "type": "boolean", "nullable": true }, "requirementLevel": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "Oversight.Request.GetOversightRequirementListRequest" } }, "OpenApi.v1.Oversight.Request.GetOversightTaskListRequest": { "title": "OpenApi.v1.Oversight.Request.GetOversightTaskListRequest", "type": "object", "properties": { "keys": { "type": "array", "items": { "type": "string" }, "nullable": true }, "statuses": { "type": "array", "items": { "type": "string" }, "nullable": true }, "lifecycles": { "type": "array", "items": { "type": "string" }, "nullable": true }, "vendorKeys": { "type": "array", "items": { "type": "string" }, "nullable": true }, "productKeys": { "type": "array", "items": { "type": "string" }, "nullable": true }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true }, "reviewResults": { "type": "array", "items": { "type": "string" }, "nullable": true }, "taskOwnerKeys": { "type": "array", "items": { "type": "string" }, "nullable": true }, "requirementKeys": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "Oversight.Request.GetOversightTaskListRequest" } }, "OpenApi.v1.OversightRequirement": { "title": "OpenApi.v1.OversightRequirement", "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true }, "appliesToAllProducts": { "type": "boolean" } }, "additionalProperties": false, "xml": { "name": "OversightRequirement" } }, "OpenApi.v1.OversightRequirementDetail": { "title": "OpenApi.v1.OversightRequirementDetail", "type": "object", "properties": { "requirementKey": { "type": "string", "nullable": true }, "key": { "type": "string", "nullable": true }, "taskOwnerKey": { "type": "string", "nullable": true }, "dueDate": { "type": "string", "format": "date-time" }, "productKeys": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "OversightRequirementDetail" } }, "OpenApi.v1.PhoneNumber": { "title": "OpenApi.v1.PhoneNumber", "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "areaCode": { "type": "string", "nullable": true }, "prefix": { "type": "string", "nullable": true }, "suffix": { "type": "string", "nullable": true }, "extension": { "type": "string", "nullable": true } }, "additionalProperties": false, "xml": { "name": "PhoneNumber" } }, "OpenApi.v1.Product": { "title": "OpenApi.v1.Product", "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "productType": { "type": "string", "nullable": true }, "category": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "xml": { "name": "Product" } }, "OpenApi.v1.ProductContact": { "title": "OpenApi.v1.ProductContact", "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "isPrimaryContact": { "type": "boolean" } }, "additionalProperties": false, "xml": { "name": "ProductContact" } }, "OpenApi.v1.ProductContactPhoneNumber": { "title": "OpenApi.v1.ProductContactPhoneNumber", "type": "object", "properties": { "countryCodeAbbreviation": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "extension": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true } }, "additionalProperties": false, "xml": { "name": "ProductContactPhoneNumber" } }, "OpenApi.v1.ProductContacts": { "title": "OpenApi.v1.ProductContacts", "type": "object", "properties": { "productKey": { "type": "string", "nullable": true }, "contacts": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.NewProductContact" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "ProductContacts" } }, "OpenApi.v1.ProductDetail": { "title": "OpenApi.v1.ProductDetail", "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "inherentRisk": { "type": "string", "nullable": true }, "inherentRiskScore": { "type": "integer", "format": "int32" }, "residualRisk": { "type": "string", "nullable": true }, "residualRiskScore": { "type": "integer", "format": "int32", "nullable": true }, "contacts": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.Contact" }, "nullable": true }, "businessUnits": { "type": "array", "items": { "type": "string" }, "nullable": true }, "category": { "type": "string", "nullable": true }, "productProfileData": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.ProfileDataAnswerWithGroupIdentity" }, "nullable": true }, "managerKey": { "type": "string", "nullable": true }, "collaboratorKeys": { "type": "array", "items": { "type": "string" }, "nullable": true }, "assessmentLastCompleted": { "type": "string", "format": "date-time", "nullable": true }, "inherentAssessmentPerformedBy": { "type": "string", "nullable": true }, "residualAssessmentPerformedBy": { "type": "string", "nullable": true }, "inherentAssessmentApprovedBy": { "type": "string", "nullable": true }, "residualAssessmentApprovedBy": { "type": "string", "nullable": true }, "assessmentNextDue": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false, "xml": { "name": "ProductDetail" } }, "OpenApi.v1.ProductProfileData": { "title": "OpenApi.v1.ProductProfileData", "type": "object", "properties": { "dataFieldKey": { "type": "string", "nullable": true }, "answers": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "ProductProfileData" } }, "OpenApi.v1.ProductProfileDataField": { "title": "OpenApi.v1.ProductProfileDataField", "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true }, "answerFormat": { "type": "string", "nullable": true }, "parentKey": { "type": "string", "nullable": true }, "selectedParentOption": { "type": "string", "nullable": true }, "productsAppliedTo": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "ProductProfileDataField" } }, "OpenApi.v1.ProfileAnswers": { "title": "OpenApi.v1.ProfileAnswers", "type": "object", "properties": { "vendorProfileAnswers": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.ProfileExpectedAnswers" }, "nullable": true }, "productProfileAnswers": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.ProfileExpectedAnswers" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "ProfileAnswers" } }, "OpenApi.v1.ProfileDataAnswerWithGroupIdentity": { "title": "OpenApi.v1.ProfileDataAnswerWithGroupIdentity", "type": "object", "properties": { "answers": { "type": "array", "items": { "type": "string" }, "nullable": true }, "answer": { "type": "string", "nullable": true }, "key": { "type": "string", "nullable": true }, "groupIdentity": { "type": "string", "nullable": true }, "dataFieldKey": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true }, "answerFormat": { "type": "string", "nullable": true }, "formattedAnswer": { "type": "string", "nullable": true } }, "additionalProperties": false, "xml": { "name": "ProfileDataAnswerWithGroupIdentity" } }, "OpenApi.v1.ProfileExpectedAnswers": { "title": "OpenApi.v1.ProfileExpectedAnswers", "type": "object", "properties": { "dataFieldKey": { "type": "string", "nullable": true }, "expectedAnswers": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "ProfileExpectedAnswers" } }, "OpenApi.v1.ProfileQuestion": { "title": "OpenApi.v1.ProfileQuestion", "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true }, "answerFormat": { "type": "string", "nullable": true }, "parentKey": { "type": "string", "nullable": true }, "valueList": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.ValueList" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "ProfileQuestion" } }, "OpenApi.v1.Questionnaire.AvailableResponse": { "title": "OpenApi.v1.Questionnaire.AvailableResponse", "type": "object", "properties": { "response": { "type": "string", "nullable": true }, "points": { "type": "string", "nullable": true } }, "additionalProperties": false, "xml": { "name": "Questionnaire.AvailableResponse" } }, "OpenApi.v1.Questionnaire.ChangeLog": { "title": "OpenApi.v1.Questionnaire.ChangeLog", "type": "object", "properties": { "date": { "type": "string", "format": "date-time" }, "typeID": { "type": "integer", "format": "int32" }, "lastUpdatedByKey": { "type": "string", "nullable": true }, "lastUpdatedByName": { "type": "string", "nullable": true }, "newAssigned": { "type": "string", "nullable": true }, "previousAssigned": { "type": "string", "nullable": true }, "declinedComments": { "type": "string", "nullable": true }, "lastUpdatedDate": { "type": "string", "format": "date-time" }, "oldDeadline": { "type": "string", "format": "date-time", "nullable": true }, "newDeadline": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false, "xml": { "name": "Questionnaire.ChangeLog" } }, "OpenApi.v1.Questionnaire.QuestionScore": { "title": "OpenApi.v1.Questionnaire.QuestionScore", "type": "object", "properties": { "appliedPoints": { "type": "integer", "format": "int32" }, "maxPoints": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "xml": { "name": "Questionnaire.QuestionScore" } }, "OpenApi.v1.Questionnaire.QuestionWithScore": { "title": "OpenApi.v1.Questionnaire.QuestionWithScore", "type": "object", "properties": { "question": { "type": "string", "nullable": true }, "questionNumber": { "type": "string", "nullable": true }, "serialNumber": { "type": "string", "nullable": true }, "questionScore": { "$ref": "#/components/schemas/OpenApi.v1.Questionnaire.QuestionScore" }, "answer": { "type": "string", "nullable": true }, "isIssueCreated": { "type": "boolean" }, "recipientAttachmentKeys": { "type": "array", "items": { "type": "string" }, "nullable": true }, "availableResponses": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.Questionnaire.AvailableResponse" }, "nullable": true }, "additionalComments": { "type": "string", "nullable": true }, "childQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.Questionnaire.QuestionWithScore" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "Questionnaire.QuestionWithScore" } }, "OpenApi.v1.Questionnaire.QuestionnaireFilterJsonRequest": { "title": "OpenApi.v1.Questionnaire.QuestionnaireFilterJsonRequest", "type": "object", "properties": { "searchText": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "sentDate": { "type": "string", "nullable": true }, "deadline": { "type": "string", "nullable": true }, "completedDate": { "type": "string", "nullable": true } }, "additionalProperties": false, "xml": { "name": "Questionnaire.QuestionnaireFilterJsonRequest" } }, "OpenApi.v1.Questionnaire.QuestionnaireLibraryData": { "title": "OpenApi.v1.Questionnaire.QuestionnaireLibraryData", "type": "object", "properties": { "questionnaireKey": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "createdByKey": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time", "nullable": true }, "lastUsedDate": { "type": "string", "format": "date-time", "nullable": true }, "status": { "type": "string", "nullable": true }, "versionID": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true } }, "additionalProperties": false, "xml": { "name": "Questionnaire.QuestionnaireLibraryData" } }, "OpenApi.v1.Questionnaire.QuestionnaireRequestEmailLog": { "title": "OpenApi.v1.Questionnaire.QuestionnaireRequestEmailLog", "type": "object", "properties": { "sentToKey": { "type": "string", "nullable": true }, "sentToAddress": { "type": "string", "nullable": true }, "sentDate": { "type": "string", "format": "date-time" }, "emailTemplate": { "type": "string", "nullable": true }, "copiedToKeys": { "type": "array", "items": { "type": "string" }, "nullable": true }, "copiedToAddresses": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "Questionnaire.QuestionnaireRequestEmailLog" } }, "OpenApi.v1.Questionnaire.QuestionnaireResponse": { "title": "OpenApi.v1.Questionnaire.QuestionnaireResponse", "type": "object", "properties": { "questionnaireRequestKey": { "type": "string", "nullable": true }, "vendorKey": { "type": "string", "nullable": true }, "productKey": { "type": "string", "nullable": true }, "questionnaireKey": { "type": "string", "nullable": true }, "sentToKey": { "type": "string", "nullable": true }, "sentTo": { "type": "string", "nullable": true }, "sentByKey": { "type": "string", "nullable": true }, "sentBy": { "type": "string", "nullable": true }, "sentDate": { "type": "string", "format": "date-time", "nullable": true }, "deadlineDate": { "type": "string", "format": "date-time", "nullable": true }, "percentageAnswered": { "type": "integer", "format": "int32", "nullable": true }, "answeredDate": { "type": "string", "format": "date-time", "nullable": true }, "percentageComplete": { "type": "integer", "format": "int32", "nullable": true }, "status": { "type": "string", "nullable": true }, "completedDate": { "type": "string", "format": "date-time", "nullable": true }, "canceledDate": { "type": "string", "format": "date-time", "nullable": true }, "changeLogs": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.Questionnaire.ChangeLog" }, "nullable": true }, "emailLogs": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.Questionnaire.QuestionnaireRequestEmailLog" }, "nullable": true }, "lifeCycleStage": { "type": "string", "nullable": true } }, "additionalProperties": false, "xml": { "name": "Questionnaire.QuestionnaireResponse" } }, "OpenApi.v1.Questionnaire.QuestionnaireWithScore": { "title": "OpenApi.v1.Questionnaire.QuestionnaireWithScore", "type": "object", "properties": { "vendorKey": { "type": "string", "nullable": true }, "productKey": { "type": "string", "nullable": true }, "isCritical": { "type": "boolean" }, "lifeCycleStage": { "type": "string", "nullable": true }, "questionnaireRequestKey": { "type": "string", "nullable": true }, "recipientKey": { "type": "string", "nullable": true }, "recipientName": { "type": "string", "nullable": true }, "dateSent": { "type": "string", "format": "date-time" }, "deadline": { "type": "string", "format": "date-time" }, "dateReceived": { "type": "string", "format": "date-time" }, "overallScore": { "type": "string", "nullable": true }, "overallPoints": { "$ref": "#/components/schemas/OpenApi.v1.Questionnaire.ScoreValues" }, "sections": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.Questionnaire.SectionWithScore" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "Questionnaire.QuestionnaireWithScore" } }, "OpenApi.v1.Questionnaire.ScoreValues": { "title": "OpenApi.v1.Questionnaire.ScoreValues", "type": "object", "properties": { "numerator": { "type": "integer", "format": "int32" }, "denominator": { "type": "integer", "format": "int32" }, "score": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false, "xml": { "name": "Questionnaire.ScoreValues" } }, "OpenApi.v1.Questionnaire.SectionWithScore": { "title": "OpenApi.v1.Questionnaire.SectionWithScore", "type": "object", "properties": { "questions": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.Questionnaire.QuestionWithScore" }, "nullable": true }, "name": { "type": "string", "nullable": true }, "sectionRiskLevel": { "type": "string", "nullable": true }, "sectionScore": { "$ref": "#/components/schemas/OpenApi.v1.Questionnaire.ScoreValues" } }, "additionalProperties": false, "xml": { "name": "Questionnaire.SectionWithScore" } }, "OpenApi.v1.ReqInfo": { "title": "OpenApi.v1.ReqInfo", "type": "object", "properties": { "requestKey": { "type": "string", "nullable": true }, "requestorName": { "type": "string", "nullable": true }, "requestorKey": { "type": "string", "nullable": true }, "requestDate": { "type": "string", "format": "date-time", "nullable": true }, "requestReason": { "type": "string", "nullable": true }, "requestReasonID": { "type": "string", "nullable": true }, "deadlineDate": { "type": "string", "format": "date-time", "nullable": true }, "vmoManagerName": { "type": "string", "nullable": true }, "vmoManagerKey": { "type": "string", "nullable": true }, "statusID": { "type": "integer", "format": "int32" }, "status": { "type": "string", "nullable": true }, "approvedOrDeclinedDate": { "type": "string", "format": "date-time", "nullable": true }, "isCategoryExempted": { "type": "boolean" }, "category": { "type": "string", "nullable": true }, "areMultipleVendorsInRequest": { "type": "boolean" }, "otherRelationshipsInRequest": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.AdditionalRelationships" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "ReqInfo" } }, "OpenApi.v1.RiskInformation": { "title": "OpenApi.v1.RiskInformation", "type": "object", "properties": { "inherentRiskScore": { "type": "integer", "format": "int32" }, "inherentRiskDescription": { "type": "string", "nullable": true }, "residualRiskScore": { "type": "integer", "format": "int32" }, "residualRiskDescription": { "type": "string", "nullable": true }, "riskLevelCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "xml": { "name": "RiskInformation" } }, "OpenApi.v1.RiskLevel": { "title": "OpenApi.v1.RiskLevel", "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "score": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "xml": { "name": "RiskLevel" } }, "OpenApi.v1.RiskLevels": { "title": "OpenApi.v1.RiskLevels", "type": "object", "properties": { "productKey": { "type": "string", "nullable": true }, "inherentRiskKey": { "type": "string", "nullable": true }, "residualRiskKey": { "type": "string", "nullable": true } }, "additionalProperties": false, "xml": { "name": "RiskLevels" } }, "OpenApi.v1.Role": { "title": "OpenApi.v1.Role", "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "roleName": { "type": "string", "nullable": true }, "isCustom": { "type": "boolean" } }, "additionalProperties": false, "xml": { "name": "Role" } }, "OpenApi.v1.Services.GetServicesRequest": { "title": "OpenApi.v1.Services.GetServicesRequest", "type": "object", "properties": { "filterByVendorKeys": { "type": "array", "items": { "type": "string" }, "nullable": true }, "filterByProductKeys": { "type": "array", "items": { "type": "string" }, "nullable": true }, "fromDateCreated": { "type": "string", "format": "date-time", "nullable": true }, "toDateCreated": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false, "xml": { "name": "Services.GetServicesRequest" } }, "OpenApi.v1.Services.Product": { "title": "OpenApi.v1.Services.Product", "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "productKey": { "type": "string", "nullable": true } }, "additionalProperties": false, "xml": { "name": "Services.Product" } }, "OpenApi.v1.Services.Service": { "title": "OpenApi.v1.Services.Service", "type": "object", "properties": { "serviceID": { "type": "string", "format": "uuid" }, "serviceKey": { "type": "string", "nullable": true, "readOnly": true }, "type": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "statusChangedDate": { "type": "string", "format": "date-time", "nullable": true }, "vendor": { "$ref": "#/components/schemas/OpenApi.v1.Services.Vendor" }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.Services.Product" }, "nullable": true }, "createdDate": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "xml": { "name": "Services.Service" } }, "OpenApi.v1.Services.ServiceDetails": { "title": "OpenApi.v1.Services.ServiceDetails", "type": "object", "properties": { "serviceID": { "type": "string", "format": "uuid" }, "serviceKey": { "type": "string", "nullable": true, "readOnly": true }, "type": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "statusChangedDate": { "type": "string", "format": "date-time", "nullable": true }, "vendor": { "$ref": "#/components/schemas/OpenApi.v1.Services.Vendor" }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.Services.Product" }, "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "documentKeys": { "type": "array", "items": { "type": "string" }, "nullable": true }, "rating": { "type": "string", "nullable": true }, "reviewLevel": { "type": "string", "nullable": true } }, "additionalProperties": false, "xml": { "name": "Services.ServiceDetails" } }, "OpenApi.v1.Services.Vendor": { "title": "OpenApi.v1.Services.Vendor", "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "vendorKey": { "type": "string", "nullable": true } }, "additionalProperties": false, "xml": { "name": "Services.Vendor" } }, "OpenApi.v1.UpdateProductProfileRequest": { "title": "OpenApi.v1.UpdateProductProfileRequest", "type": "object", "properties": { "productKey": { "type": "string", "nullable": true }, "productManagerKey": { "type": "string", "nullable": true }, "productName": { "type": "string", "nullable": true }, "productType": { "type": "string", "nullable": true }, "productProfileData": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.ProductProfileData" }, "nullable": true }, "isActive": { "type": "boolean", "nullable": true }, "category": { "type": "string", "nullable": true }, "collaboratorKeys": { "type": "array", "items": { "type": "string" }, "nullable": true }, "contacts": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.ProductContact" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "UpdateProductProfileRequest" } }, "OpenApi.v1.UpdateVendorProfileRequest": { "title": "OpenApi.v1.UpdateVendorProfileRequest", "type": "object", "properties": { "vendorKey": { "type": "string", "nullable": true }, "vendorName": { "type": "string", "nullable": true }, "vendorProfileData": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.ProfileDataAnswerWithGroupIdentity" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "UpdateVendorProfileRequest" } }, "OpenApi.v1.UpdatedAnswers": { "title": "OpenApi.v1.UpdatedAnswers", "type": "object", "properties": { "questionKey": { "type": "string", "nullable": true }, "answers": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "UpdatedAnswers" } }, "OpenApi.v1.User": { "title": "OpenApi.v1.User", "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "isEnrolled": { "type": "boolean" }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "emailAddress": { "type": "string", "nullable": true }, "fullName": { "type": "string", "nullable": true }, "phoneNumbers": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.PhoneNumber" }, "nullable": true }, "createdByUserKeyOrDescription": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time", "nullable": true }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.Role" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "User" } }, "OpenApi.v1.ValueList": { "title": "OpenApi.v1.ValueList", "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true }, "dataKeyFieldLabel": { "type": "string", "nullable": true }, "dataKeyField": { "type": "string", "nullable": true }, "sortIndex": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "xml": { "name": "ValueList" } }, "OpenApi.v1.Vendor": { "title": "OpenApi.v1.Vendor", "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "isCritical": { "type": "boolean", "nullable": true }, "isThirdParty": { "type": "boolean" }, "isFourthParty": { "type": "boolean" }, "confidenceLevel": { "type": "string", "nullable": true }, "confidenceLevelComments": { "type": "string", "nullable": true }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.Product" }, "nullable": true }, "contracts": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.ContractOverview" }, "nullable": true }, "hasVendorSpendBudgets": { "type": "boolean" }, "hasVendorSpendDetails": { "type": "boolean" } }, "additionalProperties": false, "xml": { "name": "Vendor" } }, "OpenApi.v1.VendorInfoStatusDetails": { "title": "OpenApi.v1.VendorInfoStatusDetails", "type": "object", "properties": { "vendorName": { "type": "string", "nullable": true }, "vendorKey": { "type": "string", "nullable": true }, "productName": { "type": "string", "nullable": true }, "productKey": { "type": "string", "nullable": true }, "isExempt": { "type": "boolean" }, "isOversightExempt": { "type": "boolean" } }, "additionalProperties": false, "xml": { "name": "VendorInfoStatusDetails" } }, "OpenApi.v1.VendorOnboarding.SectionStatus": { "title": "OpenApi.v1.VendorOnboarding.SectionStatus", "type": "object", "properties": { "sectionName": { "type": "string", "nullable": true }, "isRequired": { "type": "boolean" }, "status": { "type": "string", "nullable": true }, "statusDate": { "type": "string", "format": "date-time", "nullable": true }, "assignedTo": { "type": "string", "nullable": true }, "assignedToKey": { "type": "string", "nullable": true }, "approverName": { "type": "string", "nullable": true }, "approverKey": { "type": "string", "nullable": true } }, "additionalProperties": false, "xml": { "name": "VendorOnboarding.SectionStatus" } }, "OpenApi.v1.VendorOnboardingFormInformation": { "title": "OpenApi.v1.VendorOnboardingFormInformation", "type": "object", "properties": { "formName": { "type": "string", "nullable": true }, "formKey": { "type": "string", "nullable": true }, "categories": { "type": "array", "items": { "type": "string" }, "nullable": true }, "formType": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "lastEditedBy": { "type": "string", "nullable": true }, "lastEditedDate": { "type": "string", "format": "date-time" }, "lastEditedByKey": { "type": "string", "nullable": true } }, "additionalProperties": false, "xml": { "name": "VendorOnboardingFormInformation" } }, "OpenApi.v1.VendorOnboardingInformationResponse": { "title": "OpenApi.v1.VendorOnboardingInformationResponse", "type": "object", "properties": { "onboardingForms": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.VendorOnboardingFormInformation" }, "nullable": true }, "requestReasons": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.OnboardingRequestReason" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "VendorOnboardingInformationResponse" } }, "OpenApi.v1.VendorOnboardingRequest": { "title": "OpenApi.v1.VendorOnboardingRequest", "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "requests": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.VendorOnboardingRequestModel" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "VendorOnboardingRequest" } }, "OpenApi.v1.VendorOnboardingRequestDetail": { "title": "OpenApi.v1.VendorOnboardingRequestDetail", "type": "object", "properties": { "onboardingStatusDetail": { "$ref": "#/components/schemas/OpenApi.v1.OnboardingStatusDetails" }, "onboardingDetails": { "$ref": "#/components/schemas/OpenApi.v1.OnboardingDetailsTab" }, "sectionStatus": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.VendorOnboarding.SectionStatus" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "VendorOnboardingRequestDetail" } }, "OpenApi.v1.VendorOnboardingRequestModel": { "title": "OpenApi.v1.VendorOnboardingRequestModel", "type": "object", "properties": { "relationshipKey": { "type": "string", "nullable": true }, "vendorName": { "type": "string", "nullable": true }, "vendorKey": { "type": "string", "nullable": true }, "productName": { "type": "string", "nullable": true }, "productKey": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "statusID": { "type": "integer", "format": "int32" }, "approvedOrDeclinedDate": { "type": "string", "format": "date-time", "nullable": true }, "requestorName": { "type": "string", "nullable": true }, "requestorKey": { "type": "string", "nullable": true }, "requestedDate": { "type": "string", "format": "date-time" }, "deadlineDate": { "type": "string", "format": "date-time", "nullable": true }, "vmoManagerName": { "type": "string", "nullable": true }, "vmoManagerKey": { "type": "string", "nullable": true }, "sectionStatus": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.VendorOnboarding.SectionStatus" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "VendorOnboardingRequestModel" } }, "OpenApi.v1.VendorProductRequest": { "title": "OpenApi.v1.VendorProductRequest", "type": "object", "properties": { "vendorKey": { "type": "string", "nullable": true }, "vendorName": { "type": "string", "nullable": true }, "productType": { "type": "string", "nullable": true }, "productName": { "type": "string", "nullable": true }, "productManagerKey": { "type": "string", "nullable": true }, "isCriticalVendor": { "type": "boolean" }, "isThirdParty": { "type": "boolean" }, "isFourthParty": { "type": "boolean" }, "annualReviewDate": { "type": "string", "nullable": true }, "category": { "type": "string", "nullable": true }, "businessUnits": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "VendorProductRequest" } }, "OpenApi.v1.VendorProfile": { "title": "OpenApi.v1.VendorProfile", "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "contactKey": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "isThirdParty": { "type": "boolean" }, "fourthPartyVendorKeys": { "type": "array", "items": { "type": "string" }, "nullable": true }, "isFourthParty": { "type": "boolean" }, "thirdPartyVendorKeys": { "type": "array", "items": { "type": "string" }, "nullable": true }, "confidenceLevel": { "type": "string", "nullable": true }, "confidenceLevelComments": { "type": "string", "nullable": true }, "hasVendorSpendBudgets": { "type": "boolean" }, "hasVendorSpendDetails": { "type": "boolean" }, "vendorProfileData": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.ProfileDataAnswerWithGroupIdentity" }, "nullable": true }, "openRequirements": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.OversightRequirementDetail" }, "nullable": true }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.ProductDetail" }, "nullable": true }, "contracts": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.ContractOverview" }, "nullable": true }, "vendorRisk": { "$ref": "#/components/schemas/OpenApi.v1.VendorRisk" } }, "additionalProperties": false, "xml": { "name": "VendorProfile" } }, "OpenApi.v1.VendorProfileDataField": { "title": "OpenApi.v1.VendorProfileDataField", "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true }, "answerFormat": { "type": "string", "nullable": true }, "vendorsAppliedTo": { "type": "array", "items": { "type": "string" }, "nullable": true }, "parentKey": { "type": "string", "nullable": true }, "selectedParentOption": { "type": "string", "nullable": true } }, "additionalProperties": false, "xml": { "name": "VendorProfileDataField" } }, "OpenApi.v1.VendorRelationships": { "title": "OpenApi.v1.VendorRelationships", "type": "object", "properties": { "vendorKey": { "type": "string", "nullable": true }, "isThirdParty": { "type": "boolean", "nullable": true }, "fourthPartyVendorKeys": { "type": "array", "items": { "type": "string" }, "nullable": true }, "isFourthParty": { "type": "boolean", "nullable": true }, "thirdPartyVendorKeys": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "VendorRelationships" } }, "OpenApi.v1.VendorRisk": { "title": "OpenApi.v1.VendorRisk", "type": "object", "properties": { "inherentRisk": { "type": "string", "nullable": true }, "inherentRiskScore": { "type": "integer", "format": "int32", "nullable": true }, "residualRisk": { "type": "string", "nullable": true }, "residualRiskScore": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false, "xml": { "name": "VendorRisk" } }, "OpenApi.v1.VendorSpend.BudgetResponse": { "title": "OpenApi.v1.VendorSpend.BudgetResponse", "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "amount": { "type": "number", "format": "double" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "xml": { "name": "VendorSpend.BudgetResponse" } }, "OpenApi.v1.VendorSpend.CreateBudgetRequest": { "title": "OpenApi.v1.VendorSpend.CreateBudgetRequest", "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "startDate": { "type": "string", "nullable": true }, "amount": { "type": "string", "nullable": true }, "vendorKey": { "type": "string", "nullable": true } }, "additionalProperties": false, "xml": { "name": "VendorSpend.CreateBudgetRequest" } }, "OpenApi.v1.VendorSpend.CreateBudgetResponse": { "title": "OpenApi.v1.VendorSpend.CreateBudgetResponse", "type": "object", "properties": { "key": { "type": "string", "nullable": true } }, "additionalProperties": false, "xml": { "name": "VendorSpend.CreateBudgetResponse" } }, "OpenApi.v1.VendorSpend.CreateSpendRequest": { "title": "OpenApi.v1.VendorSpend.CreateSpendRequest", "type": "object", "properties": { "budgetKey": { "type": "string", "nullable": true }, "vendorKey": { "type": "string", "nullable": true }, "productKey": { "type": "string", "nullable": true }, "invoiceNumber": { "type": "string", "nullable": true }, "invoiceDate": { "type": "string", "nullable": true }, "amount": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true } }, "additionalProperties": false, "xml": { "name": "VendorSpend.CreateSpendRequest" } }, "OpenApi.v1.VendorSpend.CreateSpendResponse": { "title": "OpenApi.v1.VendorSpend.CreateSpendResponse", "type": "object", "properties": { "key": { "type": "string", "nullable": true } }, "additionalProperties": false, "xml": { "name": "VendorSpend.CreateSpendResponse" } }, "OpenApi.v1.VendorSpend.GetSpendItemsResponse": { "title": "OpenApi.v1.VendorSpend.GetSpendItemsResponse", "type": "object", "properties": { "numberOfSpends": { "type": "integer", "format": "int32", "readOnly": true }, "spends": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.VendorSpend.SpendItem" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "VendorSpend.GetSpendItemsResponse" } }, "OpenApi.v1.VendorSpend.SpendItem": { "title": "OpenApi.v1.VendorSpend.SpendItem", "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "budgetKey": { "type": "string", "nullable": true }, "budgetName": { "type": "string", "nullable": true }, "vendorKey": { "type": "string", "nullable": true }, "productKey": { "type": "string", "nullable": true }, "invoiceNumber": { "type": "string", "nullable": true }, "invoiceDate": { "type": "string", "format": "date-time" }, "amount": { "type": "number", "format": "double" }, "notes": { "type": "string", "nullable": true } }, "additionalProperties": false, "xml": { "name": "VendorSpend.SpendItem" } }, "OpenApi.v1.VendorSpend.UpdateBudgetRequest": { "title": "OpenApi.v1.VendorSpend.UpdateBudgetRequest", "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "startDate": { "type": "string", "nullable": true }, "amount": { "type": "string", "nullable": true } }, "additionalProperties": false, "xml": { "name": "VendorSpend.UpdateBudgetRequest" } }, "OpenApi.v1.VendorSpend.UpdateSpendRequest": { "title": "OpenApi.v1.VendorSpend.UpdateSpendRequest", "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "vendorKey": { "type": "string", "nullable": true }, "budgetKey": { "type": "string", "nullable": true }, "productKey": { "type": "string", "nullable": true }, "invoiceNumber": { "type": "string", "nullable": true }, "invoiceDate": { "type": "string", "nullable": true }, "amount": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true } }, "additionalProperties": false, "xml": { "name": "VendorSpend.UpdateSpendRequest" } }, "OpenApi.v1.Venmonitor.DataPartnerScore": { "title": "OpenApi.v1.Venmonitor.DataPartnerScore", "type": "object", "properties": { "dataPartnerName": { "type": "string", "nullable": true }, "normalizedScoreQuantitative": { "type": "number", "format": "double", "nullable": true }, "normalizedScoreQualitative": { "type": "string", "nullable": true } }, "additionalProperties": false, "xml": { "name": "Venmonitor.DataPartnerScore" } }, "OpenApi.v1.Venmonitor.GetVendorScoreResponse": { "title": "OpenApi.v1.Venmonitor.GetVendorScoreResponse", "type": "object", "properties": { "vendorNickname": { "type": "string", "nullable": true }, "vendorKey": { "type": "string", "nullable": true }, "venmonitorType": { "type": "string", "nullable": true }, "publishedDate": { "type": "string", "format": "date-time", "nullable": true }, "lastRefreshDate": { "type": "string", "format": "date-time", "nullable": true }, "overallScoreQuantitative": { "type": "number", "format": "double", "nullable": true }, "overallScoreQualitative": { "type": "string", "nullable": true }, "dataPartnerScores": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.Venmonitor.DataPartnerScore" }, "nullable": true } }, "additionalProperties": false, "xml": { "name": "Venmonitor.GetVendorScoreResponse" } }, "OpenApi.v1.WorkflowInformation": { "title": "OpenApi.v1.WorkflowInformation", "type": "object", "properties": { "workflowName": { "type": "string", "nullable": true }, "workflowKey": { "type": "string", "nullable": true }, "steps": { "type": "array", "items": { "$ref": "#/components/schemas/OpenApi.v1.WorkflowStepDetails" }, "nullable": true }, "isWorklfowComplete": { "type": "boolean" }, "stepsCount": { "type": "integer", "format": "int32" }, "completedStepsCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "xml": { "name": "WorkflowInformation" } }, "OpenApi.v1.WorkflowStepDetails": { "title": "OpenApi.v1.WorkflowStepDetails", "type": "object", "properties": { "description": { "type": "string", "nullable": true }, "isComplete": { "type": "boolean" }, "completedDate": { "type": "string", "nullable": true }, "startDate": { "type": "string", "nullable": true }, "dueDate": { "type": "string", "nullable": true }, "comment": { "$ref": "#/components/schemas/OpenApi.v1.WorkflowsStepCommentDetails" }, "stepStatus": { "type": "integer", "format": "int32" }, "claimedBy": { "type": "string", "nullable": true }, "approvedBy": { "type": "string", "nullable": true } }, "additionalProperties": false, "xml": { "name": "WorkflowStepDetails" } }, "OpenApi.v1.WorkflowsStepCommentDetails": { "title": "OpenApi.v1.WorkflowsStepCommentDetails", "type": "object", "properties": { "note": { "type": "string", "nullable": true }, "creator": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "xml": { "name": "WorkflowsStepCommentDetails" } } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "Please insert access token with Bearer into field eg. Bearer eyJhbGciOiJSUzI1Ni and click authorize.", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ] }