GOgorules
Document

Get documents by path

Retrieve a document by its file system path.

get/api/projects/{projectId}/documents/path

Request

Path parameters

projectIdstring uuid required

Project unique identifier

Query parameters

pathstring required

Document path to search for

Response

Document matching the specified path

idstring uuid required

Document unique identifier

keystring required

Materialized lowercase path based on the name

pathstring required

Materialized path based on the name

namestring required

Document name

type'f' | 'd' | 'e' required

Document type (file, directory, or external file)

metaobject

Document metadata

contentTypestring

Content MIME type

sizenumber

Document size in bytes

parentIdstring uuid nullable

Parent document ID

projectIdstring uuid required

Project ID

publishedIdstring uuid nullable

Currently published version ID

publishedAtstring nullable

Publication timestamp

updatedAtstring

Last update timestamp

deletedAtstring nullable

Deletion timestamp if soft deleted

Changes

No recorded changes to this operation across all 1 revision of this API.