LMS File Upload

Retrieve the FTS upload URL

This creates a url used to initiate the upload of your file.

Request

{
    "prefix": "filename.csv$"
}

The prefix needs to end with $

Response

{
   "url": "https://storage.googleapis.com/fts-usa/OUTSIDE/569a7c56-ff84-41d3-a2fd-7ce4c1614cfc/usa/filename.csv%24728983ad-06eb-4e21-835f-16072597447e?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=matrix-fts%40tcn-cloud.iam.gserviceaccount.com%2F20250101%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20250101T120000Z&X-Goog-Expires=599&X-Goog-Signature=59536277425735683451454b7175414b4968466350725254746343584a7776765856726b674375316c765a7566324b7774767a3352763863635935666b2b513345714c5531305764736c565753365936306f554a78594945634c79764b684e727a4950474d6e624b774a6a6a544570687750386c5a757369694d44776e6f6d3646394d4e6c714f5a5930484f49786830533537314661644461755969396a66433673386b393131776f737672736b2f4d2b44574b625579524e3459614c68427733386b33384939796267326956306c38726e444e486e514972654b70446f564e6c7a6d6f634e64664871597846655a4b485171493766557a72646549514a7448&X-Goog-SignedHeaders=host%3Bx-goog-resumable",
   "id": "filename.csv$728983ad-06eb-4e21-835f-16072597447e"
}

Store the response values for id and url.

Initiate the FTS upload

FTS Initiate

Send an empty POST request to the url returned by /api/v0alpha/fts/upload_url with the custom header X-Goog-Resumable: start.
This will return an empty response with location, and x-guploader-uploadid headers.

Request

{}

Response

x-guploader-uploadid: AKDAyIs1D9Ud_G004bGPHMTEsSx2jzTZhrfqUuAYIqe_QO-VnwQ8iYT0hitvDZ9zB8pK1qUH9zNqmYoDozZ-JmHeG4Aua-6Mkg_OZW6GrE807vo

location: https://storage.googleapis.com/fts-usa/OUTSIDE/569a7c56-ff84-41d3-a2fd-7ce4c1614cfc/usa/filename.csv%24728983ad-06eb-4e21-835f-16072597447e?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=matrix-fts%40tcn-cloud.iam.gserviceaccount.com%2F20250101%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20250101T120000Z&X-Goog-Expires=599&X-Goog-Signature=59536277425735683451454b7175414b4968466350725254746343584a7776765856726b674375316c765a7566324b7774767a3352763863635935666b2b513345714c5531305764736c565753365936306f554a78594945634c79764b684e727a4950474d6e624b774a6a6a544570687750386c5a757369694d44776e6f6d3646394d4e6c714f5a5930484f49786830533537314661644461755969396a66433673386b393131776f737672736b2f4d2b44574b625579524e3459614c68427733386b33384939796267326956306c38726e444e486e514972654b70446f564e6c7a6d6f634e64664871597846655a4b485171493766557a72646549514a7448&X-Goog-SignedHeaders=host%3Bx-goog-resumable&upload_id=AKDAyIs1D9Ud_G004bGPHMTEsSx2jzTZhrfqUuAYIqe_QO-VnwQ8iYT0hitvDZ9zB8pK1qUH9zNqmYoDozZ-JmHeG4Aua-6Mkg_OZW6GrE807vo

Store the location.

Upload the file

FTS Upload

Send the file in a PUT request to the URL returned in the location header
Request

Content-Type: text/csv

ABC1234,John,Smith,84770,4355551234,4355556789,john.smith@example.com
DEF5678,Jennifer,Smith,84770,4355554321,4355559876,jen.smith@example.com

Verify that the the request received status code 200

Retrieve List of LMS Elements

/api/v0alpha/lms/pipelines

Find the correct LMS entrypoint

Request

{}

Response

<snip>
{
 "elementId": "d571148f-05dc-4f9e-b853-43202c42fcc2",
 "name": "File Upload",
 "inputs": [],
 "transform": {
  "apiEntrypoint": {
   "fileTemplateId": "2a885a51-9768-4924-883c-01f03c252975",
   "incremental": false,
   "encrypted": false,
   "ftsId": "filename.csv$49672fb2-ccbd-4ceb-8f77-92c54a4e57be"
  },
  "expression": ""
 },
 "lastStatus": "PIPELINE_ELEMENT_STATUS_TYPE_INITIALIZED",
 "labels": [],
 "createdDate": "2024-01-01T12:00:00.000000Z",
 "lastEdited": "2025-01-01T12:00:00.000000Z",
 "description": "",
 "inputIsDiscard": [],
 "pipelineCanvasSid": "0"
},
<snip>

Find the correct entrypoint an store the name, transform.apiEntrypoint.elementId and transform.apiEntrypoint.fileTemplateId.

Do not store transform.apiEntrypoint.ftsId that is the ftsId from the previous pipeline run and is no longer valid.

LMS Entrypoints will always have an empty list of labels. Labels refer to the LMS element parent id.

Update the LMS Entrypoint

Update the LMS entrypoint with the new ftsId.

Request

{
  "element_id": "{{elementId}}", 
  "name": "{{elementName}}", 
  "transform": {
    "api_entrypoint": {
      "file_template_id": "{{elementFileTemplateId}}", 
      "fts_id": "{{ftsId}}"
    }
  }
}

ftsId is the value of id stored in step 1.

Process the LMS Entrypoint

/api/v0alpha/lms/pipelines/process

Process the LMS entrypoint with the new ftsId

Request

{
  "element_id": "d571148f-05dc-4f9e-b853-43202c42fcc2"
}

Response

{}

LMS File Upload

LMS File Upload#

LMS File Upload