IRPCDeclarativeMetadataStructure.GetDeclarativeMetadataStructure

View as Markdown

Administration API / specialized admin session returns metadata structure version

Gets the vault's current metadata structure as a declarative JSON document.

ServiceDeclarative metadata structure MFiles.IRPCDeclarativeMetadataStructure
gRPC method/MFiles.IRPCDeclarativeMetadataStructure/GetDeclarativeMetadataStructure
HTTP (mf-http-grpc)POST /grpc/v1/get-declarative-metadata-structure
RequestGetDeclarativeMetadataStructureRequest
ResponseGetDeclarativeMetadataStructureResponse
Book and levelAdministration API, specialized
Kindadmin
SessionRequired: the session ID from LogIn in the mfiles-session-id-bin metadata.
Idempotentno
Returns metadata structure versionyes (in the mfiles-metadata-version-bin trailer)
Streamingnone (unary)

Remarks

Request: GetDeclarativeMetadataStructureRequest

Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.

FieldTypeDescription
revisionint32Not used by the server; the current structure is returned.

Response: GetDeclarativeMetadataStructureResponse

Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.

FieldTypeDescription
declmdsstringThe declarative metadata structure document (JSON text). Its format is described by GenerateDeclarativeMetadataStructureSchema.