Skip to content
Authrim

Compile a field mapping version.

POST
/api/admin/field-mapping/field-mapping-sets/{fieldMappingSetId}/versions/{fieldMappingVersionId}/compile
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/field-mapping/field-mapping-sets/example/versions/example/compile \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "catalogVersionId": "catalog_version_123", "compatibilityRange": ">=1.0.0" }'

Compiles a field mapping version against a catalog version and returns the compiled snapshot metadata.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
fieldMappingSetId
required
string

Field mapping set identifier.

fieldMappingVersionId
required
string

Field mapping version identifier.

Header Parameters

Section titled “Header Parameters ”
Idempotency-Key
string

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

Request Body required

Section titled “Request Body required ”
Media type application/json
object
catalogVersionId
required
string
compatibilityRange
string
artifactRef
string
metadata
object
key
additional properties
key
additional properties
Example 
{
  "catalogVersionId": "catalog_version_123",
  "compatibilityRange": ">=1.0.0"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Field mapping compile response.

Media type application/json
object
result
required
object
id
required
string
tenantId
required
string
fieldMappingVersionId
required
string
catalogVersionId
required
string
snapshotHash
required
string
dependencyGraphId
required
string
lifecycleState
required
string
key
additional properties
key
additional properties
Example generated
{
  "result": {
    "id": "example",
    "tenantId": "example",
    "fieldMappingVersionId": "example",
    "catalogVersionId": "example",
    "snapshotHash": "example",
    "dependencyGraphId": "example",
    "lifecycleState": "example"
  }
}

400

Section titled “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

Section titled “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

Section titled “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

Section titled “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

Section titled “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

Section titled “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"
}