FOfountain
dataPipelineMappings

partially update one existing dataPipelineMapping

Partially update one existing dataPipelineMapping

patch/api/serviceintegrations/dataPipelineMappings/{identifier}

Request

  • Base URL
    https://services.fountain.com
  • URL
    https://services.fountain.com/api/serviceintegrations/dataPipelineMappings/{identifier}
  • Auth
    HTTP bearer

Path parameters

identifierstring uuid required

dataPipelineMapping unique identifier

Request body

uuidstring uuid
createdAtstring date-time
createdBystring uuid
lastUpdatedAtstring date-time
lastUpdatedBystring uuid
lastUpdatedByAudiencestring
lastUpdatedByAudienceUuidstring uuid
lastUpdatedByImpersonatedBystring uuid
lastUpdatedByCompanyUuidstring uuid
lastUpdatedByEnterpriseUuidstring uuid
companyUuidstring uuid required
dataPipelineUuidstring uuid required
transformFunctionArnstring

ARN of the per-pipeline parent-handler AWS Lambda that combines all per-field transform scripts. Managed by TransformLambdaManager.

Example request

{
  "uuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426",
  "createdAt": "2021-05-05T01:02:03.924Z",
  "createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
  "lastUpdatedAt": "2021-05-05T04:05:06.924Z",
  "lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
  "lastUpdatedByAudience": "employer",
  "lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
  "lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
  "lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
  "lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
  "dataPipelineUuid": "123e4567-e89b-12d3-a456-426614174000",
  "mappings": [
    {
      "from": "first_name",
      "to": "firstName",
      "dataType": "string"
    },
    {
      "from": "email_address",
      "to": "email",
      "dataType": "string"
    },
    {
      "from": "hire_date",
      "to": "startDate",
      "dataType": "date"
    },
    {
      "from": "hourly_rate",
      "to": "wage",
      "dataType": "number"
    },
    {
      "from": "is_active",
      "to": "active",
      "dataType": "boolean"
    }
  ],
  "enrichments": [
    {
      "entity": "locations",
      "sourceColumn": "locationName",
      "lookupBy": "name"
    }
  ]
}

Response

updated dataPipelineMapping. Wrapped in a JsonAPI root response.

Example response

{
  "data": {
    "uuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426",
    "createdAt": "2021-05-05T01:02:03.924Z",
    "createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
    "lastUpdatedAt": "2021-05-05T04:05:06.924Z",
    "lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
    "lastUpdatedByAudience": "employer",
    "lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
    "lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
    "lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
    "lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
    "dataPipelineUuid": "123e4567-e89b-12d3-a456-426614174000",
    "mappings": [
      {
        "from": "first_name",
        "to": "firstName",
        "dataType": "string"
      },
      {
        "from": "email_address",
        "to": "email",
        "dataType": "string"
      },
      {
        "from": "hire_date",
        "to": "startDate",
        "dataType": "date"
      },
      {
        "from": "hourly_rate",
        "to": "wage",
        "dataType": "number"
      },
      {
        "from": "is_active",
        "to": "active",
        "dataType": "boolean"
      }
    ],
    "enrichments": [
      {
        "entity": "locations",
        "sourceColumn": "locationName",
        "lookupBy": "name"
      }
    ]
  },
  "meta": {
    "timestamp": "2021-05-05T09:47:58.924Z",
    "verb": "GET",
    "path": "/api/structure/resources/5949cf7c-fec6-4b31-947c-3aceabff58c5",
    "jti": "%cQN3RIGp",
    "rid": "$2d2zkHZ5",
    "count": 1,
    "status": "200",
    "duration": 17,
    "size": 1234
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.