Docs navigationv

Core concepts

API reference

Primitive

surface.extract

BETA

Short name: extract

Version: 1.0.0

Extract a permission-trimmed surface.v1 manifest for a collection within an organization.

Back to primitive library

Inputs

Key	Type	Required	Description
collectionAtomId	objectId	false	-
collectionSlug	string	false	-
format	string	false	-
include	object	false	-
orgAtomId	objectId	true	-

Outputs

Key	Type	Required	Description
collection	object	false	-
conventions	array	false	-
examples	array	false	-
format	string	false	-
generatedAt	string	false	-
hash	string	false	-
lexemes	array	false	-
org	object	false	-
permissions	array	false	-
pixels	array	false	-
relationships	array	false	-
schemaVersion	number	false	-
summary	object	false	-
trimmed	boolean	false	-
verbs	array	false	-
warnings	array	false	-