avid.common.artefact.generator.generateArtefactEntry

avid.common.artefact.generator.generateArtefactEntry(case, caseInstance, timePoint, actionTag, artefactType, artefactFormat, url=None, objective=None, invalid=False, **additionalProps)

REMARK: This is a deprecated version. With less default and different order of arguments in signature. Use the new version generate_artefact_entry if possible.

This is a generic method to generate an arbitrary artefact entry. dict (**kwargs) can be used to pass additional infos for the dict entry :param case: Case ID for the artefact (e.g. Patient ID). May be set to None to indicate that it is a general artefact (not case specific). :param caseInstance: ID of a case instance. May be set to None to indicate that the artefact has/is no variation :param timePoint: Timepoint the artefact is corelated with. Should be an ordinal type (e.g. int or str) :param actionTag: Tag of the action that generates/generated the artefact. :param artefactType: Type of the artefact (e.g. “result”, “config”, “misc”) :param artefactFormat: Formate the artefact is stored as :param url: Location where the artefact is stored :param objective: The objective of the artefact (may be set to None) :param invalid: Indicates if the artefact is valid (e.g. correctly stored) :param additionalProps: additional properties you want to add to the artefact entry