FOfountain
dataPipelines

replace one dataPipeline which exists or not

Replace one dataPipeline which exists or not

put/api/serviceintegrations/dataPipelines/{identifier}

Request

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

Path parameters

identifierstring uuid required

dataPipeline 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
namestring required
dataType'jobs' | 'workers' | 'locations' | 'locationGroups' | 'openings' | 'applicants' | 'prospects' | 'employers' | 'optionBanks' | 'datasets' required
direction'import' | 'export' required
dataFormat'CSV' | 'JSON' required
isInternalboolean required

It will be added to the catalogue of re-usable data pipelines

isActiveboolean required

Whether the data pipeline is enabled or disabled

readOnlyboolean required

Whether the data pipeline is read-only and cannot be edited

isStandardPipelineboolean required

Whether this is a standard prebuilt pipeline that should suppress mapping warnings for empty values

isDraftboolean

Whether this pipeline is a draft created during the test-before-save flow

sampleFileKeystring nullable

Object storage key for the sample file used for mapping/tests

sampleFileUploadedAtstring date-time nullable

Timestamp of the last uploaded sample file

sampleJsonTextstring nullable

Raw JSON text used for mapping/tests (alternative to file upload)

jsonDataPathstring nullable

Lodash-style dot-notation path to the records array within the JSON payload. When set, the parser drills into this path before extracting rows. Example: "data.all" or "0.here.0.one". When empty, the root is used.

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",
  "name": "Jobs import Pipeline",
  "dataType": "locations",
  "direction": "import",
  "dataFormat": "CSV",
  "isActive": true,
  "sampleFileKey": ":companyUuid/:dataPipelineUuid/sample.csv",
  "sampleFileUploadedAt": "2025-01-01T12:00:00.000Z",
  "sampleJsonText": "[{\"firstname\": \"John\", \"email\": \"john@example.com\"}]",
  "jsonDataPath": "data.all"
}

Response

dataPipeline replaced. 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",
    "name": "Jobs import Pipeline",
    "dataType": "locations",
    "direction": "import",
    "dataFormat": "CSV",
    "isActive": true,
    "sampleFileKey": ":companyUuid/:dataPipelineUuid/sample.csv",
    "sampleFileUploadedAt": "2025-01-01T12:00:00.000Z",
    "sampleJsonText": "[{\"firstname\": \"John\", \"email\": \"john@example.com\"}]",
    "jsonDataPath": "data.all"
  },
  "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.