pyocf.objects.document

Object describing a document

pydantic model pyocf.objects.document.Document

Object describing a document

field comments: Annotated[list[str], FieldInfo(annotation=NoneType, required=True, description='Unstructured text comments related to and stored for the object')] | None = None

field id: Annotated[str, FieldInfo(annotation=NoneType, required=True, description='Identifier for the object')] [Required]: Identifier for the object

field md5: Annotated[Md5, FieldInfo(annotation=NoneType, required=True, description='MD5 file checksum')] [Required]: MD5 file checksum

field object_type: Annotated[Literal['DOCUMENT'], FieldInfo(annotation=NoneType, required=True, description='')] = 'DOCUMENT'

field path: Annotated[str, FieldInfo(annotation=NoneType, required=True, description="Relative path/filename for the document. Path is understood to be a relativelocation within an associated ZIP archive (packaged separately from the OCFarchive) e.g. './acceptance_records/John_Wayne_2017_Grant_Agreement.pdf'")] | None = None

field related_objects: Annotated[list[ObjectReference], FieldInfo(annotation=NoneType, required=True, description='List of objects which this document is related to')] | None = None

field uri: Annotated[str, FieldInfo(annotation=NoneType, required=True, description='Uniform resource identifier for the document if not using the `path` propertyand associated ZIP archive separate from the OCF package.')] | None = None