Get File by Id

Retrieves a File’s metadata using its ID.

GET /api/files/v1/filesets/{filesetId}/files/{fileId}

Get File by Id

cURL

curl --request GET \
  --url https://{instance}.domo.com/api/files/v1/filesets/{filesetId}/files/{fileId} \
  --header 'X-DOMO-Developer-Token: <api-key>'

import requests

url = "https://{instance}.domo.com/api/files/v1/filesets/{filesetId}/files/{fileId}"

headers = {"X-DOMO-Developer-Token": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-DOMO-Developer-Token': '<api-key>'}};

fetch('https://{instance}.domo.com/api/files/v1/filesets/{filesetId}/files/{fileId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{instance}.domo.com/api/files/v1/filesets/{filesetId}/files/{fileId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-DOMO-Developer-Token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{instance}.domo.com/api/files/v1/filesets/{filesetId}/files/{fileId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-DOMO-Developer-Token", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{instance}.domo.com/api/files/v1/filesets/{filesetId}/files/{fileId}")
  .header("X-DOMO-Developer-Token", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{instance}.domo.com/api/files/v1/filesets/{filesetId}/files/{fileId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-DOMO-Developer-Token"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "path": "<string>",
  "name": "<string>",
  "fileType": "<string>",
  "contentType": "<string>",
  "size": 123,
  "created": "2023-11-07T05:31:56Z",
  "createdBy": 123,
  "hash": "<string>",
  "hashAlgorithm": "<string>",
  "downloadUrl": "<string>",
  "connectorKey": "<string>",
  "indexStatus": "<string>",
  "indexReason": "<string>"
}

Authorizations

X-DOMO-Developer-Token · string · header · required

Domo Developer Token for authentication.

Path Parameters

filesetId · string<uuid> · required

fileId · string<uuid> · required

Response

200

application/json

Full file metadata.

Full metadata for a file.

id · string<uuid>

path · string

name · string

fileType · string

contentType · string

size · integer<int64>

created · string<date-time>

createdBy · integer

hash · string

hashAlgorithm · string

downloadUrl · string<url> | null

connectorKey · string | null

indexStatus · string | null

indexReason · string | null