fimidara — docs

`/v1/files/readFile/:filepathOrId`

—

`post`

Path Parameters

—Optional

Field	Type	Required	Description
`filepathOrId`	`string`	No	File path with workspace rootname (case insensitive) or file ID Example: /workspace-rootname/folder/file.ext or file000-remaining-file-id

Request Headers

HttpEndpointRequestHeaders_AuthOptional_JsonContentType

—Optional

Field	Type	Required	Description
`Authorization`	`string`	No	Access token Example: Bearer <token>
`Content-Type`	`string`	Yes	HTTP JSON request content type Example: application/json

Request Query

—Optional

Field	Type	Required	Description
`w`	`number`	No	Resize to width if file is an image Number subset: `floating point` or `integer`
`h`	`number`	No	Resize to height if file is an image Number subset: `floating point` or `integer`
`pos`	`string` or `number`	No	Gravity or strategy to use when fit is cover or contain Enum: `topright toprightright bottombottomleft bottomleftleft topnorthnortheasteastsoutheastsouthsouthwestwestnorthwestcentreentropyattention` Position to use when fit is cover or contain Number subset: `floating point` or `integer`
`fit`	`string`	No	How the image should be resized to fit provided dimensions Enum: `containcoverfillinsideoutside`
`bg`	`string`	No	Hex background color to use when fit is contain Example: #FFFFFF
`withoutEnlargement`	`boolean`	No	Do not enlarge if the width or height are already less than provided dimensions
`format`	`string`	No	Format to transform image to if file is an image Enum: `jpegpngwebptiffraw`
`download`	`boolean`	No	Whether the server should add "Content-Disposition: attachment" header which forces browsers to download files like HTML, JPEG, etc. which it'll otherwise open in the browser

Request Body

ReadFileEndpointParams

—Optional

{

filepath?: string

fileId?: string

imageResize?: ImageResizeParams

imageFormat?: string

download?: boolean

}

ImageResizeParams

—Optional

{

width?: number

height?: number

fit?: string

position?: string | number

background?: string

withoutEnlargement?: boolean

}

200 — Response Headers

—Optional

Field	Type	Required	Description
`Content-Type`	`string`	Yes	Get file endpoint result content type. If request is successful, it will be the file's content type if it is known or application/octet-stream otherwise, and application/json containing errors if request fails
`Content-Length`	`string`	Yes	HTTP response content length in bytes
`Content-Disposition`	`string`	No	HTTP response content disposition

200 — Response Body

binary

4XX or 5XX — Response Headers

HttpEndpointResponseHeaders_ContentType_ContentLength

—Optional

Field	Type	Required	Description
`Content-Type`	`string`	Yes	HTTP JSON response content type Example: application/json
`Content-Length`	`string`	Yes	HTTP response content length in bytes

4XX or 5XX — Response Body

EndpointErrorResult

—Optional

Endpoint error result

{

errors?: Array<OperationError>

}

OperationError

—Optional

{

name: string

message: string

action?: string

field?: string

notes?: Array<EndpointResultNote>

}

EndpointResultNote

—Optional

{

code: string

message: string

}

`/v1/files/readFile/:filepathOrId`

—

`post`

Path Parameters

—Optional

Field	Type	Required	Description
`filepathOrId`	`string`	No	File path with workspace rootname (case insensitive) or file ID Example: /workspace-rootname/folder/file.ext or file000-remaining-file-id

Request Headers

HttpEndpointRequestHeaders_AuthOptional_JsonContentType

—Optional

Field	Type	Required	Description
`Authorization`	`string`	No	Access token Example: Bearer <token>
`Content-Type`	`string`	Yes	HTTP JSON request content type Example: application/json

Request Query

—Optional

Field	Type	Required	Description
`w`	`number`	No	Resize to width if file is an image Number subset: `floating point` or `integer`
`h`	`number`	No	Resize to height if file is an image Number subset: `floating point` or `integer`
`pos`	`string` or `number`	No	Gravity or strategy to use when fit is cover or contain Enum: `topright toprightright bottombottomleft bottomleftleft topnorthnortheasteastsoutheastsouthsouthwestwestnorthwestcentreentropyattention` Position to use when fit is cover or contain Number subset: `floating point` or `integer`
`fit`	`string`	No	How the image should be resized to fit provided dimensions Enum: `containcoverfillinsideoutside`
`bg`	`string`	No	Hex background color to use when fit is contain Example: #FFFFFF
`withoutEnlargement`	`boolean`	No	Do not enlarge if the width or height are already less than provided dimensions
`format`	`string`	No	Format to transform image to if file is an image Enum: `jpegpngwebptiffraw`
`download`	`boolean`	No	Whether the server should add "Content-Disposition: attachment" header which forces browsers to download files like HTML, JPEG, etc. which it'll otherwise open in the browser

Request Body

ReadFileEndpointParams

—Optional

{

filepath?: string

fileId?: string

imageResize?: ImageResizeParams

imageFormat?: string

download?: boolean

}

ImageResizeParams

—Optional

{

width?: number

height?: number

fit?: string

position?: string | number

background?: string

withoutEnlargement?: boolean

}

200 — Response Headers

—Optional

Field	Type	Required	Description
`Content-Type`	`string`	Yes	Get file endpoint result content type. If request is successful, it will be the file's content type if it is known or application/octet-stream otherwise, and application/json containing errors if request fails
`Content-Length`	`string`	Yes	HTTP response content length in bytes
`Content-Disposition`	`string`	No	HTTP response content disposition

200 — Response Body

binary

4XX or 5XX — Response Headers

HttpEndpointResponseHeaders_ContentType_ContentLength

—Optional

Field	Type	Required	Description
`Content-Type`	`string`	Yes	HTTP JSON response content type Example: application/json
`Content-Length`	`string`	Yes	HTTP response content length in bytes

4XX or 5XX — Response Body

EndpointErrorResult

—Optional

Endpoint error result

{

errors?: Array<OperationError>

}

OperationError

—Optional

{

name: string

message: string

action?: string

field?: string

notes?: Array<EndpointResultNote>

}

EndpointResultNote

—Optional

{

code: string

message: string

}

/v1/files/readFile/:filepathOrId

post

Path Parameters

Request Headers

HttpEndpointRequestHeaders_AuthOptional_JsonContentType

Request Query

Request Body

ReadFileEndpointParams

ImageResizeParams

200 — Response Headers

200 — Response Body

4XX or 5XX — Response Headers

HttpEndpointResponseHeaders_ContentType_ContentLength

4XX or 5XX — Response Body

EndpointErrorResult

OperationError

EndpointResultNote

Loading...

/v1/files/readFile/:filepathOrId

post

Path Parameters

Request Headers

HttpEndpointRequestHeaders_AuthOptional_JsonContentType

Request Query

Request Body

ReadFileEndpointParams

ImageResizeParams

200 — Response Headers

200 — Response Body

4XX or 5XX — Response Headers

HttpEndpointResponseHeaders_ContentType_ContentLength

4XX or 5XX — Response Body

EndpointErrorResult

OperationError

EndpointResultNote

`/v1/files/readFile/:filepathOrId`

`post`

`/v1/files/readFile/:filepathOrId`

`post`