Skip to main content
JSON Manual Created Edited

Active

Input URI

{base url} + view/ACTIVE



Active Methods

POST



JSON Schema

Details

{
    "ACTIVE": {
        "$schema": "http://json-schema.org/draft-07/schema#",
        "type": "object",
        "properties": {
            "Argument": {
                "type": "object",
                "properties": {
                    "ACTIVE_MODE": {
                        "type": "string",
                        "description": "ActiveModeType",
                        "enum": [
                            "All",
                            "Active",
                            "Identity"
                        ]
                    },
                    "N_LIST": {
                        "type": "array",
                        "items": {
                            "type": "integer"
                        },
                        "description": "NodeNumberList"
                    },
                    "E_LIST": {
                        "type": "array",
                        "items": {
                            "type": "integer"
                        },
                        "description": "ElementNumberList"
                    },
                    "IDENTITY_TYPE": {
                        "type": "string",
                        "description": "IdentityType",
                        "enum": [
                            "Group",
                            "NamedPlane",
                            "LoadGroup",
                            "BoundaryGroup"
                        ]
                    },
                    "IDENTITY_LIST": {
                        "type": "array",
                        "items": {
                            "type": "string"
                        }
                    }
                }
            }
        }
    }
}


Examples

Active Mode 1 - All

{
    "Argument": {
        "ACTIVE_MODE": "All"
    }
}

Active Mode 2 - Active by Node/Element

{
    "Argument": {
        "ACTIVE_MODE": "Active",
        "N_LIST": [
            469,
            770,
            772,
            773
        ],
        "E_LIST": [
            1631,
            1646,
            1654
        ]
    }
}

Active Mode 3 - Active by Identity

{
    "Argument": {
        "ACTIVE_MODE": "Identity",
        "IDENTITY_TYPE": "BoundaryGroup",
        "IDENTITY_LIST": [
            "Support",
            "Support2",
            "Support3"
        ]
    }
}


Specifications

No. Description Key Value Type Default Required

Active Mode 1 - All

1

Active Mode Type

 • Active All: "All"

"ACTIVE_MODE"

String

-

Required

Active Mode 2 - Active by Node/Element

1

Active Mode Type

 • Active by Node/element: "Active"

"ACTIVE_MODE"

String

-

Required

2

Node Number List

"N_LIST"

Integer

-

Required

3

Element Number List

"E_LIST"

Integer

-

Required

Active Mode 3 - Active by Identity

1

Active Mode Type

 • Active by Identity: "Identity"

"ACTIVE_MODE"

String

-

Required

2

Identity Type (if defined)

 • Structure Group: "Group"

 • Named Plane: "Named Plane"

 • Load Group: "Load Group"

 • Boundary Group: "Boundary Group"

"IDENTITY_TYPE"

String

-

Required

3

Identity List

"IDENTITY_LIST"

String

-

Required



0
Was this article helpful?