Files Gateway (1.0.0)

Download OpenAPI specification:Download

Files Gateway is an extensible approach to integrating custom files systems with Moveworks’ Copilot Search.

This includes the following features: • Minimal infrastructure. Just bring your APIs. No job scheduling, indexing, caching, storage, etc. • Simplified traversal: Moveworks manages traversal logic (pagination / nested structures) • Multiple MIME types: Index HTML, PDF, DOC, and PPT mime types • Support multiple systems: Build & configure up to 10 different custom systems.

List files

Retrieve files in a specific node, providing features like querying, filtering, and detailed navigational information including parent folder details and direct download URLs.

Request
query Parameters
$filter
string

Filter content items by a condition.

$select
string

Select which properties to include in the response for the content items.

$orderby
string

Order content items by specific fields.

$top
integer

Specify the number of content results to return.

$skip
integer

Skip the first n content results.

Responses
200

Successfully retrieved list of content items with enhanced information.

400

Bad Request - The request could not be understood due to malformed syntax.

401

Unauthorized - Authentication is required and has failed or has not yet been provided.

403

Forbidden - Server understood the request but refuses to authorize it.

404

Not Found - The requested resource could not be found.

429

Too Many Requests - Rate limit exceeded.

get/files
Request samples 
Response samples 
application/json
{
  • "@odata.context": "https://content-gateway-example.com/v1/$metadata#Content",
  • "value": [
    ],
  • "@odata.nextLink": "https://content-gateway-example.com/v1/content?$filter=(category in (retail, sales) and file_type in (pdf, docx))&$top=10&$skip=10&$orderby=createdDateTime desc"
}
Get file metadata
Retrieves metdata for content resource


Request 
path Parameters
id
required
string <uuid> 
Unique identifier for the content item.


 
Responses 
200
Successfully retrieved metadata of content


400
Bad Request - The request could not be understood by the server due to malformed syntax.


401
Unauthorized - Authentication is required and has failed or has not yet been provided.


403
Forbidden - Server understood the request but refuses to authorize it.


404
Not Found - The requested file could not be found.


429
Too Many Requests - Rate limit exceeded.


500
Internal Server Error - The server encountered an unexpected condition that prevented it from fulfilling the request.


get/files/{id}
Request samples 
Response samples 
application/json
{
  • "@odata.context": "https://content-gateway-example.com/v1/$metadata#Content",
  • "value": {
    }
}
Download file
Retrieves and downloads the entire media file based on the specified file ID. A checksum is provided to validate the integrity of the downloaded file.


Request 
path Parameters
id
required
string <uuid> 
Unique identifier for the file to download.


 
Responses 
200
Successfully retrieved the entire file. The response body contains the file data.


400
Bad Request - The request could not be understood by the server due to malformed syntax.


401
Unauthorized - Authentication is required and has failed or has not yet been provided.


403
Forbidden - Server understood the request but refuses to authorize it.


404
Not Found - The requested file could not be found.


429
Too Many Requests - Rate limit exceeded.


500
Internal Server Error - The server encountered an unexpected condition that prevented it from fulfilling the request.


get/files/{id}/download
Request samples 
Response samples 
application/json
{
  • "code": "INTERNAL_SERVER_ERROR",
  • "message": "The server encountered an internal error and was unable to complete your request."
}