9. Metadata fields
This section includes the list of metadata fields used in E2.
9.1. Metadata fields accessibility
The metadata fields stored in an OR, VR, OC, or SR (report, from now on), along with the taxonomy entities and attributes, provide essential information that is automatically populated by the system throughout the report lifecycle. These metadata fields are visible when reports are exported, when they are selected as custom columns in the report lists, utilized in queries, or when API methods are executed.
9.1.1. Metadata fields list
The following table includes the list of the E2 metadata fields:
|
Metadata field name for both Query and Columns/Exports |
Metadata field name in API response |
Description |
|
ºIsActive |
active |
Indicates if the report is currently active. |
|
ºCreationDate |
creationDate |
The date when this version of the report was created. |
|
ºCreationUser |
creationUser |
Identifier of the user who created the report. |
|
ºModificationDate |
lastmodificationDate |
The date when this version of the report was last modified. |
|
ºModificationUser |
lastmodificationUser |
Identifier of the user who last modified the report. |
|
ºIsBlocked |
blocked |
Specifies whether the report is blocked by a process. |
|
ºE2ID |
e2Id |
The |
|
ºHasNotes |
hasNotes |
Indicates whether the report contains any notes. |
|
ºE5zMigrationFile |
e5zName |
Name of the migration file (e5z or e5x). |
|
ºE5zMigrationFileXMLFile |
xmlName |
Name of the XML file inside the migration file (e5z or e5x). |
|
ºORInitialDate |
orInitialDate |
Date the report was first sent (v0.1). |
|
ºVRInitialDate |
vrInitialDate |
Date the report was first validated or manually created (v0.1). |
|
ºOCInitialDate |
ocInitialDate |
Date the report was first processed as an occurrence or created from scratch (v0.1 or V1.0) |
|
ºSRInitialDate |
receivingDate |
Date the report was first submitted as a recommendation. |
|
ºWebformID |
pdfCode |
Code of the webform used to report the case. |
|
ºReporterFirstname |
firstName |
First name of the user who submitted the report. |
|
ºReporterLastname |
lastName |
Last name of the user who submitted the report. |
|
ºReporterTelephone |
telephone |
Telephone number of the user who submitted the report. |
|
ºReporterEmail |
|
Email address of the user who submitted the report. |
|
ºOrganisationID |
organisation_id |
ID of the organisation of the reporting user. |
|
ºOrganisationname |
name |
Name of the organisation of the reporting user. |
|
ºRelatedE2IDs |
relatedReports |
Contains |
|
ºOC_ReportToGeneratedORID |
asOR |
In an OC, the |
|
ºOC_ReportedToAuthorityID |
authorityId |
In an OC, the ID of the authority to which it was reported. |
|
ºOC_ReportToGeneratedORDate |
reportDate |
In an OC, the date the OR was generated from the report. |
|
ºOR_ReportToGeneratedORDate |
reportToDate |
In an OR, the date it was reported to this authority. |
|
ºOR_ReportToGeneratedORAuthorityID |
reportToFromAuthority |
In an OR, the authority that reported it to this one. |
|
ºReportingEntityID |
reportingEntityId |
ID of the entity that submitted the report (attribute 447). |
|
ºReportingMethod |
reportingMethod |
Method used to report the occurrence (e.g., online, e5x). |
|
ºResponsibleEntityID |
responsibleEntityId |
ID of the authority responsible for managing the report (Authority table in MySQL). |
|
ºSharedWithAuthorityIDs |
sharedEntitiesId |
Authority IDs that the report is shared with. |
|
ºSharedWithAuthorityIDsAttachments |
sharedAttachmentsEntitiesId |
Authorities allowed to view attachments in shared reports. |
|
ºSharedWithExclusionAttributes |
deidentifiedTaxonomyCodes |
List of attribute IDs excluded from sharing with the authority. |
|
ºStatus |
status |
Current status of the report (e.g., open, sent, draft). |
|
ºTransferDate |
transferredDate |
Date the report was transferred. |
|
ºTransferFromAuthorityID |
transferredFromAuthority |
Authority from which the report was transferred. |
|
ºConflictingE2ID |
updated |
|
|
ºHasAutomaticChanges |
has_automatic_changes |
Indicates whether automatic changes exist in the report. |
|
ºReportVersion |
version |
Version number of the report. |
|
ºLastSharedECR |
lastSharedEcr |
Date the report was last shared to the ECR |