Skip to main content
Version: 2.0

GraphGrid Manager

Platform Version 2.0

API Version 1.0

Introduction​

GraphGrid Manager provides management of the graph data model and Showmes which offer dynamic APIs created with Geequel. Showmes allow dynamic APIs to be created using only Geequel. They support the most common REST methods and return data translated from the Geequel query as JSON. Showmes can be secured to perform authentication and authorization challenges using Geequel. Click here to learn more about Showmes. Graphgrid Manager maintains the Manager Model. Manager models allow you to create specifications for a graph.

API​

This Manager API version is 1.0 and as such all endpoints are rooted at /1.0/. For example, http://localhost/1.0/manager (requires auth) would be the base context for this Manager API under the GraphGrid API deployed at http://localhost.

Environment​

Manager requires the following integrations: ONgDB 1.0+

Manager​

Get Status​

Check the status of GraphGrid Manager. Will return a 200 OK response if healthy.

Base URL: /1.0/manager/status
Method: GET

Request​

curl --location '${API_BASE}/1.0/manager/status'

Response​

200 OK

Create Manager​

Create a new Manager

Base URL: /1.0/manager/{{orgGrn}}
Method: POST

curl --location --request POST "${API_BASE}/1.0/manager/grn:gg:org:jvaPm1O4dpmBKjfH2keCQnIAJBmRrzQUn4bewEYSyBq" \
--header 'Content-Type: application/json' \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--data-raw '{
    "name":"default"
}'

Response:

{
    "manager": {
        "id": 72336,
        "labels": [],
        "enver": 0,
        "createdAt": "2021-07-12T16:51:30.137Z",
        "updatedAt": "2021-07-12T16:51:30.137Z",
        "createdBy": "graphgrid",
        "lastModifiedBy": "graphgrid",
        "grn": "grn:gg:manager:FqajEFvvhlrUB2hdn2GrzWyLaIg8LwnsRgV0KIFERDNY",
        "name": "default",
        "org": null,
        "grnType": "manager",
        "label": "Manager"
    }
}

Get Manager​

Return a manager

Base URL: /1.0/manager/{{managerGrn}}
Method: GET

curl --location --request GET "${API_BASE}/1.0/manager/grn:gg:manager:ZR56HEjCFsQkJ5ohbxM1YrcxCSbjGsQNeMEw2djWq2pC" \
--header "Authorization: Bearer ${BEARER_TOKEN}"

Response:

{
    "manager": {
        "id": 67689,
        "labels": [],
        "enver": 0,
        "createdAt": "2021-07-12T16:54:17.733Z",
        "updatedAt": "2021-07-12T16:54:17.733Z",
        "createdBy": "graphgrid",
        "lastModifiedBy": "graphgrid",
        "grn": "grn:gg:manager:ZR56HEjCFsQkJ5ohbxM1YrcxCSbjGsQNeMEw2djWq2pC",
        "name": "default",
        "org": null,
        "grnType": "manager",
        "label": "Manager"
    }
}

Get Manager by Name​

Return a manager node by its name. The default manager name is 'default`

Base URL: /1.0/manager/{{managerName}}
Method: GET

curl --location '${API_BASE}/1.0/manager/name/default' \
--header 'Authorization: ${BEARER_TOKEN}'

Response: 

{
    "manager": {
        "id": 21,
        "labels": [],
        "enver": 0,
        "createdAt": "2024-02-19T18:25:48.2548Z",
        "updatedAt": "2024-02-19T18:25:48.2548Z",
        "createdBy": "graphgrid",
        "lastModifiedBy": "graphgrid",
        "grn": "grn:gg:manager:default",
        "name": "default",
        "org": null,
        "grnType": "manager",
        "label": "Manager"
    }
}

Delete Manager​

Delete a manager

Base URL: /1.0/manager/{{managerGrn}}
Method: DELETE

curl --location --request DELETE "${API_BASE}/1.0/manager/grn:gg:manager:FqajEFvvhlrUB2hdn2GrzWyLaIg8LwnsRgV0KIFERDNY" \
--header "Authorization: Bearer ${BEARER_TOKEN}"

Response: 200 OK

Properties​

Add Property to Manager Version​

Add a property to a manager version

Base URL: /1.0/manager/property/{{managerGrn}}
Method: POST

curl --location --request POST "${API_BASE}/1.0/manager/property/grn:gg:managerversion:fYxQ1m8FUEgHUNVbV5n1yBOOjrGJpalHyg5bvKD0qeKs" \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-raw '{
  "key": "name",
  "dataType": "String",
  "definition": "The name of a person in the graph.",
  "displayValue": "Name",
  "isEditable": true,
  "isDeletable": false
}'

Response:

{
    "property": {
        "id": 71575,
        "labels": [],
        "enver": 0,
        "createdAt": "2021-07-09T17:49:11.133Z",
        "updatedAt": "2021-07-09T17:49:11.133Z",
        "createdBy": "graphgrid",
        "lastModifiedBy": "graphgrid",
        "grn": "grn:gg:property:VCG8D4jV0Zq3bQPB89TgHRkVavCNJczKl8e8MdyzR2yq",
        "key": "name",
        "dataType": "String",
        "definition": null,
        "displayValue": "Name",
        "managerVersion": null,
        "editable": false,
        "deletable": false,
        "grnType": "property",
        "label": "Property"
    }
}

Add Property to NodeType​

Add a property to a nodeType. This request will create a propertyImpl based on the property being added to the node.

Base URL: /1.0/manager/property/{{nodeTypeGrn}}/{{propertyGrn}}
Method: POST

curl --location --request POST "${API_BASE}/1.0/manager/property/grn:gg:nodetype:xOXhmtoUBpQved7yyH0bxC0nT6ZZbJWGFMZa86I5QaDJ/grn:gg:property:ZrXcE4LuSibRHFJt2QEt4D63HSoogPbkqbDFH1BTASAY" \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-raw '{
    "key": "propertyImpl",
    "displayValue": "propertyImpl #1"
}'

Response:

{
    "propertyImpl": {
        "id": 71262,
        "labels": [],
        "enver": 0,
        "createdAt": "2021-07-09T15:38:15.111Z",
        "updatedAt": "2021-07-09T15:38:15.111Z",
        "createdBy": "graphgrid",
        "lastModifiedBy": "graphgrid",
        "grn": "grn:gg:propertyimpl:ztoV5C39to5B0xGINIXMWL9SX1HRzc6y302uUiXxjvop",
        "displayValue": "propertyImpl #1",
        "unique": false,
        "indexed": false,
        "required": false,
        "editable": false,
        "deletable": false,
        "grnType": "propertyimpl",
        "label": "PropertyImpl"
    }
}

Update Property​

Update a property.

Base URL: /1.0/manager/property/{{propertyGrn}}
Method: PUT

curl --location --request PUT "${API_BASE}/1.0/manager/property/grn:gg:property:VCG8D4jV0Zq3bQPB89TgHRkVavCNJczKl8e8MdyzR2yq" \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-raw '{
    "key": "updatedName"
}'

Response:

{
    "property": {
        "id": 71575,
        "labels": [],
        "enver": 0,
        "createdAt": "2021-07-09T17:49:11+00:00",
        "updatedAt": "2021-07-09T17:49:11+00:00",
        "createdBy": "graphgrid",
        "lastModifiedBy": "graphgrid",
        "grn": "grn:gg:property:VCG8D4jV0Zq3bQPB89TgHRkVavCNJczKl8e8MdyzR2yq",
        "key": "updatedName",
        "dataType": null,
        "definition": null,
        "displayValue": null,
        "managerVersion": null,
        "editable": false,
        "deletable": false,
        "grnType": "property",
        "label": "Property"
    }
}

Update Property for Manager Version by Property Name​

Update the property for a manager version using the property name.

Base URL: /1.0/manager/property/name/{{managerVersionGrn}}/{{propertyName}}
Method: PUT

curl --location --request PUT "${API_BASE}/1.0/manager/property/name/grn:gg:managerversion:fYxQ1m8FUEgHUNVbV5n1yBOOjrGJpalHyg5bvKD0qeKs/name" \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-raw '{
    "key": "personName"
}'

Response:

{
    "property": {
        "id": 71575,
        "labels": [],
        "enver": 0,
        "createdAt": "2021-07-09T17:49:11+00:00",
        "updatedAt": "2021-07-09T17:49:11+00:00",
        "createdBy": "graphgrid",
        "lastModifiedBy": "graphgrid",
        "grn": "grn:gg:property:VCG8D4jV0Zq3bQPB89TgHRkVavCNJczKl8e8MdyzR2yq",
        "key": "personName",
        "dataType": null,
        "definition": null,
        "displayValue": null,
        "managerVersion": null,
        "editable": false,
        "deletable": false,
        "grnType": "property",
        "label": "Property"
    }
}

Update PropertyImpl​

Update a PropertyImpl.

Base URL: /1.0/manager/property/{{propertyImplGrn}}
Method: PUT

curl --location --request PUT "${API_BASE}/1.0/manager/property/grn:gg:propertyimpl:ztoV5C39to5B0xGINIXMWL9SX1HRzc6y302uUiXxjvop" \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-raw '{
    "displayValue": "an updated value"
}'

Response:

{
    "propertyImpl": {
        "id": 71262,
        "labels": [],
        "enver": 0,
        "createdAt": "2021-07-09T15:38:15+00:00",
        "updatedAt": "2021-07-09T15:38:15+00:00",
        "createdBy": "graphgrid",
        "lastModifiedBy": "graphgrid",
        "grn": "grn:gg:propertyimpl:ztoV5C39to5B0xGINIXMWL9SX1HRzc6y302uUiXxjvop",
        "displayValue": "an updated value",
        "unique": false,
        "indexed": false,
        "required": false,
        "editable": false,
        "deletable": false,
        "grnType": "propertyimpl",
        "label": "PropertyImpl"
    }
}

Get Properties for ManagerVersion​

Get all properties for a manager version.

Base URL: /1.0/manager/properties/{{managerVersionGrn}}
Method: GET

curl --location --request GET "${API_BASE}/1.0/manager/properties/grn:gg:managerversion:fYxQ1m8FUEgHUNVbV5n1yBOOjrGJpalHyg5bvKD0qeKs" \
--header "Authorization: Bearer ${BEARER_TOKEN}"

Response:

{
    "properties": [
        {
            "id": 70894,
            "labels": [],
            "enver": 0,
            "createdAt": "2021-07-09T15:26:37+00:00",
            "updatedAt": "2021-07-09T15:26:37+00:00",
            "createdBy": "graphgrid",
            "lastModifiedBy": "graphgrid",
            "grn": "grn:gg:property:ZrXcE4LuSibRHFJt2QEt4D63HSoogPbkqbDFH1BTASAY",
            "key": "property name",
            "dataType": null,
            "definition": null,
            "displayValue": "Property #1",
            "managerVersion": null,
            "editable": false,
            "deletable": false,
            "grnType": "property",
            "label": "Property"
        }
    ]
}

Get Properties by ManagerVersion Name​

Get all properties for a manager version using the manager version's name.

Base URL: /1.0/manager/properties/name/{{managerVersionName}}
Method: GET

curl --location --request GET "${API_BASE}/1.0/manager/properties/name/generatedManagerVersion" \
--header "Authorization: Bearer ${BEARER_TOKEN}"

Response:

{
    "properties": [
        {
            "id": 71574,
            "labels": [],
            "enver": 0,
            "createdAt": "2021-07-09T17:47:55+00:00",
            "updatedAt": "2021-07-09T17:47:55+00:00",
            "createdBy": "graphgrid",
            "lastModifiedBy": "graphgrid",
            "grn": "grn:gg:property:f4ZTLtno2MRobm4WsSvfWdb04cJXBsPul6lvlZrtiJMR",
            "key": "update",
            "dataType": null,
            "definition": null,
            "displayValue": null,
            "managerVersion": null,
            "editable": false,
            "deletable": false,
            "grnType": "property",
            "label": "Property"
        }
    ]
}

Get Property​

Return a property.

Base URL: /1.0/manager/property/{{propertyGrn}}
Method: GET

curl --location --request GET "${API_BASE}/1.0/manager/property/grn:gg:property:KYxOvSK8hgvIpFR3qckIiP6um4phGDrOuKSSkdEdlgfd" \
--header "Authorization: Bearer ${BEARER_TOKEN}"

Response:

{
    "property": {
        "id": 70513,
        "labels": [],
        "enver": 0,
        "createdAt": "2021-07-09T15:23:13+00:00",
        "updatedAt": "2021-07-09T15:23:13+00:00",
        "createdBy": "graphgrid",
        "lastModifiedBy": "graphgrid",
        "grn": "grn:gg:property:KYxOvSK8hgvIpFR3qckIiP6um4phGDrOuKSSkdEdlgfd",
        "key": null,
        "dataType": null,
        "definition": null,
        "displayValue": null,
        "managerVersion": null,
        "editable": false,
        "deletable": false,
        "grnType": "property",
        "label": "Property"
    }
}

Get Property by Property Name​

Return a property using the property's name.

Base URL: /1.0/manager/property/name/{{managerVersionGrn}}/{{propertyName}}
Method: GET

curl --location --request GET "${API_BASE}/1.0/manager/property/name/grn:gg:managerversion:fYxQ1m8FUEgHUNVbV5n1yBOOjrGJpalHyg5bvKD0qeKs/update" \
--header "Authorization: Bearer ${BEARER_TOKEN}"

Response:

{
    "property": {
        "id": 71574,
        "labels": [],
        "enver": 0,
        "createdAt": "2021-07-09T17:47:55+00:00",
        "updatedAt": "2021-07-09T17:47:55+00:00",
        "createdBy": "graphgrid",
        "lastModifiedBy": "graphgrid",
        "grn": "grn:gg:property:f4ZTLtno2MRobm4WsSvfWdb04cJXBsPul6lvlZrtiJMR",
        "key": "update",
        "dataType": null,
        "definition": null,
        "displayValue": null,
        "managerVersion": null,
        "editable": false,
        "deletable": false,
        "grnType": "property",
        "label": "Property"
    }
}

Get Properties for NodeType​

Return all properties for a nodeType.

Base URL: /1.0/manager/properties/{{nodeTypeGrn}}
Method: GET

curl --location --request GET "${API_BASE}/1.0/manager/properties/grn:gg:nodetype:xOXhmtoUBpQved7yyH0bxC0nT6ZZbJWGFMZa86I5QaDJ" \
--header "Authorization: Bearer ${BEARER_TOKEN}"

Response:

{
    "properties": [
        {
            "id": 71574,
            "labels": [],
            "enver": 0,
            "createdAt": "2021-07-09T17:47:55+00:00",
            "updatedAt": "2021-07-09T17:47:55+00:00",
            "createdBy": "graphgrid",
            "lastModifiedBy": "graphgrid",
            "grn": "grn:gg:property:f4ZTLtno2MRobm4WsSvfWdb04cJXBsPul6lvlZrtiJMR",
            "key": "update",
            "dataType": null,
            "definition": null,
            "displayValue": null,
            "managerVersion": null,
            "editable": false,
            "deletable": false,
            "grnType": "property",
            "label": "Property"
        }
    ]
}

Delete Property​

Delete a property.

Base URL: /1.0/manager/{{propertyGrn}}
Method: DELETE

curl --location --request DELETE "${API_BASE}/1.0/manager/grn:gg:property:ZrXcE4LuSibRHFJt2QEt4D63HSoogPbkqbDFH1BTASAY" \
--header "Authorization: Bearer ${BEARER_TOKEN}"

Response: 200 OK

Delete Property from ManagerVersion​

Delete a property from a manager version.

Base URL: /1.0/manager/property/{{managerVersionGrn}}/{{propertyGrn}}
Method: DELETE

curl --location --request DELETE "${API_BASE}/1.0/manager/property/grn:gg:managerversion:fYxQ1m8FUEgHUNVbV5n1yBOOjrGJpalHyg5bvKD0qeKs/grn:gg:property:GUhLVLAtjLYC5q6t64Zlfj6uSpNsZrVI4ysI33B9dltT" \
--header "Authorization: Bearer ${BEARER_TOKEN}"

Response: 200 OK

Delete Property from ManagerVersion by Property Name​

Delete a property from a manager version using the property's name.

Base URL: /1.0/manager/property/{{managerVersionGrn}}/{{propertyName}}
Method: DELETE

curl --location --request DELETE "${API_BASE}/1.0/manager/property/grn:gg:managerversion:fYxQ1m8FUEgHUNVbV5n1yBOOjrGJpalHyg5bvKD0qeKs/updatedName" \
--header "Authorization: Bearer ${BEARER_TOKEN}"

Response: 200 OK

Delete Property from NodeType​

Delete a property from a nodeType.

Base URL: /1.0/manager/property/{{managerVersionGrn}}/{{nodeTypeGrn}}/{{propertyGrn}}
Method: DELETE

curl --location --request DELETE "${API_BASE}/1.0/manager/property/grn:gg:nodetype:xOXhmtoUBpQved7yyH0bxC0nT6ZZbJWGFMZa86I5QaDJ/grn:gg:property:f4ZTLtno2MRobm4WsSvfWdb04cJXBsPul6lvlZrtiJMR" \
--header "Authorization: Bearer ${BEARER_TOKEN}"

Response: 200 OK

Delete PropertyImpl​

Delete a propertyImpl.

Base URL: /1.0/manager/{{propertyImplGrn}}
Method: DELETE

curl --location --request DELETE "${API_BASE}/1.0/manager/grn:gg:propertyimpl:qNXAhWeDSB80OmuKVsarIay9u3SeP8Yd2y1TLE3xYYc0" \
--header "Authorization: Bearer ${BEARER_TOKEN}"

Response: 200 OK

NodeTypes​

Create Node Type​

Create a node type for a manager model.

Base URL: /1.0/manager/nodeType/{{mangerVersionGrn}}
Method: POST

curl --location --request POST "${API_BASE}/1.0/manager/nodeType/grn:gg:managerversion:fYxQ1m8FUEgHUNVbV5n1yBOOjrGJpalHyg5bvKD0qeKs" \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-raw '{
    "key": "Person",
    "namespace": "Test",
    "definition": "A person in the graph.",
    "displayValue": "person"
}'

Response:

{
    "nodeType": {
        "id": 69751,
        "labels": [],
        "enver": 0,
        "createdAt": "2021-07-09T14:42:55.744Z",
        "updatedAt": "2021-07-09T14:42:55.744Z",
        "createdBy": "graphgrid",
        "lastModifiedBy": "graphgrid",
        "grn": "grn:gg:nodetype:xOXhmtoUBpQved7yyH0bxC0nT6ZZbJWGFMZa86I5QaDJ",
        "key": "Person",
        "namespace": "Test",
        "definition": "A person in the graph.",
        "displayValue": "person",
        "managerVersion": null,
        "grnType": "nodetype",
        "label": "NodeType"
    }
}

Update NodeType​

Update a nodeType.

Base URL: /1.0/manager/nodeType/{{nodeTypeGrn}}
Method: PUT

curl --location --request PUT "${API_BASE}/1.0/manager/nodeType/grn:gg:nodetype:baFQ6qCy884B8ma24ws0Hh8yF2nAdHjdtUl1krzaEjul" \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-raw '{
    "key": "Person",
    "namespace": "Test Namespace",
    "definition": "A person found in the graph.",
    "displayValue": "personage"
}'

Response:

{
    "nodeType": {
        "id": 72524,
        "labels": [],
        "enver": 0,
        "createdAt": "2021-07-13T18:26:27+00:00",
        "updatedAt": "2021-07-13T18:26:27+00:00",
        "createdBy": "graphgrid",
        "lastModifiedBy": "graphgrid",
        "grn": "grn:gg:nodetype:baFQ6qCy884B8ma24ws0Hh8yF2nAdHjdtUl1krzaEjul",
        "key": "Person",
        "namespace": "Test Namespace",
        "definition": "A person found in the graph.",
        "displayValue": "personage",
        "managerVersion": null,
        "grnType": "nodetype",
        "label": "NodeType"
    }
}

Update NodeType by Name​

Update a nodeType using the nodeType's name.

Base URL: /1.0/manager/nodeType/name/{{managerVersionGrn}}/{{nodeTypeName}}
Method: PUT

curl --location --request PUT "${API_BASE}/1.0/manager/nodeType/name/grn:gg:managerversion:fYxQ1m8FUEgHUNVbV5n1yBOOjrGJpalHyg5bvKD0qeKs/Person" \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-raw '{
    "key": "Person",
    "namespace": "Test Namespace 2",
    "definition": "A person with a name found in the graph.",
    "displayValue": "personality"
}'

Response:

{
    "nodeType": {
        "id": 72524,
        "labels": [],
        "enver": 0,
        "createdAt": "2021-07-13T18:26:27+00:00",
        "updatedAt": "2021-07-13T18:26:27+00:00",
        "createdBy": "graphgrid",
        "lastModifiedBy": "graphgrid",
        "grn": "grn:gg:nodetype:baFQ6qCy884B8ma24ws0Hh8yF2nAdHjdtUl1krzaEjul",
        "key": "Person",
        "namespace": "Test Namespace 2",
        "definition": "A person with a name found in the graph.",
        "displayValue": "personality",
        "managerVersion": null,
        "grnType": "nodetype",
        "label": "NodeType"
    }
}

Get All NodeTypes for ManagerVersion​

Get all nodeTypes by the ManagerVersion grn.

Base URL: /1.0/manager/nodeTypes/{{managerVersionGrn}}
Method: GET

curl --location --request GET "${API_BASE}/1.0/manager/nodeTypes/grn:gg:managerversion:fYxQ1m8FUEgHUNVbV5n1yBOOjrGJpalHyg5bvKD0qeKs" \
--header "Authorization: Bearer ${BEARER_TOKEN}"

Response:

{
    "nodeTypes": [
        {
            "id": 69751,
            "labels": [],
            "enver": 0,
            "createdAt": "2021-07-09T14:42:55+00:00",
            "updatedAt": "2021-07-09T14:42:55+00:00",
            "createdBy": "graphgrid",
            "lastModifiedBy": "graphgrid",
            "grn": "grn:gg:nodetype:xOXhmtoUBpQved7yyH0bxC0nT6ZZbJWGFMZa86I5QaDJ",
            "key": "Person",
            "namespace": "Test",
            "definition": "A person in the graph.",
            "displayValue": "person",
            "managerVersion": null,
            "grnType": "nodetype",
            "label": "NodeType"
        }
    ]
}

Get NodeTypes by ManagerVersion Name​

Get all nodeTypes using the managerVersion's name.

Base URL: /1.0/manager/nodeTypes/name/{{managerVersionName}}
Method: GET

curl --location --request GET "${API_BASE}/1.0/manager/nodeTypes/name/generatedManagerVersion" \
--header "Authorization: Bearer ${BEARER_TOKEN}"

Response:

{
    "nodeTypes": [
        {
            "id": 69751,
            "labels": [],
            "enver": 0,
            "createdAt": "2021-07-09T14:42:55+00:00",
            "updatedAt": "2021-07-09T14:42:55+00:00",
            "createdBy": "graphgrid",
            "lastModifiedBy": "graphgrid",
            "grn": "grn:gg:nodetype:xOXhmtoUBpQved7yyH0bxC0nT6ZZbJWGFMZa86I5QaDJ",
            "key": "Person",
            "namespace": "Test",
            "definition": "A person in the graph.",
            "displayValue": "person",
            "managerVersion": null,
            "grnType": "nodetype",
            "label": "NodeType"
        }
    ]
}

Get NodeType​

Return a nodeType.

Base URL: /1.0/manager/nodeType/{{nodeTypeGrn}}
Meth: GET

curl --location --request GET "${API_BASE}/1.0/manager/nodeType/grn:gg:nodetype:xOXhmtoUBpQved7yyH0bxC0nT6ZZbJWGFMZa86I5QaDJ" \
--header "Authorization: Bearer ${BEARER_TOKEN}"

Response:

{
    "nodeType": {
        "id": 69751,
        "labels": [],
        "enver": 0,
        "createdAt": "2021-07-09T14:42:55+00:00",
        "updatedAt": "2021-07-09T14:42:55+00:00",
        "createdBy": "graphgrid",
        "lastModifiedBy": "graphgrid",
        "grn": "grn:gg:nodetype:xOXhmtoUBpQved7yyH0bxC0nT6ZZbJWGFMZa86I5QaDJ",
        "key": "Person",
        "namespace": "Test",
        "definition": "A person in the graph.",
        "displayValue": "person",
        "managerVersion": null,
        "grnType": "nodetype",
        "label": "NodeType"
    }
}

Get NodeType by NodeType Name​

Return a nodeType by the nodeType's name.

Base URL: /1.0/manager/nodeType/name/{{managerVersionGrn}}/{{nodeTypeName}}
MethodL GET

curl --location --request GET "${API_BASE}/1.0/manager/nodeType/name/grn:gg:managerversion:fYxQ1m8FUEgHUNVbV5n1yBOOjrGJpalHyg5bvKD0qeKs/Person" \
--header "Authorization: Bearer ${BEARER_TOKEN}"

Response:

{
    "nodeType": {
        "id": 69751,
        "labels": [],
        "enver": 0,
        "createdAt": "2021-07-09T14:42:55+00:00",
        "updatedAt": "2021-07-09T14:42:55+00:00",
        "createdBy": "graphgrid",
        "lastModifiedBy": "graphgrid",
        "grn": "grn:gg:nodetype:xOXhmtoUBpQved7yyH0bxC0nT6ZZbJWGFMZa86I5QaDJ",
        "key": "Person",
        "namespace": "Test",
        "definition": "A person in the graph.",
        "displayValue": "person",
        "managerVersion": null,
        "grnType": "nodetype",
        "label": "NodeType"
    }
}

Delete NodeType​

Delete a nodeType.

Base URL: /1.0/manager/{{nodeTypeGrn}}
Method: DELETE

curl --location --request DELETE "${API_BASE}/1.0/manager/nodeType/grn:gg:nodetype:xOXhmtoUBpQved7yyH0bxC0nT6ZZbJWGFMZa86I5QaDJ" \
--header "Authorization: Bearer ${BEARER_TOKEN}"

Response: 200 OK

Delete NodeType by NodeType Name​

Delete a nodeType by the nodeType's name.

Base URL: /1.0/manager/nodeType/{{managerVersionGrn}}/{{nodeTypeName}}
Method: DELETE

curl --location --request DELETE "${API_BASE}/1.0/manager/nodeType/grn:gg:managerversion:fYxQ1m8FUEgHUNVbV5n1yBOOjrGJpalHyg5bvKD0qeKs/Person" \
--header "Authorization: Bearer ${BEARER_TOKEN}"

Response: 200 OK

Contraints​

Get Constraints by ManagerVersion​

Return constraints for a manager version.

Base URL: /1.0/manager/constraints/{{managerVersionGrn}}
Method: GET

curl --location --request GET "${API_BASE}/1.0/manager/constraints/grn:gg:managerversion:fYxQ1m8FUEgHUNVbV5n1yBOOjrGJpalHyg5bvKD0qeKs" \
--header "Authorization: Bearer ${BEARER_TOKEN}"

Response:

{
    "constraints": []
}

Get Constraints by ManagerVersion Name​

Return constraints using the managerVersion's name.

Base URL: /1.0/manager/constraints/name/{{managerVersionName}}
Method: GET

curl --location --request GET "${API_BASE}/1.0/manager/constraints/name/default" \
--header "Authorization: Bearer ${BEARER_TOKEN}"

Response:

{
    "constraints": []
}

Additional Manager Content​

Showmes​

Showmes allow dynamic APIs to be created using only Geequel. They support the most common REST methods and return data translated from the Geequel query as JSON. Learn more about showmes here.

Manager Models​

A manager model is a specification for a graph. A manager model shows what nodes, relationships, and properties are allowed and how they can be structured. Learn more about manager models here.