src/__fixtures__/json/api/schemas/organisationUnitGroupSet.json
{
"klass": "org.hisp.dhis.organisationunit.OrganisationUnitGroupSet",
"shareable": true,
"identifiableObject": true,
"relativeApiEndpoint": "/organisationUnitGroupSets",
"metadata": true,
"plural": "organisationUnitGroupSets",
"displayName": "Organisation Unit Group Set",
"collectionName": "organisationUnitGroupSets",
"apiEndpoint": "http://localhost:8080/dhis/api/organisationUnitGroupSets",
"nameableObject": true,
"defaultPrivate": false,
"name": "organisationUnitGroupSet",
"namespace": "http://dhis2.org/schema/dxf/2.0",
"href": "http://localhost:8080/dhis/api/schemas/organisationUnitGroupSet",
"singular": "organisationUnitGroupSet",
"persisted": true,
"order": 1130,
"references": [
"org.hisp.dhis.organisationunit.OrganisationUnitGroup",
"org.hisp.dhis.common.DimensionalItemObject",
"org.hisp.dhis.user.User",
"org.hisp.dhis.legend.LegendSet"
],
"authorities": [
{
"type": "CREATE_PUBLIC",
"authorities": ["F_ORGUNITGROUPSET_PUBLIC_ADD"]
},
{
"type": "CREATE_PRIVATE",
"authorities": ["F_ORGUNITGROUPSET_PRIVATE_ADD"]
},
{
"type": "DELETE",
"authorities": ["F_ORGUNITGROUPSET_DELETE"]
}
],
"properties": [
{
"fieldName": "aggregationType",
"simple": true,
"required": false,
"writable": true,
"nameableObject": false,
"klass": "org.hisp.dhis.analytics.AggregationType",
"propertyType": "CONSTANT",
"oneToOne": false,
"attribute": false,
"owner": false,
"readable": true,
"ordered": false,
"identifiableObject": false,
"manyToMany": false,
"collection": false,
"unique": false,
"name": "aggregationType",
"namespace": "http://dhis2.org/schema/dxf/2.0",
"persisted": false,
"manyToOne": false,
"constants": [
"SUM",
"AVERAGE",
"AVERAGE_SUM_ORG_UNIT",
"COUNT",
"STDDEV",
"VARIANCE",
"MIN",
"MAX",
"NONE",
"DEFAULT",
"CUSTOM",
"AVERAGE_SUM_INT",
"AVERAGE_SUM_INT_DISAGGREGATION",
"AVERAGE_INT",
"AVERAGE_INT_DISAGGREGATION",
"AVERAGE_BOOL"
]
},
{
"fieldName": "dimensionType",
"simple": true,
"required": false,
"writable": true,
"nameableObject": false,
"klass": "org.hisp.dhis.common.DimensionType",
"propertyType": "CONSTANT",
"oneToOne": false,
"attribute": false,
"owner": false,
"readable": true,
"ordered": false,
"identifiableObject": false,
"manyToMany": false,
"collection": false,
"unique": false,
"name": "dimensionType",
"namespace": "http://dhis2.org/schema/dxf/2.0",
"persisted": false,
"manyToOne": false,
"constants": [
"DATA_X",
"PROGRAM_DATA_ELEMENT",
"PROGRAM_ATTRIBUTE",
"PROGRAM_INDICATOR",
"DATA_COLLAPSED",
"CATEGORY_OPTION_COMBO",
"ATTRIBUTE_OPTION_COMBO",
"PERIOD",
"ORGANISATION_UNIT",
"CATEGORY_OPTION_GROUP_SET",
"DATA_ELEMENT_GROUP_SET",
"ORGANISATION_UNIT_GROUP_SET",
"CATEGORY",
"STATIC"
]
},
{
"fieldName": "code",
"description": "The unique code for this Object.",
"simple": true,
"required": false,
"writable": true,
"min": 0,
"nameableObject": false,
"klass": "java.lang.String",
"propertyType": "IDENTIFIER",
"oneToOne": false,
"attribute": true,
"owner": true,
"readable": true,
"ordered": false,
"identifiableObject": false,
"max": 50,
"cascade": "none",
"manyToMany": false,
"length": 50,
"collection": false,
"unique": true,
"name": "code",
"persisted": true,
"manyToOne": false,
"constants": []
},
{
"fieldName": "access",
"simple": false,
"required": false,
"writable": true,
"min": 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": 2147483647,
"manyToMany": false,
"collection": false,
"unique": false,
"name": "access",
"namespace": "http://dhis2.org/schema/dxf/2.0",
"persisted": false,
"manyToOne": false,
"constants": []
},
{
"fieldName": "displayName",
"simple": true,
"required": false,
"writable": true,
"min": 0,
"nameableObject": false,
"klass": "java.lang.String",
"propertyType": "TEXT",
"oneToOne": false,
"attribute": false,
"owner": false,
"readable": true,
"ordered": false,
"identifiableObject": false,
"max": 2147483647,
"manyToMany": false,
"collection": false,
"unique": false,
"name": "displayName",
"namespace": "http://dhis2.org/schema/dxf/2.0",
"persisted": false,
"manyToOne": false,
"constants": []
},
{
"fieldName": "publicAccess",
"simple": true,
"required": false,
"writable": true,
"min": 8,
"nameableObject": false,
"klass": "java.lang.String",
"propertyType": "TEXT",
"oneToOne": false,
"attribute": false,
"owner": true,
"readable": true,
"ordered": false,
"identifiableObject": false,
"max": 8,
"cascade": "none",
"manyToMany": false,
"length": 8,
"collection": false,
"unique": false,
"name": "publicAccess",
"namespace": "http://dhis2.org/schema/dxf/2.0",
"persisted": true,
"manyToOne": false,
"constants": []
},
{
"fieldName": "description",
"simple": true,
"required": false,
"writable": true,
"min": 1,
"nameableObject": false,
"klass": "java.lang.String",
"propertyType": "TEXT",
"oneToOne": false,
"attribute": false,
"owner": true,
"readable": true,
"ordered": false,
"identifiableObject": false,
"max": 2147483647,
"cascade": "none",
"manyToMany": false,
"length": 2147483647,
"collection": false,
"unique": false,
"name": "description",
"namespace": "http://dhis2.org/schema/dxf/2.0",
"persisted": true,
"manyToOne": false,
"constants": []
},
{
"fieldName": "displayShortName",
"simple": true,
"required": false,
"writable": true,
"min": 0,
"nameableObject": false,
"klass": "java.lang.String",
"propertyType": "TEXT",
"oneToOne": false,
"attribute": false,
"owner": false,
"readable": true,
"ordered": false,
"identifiableObject": false,
"max": 2147483647,
"manyToMany": false,
"collection": false,
"unique": false,
"name": "displayShortName",
"namespace": "http://dhis2.org/schema/dxf/2.0",
"persisted": false,
"manyToOne": false,
"constants": []
},
{
"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,
"unique": false,
"name": "externalAccess",
"namespace": "http://dhis2.org/schema/dxf/2.0",
"persisted": false,
"manyToOne": false,
"constants": []
},
{
"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,
"cascade": "none",
"manyToMany": false,
"length": 255,
"collection": false,
"unique": false,
"name": "lastUpdated",
"persisted": true,
"manyToOne": false,
"constants": []
},
{
"fieldName": "uid",
"description": "The Unique Identifier for this Object.",
"simple": true,
"required": false,
"writable": true,
"min": 11,
"nameableObject": false,
"klass": "java.lang.String",
"propertyType": "IDENTIFIER",
"oneToOne": false,
"attribute": true,
"owner": true,
"readable": true,
"ordered": false,
"identifiableObject": false,
"max": 11,
"cascade": "none",
"manyToMany": false,
"length": 11,
"collection": false,
"unique": true,
"name": "id",
"persisted": true,
"manyToOne": false,
"constants": []
},
{
"fieldName": "href",
"simple": true,
"required": false,
"writable": true,
"min": 0,
"nameableObject": false,
"klass": "java.lang.String",
"propertyType": "URL",
"oneToOne": false,
"attribute": true,
"owner": false,
"readable": true,
"ordered": false,
"identifiableObject": false,
"max": 2147483647,
"manyToMany": false,
"collection": false,
"unique": false,
"name": "href",
"persisted": false,
"manyToOne": false,
"constants": []
},
{
"relativeApiEndpoint": "/organisationUnitGroups",
"fieldName": "organisationUnitGroups",
"simple": false,
"required": false,
"writable": true,
"collectionName": "organisationUnitGroups",
"min": 0,
"nameableObject": true,
"klass": "java.util.Set",
"propertyType": "COLLECTION",
"oneToOne": false,
"attribute": false,
"href": "http://localhost:8080/dhis/api/schemas/organisationUnitGroup",
"owner": true,
"readable": true,
"ordered": false,
"identifiableObject": true,
"max": 2147483647,
"cascade": "none",
"manyToMany": true,
"collection": true,
"owningRole": "org.hisp.dhis.organisationunit.OrganisationUnitGroupSet.organisationUnitGroups",
"itemPropertyType": "REFERENCE",
"collectionWrapping": true,
"itemKlass": "org.hisp.dhis.organisationunit.OrganisationUnitGroup",
"apiEndpoint": "http://localhost:8080/dhis/api/organisationUnitGroups",
"unique": false,
"name": "organisationUnitGroup",
"namespace": "http://dhis2.org/schema/dxf/2.0",
"persisted": true,
"manyToOne": false,
"constants": []
},
{
"fieldName": "dimension",
"simple": true,
"required": false,
"writable": true,
"min": 0,
"nameableObject": false,
"klass": "java.lang.String",
"propertyType": "TEXT",
"oneToOne": false,
"attribute": false,
"owner": false,
"readable": true,
"ordered": false,
"identifiableObject": false,
"max": 2147483647,
"manyToMany": false,
"collection": false,
"unique": false,
"name": "dimension",
"namespace": "http://dhis2.org/schema/dxf/2.0",
"persisted": false,
"manyToOne": false,
"constants": []
},
{
"fieldName": "displayDescription",
"simple": true,
"required": false,
"writable": true,
"min": 0,
"nameableObject": false,
"klass": "java.lang.String",
"propertyType": "TEXT",
"oneToOne": false,
"attribute": false,
"owner": false,
"readable": true,
"ordered": false,
"identifiableObject": false,
"max": 2147483647,
"manyToMany": false,
"collection": false,
"unique": false,
"name": "displayDescription",
"namespace": "http://dhis2.org/schema/dxf/2.0",
"persisted": false,
"manyToOne": false,
"constants": []
},
{
"fieldName": "userGroupAccesses",
"simple": false,
"required": false,
"writable": true,
"collectionName": "userGroupAccesses",
"min": 0,
"nameableObject": false,
"klass": "java.util.Set",
"propertyType": "COLLECTION",
"oneToOne": false,
"attribute": false,
"owner": true,
"readable": true,
"ordered": false,
"identifiableObject": false,
"max": 2147483647,
"cascade": "none",
"manyToMany": true,
"collection": true,
"owningRole": "org.hisp.dhis.organisationunit.OrganisationUnitGroupSet.userGroupAccesses",
"itemPropertyType": "COMPLEX",
"collectionWrapping": true,
"itemKlass": "org.hisp.dhis.user.UserGroupAccess",
"unique": false,
"name": "userGroupAccess",
"namespace": "http://dhis2.org/schema/dxf/2.0",
"persisted": true,
"manyToOne": false,
"constants": []
},
{
"fieldName": "allItems",
"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,
"unique": false,
"name": "allItems",
"namespace": "http://dhis2.org/schema/dxf/2.0",
"persisted": false,
"manyToOne": false,
"constants": []
},
{
"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,
"cascade": "none",
"manyToMany": false,
"length": 255,
"collection": false,
"unique": false,
"name": "created",
"persisted": true,
"manyToOne": false,
"constants": []
},
{
"fieldName": "attributeValues",
"simple": false,
"required": false,
"writable": true,
"collectionName": "attributeValues",
"min": 0,
"nameableObject": false,
"klass": "java.util.Set",
"propertyType": "COLLECTION",
"oneToOne": false,
"attribute": false,
"owner": true,
"readable": true,
"ordered": false,
"identifiableObject": false,
"max": 2147483647,
"cascade": "delete-orphan",
"manyToMany": true,
"collection": true,
"owningRole": "org.hisp.dhis.organisationunit.OrganisationUnitGroupSet.attributeValues",
"itemPropertyType": "COMPLEX",
"collectionWrapping": true,
"itemKlass": "org.hisp.dhis.attribute.AttributeValue",
"unique": false,
"name": "attributeValue",
"namespace": "http://dhis2.org/schema/dxf/2.0",
"persisted": true,
"manyToOne": false,
"constants": []
},
{
"fieldName": "filter",
"simple": true,
"required": false,
"writable": true,
"min": 0,
"nameableObject": false,
"klass": "java.lang.String",
"propertyType": "TEXT",
"oneToOne": false,
"attribute": false,
"owner": false,
"readable": true,
"ordered": false,
"identifiableObject": false,
"max": 2147483647,
"manyToMany": false,
"collection": false,
"unique": false,
"name": "filter",
"namespace": "http://dhis2.org/schema/dxf/2.0",
"persisted": false,
"manyToOne": false,
"constants": []
},
{
"fieldName": "compulsory",
"simple": true,
"required": true,
"writable": true,
"nameableObject": false,
"klass": "java.lang.Boolean",
"propertyType": "BOOLEAN",
"oneToOne": false,
"attribute": false,
"owner": true,
"readable": true,
"ordered": false,
"identifiableObject": false,
"cascade": "none",
"manyToMany": false,
"length": 255,
"collection": false,
"unique": false,
"name": "compulsory",
"namespace": "http://dhis2.org/schema/dxf/2.0",
"persisted": true,
"manyToOne": false,
"constants": []
},
{
"fieldName": "name",
"description": "The name of this Object. Required and unique.",
"simple": true,
"required": true,
"writable": true,
"min": 1,
"nameableObject": false,
"klass": "java.lang.String",
"propertyType": "TEXT",
"oneToOne": false,
"attribute": true,
"owner": true,
"readable": true,
"ordered": false,
"identifiableObject": false,
"max": 230,
"cascade": "none",
"manyToMany": false,
"length": 230,
"collection": false,
"unique": true,
"name": "name",
"persisted": true,
"manyToOne": false,
"constants": []
},
{
"relativeApiEndpoint": "/legendSets",
"fieldName": "legendSet",
"simple": false,
"required": false,
"writable": true,
"nameableObject": false,
"klass": "org.hisp.dhis.legend.LegendSet",
"propertyType": "REFERENCE",
"oneToOne": false,
"attribute": false,
"href": "http://localhost:8080/dhis/api/schemas/legendSet",
"owner": false,
"readable": true,
"ordered": false,
"identifiableObject": true,
"manyToMany": false,
"collection": false,
"apiEndpoint": "http://localhost:8080/dhis/api/legendSets",
"unique": false,
"name": "legendSet",
"namespace": "http://dhis2.org/schema/dxf/2.0",
"persisted": false,
"manyToOne": false,
"constants": []
},
{
"fieldName": "dataDimension",
"simple": true,
"required": false,
"writable": true,
"nameableObject": false,
"klass": "java.lang.Boolean",
"propertyType": "BOOLEAN",
"oneToOne": false,
"attribute": false,
"owner": true,
"readable": true,
"ordered": false,
"identifiableObject": false,
"cascade": "none",
"manyToMany": false,
"length": 255,
"collection": false,
"unique": false,
"name": "dataDimension",
"namespace": "http://dhis2.org/schema/dxf/2.0",
"persisted": true,
"manyToOne": false,
"constants": []
},
{
"fieldName": "shortName",
"simple": true,
"required": false,
"writable": true,
"min": 1,
"nameableObject": false,
"klass": "java.lang.String",
"propertyType": "TEXT",
"oneToOne": false,
"attribute": true,
"owner": false,
"readable": true,
"ordered": false,
"identifiableObject": false,
"max": 2147483647,
"manyToMany": false,
"collection": false,
"unique": false,
"name": "shortName",
"persisted": false,
"manyToOne": false,
"constants": []
},
{
"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": true,
"readable": true,
"ordered": false,
"identifiableObject": true,
"cascade": "none",
"manyToMany": false,
"length": 255,
"collection": false,
"owningRole": "org.hisp.dhis.organisationunit.OrganisationUnitGroupSet.user",
"apiEndpoint": "http://localhost:8080/dhis/api/users",
"unique": false,
"name": "user",
"namespace": "http://dhis2.org/schema/dxf/2.0",
"persisted": true,
"manyToOne": true,
"constants": []
},
{
"fieldName": "items",
"simple": true,
"required": false,
"writable": true,
"collectionName": "items",
"min": 0,
"nameableObject": true,
"klass": "java.util.List",
"propertyType": "COLLECTION",
"oneToOne": false,
"attribute": false,
"href": "http://localhost:8080/dhis/api/schemas/nameableObject",
"owner": false,
"readable": true,
"ordered": true,
"identifiableObject": true,
"max": 2147483647,
"manyToMany": false,
"collection": true,
"itemPropertyType": "REFERENCE",
"collectionWrapping": true,
"itemKlass": "org.hisp.dhis.common.DimensionalItemObject",
"unique": false,
"name": "item",
"namespace": "http://dhis2.org/schema/dxf/2.0",
"persisted": false,
"manyToOne": false,
"constants": []
}
]
}