PUT
/
organisations
/
{organisationId}
/
data-mappings
/
{mappingId}
cURL
curl --request PUT \
  --url https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/data-mappings/{mappingId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "sourceAppId": "<string>",
  "sourceSchemaId": "<string>",
  "targetAppId": "<string>",
  "targetSchemaId": "<string>",
  "definition": [
    {
      "sourceField": "<string>",
      "targetField": "<string>"
    }
  ]
}'
{
  "id": "<string>",
  "orgId": "<string>",
  "sourceApp": {
    "id": "<string>",
    "orgId": "<string>",
    "name": "<string>",
    "public": true,
    "server": {
      "name": "<string>",
      "url": "<string>"
    },
    "schemaMetadata": {
      "type": "<string>",
      "version": "<string>",
      "url": "<string>"
    },
    "supportedAuthConfigs": [
      {
        "type": "<string>",
        "isValid": true,
        "data": {
          "discoveryUrl": "<string>",
          "clientId": "<string>",
          "clientSecret": "<string>",
          "scopes": {}
        }
      }
    ],
    "imageUrl": "<string>",
    "schema": {
      "id": "<string>",
      "type": "<string>",
      "version": "<string>",
      "sourceUrl": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z"
    },
    "schemaId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z"
  },
  "sourceSchemaId": "<string>",
  "targetApp": {
    "id": "<string>",
    "orgId": "<string>",
    "name": "<string>",
    "public": true,
    "server": {
      "name": "<string>",
      "url": "<string>"
    },
    "schemaMetadata": {
      "type": "<string>",
      "version": "<string>",
      "url": "<string>"
    },
    "supportedAuthConfigs": [
      {
        "type": "<string>",
        "isValid": true,
        "data": {
          "discoveryUrl": "<string>",
          "clientId": "<string>",
          "clientSecret": "<string>",
          "scopes": {}
        }
      }
    ],
    "imageUrl": "<string>",
    "schema": {
      "id": "<string>",
      "type": "<string>",
      "version": "<string>",
      "sourceUrl": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z"
    },
    "schemaId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z"
  },
  "targetSchemaId": "<string>",
  "definition": [
    {
      "sourceField": "<string>",
      "targetField": "<string>"
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
organisationId
string
required
​
mappingId
string
required

Body

application/json

Payload to update an existing DataMapping.

DataMappingUpdate is the request body to update a credential. The ID and organisation ID fields are taken from the URL path.

​
sourceAppId
string
required

The ID of the source App instance.

​
sourceSchemaId
string
required

The ID of the source app operation, for OpenAPI this will be the operationId field if set, otherwise the request's type and path.

​
targetAppId
string
required

The ID of the target App instance.

​
targetSchemaId
string
required

The ID of the target app operation, for OpenAPI this will be the operationId field if set, otherwise the request's type and path.

​
definition
object[]
required

Response

A single DataMapping result

​
id
string
required
​
orgId
string
required
​
sourceSchemaId
string
required
​
targetSchemaId
string
required
​
definition
object[]
required
​
sourceApp
object
​
targetApp
object
​
createdAt
string<date-time>
​
updatedAt
string<date-time>
​
deletedAt
string<date-time>