User Tools

Site Tools


api2:knowledge_structure:knowledge_graph

The content’s structure is gathered into Knowledge Graphs. A Knowledge Graph is the first object to instantiate while setting up your content on our API.

graph

Object resources

Property Type Description
id Integer identifier for the database of Domoscio's API
name String Custom data
created_at DateTime Date of creation of the object
updated_at DateTime Last time the object has been modified

Create (POST)

Method POST
URL /knowledge_graphs
Parameters (*Requiered parameters)
Property Type Description
name String Custom data
Send the request (JSON input example)
{
	name: "Corporate Finance"
}
Get the response (JSON output example)
{
    "name": "Corporate Finance",
    "id": 856,
    "created_at": "2017-11-22T15:01:23.263Z",
    "updated_at": "2017-11-22T15:01:23.263Z"
}

Fetch (GET)

Method GET
URL /knowledge_graphs/{knowledge_graph_id}

If no knowledge_graph_id is provided it will fetch all the knowledge graphs for your instance.

Get the response (JSON output example)

With ID provided

{
    "id": 856,
    "name": "Corporate Finance",
    "created_at": "2017-11-22T15:01:23.263Z",
    "updated_at": "2017-11-22T15:01:23.263Z"
}

Without ID provided

[
    {
        "id": 855,
        "name": "Assets",
        "created_at": "2017-11-20T12:52:35.880Z",
        "updated_at": "2017-11-20T12:52:35.880Z"
    },
    {
        "id": 856,
        "name": "Corporate Finance",
        "created_at": "2017-11-22T15:01:23.263Z",
        "updated_at": "2017-11-22T15:01:23.263Z"
    }
]

EDIT (PUT)

Method PUT
URL /knowledge_graphs/{knowledge_graph_id}
Editable parameters
Property Type Description/expected values
name String Custom data (<255 characters)
Send the request (JSON input example)
{
	name : "No more Corporate Finance"
}
Get the response (JSON output example)
{
    "id": 856,
    "name": "No more Corporate Finance",
    "created_at": "2017-11-22T15:01:23.263Z",
    "updated_at": "2017-11-22T15:04:11.268Z"
}
api2/knowledge_structure/knowledge_graph.txt · Last modified: 2017/11/22 16:09 by maries