Relationship Options Schema

relationship.json

{
    "copyright": "© Sutoiku, Inc. 2013",
    "title": "Relationship Options Schema",
    "type": "object",
    "properties": {
        "stc_target_object": {
            "stc_datatype": "stc_relationship",
            "stc_name": "Target object",
            "stc_description": "Target objet for the relationship.",
            "stc_required": true,
            "stc_advanced": false,
            "stc_position": 1,
            "stc_options": {
                "stc_target_object": "stc_object",
                "stc_identifier": true
            }
        },
        "stc_group_by": {
            "stc_datatype": "stc_relationship",
            "stc_name": "Group by",
            "stc_description": "Field of the target object against which source records should be grouped.",
            "stc_required": false,
            "stc_advanced": true,
            "stc_position": 2,
            "stc_options": {
                "stc_target_object": "stc_field"
            }
        },
        "stc_identifier": {
            "stc_datatype": "stc_boolean",
            "stc_name": "Identifier",
            "stc_description": "Whether the relation should be stored with an identifier instead of a UUID.",
            "stc_default": false,
            "stc_required": false,
            "stc_advanced": true,
            "stc_position": 3
        },
        "stc_reverse_singular_name": {
            "stc_datatype": "stc_string",
            "stc_name": "Reverse singular name",
            "stc_description": "Singular name of reverse relations.",
            "stc_required": false,
            "stc_advanced": true,
            "stc_position": 4
        },
        "stc_reverse_plural_name": {
            "stc_datatype": "stc_string",
            "stc_name": "Reverse plural name",
            "stc_description": "Plural name of reverse relations.",
            "stc_required": false,
            "stc_advanced": true,
            "stc_position": 5
        },
        "stc_root": {
            "stc_datatype": "stc_json",
            "stc_name": "Root",
            "stc_description": "Description of the roots of the optional hierarchy defined by the relationship.",
            "stc_required": false,
            "stc_advanced": true,
            "stc_position": 6,
            "stc_options": {
                "stc_schema": {
                    "title": "Hierarchical Root Schema",
                    "type": "object",
                    "properties": {
                        "stc_name": {
                            "stc_datatype": "stc_string",
                            "stc_name": "Name",
                            "stc_description": "Singular name of roots.",
                            "stc_required": true,
                            "stc_advanced": false,
                            "stc_position": 1
                        },
                        "stc_plural_name": {
                            "stc_datatype": "stc_string",
                            "stc_name": "Plural name",
                            "stc_description": "Plural name of roots.",
                            "stc_required": true,
                            "stc_advanced": false,
                            "stc_position": 2
                        },
                        "stc_identifier": {
                            "stc_datatype": "stc_identifier",
                            "stc_name": "Identifier",
                            "stc_description": "Identifier of the root entity defined by the optional hierarchy.",
                            "stc_required": true,
                            "stc_advanced": false,
                            "stc_position": 3
                        }
                    }
                }
            }
        },
        "stc_inheritance": {
            "stc_datatype": "stc_category",
            "stc_name": "Inheritance",
            "stc_description": "Direction of hierarchical inheritance.",
            "stc_default": "stc_descending",
            "stc_required": false,
            "stc_advanced": true,
            "stc_position": 7,
            "stc_options": [
                {
                    "stc_name": "Ascending",
                    "stc_identifier": "stc_ascending",
                    "stc_color": "#00a1c2",
                    "stc_icon": "icon-arrow-up"
                },
                {
                    "stc_name": "Descending",
                    "stc_identifier": "stc_descending",
                    "stc_color": "#27a64c",
                    "stc_icon": "icon-arrow-down"
                }
            ]
        }
    }
}