Search Files in FileSet

Performs an advanced search for files based on metadata filters.

POST /api/files/v1/filesets/{filesetId}/files/search

Search Files in FileSet

cURL

curl --request POST \
  --url https://{instance}.domo.com/api/files/v1/filesets/{filesetId}/files/search \
  --header 'Content-Type: application/json' \
  --header 'X-DOMO-Developer-Token: <api-key>' \
  --data '
{
  "fieldSort": [
    {
      "field": "<string>"
    }
  ],
  "filters": [
    {
      "field": "<string>",
      "value": [
        "<string>"
      ],
      "not": false
    }
  ],
  "dateFilters": [
    {
      "field": "<string>",
      "start": "2023-11-07T05:31:56Z",
      "end": "2023-11-07T05:31:56Z",
      "not": false
    }
  ]
}
'

import requests

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

payload = {
    "fieldSort": [{ "field": "<string>" }],
    "filters": [
        {
            "field": "<string>",
            "value": ["<string>"],
            "not": False
        }
    ],
    "dateFilters": [
        {
            "field": "<string>",
            "start": "2023-11-07T05:31:56Z",
            "end": "2023-11-07T05:31:56Z",
            "not": False
        }
    ]
}
headers = {
    "X-DOMO-Developer-Token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-DOMO-Developer-Token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    fieldSort: [{field: '<string>'}],
    filters: [{field: '<string>', value: ['<string>'], not: false}],
    dateFilters: [
      {
        field: '<string>',
        start: '2023-11-07T05:31:56Z',
        end: '2023-11-07T05:31:56Z',
        not: false
      }
    ]
  })
};

fetch('https://{instance}.domo.com/api/files/v1/filesets/{filesetId}/files/search', 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/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'fieldSort' => [
        [
                'field' => '<string>'
        ]
    ],
    'filters' => [
        [
                'field' => '<string>',
                'value' => [
                                '<string>'
                ],
                'not' => false
        ]
    ],
    'dateFilters' => [
        [
                'field' => '<string>',
                'start' => '2023-11-07T05:31:56Z',
                'end' => '2023-11-07T05:31:56Z',
                'not' => false
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"fieldSort\": [\n    {\n      \"field\": \"<string>\"\n    }\n  ],\n  \"filters\": [\n    {\n      \"field\": \"<string>\",\n      \"value\": [\n        \"<string>\"\n      ],\n      \"not\": false\n    }\n  ],\n  \"dateFilters\": [\n    {\n      \"field\": \"<string>\",\n      \"start\": \"2023-11-07T05:31:56Z\",\n      \"end\": \"2023-11-07T05:31:56Z\",\n      \"not\": false\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-DOMO-Developer-Token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{instance}.domo.com/api/files/v1/filesets/{filesetId}/files/search")
  .header("X-DOMO-Developer-Token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"fieldSort\": [\n    {\n      \"field\": \"<string>\"\n    }\n  ],\n  \"filters\": [\n    {\n      \"field\": \"<string>\",\n      \"value\": [\n        \"<string>\"\n      ],\n      \"not\": false\n    }\n  ],\n  \"dateFilters\": [\n    {\n      \"field\": \"<string>\",\n      \"start\": \"2023-11-07T05:31:56Z\",\n      \"end\": \"2023-11-07T05:31:56Z\",\n      \"not\": false\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["X-DOMO-Developer-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"fieldSort\": [\n    {\n      \"field\": \"<string>\"\n    }\n  ],\n  \"filters\": [\n    {\n      \"field\": \"<string>\",\n      \"value\": [\n        \"<string>\"\n      ],\n      \"not\": false\n    }\n  ],\n  \"dateFilters\": [\n    {\n      \"field\": \"<string>\",\n      \"start\": \"2023-11-07T05:31:56Z\",\n      \"end\": \"2023-11-07T05:31:56Z\",\n      \"not\": false\n    }\n  ]\n}"

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

200

{
  "files": [
    {
      "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>"
    }
  ],
  "pageContext": {
    "next": "<string>",
    "offset": 123,
    "limit": 123,
    "total": 123
  }
}

Authorizations

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

Domo Developer Token for authentication.

Path Parameters

filesetId · string<uuid> · required

Query Parameters

directoryPath · string

immediateChildren · boolean · default: false

limit · integer · default: 100

next · string

Pagination token.

Body

application/json

Body for search operations on Files or FileSets.

fieldSort · object[]

Show child attributes

filters · object[]

Show child attributes

dateFilters · object[]

Show child attributes

Response

200

application/json

A paginated list of matching files.

files · object[]

Show child attributes

pageContext · object

Show child attributes