Activate a field mapping version.

POST

/api/admin/field-mapping/field-mapping-sets/{fieldMappingSetId}/versions/{fieldMappingVersionId}/activate

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/admin/field-mapping/field-mapping-sets/example/versions/example/activate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "snapshotId": "mapping_snapshot_123", "activationScope": { "clients": [ "web-app" ] } }'

Activates a compiled field mapping version for the supplied activation scope. Requires a compiled snapshot id in the request body.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

fieldMappingSetId

required

string

Field mapping set identifier.

fieldMappingVersionId

required

string

Field mapping version identifier.

Header Parameters

Idempotency-Key

string

Idempotency key for state-changing operations that support replay protection.

Request Body ^required

Media type application/json

object

snapshotId

required

string

activationScope

required

object

key

additional properties

holderId

string

key

additional properties

Example

{
  "snapshotId": "mapping_snapshot_123",
  "activationScope": {
    "clients": [
      "web-app"
    ]
  }
}

Responses

200

Field mapping activation response.

Media type application/json

object

result

required

object

id

required

string

tenantId

required

string

fieldMappingSetId

required

string

fieldMappingVersionId

required

string

snapshotId

string

lifecycleState

required

string

activatedAt

integer

holderId

string

alreadyActive

boolean

key

additional properties

key

additional properties

Example ^generated

{
  "result": {
    "id": "example",
    "tenantId": "example",
    "fieldMappingSetId": "example",
    "fieldMappingVersionId": "example",
    "snapshotId": "example",
    "lifecycleState": "example",
    "activatedAt": 1,
    "holderId": "example",
    "alreadyActive": true
  }
}

400

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

404

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

409

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}