From bcdd2ae0fd359092fe4a14d202fafe95802c23d3 Mon Sep 17 00:00:00 2001 From: Ralph Noordanus Date: Thu, 25 Mar 2021 03:23:53 +0100 Subject: [PATCH] Add Mavim iMprove connector (#731) * Updated apiProperties.json and apiDefinition.swagger.json (#546) * Update apiDefinition.swagger.json * Add files via upload * update readme * Update Get User Info Action and apiProperties file * In d insurance (#560) * Create IN-D KYC India * Delete IN-D KYC India * Create apiDefinition.swagger.json * Add files via upload * Create README.MD * Update README.MD * Delete README.MD * Delete apiDefinition.swagger.json * Delete apiProperties.json * Create IN-D Insurance * Delete IN-D Insurance * Create IN-D Insurance * Delete IN-D Insurance * Create Readme.md * Add files via upload * Add files via upload * Delete Readme.md * Delete apiDefinition.swagger.json * Delete apiProperties.json * Create Readme.md * Add files via upload * Add files via upload * Add Mavim iMprove connector * Changed background color for new logo White background is not "approved" by Microsoft to be used in the PowerApps connector. Therefor we inverted the logo colors to white logo on color background. * Added stackOwner Added the required stackOwner to the api properties. * Added the resource URI Our API uses this Guid Co-authored-by: Calvin Leong <60145424+calvinleong@users.noreply.github.com> Co-authored-by: gowthamd3 <65020517+gowthamd3@users.noreply.github.com> --- certified-connectors/Mavim iMprove/README.md | 18 + .../Mavim iMprove/apiDefinition.swagger.json | 4478 +++++++++++++++++ .../Mavim iMprove/apiProperties.json | 48 + 3 files changed, 4544 insertions(+) create mode 100644 certified-connectors/Mavim iMprove/README.md create mode 100644 certified-connectors/Mavim iMprove/apiDefinition.swagger.json create mode 100644 certified-connectors/Mavim iMprove/apiProperties.json diff --git a/certified-connectors/Mavim iMprove/README.md b/certified-connectors/Mavim iMprove/README.md new file mode 100644 index 0000000000..d458e1976a --- /dev/null +++ b/certified-connectors/Mavim iMprove/README.md @@ -0,0 +1,18 @@ +## Mavim iMprove Connector + +With the Mavim connector you are able to build a digital twin of your organization by visualizing the relationships among people, process and technology and creates a map of business operations to help you monitor change, measure impact, and make informed business decisions to help you reach your destination. Our cloud software makes use of open standards for integration with third party applications, enabling simple adoption into any company’s technology stack. + +## Prerequisites + +To start using this connector, you need to have an Mavim Cloud database and a Microsoft work account registered in Azure Active Directory (AAD) to be able to access. + +## How to get credentials + +In order to login you must have a Mavim database in de Mavim Cloud. The accounts added to the Mavim database needs to be known in the AAD. + +## Getting started with your connector + +This area is good for providing users with a step-by-step process for getting started with your connector. This is where you should highlight common use cases, such as your expected popular triggers and actions, and how they can help in automation scenarios. Include images where possible. + +## Deployment instructions +Please use [these instructions](https://docs.microsoft.com/en-us/connectors/custom-connectors/paconn-cli) to deploy this connector as custom connector in Microsoft Power Automate and Power Apps. \ No newline at end of file diff --git a/certified-connectors/Mavim iMprove/apiDefinition.swagger.json b/certified-connectors/Mavim iMprove/apiDefinition.swagger.json new file mode 100644 index 0000000000..967f53cc39 --- /dev/null +++ b/certified-connectors/Mavim iMprove/apiDefinition.swagger.json @@ -0,0 +1,4478 @@ +{ + "swagger": "2.0", + "info": { + "title": "Mavim-iMprove", + "description": "With the Mavim connector you are able to build a digital twin of your organization by visualizing the relationships among people, process and technology and creates a map of business operations to help you monitor change, measure impact, and make informed business decisions to help you reach your destination. Our cloud software makes use of open standards for integration with third party applications, enabling simple adoption into any company’s technology stack.", + "contact": { + "name": "Mavim servicedesk", + "url": "https://my.mavim.com", + "email": "servicedesk@mavim.com" + }, + "version": "1.0" + }, + "host": "api.mavimcloud.com", + "basePath": "/topic", + "schemes": [ + "https" + ], + "paths": { + "/v1/{dbId}/{dataLanguage}/topic/{topicId}/charts": { + "get": { + "tags": [ + "Chart" + ], + "summary": "Get the Charts of the topic", + "description": "From a specific topic requested with the topic id, a collection of charts is returned.", + "operationId": "GetTopicCharts", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dbId", + "description": "The Mavim database identifier.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Mavim database identifier." + }, + { + "in": "path", + "name": "dataLanguage", + "description": "The Topic language.", + "required": true, + "type": "string", + "enum": [ + "en", + "nl" + ], + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic language." + }, + { + "in": "path", + "name": "topicId", + "description": "The Topic identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic identifier." + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/IChart" + } + } + }, + "401": { + "description": "Unauthorized" + }, + "400": { + "description": "Bad Request" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Server Error" + } + } + } + }, + "/v1/{dbId}/{dataLanguage}/topic/{topicId}": { + "post": { + "tags": [ + "CreateTopics" + ], + "summary": "Create a new topic", + "description": "A new topic is created as a sibling after the referenced topic.", + "operationId": "CreateTopicAfter", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dbId", + "description": "The Mavim database identifier.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Mavim database identifier." + }, + { + "in": "path", + "name": "dataLanguage", + "description": "The Topic language.", + "required": true, + "type": "string", + "enum": [ + "en", + "nl" + ], + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic language." + }, + { + "in": "path", + "name": "topicId", + "description": "The Topic identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic identifier." + }, + { + "in": "body", + "name": "body", + "description": "The topic.", + "schema": { + "$ref": "#/definitions/CreateTopic" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ITopic" + } + }, + "401": { + "description": "Unauthorized" + }, + "400": { + "description": "Bad Request" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Server Error" + } + } + }, + "delete": { + "tags": [ + "DeleteTopics" + ], + "summary": "Delete a topic", + "description": "The specific topic requested by the topic id is deleted.", + "operationId": "DeleteTopic", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dbId", + "description": "The Mavim database identifier.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Mavim database identifier." + }, + { + "in": "path", + "name": "dataLanguage", + "description": "The Topic language.", + "required": true, + "type": "string", + "enum": [ + "en", + "nl" + ], + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic language." + }, + { + "in": "path", + "name": "topicId", + "description": "The Topic identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic identifier." + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ITopic" + } + }, + "401": { + "description": "Unauthorized" + }, + "400": { + "description": "Bad Request" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Server Error" + } + } + }, + "get": { + "tags": [ + "Topics" + ], + "summary": "Get Topic", + "description": "Get a specific topic by the DCV indentifier.", + "operationId": "GetTopic", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dbId", + "description": "The Mavim database identifier.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Mavim database identifier." + }, + { + "in": "path", + "name": "dataLanguage", + "description": "The Topic language.", + "required": true, + "type": "string", + "enum": [ + "en", + "nl" + ], + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic language." + }, + { + "in": "path", + "name": "topicId", + "description": "The Topic identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic identifier." + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ITopic" + } + }, + "401": { + "description": "Unauthorized" + }, + "400": { + "description": "Bad Request" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Server Error" + } + } + }, + "patch": { + "tags": [ + "Topics" + ], + "summary": "Updates the name of the topic", + "description": "Updates the name of a specific topic.", + "operationId": "UpdateTopic", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dbId", + "description": "The Mavim database identifier.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Mavim database identifier." + }, + { + "in": "path", + "name": "dataLanguage", + "description": "The Topic language.", + "required": true, + "type": "string", + "enum": [ + "en", + "nl" + ], + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic language." + }, + { + "in": "path", + "name": "topicId", + "description": "The Topic identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic identifier." + }, + { + "in": "body", + "name": "body", + "description": "The topic", + "schema": { + "$ref": "#/definitions/SaveTopic" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ITopic" + } + }, + "401": { + "description": "Unauthorized" + }, + "400": { + "description": "Bad Request" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Server Error" + } + } + } + }, + "/v1/{dbId}/{dataLanguage}/topic/{topicId}/children": { + "post": { + "tags": [ + "CreateTopics" + ], + "summary": "Create new child topic", + "description": "A new topic is created as a child of the referenced topic.", + "operationId": "CreateChildTopic", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dbId", + "description": "The Mavim database identifier.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Mavim database identifier." + }, + { + "in": "path", + "name": "dataLanguage", + "description": "The Topic language.", + "required": true, + "type": "string", + "enum": [ + "en", + "nl" + ], + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic language." + }, + { + "in": "path", + "name": "topicId", + "description": "The Topic identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic identifier." + }, + { + "in": "body", + "name": "body", + "description": "The topic.", + "schema": { + "$ref": "#/definitions/CreateTopic" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ITopic" + } + }, + "401": { + "description": "Unauthorized" + }, + "400": { + "description": "Bad Request" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Server Error" + } + } + }, + "get": { + "tags": [ + "Topics" + ], + "summary": "Get the children af a topic", + "description": "Get the children topics of the topic", + "operationId": "GetTopicChildren", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dbId", + "description": "The Mavim database identifier.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Mavim database identifier." + }, + { + "in": "path", + "name": "dataLanguage", + "description": "The Topic language.", + "required": true, + "type": "string", + "enum": [ + "en", + "nl" + ], + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic language." + }, + { + "in": "path", + "name": "topicId", + "description": "The Topic identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic identifier." + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/ITopic" + } + } + }, + "401": { + "description": "Unauthorized" + }, + "400": { + "description": "Bad Request" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Server Error" + } + } + } + }, + "/v1/{dbId}/{dataLanguage}/topic/{topicId}/fieldsets": { + "get": { + "tags": [ + "FieldSet" + ], + "summary": "Get the fields from topic", + "description": "From a specific topic requested with the topic id, a collection of fields is returned.", + "operationId": "GetTopicFields", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dbId", + "description": "The Mavim database identifier.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Mavim database identifier." + }, + { + "in": "path", + "name": "dataLanguage", + "description": "The Topic language.", + "required": true, + "type": "string", + "enum": [ + "en", + "nl" + ], + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic language." + }, + { + "in": "path", + "name": "topicId", + "description": "The topic identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The topic identifier." + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/IField" + } + } + }, + "401": { + "description": "Unauthorized" + }, + "400": { + "description": "Bad Request" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Server Error" + } + } + } + }, + "/v1/{dbId}/{dataLanguage}/topic/{topicId}/fieldsets/{fieldsetId}/{fieldId}": { + "get": { + "tags": [ + "FieldSet" + ], + "summary": "Get field from topic", + "description": "Get a specific field by field and fieldset identifier for a specific topic.", + "operationId": "GetFieldByDcvAndFieldsetId", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dbId", + "description": "The Mavim database identifier.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Mavim database identifier." + }, + { + "in": "path", + "name": "dataLanguage", + "description": "The Topic language.", + "required": true, + "type": "string", + "enum": [ + "en", + "nl" + ], + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic language." + }, + { + "in": "path", + "name": "topicId", + "description": "The topic identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The topic identifier." + }, + { + "in": "path", + "name": "fieldsetId", + "description": "The field set definition identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The field set definition identifier." + }, + { + "in": "path", + "name": "fieldId", + "description": "The field definition identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The field definition identifier." + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/IField" + } + }, + "401": { + "description": "Unauthorized" + }, + "400": { + "description": "Bad Request" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Server Error" + } + } + } + }, + "/v1/{dbId}/{dataLanguage}/topic/{topicId}/fieldsets/{fieldsetId}/bool/{fieldId}": { + "patch": { + "tags": [ + "FieldSet" + ], + "summary": "Update boolean field from topic", + "description": "Updates a specific boolean field by field and fieldset identifier for a specific topic.", + "operationId": "UpdateBooleanSingleField", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dbId", + "description": "The Mavim database identifier.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Mavim database identifier." + }, + { + "in": "path", + "name": "dataLanguage", + "description": "The Topic language.", + "required": true, + "type": "string", + "enum": [ + "en", + "nl" + ], + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic language." + }, + { + "in": "path", + "name": "topicId", + "description": "The topic identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The topic identifier." + }, + { + "in": "path", + "name": "fieldsetId", + "description": "The field set definition identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The field set definition identifier." + }, + { + "in": "path", + "name": "fieldId", + "description": "The field definition identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The field definition identifier." + }, + { + "in": "body", + "name": "body", + "description": "The field.", + "schema": { + "$ref": "#/definitions/SingleBooleanField" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/IField" + } + }, + "401": { + "description": "Unauthorized" + }, + "400": { + "description": "Bad Request" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Server Error" + } + } + } + }, + "/v1/{dbId}/{dataLanguage}/topic/{topicId}/fieldsets/{fieldsetId}/text/{fieldId}": { + "patch": { + "tags": [ + "FieldSet" + ], + "summary": "Update text field from topic", + "description": "Updates a specific single value text field by field and fieldset identifier for a specific topic.", + "operationId": "UpdateTextSingleField", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dbId", + "description": "The Mavim database identifier.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Mavim database identifier." + }, + { + "in": "path", + "name": "dataLanguage", + "description": "The Topic language.", + "required": true, + "type": "string", + "enum": [ + "en", + "nl" + ], + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic language." + }, + { + "in": "path", + "name": "topicId", + "description": "The topic identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The topic identifier." + }, + { + "in": "path", + "name": "fieldsetId", + "description": "The field set definition identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The field set definition identifier." + }, + { + "in": "path", + "name": "fieldId", + "description": "The field definition identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The field definition identifier." + }, + { + "in": "body", + "name": "body", + "description": "The field.", + "schema": { + "$ref": "#/definitions/SingleTextField" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/IField" + } + }, + "401": { + "description": "Unauthorized" + }, + "400": { + "description": "Bad Request" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Server Error" + } + } + } + }, + "/v1/{dbId}/{dataLanguage}/topic/{topicId}/fieldsets/{fieldsetId}/multitext/{fieldId}": { + "patch": { + "tags": [ + "FieldSet" + ], + "summary": "Update multi value text field from topic", + "description": "Updates a specific multi value text field by field and fieldset identifier for a specific topic.", + "operationId": "UpdateTextMultiField", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dbId", + "description": "The Mavim database identifier.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Mavim database identifier." + }, + { + "in": "path", + "name": "dataLanguage", + "description": "The Topic language.", + "required": true, + "type": "string", + "enum": [ + "en", + "nl" + ], + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic language." + }, + { + "in": "path", + "name": "topicId", + "description": "The topic identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The topic identifier." + }, + { + "in": "path", + "name": "fieldsetId", + "description": "The field set definition identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The field set definition identifier." + }, + { + "in": "path", + "name": "fieldId", + "description": "The field definition identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The field definition identifier." + }, + { + "in": "body", + "name": "body", + "description": "The field.", + "schema": { + "$ref": "#/definitions/MultiTextField" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/IField" + } + }, + "401": { + "description": "Unauthorized" + }, + "400": { + "description": "Bad Request" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Server Error" + } + } + } + }, + "/v1/{dbId}/{dataLanguage}/topic/{topicId}/fieldsets/{fieldsetId}/number/{fieldId}": { + "patch": { + "tags": [ + "FieldSet" + ], + "summary": "Update number field from topic", + "description": "Updates a specific single value number field by field and fieldset identifier for a specific topic.", + "operationId": "UpdateNumberSingleField", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dbId", + "description": "The Mavim database identifier.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Mavim database identifier." + }, + { + "in": "path", + "name": "dataLanguage", + "description": "The Topic language.", + "required": true, + "type": "string", + "enum": [ + "en", + "nl" + ], + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic language." + }, + { + "in": "path", + "name": "topicId", + "description": "The topic identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The topic identifier." + }, + { + "in": "path", + "name": "fieldsetId", + "description": "The field set definition identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The field set definition identifier." + }, + { + "in": "path", + "name": "fieldId", + "description": "The field definition identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The field definition identifier." + }, + { + "in": "body", + "name": "body", + "description": "The field.", + "schema": { + "$ref": "#/definitions/SingleNumberField" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/IField" + } + }, + "401": { + "description": "Unauthorized" + }, + "400": { + "description": "Bad Request" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Server Error" + } + } + } + }, + "/v1/{dbId}/{dataLanguage}/topic/{topicId}/fieldsets/{fieldsetId}/multinumber/{fieldId}": { + "patch": { + "tags": [ + "FieldSet" + ], + "summary": "Update multivalue number field from topic", + "description": "Updates a specific boolean field by field and fieldset identifier for a specific topic.", + "operationId": "UpdateNumberMultiField", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dbId", + "description": "The Mavim database identifier.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Mavim database identifier." + }, + { + "in": "path", + "name": "dataLanguage", + "description": "The Topic language.", + "required": true, + "type": "string", + "enum": [ + "en", + "nl" + ], + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic language." + }, + { + "in": "path", + "name": "topicId", + "description": "The topic identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The topic identifier." + }, + { + "in": "path", + "name": "fieldsetId", + "description": "The field set definition identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The field set definition identifier." + }, + { + "in": "path", + "name": "fieldId", + "description": "The field definition identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The field definition identifier." + }, + { + "in": "body", + "name": "body", + "description": "The field.", + "schema": { + "$ref": "#/definitions/MultiNumberField" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/IField" + } + }, + "401": { + "description": "Unauthorized" + }, + "400": { + "description": "Bad Request" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Server Error" + } + } + } + }, + "/v1/{dbId}/{dataLanguage}/topic/{topicId}/fieldsets/{fieldsetId}/decimal/{fieldId}": { + "patch": { + "tags": [ + "FieldSet" + ], + "summary": "Update decimal field from topic", + "description": "Updates a specific single value decimal field by field and fieldset identifier for a specific topic.", + "operationId": "UpdateDecimalSingleField", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dbId", + "description": "The Mavim database identifier.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Mavim database identifier." + }, + { + "in": "path", + "name": "dataLanguage", + "description": "The Topic language.", + "required": true, + "type": "string", + "enum": [ + "en", + "nl" + ], + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic language." + }, + { + "in": "path", + "name": "topicId", + "description": "The topic identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The topic identifier." + }, + { + "in": "path", + "name": "fieldsetId", + "description": "The field set definition identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The field set definition identifier." + }, + { + "in": "path", + "name": "fieldId", + "description": "The field definition identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The field definition identifier." + }, + { + "in": "body", + "name": "body", + "description": "The field.", + "schema": { + "$ref": "#/definitions/SingleDecimalField" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/IField" + } + }, + "401": { + "description": "Unauthorized" + }, + "400": { + "description": "Bad Request" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Server Error" + } + } + } + }, + "/v1/{dbId}/{dataLanguage}/topic/{topicId}/fieldsets/{fieldsetId}/multidecimal/{fieldId}": { + "patch": { + "tags": [ + "FieldSet" + ], + "summary": "Update multi value decimal field from topic", + "description": "Updates a specific multi value decimal field by field and fieldset identifier for a specific topic.", + "operationId": "UpdateDecimalMultiField", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dbId", + "description": "The Mavim database identifier.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Mavim database identifier." + }, + { + "in": "path", + "name": "dataLanguage", + "description": "The Topic language.", + "required": true, + "type": "string", + "enum": [ + "en", + "nl" + ], + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic language." + }, + { + "in": "path", + "name": "topicId", + "description": "The topic identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The topic identifier." + }, + { + "in": "path", + "name": "fieldsetId", + "description": "The field set definition identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The field set definition identifier." + }, + { + "in": "path", + "name": "fieldId", + "description": "The field definition identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The field definition identifier." + }, + { + "in": "body", + "name": "body", + "description": "The field.", + "schema": { + "$ref": "#/definitions/MultiDecimalField" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/IField" + } + }, + "401": { + "description": "Unauthorized" + }, + "400": { + "description": "Bad Request" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Server Error" + } + } + } + }, + "/v1/{dbId}/{dataLanguage}/topic/{topicId}/fieldsets/{fieldsetId}/date/{fieldId}": { + "patch": { + "tags": [ + "FieldSet" + ], + "summary": "Update date field from topic", + "description": "Updates a specific single value date field by field and fieldset identifier for a specific topic.", + "operationId": "UpdateDateSingleField", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dbId", + "description": "The Mavim database identifier.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Mavim database identifier." + }, + { + "in": "path", + "name": "dataLanguage", + "description": "The Topic language.", + "required": true, + "type": "string", + "enum": [ + "en", + "nl" + ], + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic language." + }, + { + "in": "path", + "name": "topicId", + "description": "The topic identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The topic identifier." + }, + { + "in": "path", + "name": "fieldsetId", + "description": "The field set definition identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The field set definition identifier." + }, + { + "in": "path", + "name": "fieldId", + "description": "The field definition identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The field definition identifier." + }, + { + "in": "body", + "name": "body", + "description": "The field.", + "schema": { + "$ref": "#/definitions/SingleDateField" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/IField" + } + }, + "401": { + "description": "Unauthorized" + }, + "400": { + "description": "Bad Request" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Server Error" + } + } + } + }, + "/v1/{dbId}/{dataLanguage}/topic/{topicId}/fieldsets/{fieldsetId}/multidate/{fieldId}": { + "patch": { + "tags": [ + "FieldSet" + ], + "summary": "Update multi value date field from topic", + "description": "Updates a specific multi value date field by field and fieldset identifier for a specific topic.", + "operationId": "UpdateDateMultiField", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dbId", + "description": "The Mavim database identifier.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Mavim database identifier." + }, + { + "in": "path", + "name": "dataLanguage", + "description": "The Topic language.", + "required": true, + "type": "string", + "enum": [ + "en", + "nl" + ], + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic language." + }, + { + "in": "path", + "name": "topicId", + "description": "The topic identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The topic identifier." + }, + { + "in": "path", + "name": "fieldsetId", + "description": "The field set definition identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The field set definition identifier." + }, + { + "in": "path", + "name": "fieldId", + "description": "The field definition identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The field definition identifier." + }, + { + "in": "body", + "name": "body", + "description": "The field.", + "schema": { + "$ref": "#/definitions/MultiDateField" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/IField" + } + }, + "401": { + "description": "Unauthorized" + }, + "400": { + "description": "Bad Request" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Server Error" + } + } + } + }, + "/v1/{dbId}/{dataLanguage}/topic/{topicId}/fieldsets/{fieldsetId}/list/{fieldId}": { + "patch": { + "tags": [ + "FieldSet" + ], + "summary": "Update list field from topic", + "description": "Updates a specific list field by field and fieldset identifier for a specific topic.", + "operationId": "UpdateListSingleField", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dbId", + "description": "The Mavim database identifier.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Mavim database identifier." + }, + { + "in": "path", + "name": "dataLanguage", + "description": "The Topic language.", + "required": true, + "type": "string", + "enum": [ + "en", + "nl" + ], + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic language." + }, + { + "in": "path", + "name": "topicId", + "description": "The topic identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The topic identifier." + }, + { + "in": "path", + "name": "fieldsetId", + "description": "The field set definition identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The field set definition identifier." + }, + { + "in": "path", + "name": "fieldId", + "description": "The field definition identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The field definition identifier." + }, + { + "in": "body", + "name": "body", + "description": "The field.", + "schema": { + "$ref": "#/definitions/SingleListField" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/IField" + } + }, + "401": { + "description": "Unauthorized" + }, + "400": { + "description": "Bad Request" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Server Error" + } + } + } + }, + "/v1/{dbId}/{dataLanguage}/topic/{topicId}/fieldsets/{fieldsetId}/relationship/{fieldId}": { + "patch": { + "tags": [ + "FieldSet" + ], + "summary": "Update relationship field from topic", + "description": "Updates a specific single value relationship field by field and fieldset identifier for a specific topic.", + "operationId": "UpdateRelationshipSingleField", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dbId", + "description": "The Mavim database identifier.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Mavim database identifier." + }, + { + "in": "path", + "name": "dataLanguage", + "description": "The Topic language.", + "required": true, + "type": "string", + "enum": [ + "en", + "nl" + ], + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic language." + }, + { + "in": "path", + "name": "topicId", + "description": "The topic identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The topic identifier." + }, + { + "in": "path", + "name": "fieldsetId", + "description": "The field set definition identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The field set definition identifier." + }, + { + "in": "path", + "name": "fieldId", + "description": "The field definition identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The field definition identifier." + }, + { + "in": "body", + "name": "body", + "description": "The field.", + "schema": { + "$ref": "#/definitions/RelationshipField" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/IField" + } + }, + "401": { + "description": "Unauthorized" + }, + "400": { + "description": "Bad Request" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Server Error" + } + } + } + }, + "/v1/{dbId}/{dataLanguage}/topic/{topicId}/fieldsets/{fieldsetId}/multirelationship/{fieldId}": { + "patch": { + "tags": [ + "FieldSet" + ], + "summary": "Update multi value relationship field from topic", + "description": "Updates a specific multi value relationship field by field and fieldset identifier for a specific topic.", + "operationId": "UpdateRelationshipMultiField", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dbId", + "description": "The Mavim database identifier.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Mavim database identifier." + }, + { + "in": "path", + "name": "dataLanguage", + "description": "The Topic language.", + "required": true, + "type": "string", + "enum": [ + "en", + "nl" + ], + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic language." + }, + { + "in": "path", + "name": "topicId", + "description": "The topic identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The topic identifier." + }, + { + "in": "path", + "name": "fieldsetId", + "description": "The field set definition identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The field set definition identifier." + }, + { + "in": "path", + "name": "fieldId", + "description": "The field definition identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The field definition identifier." + }, + { + "in": "body", + "name": "body", + "description": "The field.", + "schema": { + "$ref": "#/definitions/MultiRelationshipField" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/IField" + } + }, + "401": { + "description": "Unauthorized" + }, + "400": { + "description": "Bad Request" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Server Error" + } + } + } + }, + "/v1/{dbId}/{dataLanguage}/topic/{topicId}/fieldsets/{fieldsetId}/relationshiplist/{fieldId}": { + "patch": { + "tags": [ + "FieldSet" + ], + "summary": "Update relationshiplist field from topic", + "description": "Updates a specific single value relationshiplist field by field and fieldset identifier for a specific topic.", + "operationId": "UpdateRelationshipListField", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dbId", + "description": "The Mavim database identifier.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Mavim database identifier." + }, + { + "in": "path", + "name": "dataLanguage", + "description": "The Topic language.", + "required": true, + "type": "string", + "enum": [ + "en", + "nl" + ], + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic language." + }, + { + "in": "path", + "name": "topicId", + "description": "The topic identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The topic identifier." + }, + { + "in": "path", + "name": "fieldsetId", + "description": "The field set definition identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The field set definition identifier." + }, + { + "in": "path", + "name": "fieldId", + "description": "The field definition identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The field definition identifier." + }, + { + "in": "body", + "name": "body", + "description": "The field.", + "schema": { + "$ref": "#/definitions/RelationshipListField" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/IField" + } + }, + "401": { + "description": "Unauthorized" + }, + "400": { + "description": "Bad Request" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Server Error" + } + } + } + }, + "/v1/{dbId}/{dataLanguage}/topic/{topicId}/fields": { + "patch": { + "tags": [ + "FieldSet" + ], + "summary": "Updates the fields from topic", + "description": "Updates multiple types of fields for a specific topic.", + "operationId": "UpdateFields", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dbId", + "description": "The Mavim database identifier.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Mavim database identifier." + }, + { + "in": "path", + "name": "dataLanguage", + "description": "The Topic language.", + "required": true, + "type": "string", + "enum": [ + "en", + "nl" + ], + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic language." + }, + { + "in": "path", + "name": "topicId", + "description": "The topic identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The topic identifier." + }, + { + "in": "body", + "name": "body", + "description": "The fields.", + "schema": { + "$ref": "#/definitions/Fields" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/IField" + } + }, + "401": { + "description": "Unauthorized" + }, + "400": { + "description": "Bad Request" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Server Error" + } + } + } + }, + "/v1/{dbId}/{dataLanguage}/topic/{topicId}/fieldsets/{fieldsetId}/hyperlink/{fieldId}": { + "patch": { + "tags": [ + "FieldSet" + ], + "summary": "Updates a singlevalue hyperlink field", + "description": "Updates a single value hyperlink field for a specific topic.", + "operationId": "UpdateSingleHyperlinkField", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dbId", + "description": "The Mavim database identifier.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Mavim database identifier." + }, + { + "in": "path", + "name": "dataLanguage", + "description": "The Topic language.", + "required": true, + "type": "string", + "enum": [ + "en", + "nl" + ], + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic language." + }, + { + "in": "path", + "name": "topicId", + "description": "The topic identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The topic identifier." + }, + { + "in": "path", + "name": "fieldsetId", + "description": "The fieldset identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The fieldset identifier." + }, + { + "in": "path", + "name": "fieldId", + "description": "The field identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The field identifier." + }, + { + "in": "body", + "name": "body", + "description": "The field.", + "schema": { + "$ref": "#/definitions/PatchHyperlinkField" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/IField" + } + }, + "401": { + "description": "Unauthorized" + }, + "400": { + "description": "Bad Request" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Server Error" + } + } + } + }, + "/v1/{dbId}/{dataLanguage}/topic/{topicId}/fieldsets/{fieldsetId}/multihyperlink/{fieldId}": { + "patch": { + "tags": [ + "FieldSet" + ], + "summary": "Updates a multivalue hyperlink field", + "description": "Updates a multi value hyperlink field for a specific topic.", + "operationId": "UpdateMultiHyperlinkField", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dbId", + "description": "The Mavim database identifier.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Mavim database identifier." + }, + { + "in": "path", + "name": "dataLanguage", + "description": "The Topic language.", + "required": true, + "type": "string", + "enum": [ + "en", + "nl" + ], + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic language." + }, + { + "in": "path", + "name": "topicId", + "description": "The topic identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The topic identifier." + }, + { + "in": "path", + "name": "fieldsetId", + "description": "The fieldset identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The fieldset identifier." + }, + { + "in": "path", + "name": "fieldId", + "description": "The field identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The field identifier." + }, + { + "in": "body", + "name": "body", + "description": "The field.", + "schema": { + "$ref": "#/definitions/PatchMultiHyperlinkField" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/IField" + } + }, + "401": { + "description": "Unauthorized" + }, + "400": { + "description": "Bad Request" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Server Error" + } + } + } + }, + "/v1/{dbId}/{dataLanguage}/topic/{topicId}/movetotop": { + "patch": { + "tags": [ + "MoveTopics" + ], + "summary": "Move a topic to the top of the branch", + "description": "Move a specific topic to the top of the branch.", + "operationId": "MoveTopicToTop", + "parameters": [ + { + "in": "path", + "name": "dbId", + "description": "The Mavim database identifier.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Mavim database identifier." + }, + { + "in": "path", + "name": "dataLanguage", + "description": "The Topic language.", + "required": true, + "type": "string", + "enum": [ + "en", + "nl" + ], + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic language." + }, + { + "in": "path", + "name": "topicId", + "description": "The Topic identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic identifier." + } + ], + "responses": { + "200": { + "description": "Success" + }, + "401": { + "description": "Unauthorized" + }, + "400": { + "description": "Bad Request" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Server Error" + } + } + } + }, + "/v1/{dbId}/{dataLanguage}/topic/{topicId}/movetobottom": { + "patch": { + "tags": [ + "MoveTopics" + ], + "summary": "Move a topic to the bottom of the branch", + "description": "Move a specific topic to the bottom of the branch.", + "operationId": "MoveTopicToBottom", + "parameters": [ + { + "in": "path", + "name": "dbId", + "description": "The Mavim database identifier.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Mavim database identifier." + }, + { + "in": "path", + "name": "dataLanguage", + "description": "The Topic language.", + "required": true, + "type": "string", + "enum": [ + "en", + "nl" + ], + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic language." + }, + { + "in": "path", + "name": "topicId", + "description": "The Topic identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic identifier." + } + ], + "responses": { + "200": { + "description": "Success" + }, + "401": { + "description": "Unauthorized" + }, + "400": { + "description": "Bad Request" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Server Error" + } + } + } + }, + "/v1/{dbId}/{dataLanguage}/topic/{topicId}/moveup": { + "patch": { + "tags": [ + "MoveTopics" + ], + "summary": "Move a topic up in the branch", + "description": "Move a specific topic one place up in the branch.", + "operationId": "MoveTopicUp", + "parameters": [ + { + "in": "path", + "name": "dbId", + "description": "The Mavim database identifier.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Mavim database identifier." + }, + { + "in": "path", + "name": "dataLanguage", + "description": "The Topic language.", + "required": true, + "type": "string", + "enum": [ + "en", + "nl" + ], + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic language." + }, + { + "in": "path", + "name": "topicId", + "description": "The Topic identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic identifier." + } + ], + "responses": { + "200": { + "description": "Success" + }, + "401": { + "description": "Unauthorized" + }, + "400": { + "description": "Bad Request" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Server Error" + } + } + } + }, + "/v1/{dbId}/{dataLanguage}/topic/{topicId}/movedown": { + "patch": { + "tags": [ + "MoveTopics" + ], + "summary": "Move a topic down in the branch", + "description": "Move a specific topic one place down in the branch.", + "operationId": "MoveTopicDown", + "parameters": [ + { + "in": "path", + "name": "dbId", + "description": "The Mavim database identifier.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Mavim database identifier." + }, + { + "in": "path", + "name": "dataLanguage", + "description": "The Topic language.", + "required": true, + "type": "string", + "enum": [ + "en", + "nl" + ], + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic language." + }, + { + "in": "path", + "name": "topicId", + "description": "The Topic identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic identifier." + } + ], + "responses": { + "200": { + "description": "Success" + }, + "401": { + "description": "Unauthorized" + }, + "400": { + "description": "Bad Request" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Server Error" + } + } + } + }, + "/v1/{dbId}/{dataLanguage}/topic/{topicId}/movelevelup": { + "patch": { + "tags": [ + "MoveTopics" + ], + "summary": "Move a topic up in the branch", + "description": "Move a specific topic one place up in the branch.", + "operationId": "MoveTopicLevelUp", + "parameters": [ + { + "in": "path", + "name": "dbId", + "description": "The Mavim database identifier.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Mavim database identifier." + }, + { + "in": "path", + "name": "dataLanguage", + "description": "The Topic language.", + "required": true, + "type": "string", + "enum": [ + "en", + "nl" + ], + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic language." + }, + { + "in": "path", + "name": "topicId", + "description": "The Topic identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic identifier." + } + ], + "responses": { + "200": { + "description": "Success" + }, + "401": { + "description": "Unauthorized" + }, + "400": { + "description": "Bad Request" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Server Error" + } + } + } + }, + "/v1/{dbId}/{dataLanguage}/topic/{topicId}/moveleveldown": { + "patch": { + "tags": [ + "MoveTopics" + ], + "summary": "Move a topic down in the branch", + "description": "Move a specific topic one place down in the branch.", + "operationId": "MoveTopicLevelDown", + "parameters": [ + { + "in": "path", + "name": "dbId", + "description": "The Mavim database identifier.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Mavim database identifier." + }, + { + "in": "path", + "name": "dataLanguage", + "description": "The Topic language.", + "required": true, + "type": "string", + "enum": [ + "en", + "nl" + ], + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic language." + }, + { + "in": "path", + "name": "topicId", + "description": "The Topic identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic identifier." + } + ], + "responses": { + "200": { + "description": "Success" + }, + "401": { + "description": "Unauthorized" + }, + "400": { + "description": "Bad Request" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Server Error" + } + } + } + }, + "/v1/{dbId}/{dataLanguage}/topic/{topicId}/relations": { + "get": { + "tags": [ + "Relationships" + ], + "summary": "Get the Relations of the topic", + "description": "Get the Relations of the topic supplied by topic DCV ID.", + "operationId": "GetTopicRelations", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dbId", + "description": "The Mavim database identifier.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Mavim database identifier." + }, + { + "in": "path", + "name": "dataLanguage", + "description": "The Topic language.", + "required": true, + "type": "string", + "enum": [ + "en", + "nl" + ], + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic language." + }, + { + "in": "path", + "name": "topicId", + "description": "The Topic identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic identifier." + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/IRelationship" + } + } + }, + "401": { + "description": "Unauthorized" + }, + "400": { + "description": "Bad Request" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Server Error" + } + } + } + }, + "/v1/{dbId}/{dataLanguage}/relation": { + "post": { + "tags": [ + "Relationships" + ], + "summary": "Create relation", + "description": "Creates a relation between two topics.", + "operationId": "SaveRelation", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dbId", + "description": "The Mavim database identifier.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Mavim database identifier." + }, + { + "in": "path", + "name": "dataLanguage", + "description": "The Topic language.", + "required": true, + "type": "string", + "enum": [ + "en", + "nl" + ], + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic language." + }, + { + "in": "body", + "name": "body", + "description": "The relation.", + "schema": { + "$ref": "#/definitions/SaveRelationship" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/IRelationship" + } + }, + "401": { + "description": "Unauthorized" + }, + "400": { + "description": "Bad Request" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Server Error" + } + } + } + }, + "/v1/{dbId}/{dataLanguage}/topic/{topicId}/relation/{relationId}": { + "delete": { + "tags": [ + "Relationships" + ], + "summary": "Delete relation from topic", + "description": "Deletes the relation by topic id and relationId.", + "operationId": "DeleteRelation", + "parameters": [ + { + "in": "path", + "name": "dbId", + "description": "The Mavim database identifier.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Mavim database identifier." + }, + { + "in": "path", + "name": "dataLanguage", + "description": "The Topic language.", + "required": true, + "type": "string", + "enum": [ + "en", + "nl" + ], + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic language." + }, + { + "in": "path", + "name": "topicId", + "description": "The Topic identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic identifier." + }, + { + "in": "path", + "name": "relationId", + "description": "The relation identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The relation identifier." + } + ], + "responses": { + "200": { + "description": "Success" + }, + "401": { + "description": "Unauthorized" + }, + "400": { + "description": "Bad Request" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Server Error" + } + } + } + }, + "/v1/{dbId}/{dataLanguage}/root": { + "get": { + "tags": [ + "Topics" + ], + "summary": "Get the root topic", + "description": "Get the root topic.", + "operationId": "GetTopicRoot", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dbId", + "description": "The Mavim database identifier.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Mavim database identifier." + }, + { + "in": "path", + "name": "dataLanguage", + "description": "The Topic language.", + "required": true, + "type": "string", + "enum": [ + "en", + "nl" + ], + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic language." + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ITopic" + } + }, + "401": { + "description": "Unauthorized" + }, + "400": { + "description": "Bad Request" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Server Error" + } + } + } + }, + "/v1/{dbId}/{dataLanguage}/path/{topicId}": { + "get": { + "tags": [ + "Topics" + ], + "summary": "Get the path of the supplied topic id to the root", + "description": "Get the all topics in the path to the root topic.", + "operationId": "GetPathToRoot", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dbId", + "description": "The Mavim database identifier.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Mavim database identifier." + }, + { + "in": "path", + "name": "dataLanguage", + "description": "The Topic language.", + "required": true, + "type": "string", + "enum": [ + "en", + "nl" + ], + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic language." + }, + { + "in": "path", + "name": "topicId", + "description": "The Topic identifier.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic identifier." + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ITopicPath" + } + }, + "401": { + "description": "Unauthorized" + }, + "400": { + "description": "Bad Request" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Server Error" + } + } + } + }, + "/v1/{dbId}/{dataLanguage}/topic/{topicId}/siblings": { + "get": { + "tags": [ + "Topics" + ], + "summary": "Get the sibling topics of the topic", + "description": "Get the siblings topics of the topic supplied by the topic id.", + "operationId": "GetTopicSiblings", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dbId", + "description": "The Mavim database identifier.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Mavim database identifier." + }, + { + "in": "path", + "name": "dataLanguage", + "description": "The Topic language.", + "required": true, + "type": "string", + "enum": [ + "en", + "nl" + ], + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic language." + }, + { + "in": "path", + "name": "topicId", + "description": "The DCV identifie.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The DCV identifie." + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/ITopic" + } + } + }, + "401": { + "description": "Unauthorized" + }, + "400": { + "description": "Bad Request" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Server Error" + } + } + } + }, + "/v1/{dbId}/{dataLanguage}/topic/categories": { + "get": { + "tags": [ + "Topics" + ], + "summary": "Get a collection of topics", + "description": "Get the relationship categories of the topic", + "operationId": "GetRelationCategories", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dbId", + "description": "The Mavim database identifier.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Mavim database identifier." + }, + { + "in": "path", + "name": "dataLanguage", + "description": "The Topic language.", + "required": true, + "type": "string", + "enum": [ + "en", + "nl" + ], + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic language." + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/ITopic" + } + } + }, + "401": { + "description": "Unauthorized" + }, + "400": { + "description": "Bad Request" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Server Error" + } + } + } + }, + "/v1/{dbId}/{dataLanguage}/topic/{topicId}/types": { + "get": { + "tags": [ + "TopicsMeta" + ], + "summary": "Get types for a topic", + "description": "Get a collection of types for an specific topic supplied by the topic id.", + "operationId": "GetTopicTypes", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dbId", + "description": "The Mavim database identifier.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Mavim database identifier." + }, + { + "in": "path", + "name": "dataLanguage", + "description": "The Topic language.", + "required": true, + "type": "string", + "enum": [ + "en", + "nl" + ], + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic language." + }, + { + "in": "path", + "name": "topicId", + "description": "The DCV identifie.", + "required": true, + "type": "string", + "pattern": "^d\\d{1,8}c\\d{1,8}v\\d{1,8}$", + "x-ms-url-encoding": "single", + "x-ms-summary": "The DCV identifie." + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ElementTypeInfo" + } + } + }, + "401": { + "description": "Unauthorized" + }, + "400": { + "description": "Bad Request" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Server Error" + } + } + } + }, + "/v1/{dbId}/{dataLanguage}/types/{topicType}/icons": { + "get": { + "tags": [ + "TopicsMeta" + ], + "summary": "Get availible icons for a topic type", + "description": "Get a collection of icons for a specific topic type.", + "operationId": "GetTopicIcons", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "dbId", + "description": "The Mavim database identifier.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Mavim database identifier." + }, + { + "in": "path", + "name": "dataLanguage", + "description": "The Topic language.", + "required": true, + "type": "string", + "enum": [ + "en", + "nl" + ], + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic language." + }, + { + "in": "path", + "name": "topicType", + "description": "The Topic type.", + "required": true, + "type": "string", + "x-ms-url-encoding": "single", + "x-ms-summary": "The Topic type." + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "401": { + "description": "Unauthorized" + }, + "400": { + "description": "Bad Request" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Server Error" + } + } + } + }, + "/v1/version": { + "get": { + "tags": [ + "Version" + ], + "summary": "Get API version", + "description": "Retrieve the API version number.", + "operationId": "Version", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "type": "string" + } + }, + "401": { + "description": "Unauthorized" + }, + "400": { + "description": "Bad Request" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Server Error" + } + } + } + } + }, + "definitions": { + "CategoryType": { + "enum": [ + "Unknown", + "With", + "Goto", + "From", + "Who", + "When", + "Where", + "Why", + "HypTo", + "HypFrom", + "Chart", + "Matrix", + "Report" + ], + "type": "string" + }, + "CreateTopic": { + "required": [ + "icon", + "name", + "type" + ], + "type": "object", + "properties": { + "name": { + "description": "Gets or sets the name", + "type": "string" + }, + "type": { + "description": "Gets or sets the type", + "type": "string" + }, + "icon": { + "description": "Gets or sets the icon", + "type": "string" + } + } + }, + "DataLanguages": { + "enum": [ + "en", + "nl" + ], + "type": "string" + }, + "ElementTypeInfo": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "isSystemName": { + "type": "boolean" + }, + "resourceId": { + "type": "string" + } + } + }, + "Fields": { + "type": "object", + "properties": { + "singleTextFields": { + "type": "array", + "items": { + "$ref": "#/definitions/SingleTextField" + } + }, + "multiTextFields": { + "type": "array", + "items": { + "$ref": "#/definitions/MultiTextField" + } + }, + "singleNumberFields": { + "type": "array", + "items": { + "$ref": "#/definitions/SingleNumberField" + } + }, + "multiNumberFields": { + "type": "array", + "items": { + "$ref": "#/definitions/MultiNumberField" + } + }, + "singleBooleanFields": { + "type": "array", + "items": { + "$ref": "#/definitions/SingleBooleanField" + } + }, + "singleDecimalFields": { + "type": "array", + "items": { + "$ref": "#/definitions/SingleDecimalField" + } + }, + "multiDecimalFields": { + "type": "array", + "items": { + "$ref": "#/definitions/MultiDecimalField" + } + }, + "singleDateFields": { + "type": "array", + "items": { + "$ref": "#/definitions/SingleDateField" + } + }, + "multiDateFields": { + "type": "array", + "items": { + "$ref": "#/definitions/MultiDateField" + } + }, + "singleListFields": { + "type": "array", + "items": { + "$ref": "#/definitions/SingleListField" + } + }, + "singleRelationshipFields": { + "type": "array", + "items": { + "$ref": "#/definitions/RelationshipField" + } + }, + "multiRelationshipFields": { + "type": "array", + "items": { + "$ref": "#/definitions/MultiRelationshipField" + } + }, + "singleRelationshipListFields": { + "type": "array", + "items": { + "$ref": "#/definitions/RelationshipListField" + } + }, + "singleHyperlinkFields": { + "type": "array", + "items": { + "$ref": "#/definitions/SingleHyperlinkField" + } + }, + "multiHyperlinkFields": { + "type": "array", + "items": { + "$ref": "#/definitions/MultiHyperlinkField" + } + } + } + }, + "FieldType": { + "enum": [ + "Unknown", + "Text", + "MultiText", + "Number", + "MultiNumber", + "Decimal", + "MultiDecimal", + "Boolean", + "Date", + "MultiDate", + "List", + "Relationship", + "MultiRelationship", + "RelationshipList", + "Hyperlink", + "MultiHyperlink" + ], + "type": "string" + }, + "IChart": { + "type": "object", + "properties": { + "dcv": { + "type": "string" + }, + "name": { + "type": "string" + } + } + }, + "IField": { + "type": "object", + "properties": { + "fieldsetId": { + "type": "string" + }, + "fieldId": { + "type": "string" + }, + "setOrder": { + "format": "int32", + "type": "integer" + }, + "order": { + "format": "int32", + "type": "integer" + }, + "setName": { + "type": "string" + }, + "fieldName": { + "type": "string" + }, + "topicId": { + "type": "string" + }, + "fieldValueType": { + "$ref": "#/definitions/FieldType" + }, + "required": { + "type": "boolean" + }, + "readonly": { + "type": "boolean" + }, + "usage": { + "type": "string" + }, + "relationshipCategory": { + "$ref": "#/definitions/IRelationshipElement" + }, + "characteristic": { + "$ref": "#/definitions/IRelationshipElement" + }, + "openLocation": { + "type": "string" + } + } + }, + "IPathItem": { + "type": "object", + "properties": { + "order": { + "format": "int32", + "type": "integer" + }, + "dcvId": { + "type": "string" + } + } + }, + "IRelationship": { + "type": "object", + "properties": { + "dcv": { + "type": "string" + }, + "isTypeOfTopic": { + "type": "boolean" + }, + "category": { + "type": "string" + }, + "categoryType": { + "$ref": "#/definitions/CategoryType" + }, + "relationshipType": { + "$ref": "#/definitions/RelationshipType" + }, + "icon": { + "type": "string" + }, + "userInstruction": { + "$ref": "#/definitions/IRelationshipElement" + }, + "dispatchInstructions": { + "type": "array", + "items": { + "$ref": "#/definitions/ISimpleDispatchInstruction" + } + }, + "characteristic": { + "$ref": "#/definitions/IRelationshipElement" + }, + "withElement": { + "$ref": "#/definitions/IRelationshipElement" + }, + "withElementParent": { + "$ref": "#/definitions/IRelationshipElement" + } + } + }, + "IRelationshipElement": { + "type": "object", + "properties": { + "dcv": { + "type": "string" + }, + "name": { + "type": "string" + }, + "icon": { + "type": "string" + } + } + }, + "ISimpleDispatchInstruction": { + "type": "object", + "properties": { + "typeName": { + "type": "string", + "readOnly": true + }, + "dcv": { + "type": "string" + }, + "name": { + "type": "string" + }, + "icon": { + "type": "string" + } + } + }, + "ITopic": { + "type": "object", + "properties": { + "dcv": { + "type": "string" + }, + "parent": { + "type": "string" + }, + "hasChildren": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "typeCategory": { + "$ref": "#/definitions/TopicType" + }, + "icon": { + "type": "string" + }, + "orderNumber": { + "format": "int32", + "type": "integer" + }, + "resources": { + "type": "array", + "items": { + "$ref": "#/definitions/TopicResource" + } + }, + "isInRecycleBin": { + "type": "boolean" + }, + "business": { + "$ref": "#/definitions/ITopicBusiness" + } + } + }, + "ITopicBusiness": { + "type": "object", + "properties": { + "isReadOnly": { + "type": "boolean" + }, + "canDelete": { + "type": "boolean" + }, + "canCreateChildTopic": { + "type": "boolean" + }, + "canCreateTopicAfter": { + "type": "boolean" + } + } + }, + "ITopicPath": { + "type": "object", + "properties": { + "path": { + "type": "array", + "items": { + "$ref": "#/definitions/IPathItem" + } + }, + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/ITopic" + } + } + } + }, + "MultiDateField": { + "type": "object", + "properties": { + "fieldsetId": { + "type": "string" + }, + "fieldId": { + "type": "string" + }, + "setOrder": { + "format": "int32", + "type": "integer" + }, + "order": { + "format": "int32", + "type": "integer" + }, + "topicId": { + "type": "string" + }, + "setName": { + "type": "string" + }, + "fieldName": { + "type": "string" + }, + "fieldValueType": { + "$ref": "#/definitions/FieldType" + }, + "required": { + "type": "boolean" + }, + "readonly": { + "type": "boolean" + }, + "usage": { + "type": "string" + }, + "relationshipCategory": { + "$ref": "#/definitions/IRelationshipElement" + }, + "characteristic": { + "$ref": "#/definitions/IRelationshipElement" + }, + "openLocation": { + "type": "string" + }, + "data": { + "type": "array", + "items": { + "format": "date-time", + "type": "string" + } + } + } + }, + "MultiDecimalField": { + "type": "object", + "properties": { + "fieldsetId": { + "type": "string" + }, + "fieldId": { + "type": "string" + }, + "setOrder": { + "format": "int32", + "type": "integer" + }, + "order": { + "format": "int32", + "type": "integer" + }, + "topicId": { + "type": "string" + }, + "setName": { + "type": "string" + }, + "fieldName": { + "type": "string" + }, + "fieldValueType": { + "$ref": "#/definitions/FieldType" + }, + "required": { + "type": "boolean" + }, + "readonly": { + "type": "boolean" + }, + "usage": { + "type": "string" + }, + "relationshipCategory": { + "$ref": "#/definitions/IRelationshipElement" + }, + "characteristic": { + "$ref": "#/definitions/IRelationshipElement" + }, + "openLocation": { + "type": "string" + }, + "data": { + "type": "array", + "items": { + "format": "double", + "type": "number" + } + } + } + }, + "MultiHyperlinkField": { + "type": "object", + "properties": { + "fieldsetId": { + "type": "string" + }, + "fieldId": { + "type": "string" + }, + "setOrder": { + "format": "int32", + "type": "integer" + }, + "order": { + "format": "int32", + "type": "integer" + }, + "topicId": { + "type": "string" + }, + "setName": { + "type": "string" + }, + "fieldName": { + "type": "string" + }, + "fieldValueType": { + "$ref": "#/definitions/FieldType" + }, + "required": { + "type": "boolean" + }, + "readonly": { + "type": "boolean" + }, + "usage": { + "type": "string" + }, + "relationshipCategory": { + "$ref": "#/definitions/IRelationshipElement" + }, + "characteristic": { + "$ref": "#/definitions/IRelationshipElement" + }, + "openLocation": { + "type": "string" + }, + "data": { + "type": "array", + "items": { + "format": "uri", + "type": "string" + } + } + } + }, + "MultiNumberField": { + "type": "object", + "properties": { + "fieldsetId": { + "type": "string" + }, + "fieldId": { + "type": "string" + }, + "setOrder": { + "format": "int32", + "type": "integer" + }, + "order": { + "format": "int32", + "type": "integer" + }, + "topicId": { + "type": "string" + }, + "setName": { + "type": "string" + }, + "fieldName": { + "type": "string" + }, + "fieldValueType": { + "$ref": "#/definitions/FieldType" + }, + "required": { + "type": "boolean" + }, + "readonly": { + "type": "boolean" + }, + "usage": { + "type": "string" + }, + "relationshipCategory": { + "$ref": "#/definitions/IRelationshipElement" + }, + "characteristic": { + "$ref": "#/definitions/IRelationshipElement" + }, + "openLocation": { + "type": "string" + }, + "data": { + "type": "array", + "items": { + "format": "int64", + "type": "integer" + } + } + } + }, + "MultiRelationshipField": { + "type": "object", + "properties": { + "fieldId": { + "type": "string" + }, + "fieldsetId": { + "type": "string" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/RelationshipElement" + } + } + } + }, + "MultiTextField": { + "type": "object", + "properties": { + "fieldsetId": { + "type": "string" + }, + "fieldId": { + "type": "string" + }, + "setOrder": { + "format": "int32", + "type": "integer" + }, + "order": { + "format": "int32", + "type": "integer" + }, + "topicId": { + "type": "string" + }, + "setName": { + "type": "string" + }, + "fieldName": { + "type": "string" + }, + "fieldValueType": { + "$ref": "#/definitions/FieldType" + }, + "required": { + "type": "boolean" + }, + "readonly": { + "type": "boolean" + }, + "usage": { + "type": "string" + }, + "relationshipCategory": { + "$ref": "#/definitions/IRelationshipElement" + }, + "characteristic": { + "$ref": "#/definitions/IRelationshipElement" + }, + "openLocation": { + "type": "string" + }, + "data": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "PatchHyperlinkField": { + "type": "object", + "properties": { + "data": { + "type": "string" + } + } + }, + "PatchMultiHyperlinkField": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "RelationshipElement": { + "type": "object", + "properties": { + "dcv": { + "type": "string" + }, + "name": { + "type": "string" + }, + "icon": { + "type": "string" + } + } + }, + "RelationshipField": { + "type": "object", + "properties": { + "fieldId": { + "type": "string" + }, + "fieldsetId": { + "type": "string" + }, + "data": { + "$ref": "#/definitions/RelationshipElement" + } + } + }, + "RelationshipListField": { + "type": "object", + "properties": { + "fieldId": { + "type": "string" + }, + "fieldsetId": { + "type": "string" + }, + "data": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/RelationshipElement" + } + } + } + }, + "RelationshipType": { + "enum": [ + "Unknown", + "WithWhat", + "Who", + "When", + "Where", + "Why", + "WhereTo" + ], + "type": "string" + }, + "SaveRelationship": { + "type": "object", + "properties": { + "fromElementDcv": { + "description": "FromElementDcv", + "type": "string" + }, + "toElementDcv": { + "description": "ToElementDcv", + "type": "string" + }, + "relationshipType": { + "$ref": "#/definitions/RelationshipType" + } + } + }, + "SaveTopic": { + "type": "object", + "properties": { + "name": { + "description": "Gets or sets the title", + "maxLength": 2000, + "type": "string" + } + } + }, + "SingleBooleanField": { + "type": "object", + "properties": { + "fieldsetId": { + "type": "string" + }, + "fieldId": { + "type": "string" + }, + "setOrder": { + "format": "int32", + "type": "integer" + }, + "order": { + "format": "int32", + "type": "integer" + }, + "topicId": { + "type": "string" + }, + "setName": { + "type": "string" + }, + "fieldName": { + "type": "string" + }, + "fieldValueType": { + "$ref": "#/definitions/FieldType" + }, + "required": { + "type": "boolean" + }, + "readonly": { + "type": "boolean" + }, + "usage": { + "type": "string" + }, + "relationshipCategory": { + "$ref": "#/definitions/IRelationshipElement" + }, + "characteristic": { + "$ref": "#/definitions/IRelationshipElement" + }, + "openLocation": { + "type": "string" + }, + "data": { + "type": "boolean" + } + } + }, + "SingleDateField": { + "type": "object", + "properties": { + "fieldsetId": { + "type": "string" + }, + "fieldId": { + "type": "string" + }, + "setOrder": { + "format": "int32", + "type": "integer" + }, + "order": { + "format": "int32", + "type": "integer" + }, + "topicId": { + "type": "string" + }, + "setName": { + "type": "string" + }, + "fieldName": { + "type": "string" + }, + "fieldValueType": { + "$ref": "#/definitions/FieldType" + }, + "required": { + "type": "boolean" + }, + "readonly": { + "type": "boolean" + }, + "usage": { + "type": "string" + }, + "relationshipCategory": { + "$ref": "#/definitions/IRelationshipElement" + }, + "characteristic": { + "$ref": "#/definitions/IRelationshipElement" + }, + "openLocation": { + "type": "string" + }, + "data": { + "format": "date-time", + "type": "string" + } + } + }, + "SingleDecimalField": { + "type": "object", + "properties": { + "fieldsetId": { + "type": "string" + }, + "fieldId": { + "type": "string" + }, + "setOrder": { + "format": "int32", + "type": "integer" + }, + "order": { + "format": "int32", + "type": "integer" + }, + "topicId": { + "type": "string" + }, + "setName": { + "type": "string" + }, + "fieldName": { + "type": "string" + }, + "fieldValueType": { + "$ref": "#/definitions/FieldType" + }, + "required": { + "type": "boolean" + }, + "readonly": { + "type": "boolean" + }, + "usage": { + "type": "string" + }, + "relationshipCategory": { + "$ref": "#/definitions/IRelationshipElement" + }, + "characteristic": { + "$ref": "#/definitions/IRelationshipElement" + }, + "openLocation": { + "type": "string" + }, + "data": { + "format": "double", + "type": "number" + } + } + }, + "SingleHyperlinkField": { + "type": "object", + "properties": { + "fieldsetId": { + "type": "string" + }, + "fieldId": { + "type": "string" + }, + "setOrder": { + "format": "int32", + "type": "integer" + }, + "order": { + "format": "int32", + "type": "integer" + }, + "topicId": { + "type": "string" + }, + "setName": { + "type": "string" + }, + "fieldName": { + "type": "string" + }, + "fieldValueType": { + "$ref": "#/definitions/FieldType" + }, + "required": { + "type": "boolean" + }, + "readonly": { + "type": "boolean" + }, + "usage": { + "type": "string" + }, + "relationshipCategory": { + "$ref": "#/definitions/IRelationshipElement" + }, + "characteristic": { + "$ref": "#/definitions/IRelationshipElement" + }, + "openLocation": { + "type": "string" + }, + "data": { + "format": "uri", + "type": "string" + } + } + }, + "SingleListField": { + "type": "object", + "properties": { + "fieldsetId": { + "type": "string" + }, + "fieldId": { + "type": "string" + }, + "setOrder": { + "format": "int32", + "type": "integer" + }, + "order": { + "format": "int32", + "type": "integer" + }, + "topicId": { + "type": "string" + }, + "setName": { + "type": "string" + }, + "fieldName": { + "type": "string" + }, + "fieldValueType": { + "$ref": "#/definitions/FieldType" + }, + "required": { + "type": "boolean" + }, + "readonly": { + "type": "boolean" + }, + "usage": { + "type": "string" + }, + "relationshipCategory": { + "$ref": "#/definitions/IRelationshipElement" + }, + "characteristic": { + "$ref": "#/definitions/IRelationshipElement" + }, + "openLocation": { + "type": "string" + }, + "data": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "options": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "SingleNumberField": { + "type": "object", + "properties": { + "fieldsetId": { + "type": "string" + }, + "fieldId": { + "type": "string" + }, + "setOrder": { + "format": "int32", + "type": "integer" + }, + "order": { + "format": "int32", + "type": "integer" + }, + "topicId": { + "type": "string" + }, + "setName": { + "type": "string" + }, + "fieldName": { + "type": "string" + }, + "fieldValueType": { + "$ref": "#/definitions/FieldType" + }, + "required": { + "type": "boolean" + }, + "readonly": { + "type": "boolean" + }, + "usage": { + "type": "string" + }, + "relationshipCategory": { + "$ref": "#/definitions/IRelationshipElement" + }, + "characteristic": { + "$ref": "#/definitions/IRelationshipElement" + }, + "openLocation": { + "type": "string" + }, + "data": { + "format": "int64", + "type": "integer" + } + } + }, + "SingleTextField": { + "type": "object", + "properties": { + "fieldsetId": { + "type": "string" + }, + "fieldId": { + "type": "string" + }, + "setOrder": { + "format": "int32", + "type": "integer" + }, + "order": { + "format": "int32", + "type": "integer" + }, + "topicId": { + "type": "string" + }, + "setName": { + "type": "string" + }, + "fieldName": { + "type": "string" + }, + "fieldValueType": { + "$ref": "#/definitions/FieldType" + }, + "required": { + "type": "boolean" + }, + "readonly": { + "type": "boolean" + }, + "usage": { + "type": "string" + }, + "relationshipCategory": { + "$ref": "#/definitions/IRelationshipElement" + }, + "characteristic": { + "$ref": "#/definitions/IRelationshipElement" + }, + "openLocation": { + "type": "string" + }, + "data": { + "type": "string" + } + } + }, + "TopicResource": { + "enum": [ + "Chart", + "Description", + "Fields", + "Relations", + "SubTopics" + ], + "type": "string" + }, + "TopicType": { + "enum": [ + "Unknown", + "Virtual", + "MavimElementContainer", + "RelationCategories", + "WithWhat", + "Who", + "Where", + "When", + "Why", + "WhereTo", + "RecycleBin" + ], + "type": "string" + } + }, + "x-ms-connector-metadata": [ + { + "propertyName": "Website", + "propertyValue": "https://www.mavim.com/" + }, + { + "propertyName": "Privacy policy", + "propertyValue": "https://trustcenter.mavim.com/" + }, + { + "propertyName": "Categories", + "propertyValue": "Business Management;Collaboration" + } + ] +} \ No newline at end of file diff --git a/certified-connectors/Mavim iMprove/apiProperties.json b/certified-connectors/Mavim iMprove/apiProperties.json new file mode 100644 index 0000000000..b0716b0445 --- /dev/null +++ b/certified-connectors/Mavim iMprove/apiProperties.json @@ -0,0 +1,48 @@ +{ + "properties": { + "connectionParameters": { + "token": { + "type": "oauthSetting", + "oAuthSettings": { + "identityProvider": "aad", + "clientId": "<>", + "redirectMode": "Global", + "redirectUrl": "https://global.consent.azure-apim.net/redirect", + "properties": { + "IsFirstParty": "False", + "AzureActiveDirectoryResourceId": "{{Please_add_AzureActiveDirectoryResourceId_here}}" + }, + "customParameters": { + "loginUri": { + "value": "https://login.windows.net" + }, + "tenantId": { + "value": "common" + }, + "resourceUri": { + "value": "15e1f0d0-3141-47b0-a87e-323d62b71b75" + } + } + } + }, + "token:TenantId": { + "type": "string", + "metadata": { + "sourceType": "AzureActiveDirectoryTenant" + }, + "uiDefinition": { + "constraints": { + "required": "false", + "hidden": "true" + } + } + } + }, + "iconBrandColor": "#E31B86", + "policyTemplateInstances": [ + ], + "capabilities": [], + "publisher": "Mavim", + "stackOwner": "Mavim" + } + }