To query the nodegoat API you need a valid domain, a valid path, and a valid query component. The following URL contains the possible basic domain, path, and query parameters:
Authenticated, access Project 1, access Project’s data, Type 2, apply Scope 3, apply Filter 4, request Object 5 & 6 & 7, request Object 8, quick search for 'A', apply a JSON-formatted filter form:
Authenticated, access Project 1, access Project’s Data Design, request Types 2 & 3 & 4
The domain indicates whether you are creating an authenticated or unauthenticated/open request.
When making an authenticated request, HTTPS is required and should query nodegoat’s main API domain at nodegoat.io or api.nodegoat.net.
To make an unauthenticated request, you use the subdomain of your nodegoat Domain’s to query the nodegoat API over unencrypted HTTP at DOMAIN.nodegoat.io or api.DOMAIN.nodegoat.net. When you have an institutional installation of nodegoat you use the main API domain, you also have the option to use HTTPS.
The path tells the API what Project and what data you want to access.
Specify which nodegoat Project to access. Optional.
|/ project / ID||Access a specific nodegoat Project. If this is left out, the default configured Project is assumed.|
Specify the mode. One of the following parameters has to be provided.
|/ ID or ?id = ID||Directly access Objects with their corresponding nodegoat IDs or other identifiers (see Data Design on how to indicate what Object Descriptions can be used for identification). The ID can also be provided using the query component id (both GET and POST). The query component has to be used when identifiers contain characters reserved for URLs.|
|/ data||Access the Project’s data.|
|/ design||Access the Projects's Data Design.|
Specify for which Type you want to access the data.
|/ type / ID||Access data for the specified Type.|
Apply Project- and Type-specific operations to the request. More than one of the following parameters can be provided. Optional.
|/ scope / ID||Apply the specified scope to the request. This allows you to generate highly-relational and ready-to-use data structures using nodegoat Scope functionality.|
|/ filter / ID||Apply the specified filter to the request. Additionally, the filter can be manipulated in the query component of the request.|
|/ object / ID(,ID)||Select the specified Object(s).|
Specify for which Type(s) to access the Data Design.
|/ type / ID(,ID)||Access the Data Design for the specified Type(s).|
The query component allows you to further specify your request by means of search parameters. It is also possible to POST the query component instead of using GET (e.g. when creating large requests that exceed the GET limit).
All parameters in the query component are optional. When combined, each additional parameter will filter the result (AND).
Query the API for a Type's Data Design to get an overview of the possible IDs for Object Descriptions, Sub-Object Details, and Sub-Object Descriptions.
|object_id = ID(,ID)||Select the specified Object(s).|
|search = value||Quick search Objects for 'value'.|
|form = value||Apply a JSON-formatted filter. The form parameter allows you to customise and apply full-featured nodegoat filters to your query.|
|scope = value||Apply a JSON-formatted filter. The scope parameter allows you to customise and apply full-featured nodegoat scopes to your query.|
|limit = nr||Limit the results to a maximum amount of Objects. Handy for pagination purposes.|
|offset = nr||Offset the results with a specific amount of Objects. Handy for pagination purposes.|
Design currently does not have an additional query component.
The result from your request to the nodegoat API can be found in the JSON response under the key 'data'. The result is a JSON dictionary that promotes direct lookup and access to its structure.
The specific response depends on the mode (design or data, see the previous Query section) of your request.
In design mode the result contains the requested Type IDs with the Type's configuration.
In data mode the result contains the requested or queried Object IDs with the Object's definition.