PUT
/
organisations
/
{organisationId}
/
data-mappings
/
{mappingId}

Authorizations

Authorization
string
headerrequired

Path Parameters

organisationId
string
required
mappingId
string
required

Body

application/json

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
definition.sourceField
string
definition.targetField
string

Response

200 - application/json
id
string
required
orgId
string
required
sourceApp
object
sourceApp.id
string
required
sourceApp.orgId
string
required
sourceApp.name
string
required
sourceApp.public
boolean
required
sourceApp.server
object
required
sourceApp.schemaMetadata
object
required
sourceApp.supportedAuthConfigs
object[]

SupportedAuthConfigs is a list of authentication standards which can be used to connect a user's account to this app. At least one auth type needs to be valid for the App to be used by a user.

sourceApp.imageUrl
string
sourceApp.schema
object
required
sourceApp.schemaId
string
sourceApp.createdAt
string
required
sourceApp.updatedAt
string
required
sourceApp.deletedAt
string
sourceSchemaId
string
required
targetApp
object
targetApp.id
string
required
targetApp.orgId
string
required
targetApp.name
string
required
targetApp.public
boolean
required
targetApp.server
object
required
targetApp.schemaMetadata
object
required
targetApp.supportedAuthConfigs
object[]

SupportedAuthConfigs is a list of authentication standards which can be used to connect a user's account to this app. At least one auth type needs to be valid for the App to be used by a user.

targetApp.imageUrl
string
targetApp.schema
object
required
targetApp.schemaId
string
targetApp.createdAt
string
required
targetApp.updatedAt
string
required
targetApp.deletedAt
string
targetSchemaId
string
required
definition
object[]
required
definition.sourceField
string
definition.targetField
string
createdAt
string
updatedAt
string
deletedAt
string
Post organisations data mappingsDelete organisations data mappings