Search project files

get

https://api.rocketlane.com/api/1.0/project-files/search

Search files with filtering, sorting, and pagination. At least one filter parameter (projectId.eq or folderId.eq) is required. Supports file name filters (fileName.eq, fileName.cn, fileName.nc).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

pageSize

number

≥ 0

This parameter sets the maximum number of responses to be displayed per page. If the page size is insufficient to accommodate the whole number of responses obtained, the pagination object will include a link to the next page as well as the next page token. If left blank, it defaults to 100.

pageToken

string

Use this parameter to specify the pageToken of a page to which you want to navigate. This pageToken can be obtained from a previous request which specified a limit and will only be active for 15 minutes after it is created.

includeFields

array of strings

Use this query parameter to opt in for fields to be returned in the response body. Use comma separated values to fetch the respective fields. If left blank, default properties are returned.

includeFields

Allowed:

includeAllFields

boolean

This query parameter allows you to specify if all the fields should be returned in the response body. If the field is left blank, the default properties are returned.

sortBy

string

enum

You can use the sortBy param to sort the responses by the given field.

Allowed:

sortOrder

string

enum

The sortOrder param can be used to specify the sorting order, which can be Ascending (ASC) or Descending (DESC). Descending is the default option.

Allowed:

match

string

enum

You can use the match param to specify if we need to filter the entries using either AND(all) / OR(any). Defaults to AND.

Allowed:

projectId.eq

number

You can use this param to specify some value as project id and the responses will contain exact matches of files that match the given value.

folderId.eq

number

You can use this param to specify some value as folder id and the responses will contain exact matches of files that match the given value.

fileName.eq

string

You can use this param to specify a file name and the responses will contain exact matches of files that match the given name.

fileName.cn

string

You can use this param to specify some file name and the responses will contain files whose name contains the given text.

fileName.nc

string

You can use this param to specify some file name and the responses will not contain files whose name contains the given text.

Responses

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The requested action was successfully executed.

400This error typically happens when the request payload contains an error. If you want to make sure that the request's parameters are named correctly and are the right data types, you can examine the request's syntax.

401You see this error when trying to access this resource without being authenticated. Check the API request header to make sure it is not empty and has a valid api-key that you acquired from the Rocketlane API Settings tab.

500This error denotes that there is an error that occured within our servers. The response body could help narrow down the cause for the error by our support team.