v1

latestOpenAPI 3.0.3Apache 2.02026-07-133681213.9 KB

Custom Mappings

Update custom mapping

Update a custom mapping

patch/vault/custom-mappings/{unified_api}/{service_id}/{target_field_id}

Path parameters

unified_apistring required

Unified API

service_idstring required

Service ID of the resource to return

target_field_idstring required

ID of the target field to return as a custom mapping.

Headers

x-apideck-consumer-idstring required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring required

The ID of your Unify application

Request body

valuestring required

Target Field Mapping value

Example request

{
  "value": "$.root.training.first_aid"
}

Response

Custom mapping updated

status_codeinteger required

HTTP Response Status Code

statusstring required

HTTP Response Status

_rawRaw nullable

Raw response from the integration when raw=true query param is provided

Example response

{
  "status_code": 200,
  "status": "OK",
  "data": {
    "id": "hris+employees+first_aid_training",
    "label": "First Aid Training",
    "description": "First Aid Training completed after 2019-01-01",
    "value": "$.root.training.first_aid",
    "key": "first_aid_training",
    "custom_field": true,
    "consumer_id": "test_user_id",
    "example": "Some value"
  }
}