POST v1/mappings/add

save mapping to storage

Request Information

URI Parameters

None.

Body Parameters

ConfidenceApps.Interfaces.Pris.IMapping

Name	Description	Type	Additional information
AppId	The unique identifier of the related CApp.	globally unique identifier	None.
AppName	The name of the related CApp (Info only).	string	None.
AppVersion	The CApp version that was is targeted by the mapping xml.	string	None.
Database	Contains required data to connect to the target database for inserting the result data to it (results) read data from (tasks).	ConfidenceApps.Interfaces.Pris.IDatabase	None.
IsChanged	Indicates if at least one property has changed since the last reset (except Id). Can be reseted by set to false.	boolean	None.
MapItems	The mappings of form controls from a CApp to a specified database field.	Collection of ConfidenceApps.Interfaces.Pris.IMapItem	None.
IsTaskMapping	Defines if mapping is result or task type [Deprecated] better use MappingType - Setting influences MappingType	boolean	None.
MappingType	Defines what kind of mapping is targeted. Default is Result.	ConfidenceApps.Types.MappingTypes	None.
Name	The name of the mapping.	string	None.
Relations	Contains the relation structure data of the database´s tables.	Collection of ConfidenceApps.Interfaces.Pris.IRelation	None.
StateMappings	Mapping for CC-Portal users to database users.	Collection of ConfidenceApps.Interfaces.Pris.IStateMapping	None.
Tables	Contains all information about required tables of the database to input, update data (results) or read data (tasks).	Collection of ConfidenceApps.Interfaces.Pris.ITable	None.
TaskMapping	Additional mapping data for tasks to enable edition of existing data within the database.	ConfidenceApps.Interfaces.Pris.ITaskMapping	None.
DataListMapping	Additional mapping data for datalists (resources) to provide formcontrols datalists with dynamic data from the database.	ConfidenceApps.Interfaces.Pris.IDataListMapping	None.
UserMappings	Mapping for CC-Portal users to database users.	Collection of ConfidenceApps.Interfaces.Pris.IUserMapping	None.
XmlVersion	The version of the mapping xml schema format.	string	None.
ServerTimeStamp	The last modification on the cloud portal server	date	None.
CreationType	Defines how the mapping was created using the AutoCreator. Default is Manually.	ConfidenceApps.Types.CreationTypes	None.

Request Formats

application/json, text/json

Sample:

{
  "appId": "6026ccc4-32fb-4a0f-bc14-d90bc45483e0",
  "appName": "Sample CApp",
  "appVersion": "1.0",
  "database": {
    "createdAt": "0001-01-01T00:00:00",
    "modifiedAt": "0001-01-01T00:00:00",
    "referenceId": "00000000-0000-0000-0000-000000000000"
  },
  "isTaskMapping": false,
  "mapItems": [
    {
      "field": "Sample Field",
      "indexName": "Sample Index",
      "sourceName": "Sample Source",
      "table": "Sample Table",
      "useForTasks": false,
      "useForUpdate": false,
      "value": "Sample Value",
      "createdAt": "0001-01-01T00:00:00",
      "modifiedAt": "0001-01-01T00:00:00",
      "referenceId": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "name": "Sample Mapping",
  "relations": [
    {
      "detailTable": "Sample Detail",
      "masterTable": "Sample Master",
      "createdAt": "0001-01-01T00:00:00",
      "modifiedAt": "0001-01-01T00:00:00",
      "referenceId": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "stateMappings": [
    {
      "name": "Sample Name",
      "value": "Sample Value",
      "createdAt": "0001-01-01T00:00:00",
      "modifiedAt": "0001-01-01T00:00:00",
      "referenceId": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "tables": [
    {
      "identityField": "Id",
      "name": "Sample Table",
      "createdAt": "0001-01-01T00:00:00",
      "modifiedAt": "0001-01-01T00:00:00",
      "referenceId": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "taskMapping": {
    "doneItems": [
      {
        "field": "Sample Field",
        "value": "Sample Value",
        "createdAt": "0001-01-01T00:00:00",
        "modifiedAt": "0001-01-01T00:00:00",
        "referenceId": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "table": "Sample Table",
    "taskProperties": [
      {
        "field": "Sample Field",
        "name": "Name",
        "createdAt": "0001-01-01T00:00:00",
        "modifiedAt": "0001-01-01T00:00:00",
        "referenceId": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "createdAt": "0001-01-01T00:00:00",
    "modifiedAt": "0001-01-01T00:00:00",
    "referenceId": "00000000-0000-0000-0000-000000000000"
  },
  "userMappings": [
    {
      "ccUser": "1000",
      "dbUser": "ADM",
      "createdAt": "0001-01-01T00:00:00",
      "modifiedAt": "0001-01-01T00:00:00",
      "referenceId": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "xmlVersion": "2.0",
  "createdAt": "2024-05-08T22:26:51",
  "isChanged": false,
  "id": "687c384b-fd56-431a-ab5c-bf95c9b3395b",
  "modifiedAt": "0001-01-01T00:00:00",
  "referenceId": "00000000-0000-0000-0000-000000000000",
  "mappingType": "Result",
  "dataListMapping": {
    "createdAt": "0001-01-01T00:00:00",
    "modifiedAt": "0001-01-01T00:00:00",
    "referenceId": "00000000-0000-0000-0000-000000000000"
  },
  "isEnabled": true,
  "creationType": "Manually"
}

Response Information

Resource Description

System.Net.Http.HttpResponseMessage

Name	Type	Additional information
Version	System.Version	None.
Content	System.Net.Http.HttpContent	None.
StatusCode	System.Net.HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	System.Net.Http.HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.