src/__fixtures__/json/api/schemas/programNotificationTemplate.json
{
"klass": "org.hisp.dhis.program.notification.ProgramNotificationTemplate",
"shareable": false,
"translatable": false,
"relativeApiEndpoint": "/programNotificationTemplates",
"metadata": true,
"identifiableObject": true,
"plural": "programNotificationTemplates",
"displayName": "Program Notification Template",
"collectionName": "programNotificationTemplates",
"implicitPrivateAuthority": false,
"apiEndpoint": "http://localhost:8080/dhis/api/programNotificationTemplates",
"nameableObject": false,
"embeddedObject": false,
"defaultPrivate": false,
"name": "programNotificationTemplate",
"namespace": "http://dhis2.org/schema/dxf/2.0",
"href": "http://localhost:8080/dhis/api/schemas/programNotificationTemplate",
"singular": "programNotificationTemplate",
"persisted": true,
"order": 1508,
"references": [
"org.hisp.dhis.user.UserGroup",
"org.hisp.dhis.trackedentity.TrackedEntityAttribute",
"org.hisp.dhis.user.User"
],
"authorities": [
{
"type": "CREATE",
"authorities": ["F_PROGRAM_ADD"]
},
{
"type": "DELETE",
"authorities": ["F_PROGRAM_DELETE"]
}
],
"properties": [
{
"fieldName": "access",
"simple": false,
"required": false,
"writable": true,
"min": 0.0,
"nameableObject": false,
"klass": "org.hisp.dhis.security.acl.Access",
"propertyType": "COMPLEX",
"oneToOne": false,
"attribute": false,
"owner": false,
"readable": true,
"ordered": false,
"identifiableObject": false,
"max": 1.7976931348623157e308,
"manyToMany": false,
"collection": false,
"embeddedObject": false,
"unique": false,
"name": "access",
"namespace": "http://dhis2.org/schema/dxf/2.0",
"persisted": false,
"manyToOne": false
},
{
"fieldName": "code",
"description": "The unique code for this Object.",
"simple": true,
"required": false,
"writable": true,
"min": 0.0,
"nameableObject": false,
"klass": "java.lang.String",
"propertyType": "IDENTIFIER",
"oneToOne": false,
"attribute": true,
"owner": true,
"readable": true,
"ordered": false,
"identifiableObject": false,
"max": 50.0,
"manyToMany": false,
"length": 50,
"collection": false,
"embeddedObject": false,
"unique": true,
"name": "code",
"persisted": true,
"manyToOne": false
},
{
"fieldName": "displayName",
"simple": true,
"required": false,
"writable": true,
"min": 0.0,
"nameableObject": false,
"klass": "java.lang.String",
"propertyType": "TEXT",
"oneToOne": false,
"attribute": false,
"owner": false,
"readable": true,
"ordered": false,
"identifiableObject": false,
"max": 2.147483647e9,
"manyToMany": false,
"collection": false,
"embeddedObject": false,
"unique": false,
"name": "displayName",
"namespace": "http://dhis2.org/schema/dxf/2.0",
"persisted": false,
"manyToOne": false
},
{
"fieldName": "publicAccess",
"simple": true,
"required": false,
"writable": true,
"min": 8.0,
"nameableObject": false,
"klass": "java.lang.String",
"propertyType": "TEXT",
"oneToOne": false,
"attribute": false,
"owner": false,
"readable": true,
"ordered": false,
"identifiableObject": false,
"max": 8.0,
"manyToMany": false,
"collection": false,
"embeddedObject": false,
"unique": false,
"name": "publicAccess",
"namespace": "http://dhis2.org/schema/dxf/2.0",
"persisted": false,
"manyToOne": false
},
{
"fieldName": "externalAccess",
"simple": true,
"required": false,
"writable": true,
"nameableObject": false,
"klass": "java.lang.Boolean",
"propertyType": "BOOLEAN",
"oneToOne": false,
"attribute": false,
"owner": false,
"readable": true,
"ordered": false,
"identifiableObject": false,
"manyToMany": false,
"collection": false,
"embeddedObject": false,
"unique": false,
"name": "externalAccess",
"namespace": "http://dhis2.org/schema/dxf/2.0",
"persisted": false,
"manyToOne": false
},
{
"fieldName": "lastUpdated",
"description": "The date this object was last updated.",
"simple": true,
"required": false,
"writable": true,
"nameableObject": false,
"klass": "java.util.Date",
"propertyType": "DATE",
"oneToOne": false,
"attribute": true,
"owner": true,
"readable": true,
"ordered": false,
"identifiableObject": false,
"manyToMany": false,
"length": 255,
"collection": false,
"embeddedObject": false,
"unique": false,
"name": "lastUpdated",
"persisted": true,
"manyToOne": false
},
{
"fieldName": "notificationTrigger",
"simple": true,
"required": false,
"writable": true,
"nameableObject": false,
"klass": "org.hisp.dhis.program.notification.NotificationTrigger",
"propertyType": "CONSTANT",
"oneToOne": false,
"attribute": false,
"owner": true,
"readable": true,
"ordered": false,
"identifiableObject": false,
"manyToMany": false,
"length": 255,
"collection": false,
"embeddedObject": false,
"unique": false,
"name": "notificationTrigger",
"namespace": "http://dhis2.org/schema/dxf/2.0",
"persisted": true,
"manyToOne": false,
"constants": [
"ENROLLMENT",
"COMPLETION",
"SCHEDULED_DAYS_DUE_DATE",
"SCHEDULED_DAYS_INCIDENT_DATE",
"SCHEDULED_DAYS_ENROLLMENT_DATE"
]
},
{
"fieldName": "translations",
"simple": false,
"required": false,
"writable": true,
"collectionName": "translations",
"min": 0.0,
"nameableObject": false,
"klass": "java.util.Set",
"propertyType": "COLLECTION",
"oneToOne": false,
"attribute": false,
"owner": false,
"readable": true,
"ordered": false,
"identifiableObject": false,
"max": 1.7976931348623157e308,
"manyToMany": false,
"collection": true,
"itemPropertyType": "COMPLEX",
"collectionWrapping": true,
"itemKlass": "org.hisp.dhis.translation.ObjectTranslation",
"embeddedObject": false,
"unique": false,
"name": "translation",
"namespace": "http://dhis2.org/schema/dxf/2.0",
"persisted": false,
"manyToOne": false
},
{
"fieldName": "relativeScheduledDays",
"simple": true,
"required": false,
"writable": true,
"min": -2.147483648e9,
"nameableObject": false,
"klass": "java.lang.Integer",
"propertyType": "INTEGER",
"oneToOne": false,
"attribute": false,
"owner": true,
"readable": true,
"ordered": false,
"identifiableObject": false,
"max": 2.147483647e9,
"manyToMany": false,
"length": 2147483647,
"collection": false,
"embeddedObject": false,
"unique": false,
"name": "relativeScheduledDays",
"namespace": "http://dhis2.org/schema/dxf/2.0",
"persisted": true,
"manyToOne": false
},
{
"fieldName": "href",
"simple": true,
"required": false,
"writable": true,
"min": 0.0,
"nameableObject": false,
"klass": "java.lang.String",
"propertyType": "URL",
"oneToOne": false,
"attribute": true,
"owner": false,
"readable": true,
"ordered": false,
"identifiableObject": false,
"max": 1.7976931348623157e308,
"manyToMany": false,
"collection": false,
"embeddedObject": false,
"unique": false,
"name": "href",
"persisted": false,
"manyToOne": false
},
{
"fieldName": "subjectTemplate",
"simple": true,
"required": false,
"writable": true,
"min": 0.0,
"nameableObject": false,
"klass": "java.lang.String",
"propertyType": "TEXT",
"oneToOne": false,
"attribute": false,
"owner": true,
"readable": true,
"ordered": false,
"identifiableObject": false,
"max": 100.0,
"manyToMany": false,
"length": 100,
"collection": false,
"embeddedObject": false,
"unique": false,
"name": "subjectTemplate",
"namespace": "http://dhis2.org/schema/dxf/2.0",
"persisted": true,
"manyToOne": false
},
{
"fieldName": "uid",
"description": "The Unique Identifier for this Object.",
"simple": true,
"required": false,
"writable": true,
"min": 11.0,
"nameableObject": false,
"klass": "java.lang.String",
"propertyType": "IDENTIFIER",
"oneToOne": false,
"attribute": true,
"owner": true,
"readable": true,
"ordered": false,
"identifiableObject": false,
"max": 11.0,
"manyToMany": false,
"length": 11,
"collection": false,
"embeddedObject": false,
"unique": true,
"name": "id",
"persisted": true,
"manyToOne": false
},
{
"relativeApiEndpoint": "/users",
"fieldName": "lastUpdatedBy",
"simple": false,
"required": false,
"writable": true,
"nameableObject": false,
"klass": "org.hisp.dhis.user.User",
"propertyType": "REFERENCE",
"oneToOne": false,
"attribute": false,
"href": "http://localhost:8080/dhis/api/schemas/user",
"owner": true,
"readable": true,
"ordered": false,
"identifiableObject": true,
"cascade": "none",
"manyToMany": false,
"length": 255,
"collection": false,
"owningRole": "org.hisp.dhis.program.notification.ProgramNotificationTemplate.lastUpdatedBy",
"apiEndpoint": "http://localhost:8080/dhis/api/users",
"embeddedObject": false,
"unique": false,
"name": "lastUpdatedBy",
"namespace": "http://dhis2.org/schema/dxf/2.0",
"persisted": true,
"manyToOne": true
},
{
"fieldName": "userGroupAccesses",
"simple": false,
"required": false,
"writable": true,
"collectionName": "userGroupAccesses",
"min": 0.0,
"nameableObject": false,
"klass": "java.util.Set",
"propertyType": "COLLECTION",
"oneToOne": false,
"attribute": false,
"owner": false,
"readable": true,
"ordered": false,
"identifiableObject": false,
"max": 1.7976931348623157e308,
"manyToMany": false,
"collection": true,
"itemPropertyType": "COMPLEX",
"collectionWrapping": true,
"itemKlass": "org.hisp.dhis.user.UserGroupAccess",
"embeddedObject": true,
"unique": false,
"name": "userGroupAccess",
"namespace": "http://dhis2.org/schema/dxf/2.0",
"persisted": false,
"manyToOne": false
},
{
"fieldName": "deliveryChannels",
"simple": true,
"required": false,
"writable": true,
"collectionName": "deliveryChannels",
"min": 0.0,
"nameableObject": false,
"klass": "java.util.Set",
"propertyType": "COLLECTION",
"oneToOne": false,
"attribute": false,
"owner": true,
"readable": true,
"ordered": false,
"identifiableObject": false,
"max": 1.7976931348623157e308,
"cascade": "none",
"manyToMany": false,
"collection": true,
"owningRole": "org.hisp.dhis.program.notification.ProgramNotificationTemplate.deliveryChannels",
"itemPropertyType": "CONSTANT",
"itemKlass": "org.hisp.dhis.common.DeliveryChannel",
"embeddedObject": false,
"unique": false,
"name": "deliveryChannels",
"namespace": "http://dhis2.org/schema/dxf/2.0",
"persisted": true,
"manyToOne": false
},
{
"fieldName": "created",
"description": "The date this object was created.",
"simple": true,
"required": false,
"writable": true,
"nameableObject": false,
"klass": "java.util.Date",
"propertyType": "DATE",
"oneToOne": false,
"attribute": true,
"owner": true,
"readable": true,
"ordered": false,
"identifiableObject": false,
"manyToMany": false,
"length": 255,
"collection": false,
"embeddedObject": false,
"unique": false,
"name": "created",
"persisted": true,
"manyToOne": false
},
{
"fieldName": "attributeValues",
"simple": false,
"required": false,
"writable": true,
"collectionName": "attributeValues",
"min": 0.0,
"nameableObject": false,
"klass": "java.util.Set",
"propertyType": "COLLECTION",
"oneToOne": false,
"attribute": false,
"owner": false,
"readable": true,
"ordered": false,
"identifiableObject": false,
"max": 1.7976931348623157e308,
"manyToMany": false,
"collection": true,
"itemPropertyType": "COMPLEX",
"collectionWrapping": true,
"itemKlass": "org.hisp.dhis.attribute.AttributeValue",
"embeddedObject": false,
"unique": false,
"name": "attributeValue",
"namespace": "http://dhis2.org/schema/dxf/2.0",
"persisted": false,
"manyToOne": false
},
{
"fieldName": "notificationRecipient",
"simple": true,
"required": false,
"writable": true,
"nameableObject": false,
"klass": "org.hisp.dhis.program.notification.ProgramNotificationRecipient",
"propertyType": "CONSTANT",
"oneToOne": false,
"attribute": false,
"owner": true,
"readable": true,
"ordered": false,
"identifiableObject": false,
"manyToMany": false,
"length": 255,
"collection": false,
"embeddedObject": false,
"unique": false,
"name": "notificationRecipient",
"namespace": "http://dhis2.org/schema/dxf/2.0",
"persisted": true,
"manyToOne": false,
"constants": [
"TRACKED_ENTITY_INSTANCE",
"ORGANISATION_UNIT_CONTACT",
"USERS_AT_ORGANISATION_UNIT",
"USER_GROUP",
"PROGRAM_ATTRIBUTE"
]
},
{
"relativeApiEndpoint": "/trackedEntityAttributes",
"fieldName": "recipientProgramAttribute",
"simple": false,
"required": false,
"writable": true,
"nameableObject": true,
"klass": "org.hisp.dhis.trackedentity.TrackedEntityAttribute",
"propertyType": "REFERENCE",
"oneToOne": false,
"attribute": false,
"href": "http://localhost:8080/dhis/api/schemas/trackedEntityAttribute",
"owner": true,
"readable": true,
"ordered": false,
"identifiableObject": true,
"cascade": "none",
"manyToMany": false,
"length": 255,
"collection": false,
"owningRole": "org.hisp.dhis.program.notification.ProgramNotificationTemplate.recipientProgramAttribute",
"apiEndpoint": "http://localhost:8080/dhis/api/trackedEntityAttributes",
"embeddedObject": false,
"unique": false,
"name": "recipientProgramAttribute",
"namespace": "http://dhis2.org/schema/dxf/2.0",
"persisted": true,
"manyToOne": true
},
{
"fieldName": "userAccesses",
"simple": false,
"required": false,
"writable": true,
"collectionName": "userAccesses",
"min": 0.0,
"nameableObject": false,
"klass": "java.util.Set",
"propertyType": "COLLECTION",
"oneToOne": false,
"attribute": false,
"owner": false,
"readable": true,
"ordered": false,
"identifiableObject": false,
"max": 1.7976931348623157e308,
"manyToMany": false,
"collection": true,
"itemPropertyType": "COMPLEX",
"collectionWrapping": true,
"itemKlass": "org.hisp.dhis.user.UserAccess",
"embeddedObject": true,
"unique": false,
"name": "userAccess",
"namespace": "http://dhis2.org/schema/dxf/2.0",
"persisted": false,
"manyToOne": false
},
{
"fieldName": "name",
"translationKey": "NAME",
"description": "The name of this Object. Required and unique.",
"simple": true,
"required": true,
"writable": true,
"min": 1.0,
"nameableObject": false,
"klass": "java.lang.String",
"propertyType": "TEXT",
"oneToOne": false,
"attribute": true,
"owner": true,
"readable": true,
"ordered": false,
"identifiableObject": false,
"max": 2.147483647e9,
"manyToMany": false,
"length": 230,
"collection": false,
"embeddedObject": false,
"unique": false,
"name": "name",
"persisted": true,
"manyToOne": false
},
{
"relativeApiEndpoint": "/users",
"fieldName": "user",
"simple": false,
"required": false,
"writable": true,
"nameableObject": false,
"klass": "org.hisp.dhis.user.User",
"propertyType": "REFERENCE",
"oneToOne": false,
"attribute": false,
"href": "http://localhost:8080/dhis/api/schemas/user",
"owner": false,
"readable": true,
"ordered": false,
"identifiableObject": true,
"manyToMany": false,
"collection": false,
"apiEndpoint": "http://localhost:8080/dhis/api/users",
"embeddedObject": false,
"unique": false,
"name": "user",
"namespace": "http://dhis2.org/schema/dxf/2.0",
"persisted": false,
"manyToOne": false
},
{
"relativeApiEndpoint": "/userGroups",
"fieldName": "recipientUserGroup",
"simple": false,
"required": false,
"writable": true,
"nameableObject": false,
"klass": "org.hisp.dhis.user.UserGroup",
"propertyType": "REFERENCE",
"oneToOne": false,
"attribute": false,
"href": "http://localhost:8080/dhis/api/schemas/userGroup",
"owner": true,
"readable": true,
"ordered": false,
"identifiableObject": true,
"cascade": "none",
"manyToMany": false,
"length": 255,
"collection": false,
"owningRole": "org.hisp.dhis.program.notification.ProgramNotificationTemplate.recipientUserGroup",
"apiEndpoint": "http://localhost:8080/dhis/api/userGroups",
"embeddedObject": false,
"unique": false,
"name": "recipientUserGroup",
"namespace": "http://dhis2.org/schema/dxf/2.0",
"persisted": true,
"manyToOne": true
},
{
"fieldName": "messageTemplate",
"simple": true,
"required": true,
"writable": true,
"min": 1.0,
"nameableObject": false,
"klass": "java.lang.String",
"propertyType": "TEXT",
"oneToOne": false,
"attribute": false,
"owner": true,
"readable": true,
"ordered": false,
"identifiableObject": false,
"max": 10000.0,
"manyToMany": false,
"length": 2147483647,
"collection": false,
"embeddedObject": false,
"unique": false,
"name": "messageTemplate",
"namespace": "http://dhis2.org/schema/dxf/2.0",
"persisted": true,
"manyToOne": false
}
]
}