WebGME version 1.0
/
WebGME API entry point
get /
WebGME API entry point
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"current_user_url": "http://localhost:8888/api/user",
"organization_url": "http://localhost:8888/api/orgs/{org}",
"project_url": "http://localhost:8888/api/projects/{owner}/{project}",
"user_url": "http://localhost:8888/api/users/{user}",
"documentation_url": "http://localhost:8888/developer/api"
}
/componentSettings
End points for default deployment settings.
Returns all component settings defined for the deployment, see https://github.com/webgme/webgme/wiki/Component-Settings
get /componentSettings
Returns all component settings defined for the deployment, see https://github.com/webgme/webgme/wiki/Component-Settings
Basic authentication scheme
JWT Bearer with authentication token.
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"Plugin_ConfigurationArtifact__0_1_0": {
"species": "Horsie",
"age": 3,
"carnivore": false,
"classification": "Vertebrates",
"color": "#FF0000",
"file": ""
},
"ICorePanel": {
"consoleWindow": {
"logLevel": "info",
"verticalOrientation": false
}
}
}
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Returns a specific component settings defined for the deployment, see https://github.com/webgme/webgme/wiki/Component-Settings
get /componentSettings/{componentId}
Returns a specific component settings defined for the deployment, see https://github.com/webgme/webgme/wiki/Component-Settings
Basic authentication scheme
JWT Bearer with authentication token.
URI Parameters
- componentId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"consoleWindow": {
"logLevel": "info",
"verticalOrientation": false
}
}
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
/user
End points for currently connected user.
Returns with the current user
Remove the current user
get /user
Returns with the current user
Basic authentication scheme
JWT Bearer with authentication token.
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"_id": "demo",
"email": "a@example.com",
"canCreate": true,
"projects": {
"guest+aaaaaa": {
"read": true,
"write": true,
"delete": false
},
"demo+ASDF": {
"read": true,
"write": true,
"delete": true
}
},
"orgs": [
"ATeam"
],
"siteAdmin": true,
"data": {}
}
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
delete /user
Remove the current user
Basic authentication scheme
JWT Bearer with authentication token.
HTTP status code 204
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Creates and returns a token for the user
get /user/token
Creates and returns a token for the user
Basic authentication scheme
JWT Bearer with authentication token.
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"webgmeToken": "eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38"
}
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Entity representing a datum. Nested values can be accessed via URI parameters such as /user/data/key1/key2...
.
Get the datum. The user data field is an arbitrary object where developers can put custom data associated with a specific user. For preferences consider using settings instead, which provides options for server defaults.
Add a new datum to WebGME. Overwrites the data field.
Update datum within WebGME. Updates/overwrites the user's data with the sent values for matching keys.
Delete datum from WebGME. Clears out the user's data field (sets it to empty dictionary).
get /user/data
Get the datum. The user data field is an arbitrary object where developers can put custom data associated with a specific user. For preferences consider using settings instead, which provides options for server defaults.
Basic authentication scheme
JWT Bearer with authentication token.
Query Parameters
- decrypt: (boolean)
Decrypt the requested data.
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"country": "USA",
"organization": "Org",
"name": "Joe Smith"
}
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{
"message": "datum not found"
}
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
put /user/data
Add a new datum to WebGME. Overwrites the data field.
Basic authentication scheme
JWT Bearer with authentication token.
Query Parameters
- encrypt: (boolean)
Encrypt the submitted data before saving.
Body
Media type: application/json
Type: any
Example:
{
"country": "USA",
"organization": "Org",
"name": "Joe Smith"
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"country": "USA",
"organization": "Org",
"name": "Joe Smith"
}
HTTP status code 403
HTTP status code 404
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
patch /user/data
Update datum within WebGME. Updates/overwrites the user's data with the sent values for matching keys.
Basic authentication scheme
JWT Bearer with authentication token.
Query Parameters
- encrypt: (boolean)
Encrypt the submitted data before saving.
Body
Media type: application/json
Type: any
Example:
{
"country": "USA"
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"country": "USA",
"organization": "Org",
"name": "Joe Smith"
}
HTTP status code 403
HTTP status code 404
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
delete /user/data
Delete datum from WebGME. Clears out the user's data field (sets it to empty dictionary).
Basic authentication scheme
JWT Bearer with authentication token.
Query Parameters
- force: (boolean)
If true and user.siteAdmin user will be deleted from database
Example:
true
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Entity representing a setting
Get the setting. Gets all component-settings for a user, see https://github.com/webgme/webgme/wiki/Component-Settings
Add a new setting to WebGME. Overwrites the settings field.
Update setting within WebGME. Updates/overwrites the user's settings with the sent values for matching keys.
Delete setting from WebGME. Clears out the user's settings field (sets it to empty dictionary).
get /user/settings
Get the setting. Gets all component-settings for a user, see https://github.com/webgme/webgme/wiki/Component-Settings
Basic authentication scheme
JWT Bearer with authentication token.
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"Plugin_ConfigurationArtifact__0_1_0": {
"species":"Horsie",
"age":3,
"carnivore":false,
"classification":"Vertebrates",
"color":"#FF0000",
"file":""
},
"ICorePanel":{
"consoleWindow":{
"logLevel": "info",
"verticalOrientation":false
}
}
}
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{
"message": "setting not found"
}
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
put /user/settings
Add a new setting to WebGME. Overwrites the settings field.
Basic authentication scheme
JWT Bearer with authentication token.
Body
Media type: application/json
Type: any
Example:
{
"Plugin_ConfigurationArtifact__0_1_0": {
"species":"Horsie",
"age":3,
"carnivore":false,
"classification":"Vertebrates",
"color":"#FF0000",
"file":""
},
"ICorePanel":{
"consoleWindow":{
"logLevel": "info",
"verticalOrientation":false
}
}
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"Plugin_ConfigurationArtifact__0_1_0": {
"species":"Horsie",
"age":3,
"carnivore":false,
"classification":"Vertebrates",
"color":"#FF0000",
"file":""
},
"ICorePanel":{
"consoleWindow":{
"logLevel": "info",
"verticalOrientation":false
}
}
}
HTTP status code 403
HTTP status code 404
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
patch /user/settings
Update setting within WebGME. Updates/overwrites the user's settings with the sent values for matching keys.
Basic authentication scheme
JWT Bearer with authentication token.
Body
Media type: application/json
Type: any
Example:
{
"Plugin_ConfigurationArtifact__0_1_0": {
"carnivore":false
},
"ICorePanel":{
"consoleWindow":{
"verticalOrientation":true
}
}
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"Plugin_ConfigurationArtifact__0_1_0": {
"species":"Horsie",
"age":3,
"carnivore":false,
"classification":"Vertebrates",
"color":"#FF0000",
"file":""
},
"ICorePanel":{
"consoleWindow":{
"logLevel": "info",
"verticalOrientation":false
}
}
}
HTTP status code 403
HTTP status code 404
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
delete /user/settings
Delete setting from WebGME. Clears out the user's settings field (sets it to empty dictionary).
Basic authentication scheme
JWT Bearer with authentication token.
Query Parameters
- force: (boolean)
If true and user.siteAdmin user will be deleted from database
Example:
true
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Entity representing a setting
Get the setting. Gets a specific component settings for a user, see https://github.com/webgme/webgme/wiki/Component-Settings
Add a new setting to WebGME. Overwrites the settings field for a specific component.
Update setting within WebGME. Updates/overwrites a specific component settings with the sent values for matching keys.
Delete setting from WebGME. Clears out the settings for a specific component.
get /user/settings/{componentId}
Get the setting. Gets a specific component settings for a user, see https://github.com/webgme/webgme/wiki/Component-Settings
Basic authentication scheme
JWT Bearer with authentication token.
URI Parameters
- componentId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"consoleWindow": {
"logLevel": "info",
"verticalOrientation":false
}
}
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{
"message": "setting not found"
}
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
put /user/settings/{componentId}
Add a new setting to WebGME. Overwrites the settings field for a specific component.
Basic authentication scheme
JWT Bearer with authentication token.
URI Parameters
- componentId: required(string)
Body
Media type: application/json
Type: any
Example:
{
"consoleWindow": {
"logLevel": "info",
"verticalOrientation":false
}
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"consoleWindow": {
"logLevel": "info",
"verticalOrientation":false
}
}
HTTP status code 403
HTTP status code 404
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
patch /user/settings/{componentId}
Update setting within WebGME. Updates/overwrites a specific component settings with the sent values for matching keys.
Basic authentication scheme
JWT Bearer with authentication token.
URI Parameters
- componentId: required(string)
Body
Media type: application/json
Type: any
Example:
{
"consoleWindow": {
"verticalOrientation":false
}
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"consoleWindow": {
"logLevel": "info",
"verticalOrientation":false
}
}
HTTP status code 403
HTTP status code 404
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
delete /user/settings/{componentId}
Delete setting from WebGME. Clears out the settings for a specific component.
Basic authentication scheme
JWT Bearer with authentication token.
URI Parameters
- componentId: required(string)
Query Parameters
- force: (boolean)
If true and user.siteAdmin user will be deleted from database
Example:
true
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
/users
End points for users on deployment. PUT/PATCH/DELETE requires that authenticated user is siteAdmin.
Collection of available users in WebGME
get /users
Collection of available users in WebGME
Basic authentication scheme
JWT Bearer with authentication token.
Query Parameters
- includeDisabled: (boolean)
If true and user.siteAdmin disabled users will be included in response.
Example:
true
- displayName: (boolean)
If true users with display name will be listed (only id and displayName will be in the response).
Example:
true
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"_id": "aaaa23",
"email": "asdf@alkfm.afdk",
"canCreate": "true",
"projects": {},
"orgs": [],
"siteAdmin": false,
"data": {}
},
{
"_id": "anonymous",
"email": "anonymous",
"canCreate": true,
"projects": {},
"orgs": [],
"siteAdmin": false
},
{
"_id": "user",
"email": "user@example.com",
"canCreate": null,
"projects": {},
"orgs": []
},
{
"_id": "guest",
"email": "guest",
"canCreate": true,
"projects": {
"guest+6c": {
"read": true,
"write": true,
"delete": true
},
"guest+2b": {
"read": true,
"write": true,
"delete": true
},
"guest+xmptest": {
"read": true,
"write": true,
"delete": true
},
"guest+t1": {
"read": true,
"write": true,
"delete": true
},
"guest+t3": {
"read": true,
"write": true,
"delete": true
},
"guest+aaaaaa": {
"read": true,
"write": true,
"delete": true
},
"guest+bbb": {
"read": true,
"write": true,
"delete": true
},
"guest+a234": {
"read": true,
"write": true,
"delete": true
},
"guest+rty": {
"read": true,
"write": true,
"delete": true
},
"guest+rtyui": {
"read": true,
"write": true,
"delete": true
},
"guest+corediff": {
"read": true,
"write": true,
"delete": true
},
"guest+d": {
"read": true,
"write": true,
"delete": true
},
"guest+rt": {
"read": true,
"write": true,
"delete": true
},
"guest+d12": {
"read": true,
"write": true,
"delete": true
},
"guest+aaaaaaa": {
"read": true,
"write": true,
"delete": true
},
"guest+ghjklo": {
"read": true,
"write": true,
"delete": true
},
"guest+oiuytre": {
"read": true,
"write": true,
"delete": true
},
"guest+ccccccc": {
"read": true,
"write": true,
"delete": true
},
"guest+SFS": {
"read": true,
"write": true,
"delete": true
}
},
"orgs": [],
"siteAdmin": false,
"data": {}
},
{
"_id": "demo",
"email": "demo",
"canCreate": true,
"projects": {
"guest+aaaaaa": {
"read": true,
"write": true,
"delete": false
},
"demo+ASDF": {
"read": true,
"write": true,
"delete": true
}
},
"orgs": [],
"siteAdmin": false,
"data": {}
}
]
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Retrives the user entry.
Create a new user. Requires user.siteAdmin.
Updates the user if user.siteAdmin or same user. If {disabled ":" false} given and user.siteAdmin disabled user will be re-enabled.
Deletes the user. Requires user.siteAdmin or same user.
get /users/{username}
Retrives the user entry.
Basic authentication scheme
JWT Bearer with authentication token.
URI Parameters
- username: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"_id": "demo",
"email": "a@example.com",
"canCreate": true,
"projects": {
"guest+aaaaaa": {
"read": true,
"write": true,
"delete": false
},
"demo+ASDF": {
"read": true,
"write": true,
"delete": true
}
},
"orgs": [
"ATeam"
],
"siteAdmin": true,
"data": {}
}
HTTP status code 404
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
put /users/{username}
Create a new user. Requires user.siteAdmin.
Basic authentication scheme
JWT Bearer with authentication token.
URI Parameters
- username: required(string)
Body
Media type: application/json
Type: See_example
Example:
{
"password": "demo",
"email": "a@example.com",
"canCreate": true,
"siteAdmin": true
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"_id": "demo",
"email": "a@example.com",
"canCreate": true,
"projects": {
"guest+aaaaaa": {
"read": true,
"write": true,
"delete": false
},
"demo+ASDF": {
"read": true,
"write": true,
"delete": true
}
},
"orgs": [
"ATeam"
],
"siteAdmin": true,
"data": {}
}
HTTP status code 403
HTTP status code 404
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
patch /users/{username}
Updates the user if user.siteAdmin or same user. If {disabled ":" false} given and user.siteAdmin disabled user will be re-enabled.
Basic authentication scheme
JWT Bearer with authentication token.
URI Parameters
- username: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"password": "wordpass",
"email": "a@example.com",
"canCreate": true,
"siteAdmin": true
}
HTTP status code 403
HTTP status code 404
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
delete /users/{username}
Deletes the user. Requires user.siteAdmin or same user.
Basic authentication scheme
JWT Bearer with authentication token.
URI Parameters
- username: required(string)
Query Parameters
- force: (boolean)
If true and user.siteAdmin user at username will be permanently deleted from database.
Example:
true
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Entity representing a datum
Get the datum. The user data field is an arbitrary object where developers can put custom data associated with a specific user. Consider using settings instead, which provides options for server defaults.
Add a new datum to WebGME. Overwrites the user's data field. Requires is current user or user.siteAdmin.
Update datum within WebGME. Updates/overwrites the user's data with the sent values for matching keys. Requires is current user or user.siteAdmin.
Delete datum from WebGME. Clears out the user's data field (sets it to empty dictionary). Requires is current user or user.siteAdmin.
get /users/{username}/data
Get the datum. The user data field is an arbitrary object where developers can put custom data associated with a specific user. Consider using settings instead, which provides options for server defaults.
Basic authentication scheme
JWT Bearer with authentication token.
URI Parameters
- username: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"country": "USA",
"organization": "Org",
"name": "Joe Smith"
}
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{
"message": "datum not found"
}
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
put /users/{username}/data
Add a new datum to WebGME. Overwrites the user's data field. Requires is current user or user.siteAdmin.
Basic authentication scheme
JWT Bearer with authentication token.
URI Parameters
- username: required(string)
Body
Media type: application/json
Type: any
Example:
{
"country": "USA",
"organization": "Org",
"name": "Joe Smith"
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"country": "USA",
"organization": "Org",
"name": "Joe Smith"
}
HTTP status code 403
HTTP status code 404
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
patch /users/{username}/data
Update datum within WebGME. Updates/overwrites the user's data with the sent values for matching keys. Requires is current user or user.siteAdmin.
Basic authentication scheme
JWT Bearer with authentication token.
URI Parameters
- username: required(string)
Body
Media type: application/json
Type: any
Example:
{
"country": "USA"
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"country": "USA",
"organization": "Org",
"name": "Joe Smith"
}
HTTP status code 403
HTTP status code 404
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
delete /users/{username}/data
Delete datum from WebGME. Clears out the user's data field (sets it to empty dictionary). Requires is current user or user.siteAdmin.
Basic authentication scheme
JWT Bearer with authentication token.
URI Parameters
- username: required(string)
Query Parameters
- force: (boolean)
If true and user.siteAdmin user will be deleted from database
Example:
true
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Entity representing a setting
Get the setting. Gets all component-settings for a user, see https://github.com/webgme/webgme/wiki/Component-Settings
Add a new setting to WebGME. Overwrites the settings field.
Update setting within WebGME. Updates/overwrites the user's settings with the sent values for matching keys.
Delete setting from WebGME. Clears out the user's settings field (sets it to empty dictionary).
get /users/{username}/settings
Get the setting. Gets all component-settings for a user, see https://github.com/webgme/webgme/wiki/Component-Settings
Basic authentication scheme
JWT Bearer with authentication token.
URI Parameters
- username: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"Plugin_ConfigurationArtifact__0_1_0": {
"species":"Horsie",
"age":3,
"carnivore":false,
"classification":"Vertebrates",
"color":"#FF0000",
"file":""
},
"ICorePanel":{
"consoleWindow":{
"logLevel": "info",
"verticalOrientation":false
}
}
}
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{
"message": "setting not found"
}
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
put /users/{username}/settings
Add a new setting to WebGME. Overwrites the settings field.
Basic authentication scheme
JWT Bearer with authentication token.
URI Parameters
- username: required(string)
Body
Media type: application/json
Type: any
Example:
{
"Plugin_ConfigurationArtifact__0_1_0": {
"species":"Horsie",
"age":3,
"carnivore":false,
"classification":"Vertebrates",
"color":"#FF0000",
"file":""
},
"ICorePanel":{
"consoleWindow":{
"logLevel": "info",
"verticalOrientation":false
}
}
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"Plugin_ConfigurationArtifact__0_1_0": {
"species":"Horsie",
"age":3,
"carnivore":false,
"classification":"Vertebrates",
"color":"#FF0000",
"file":""
},
"ICorePanel":{
"consoleWindow":{
"logLevel": "info",
"verticalOrientation":false
}
}
}
HTTP status code 403
HTTP status code 404
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
patch /users/{username}/settings
Update setting within WebGME. Updates/overwrites the user's settings with the sent values for matching keys.
Basic authentication scheme
JWT Bearer with authentication token.
URI Parameters
- username: required(string)
Body
Media type: application/json
Type: any
Example:
{
"Plugin_ConfigurationArtifact__0_1_0": {
"carnivore":false
},
"ICorePanel":{
"consoleWindow":{
"verticalOrientation":true
}
}
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"Plugin_ConfigurationArtifact__0_1_0": {
"species":"Horsie",
"age":3,
"carnivore":false,
"classification":"Vertebrates",
"color":"#FF0000",
"file":""
},
"ICorePanel":{
"consoleWindow":{
"logLevel": "info",
"verticalOrientation":false
}
}
}
HTTP status code 403
HTTP status code 404
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
delete /users/{username}/settings
Delete setting from WebGME. Clears out the user's settings field (sets it to empty dictionary).
Basic authentication scheme
JWT Bearer with authentication token.
URI Parameters
- username: required(string)
Query Parameters
- force: (boolean)
If true and user.siteAdmin user will be deleted from database
Example:
true
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Entity representing a setting
Get the setting. Gets a specific component settings for a user, see https://github.com/webgme/webgme/wiki/Component-Settings
Add a new setting to WebGME. Overwrites the settings field for a specific component.
Update setting within WebGME. Updates/overwrites a specific component settings with the sent values for matching keys.
Delete setting from WebGME. Clears out the settings for a specific component.
get /users/{username}/settings/{componentId}
Get the setting. Gets a specific component settings for a user, see https://github.com/webgme/webgme/wiki/Component-Settings
Basic authentication scheme
JWT Bearer with authentication token.
URI Parameters
- username: required(string)
- componentId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"consoleWindow": {
"logLevel": "info",
"verticalOrientation":false
}
}
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{
"message": "setting not found"
}
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
put /users/{username}/settings/{componentId}
Add a new setting to WebGME. Overwrites the settings field for a specific component.
Basic authentication scheme
JWT Bearer with authentication token.
URI Parameters
- username: required(string)
- componentId: required(string)
Body
Media type: application/json
Type: any
Example:
{
"consoleWindow": {
"logLevel": "info",
"verticalOrientation":false
}
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"consoleWindow": {
"logLevel": "info",
"verticalOrientation":false
}
}
HTTP status code 403
HTTP status code 404
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
patch /users/{username}/settings/{componentId}
Update setting within WebGME. Updates/overwrites a specific component settings with the sent values for matching keys.
Basic authentication scheme
JWT Bearer with authentication token.
URI Parameters
- username: required(string)
- componentId: required(string)
Body
Media type: application/json
Type: any
Example:
{
"consoleWindow": {
"verticalOrientation":false
}
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"consoleWindow": {
"logLevel": "info",
"verticalOrientation":false
}
}
HTTP status code 403
HTTP status code 404
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
delete /users/{username}/settings/{componentId}
Delete setting from WebGME. Clears out the settings for a specific component.
Basic authentication scheme
JWT Bearer with authentication token.
URI Parameters
- username: required(string)
- componentId: required(string)
Query Parameters
- force: (boolean)
If true and user.siteAdmin user will be deleted from database
Example:
true
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
/orgs
End points for organizations on deployment. PUT/PATCH/DELETE requires that authenticated user is siteAdmin or admin in organization.
Collection of available organizations in WebGME
get /orgs
Collection of available organizations in WebGME
Basic authentication scheme
JWT Bearer with authentication token.
Query Parameters
- includeDisabled: (boolean)
If true and user.siteAdmin disabled organizations will be included in response.
Example:
true
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"_id": "webgme",
"projects": {
"guest+aaaaaa": {
"read": true,
"write": true,
"delete": false
},
"webgme+ASDF": {
"read": true,
"write": true,
"delete": true
}
},
"type": "Organization",
"admins": [
"user1",
"user2"
],
"info": {}
},
{
"_id": "org2",
"projects": {
"webgme+ASDF": {
"read": true,
"write": false,
"delete": false
}
},
"type": "Organization",
"admins": [
"pelleBlom"
],
"info": {}
},
{
"_id": "org",
"projects": {},
"type": "Organization",
"admins": [
"guest"
],
"info": {}
}
]
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Retrives organization data including members.
Create a new organization. Requires user.canCreate or user.siteAdmin.
Updates the organization info if given which requires admin in organization or user.siteAdmin. If {disabled ":" false} given and user.siteAdmin disabled organization will be re-enabled.
Delete an organization. Requires admin in organization or user.siteAdmin.
get /orgs/{orgId}
Retrives organization data including members.
Basic authentication scheme
JWT Bearer with authentication token.
URI Parameters
- orgId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"_id": "webgme",
"projects": {},
"type": "Organization",
"admins": [
"pelleBlom"
],
"info": {
"description": "My organization",
"webpage": "https://org.org"
},
"users": [
"pelleBlom"
]
}
HTTP status code 404
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
put /orgs/{orgId}
Create a new organization. Requires user.canCreate or user.siteAdmin.
Basic authentication scheme
JWT Bearer with authentication token.
URI Parameters
- orgId: required(string)
Body
Media type: application/json
Type: See_example
Example:
{
"info": {
"description": "My organization",
"webpage": "https://org.org"
}
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"_id": "webgme",
"projects": {},
"type": "Organization",
"admins": [
"pelleBlom"
],
"info": {
"description": "My organization",
"webpage": "https://org.org"
},
"users": [
"pelleBlom"
]
}
HTTP status code 403
HTTP status code 404
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
patch /orgs/{orgId}
Updates the organization info if given which requires admin in organization or user.siteAdmin. If {disabled ":" false} given and user.siteAdmin disabled organization will be re-enabled.
Basic authentication scheme
JWT Bearer with authentication token.
URI Parameters
- orgId: required(string)
Body
Media type: application/json
Type: See_example
Example:
{
"info": {
"description": "My organization",
"webpage": "https://org.org"
}
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"_id": "webgme",
"projects": {},
"type": "Organization",
"admins": [
"pelleBlom"
],
"info": {
"description": "My organization",
"webpage": "https://org.org"
},
"users": [
"pelleBlom"
]
}
HTTP status code 403
HTTP status code 404
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
delete /orgs/{orgId}
Delete an organization. Requires admin in organization or user.siteAdmin.
Basic authentication scheme
JWT Bearer with authentication token.
URI Parameters
- orgId: required(string)
Query Parameters
- force: (boolean)
If true and user.siteAdmin the organization will be permanently deleted from database.
Example:
true
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Adds user to the organization. Requires admin in organization or user.siteAdmin.
Delete user from the organization. Requires admin in organization or user.siteAdmin.
put /orgs/{orgId}/users/{username}
Adds user to the organization. Requires admin in organization or user.siteAdmin.
Basic authentication scheme
JWT Bearer with authentication token.
URI Parameters
- orgId: required(string)
- username: required(string)
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
delete /orgs/{orgId}/users/{username}
Delete user from the organization. Requires admin in organization or user.siteAdmin.
Basic authentication scheme
JWT Bearer with authentication token.
URI Parameters
- orgId: required(string)
- username: required(string)
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Make user admin for the organization. Requires admin in organization or user.siteAdmin.
Remove user from admins of the organization. Requires admin in organization or user.siteAdmin.
put /orgs/{orgId}/admins/{username}
Make user admin for the organization. Requires admin in organization or user.siteAdmin.
Basic authentication scheme
JWT Bearer with authentication token.
URI Parameters
- orgId: required(string)
- username: required(string)
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
delete /orgs/{orgId}/admins/{username}
Remove user from admins of the organization. Requires admin in organization or user.siteAdmin.
Basic authentication scheme
JWT Bearer with authentication token.
URI Parameters
- orgId: required(string)
- username: required(string)
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
/projects
Collection of available projects in WebGME.
Get a list of projects. Only lists the projects where the user has at least read access.
get /projects
Get a list of projects. Only lists the projects where the user has at least read access.
Basic authentication scheme
JWT Bearer with authentication token.
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"_id":"guest+FSM",
"owner":"guest",
"name":"FSM",
"fullName":"guest/FSM",
"info": {
"viewedAt": "2017-02-19T00:06:57.842Z",
"viewer": "guest",
"modifiedAt": "2017-02-13T20:34:23.217Z",
"modifier": "demo",
"createdAt": "2016-02-13T20:34:23.217Z",
"creator": "guest",
"kind": "FiniteStateMachine"
}
},
{
"_id":"guest+SFS",
"owner":"guest",
"name":"SFS",
"fullName":"guest/SFS",
"info": {
"viewedAt": "2017-02-19T00:06:57.842Z",
"viewer": "guest",
"modifiedAt": "2017-02-13T20:34:23.217Z",
"modifier": "demo",
"createdAt": "2016-02-13T20:34:23.217Z",
"creator": "guest",
"kind": "SignalFlowSystem"
}
}
]
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Entity representing a project
Get the project. Requires read access for project.
Add a new project to WebGME. Requires user.canCreate.
Update project within WebGME. Requires write access for project.
Delete project from WebGME. Requires delete access for project.
get /projects/{ownerId}/{projectName}
Get the project. Requires read access for project.
Basic authentication scheme
JWT Bearer with authentication token.
URI Parameters
- ownerId: required(string)
Example:
guest
- projectName: required(string)
Example:
ActivePanels
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"_id": "demo+FSM",
"owner": "demo",
"name": "FSM",
"info": {
"createdAt": "2015-11-03T22:08:35.706Z",
"viewedAt": "2015-12-01T22:42:08.713Z",
"viewer": "demo",
"modifiedAt": "2015-12-01T22:42:08.713Z",
"modifier": "demo",
"creator": "demo",
"kind": "FiniteStateMachine"
},
"branches": {
"important_point": "#48e883fe1fbd1f370a34263218e1572cc885b0bc",
"master": "#bd5ea217510a3f6a3f7e98fbdae0d10669ef9c2d"
},
"hooks": {
"hookOne": {
"events": [
"COMMIT"
],
"description": "The first ever webhook for WebGME",
"url": "http://index.hu",
"active": false
}
}
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{
"message": "project not found"
}
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
put /projects/{ownerId}/{projectName}
Add a new project to WebGME. Requires user.canCreate.
Basic authentication scheme
JWT Bearer with authentication token.
URI Parameters
- ownerId: required(string)
Example:
guest
- projectName: required(string)
Example:
ActivePanels
Body
Media type: application/json
Type: any
Example:
{
"type": "db",
"seedName": "me+myOtherProject",
"seedBranch": "master",
"ownerId": "myOrganization"
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"_id": "demo+FSM",
"owner": "demo",
"name": "FSM",
"info": {
"createdAt": "2015-11-03T22:08:35.706Z",
"viewedAt": "2015-12-01T22:42:08.713Z",
"viewer": "demo",
"modifiedAt": "2015-12-01T22:42:08.713Z",
"modifier": "demo",
"creator": "demo",
"kind": "FiniteStateMachine"
},
"branches": {
"important_point": "#48e883fe1fbd1f370a34263218e1572cc885b0bc",
"master": "#bd5ea217510a3f6a3f7e98fbdae0d10669ef9c2d"
},
"hooks": {
"hookOne": {
"events": [
"COMMIT"
],
"description": "The first ever webhook for WebGME",
"url": "http://index.hu",
"active": false
}
}
HTTP status code 403
HTTP status code 404
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
patch /projects/{ownerId}/{projectName}
Update project within WebGME. Requires write access for project.
Basic authentication scheme
JWT Bearer with authentication token.
URI Parameters
- ownerId: required(string)
Example:
guest
- projectName: required(string)
Example:
ActivePanels
Body
Media type: application/json
Type: any
Example:
{
"createdAt": "2015-11-03T22:08:35.706Z",
"viewedAt": "2015-12-01T22:42:08.713Z",
"viewer": "gurka",
"modifiedAt": "2015-12-01T22:42:08.713Z",
"modifier": "arnold",
"creator": "pelleBlom",
"kind": null
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"_id": "demo+FSM",
"owner": "demo",
"name": "FSM",
"info": {
"createdAt": "2015-11-03T22:08:35.706Z",
"viewedAt": "2015-12-01T22:42:08.713Z",
"viewer": "demo",
"modifiedAt": "2015-12-01T22:42:08.713Z",
"modifier": "demo",
"creator": "demo",
"kind": "FiniteStateMachine"
},
"branches": {
"important_point": "#48e883fe1fbd1f370a34263218e1572cc885b0bc",
"master": "#bd5ea217510a3f6a3f7e98fbdae0d10669ef9c2d"
},
"hooks": {
"hookOne": {
"events": [
"COMMIT"
],
"description": "The first ever webhook for WebGME",
"url": "http://index.hu",
"active": false
}
}
HTTP status code 403
HTTP status code 404
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
delete /projects/{ownerId}/{projectName}
Delete project from WebGME. Requires delete access for project.
Basic authentication scheme
JWT Bearer with authentication token.
URI Parameters
- ownerId: required(string)
Example:
guest
- projectName: required(string)
Example:
ActivePanels
Query Parameters
- force: (boolean)
If true and user.siteAdmin user will be deleted from database
Example:
true
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Retrives an array of latested commits made to the project. Requires read access for project.
get /projects/{ownerId}/{projectName}/commits
Retrives an array of latested commits made to the project. Requires read access for project.
URI Parameters
- ownerId: required(string)
Example:
guest
- projectName: required(string)
Example:
ActivePanels
Query Parameters
- n: (number)
Maximum number of commits to retrieve (default 100).
Example:
2
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"_id": "#f2a624d9cfbf883c927b04dd45800ba55537dff5",
"root": "#e1721a407ecce45c83b7352a62349cada71056bf",
"parents": [
"#4ac76d63da6f50cc5baaa5bfb42c86138edc9396"
],
"updater": [
"guest"
],
"time": 1449590037764,
"message": "[setRegistry(/1054504320/354493498/496824070/2098980444,,rotation,0)]",
"type": "commit"
},
{
"_id": "#4ac76d63da6f50cc5baaa5bfb42c86138edc9396",
"root": "#6fc60b12e9b17ebb69231fae3356455365d0f8b9",
"parents": [
""
],
"updater": [
"guest"
],
"time": 1449589988631,
"message": "project created",
"type": "commit"
}
]
HTTP status code 403
Retrieves the commit object associated with the commitId. Requires read access for project.
get /projects/{ownerId}/{projectName}/commits/{commitId}
Retrieves the commit object associated with the commitId. Requires read access for project.
URI Parameters
- ownerId: required(string)
Example:
guest
- projectName: required(string)
Example:
ActivePanels
- commitId: required(string)
Commit hash, with or without URL-encoded '#'.
Example:
b83ee8d50034fc96f006176bba516e68ce50838a
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"root": "#20d99ca1c0a2ec8a256d0beda8302d2bc0ddd300",
"parents": [
"#8b2ce483f807d52d44a9377d08ac5a7573ddb07c"
],
"updater": [
"pmeijer"
],
"time": 1448397167677,
"message": "[setRegistry(/1036661779/588886926,,position,[object Object])]",
"type": "commit",
"_id": "#cdfc41958e056e5faf59ff3059394368204a7bbc"
}
HTTP status code 403
Retrieves the given state of the project as a webgmex file. Requires read access for project.
get /projects/{ownerId}/{projectName}/commits/{commitId}/export
Retrieves the given state of the project as a webgmex file. Requires read access for project.
URI Parameters
- ownerId: required(string)
Example:
guest
- projectName: required(string)
Example:
ActivePanels
- commitId: required(string)
Commit hash, with or without URL-encoded '#'.
Example:
b83ee8d50034fc96f006176bba516e68ce50838a
Retrieves the given state of a model - pointed by the path of its root node - as a webgmexm file. Requires read access for project.
get /projects/{ownerId}/{projectName}/commits/{commitId}/export/{nodePath}
Retrieves the given state of a model - pointed by the path of its root node - as a webgmexm file. Requires read access for project.
URI Parameters
- ownerId: required(string)
Example:
guest
- projectName: required(string)
Example:
ActivePanels
- commitId: required(string)
Commit hash, with or without URL-encoded '#'.
Example:
b83ee8d50034fc96f006176bba516e68ce50838a
- nodePath: required(string)
Example:
1aB/CdE2
Retrieves the raw data object at given path within the project tree. Requires read access for project.
get /projects/{ownerId}/{projectName}/commits/{commitId}/tree/{nodePath}
Retrieves the raw data object at given path within the project tree. Requires read access for project.
URI Parameters
- ownerId: required(string)
Example:
guest
- projectName: required(string)
Example:
ActivePanels
- commitId: required(string)
Commit hash, with or without URL-encoded '#'.
Example:
b83ee8d50034fc96f006176bba516e68ce50838a
- nodePath: required(string)
Example:
1563412505/5585498754
Collection of available branches in WebGME.
Get a list of branches. Requires read access for project.
get /projects/{ownerId}/{projectName}/branches
Get a list of branches. Requires read access for project.
Basic authentication scheme
JWT Bearer with authentication token.
URI Parameters
- ownerId: required(string)
Example:
guest
- projectName: required(string)
Example:
ActivePanels
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"dev":"#6d9f4a36be8339b6841c0ddf74eebdf4a6387288",
"development":"#865778bd9f9f800ffaf280493fd88711531d1012",
"master":"#d46d17982c3800c6a4c8226c89c3609fc4c0ab86",
"merge":"#51228646fe143d04a36fc8fd369e2c1ccadfd173"
}
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Entity representing a branch
Get the branch. Requires read access for project.
Add a new branch to WebGME. Requires write access for project.
Update branch within WebGME. Requires write access for project.
Delete branch from WebGME. Requires write access for project.
get /projects/{ownerId}/{projectName}/branches/{branchId}
Get the branch. Requires read access for project.
Basic authentication scheme
JWT Bearer with authentication token.
URI Parameters
- ownerId: required(string)
Example:
guest
- projectName: required(string)
Example:
ActivePanels
- branchId: required(string)
Example:
master
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"projectId":"guest+2b",
"branchName":"master",
"commitObject":{
"_id":"#d46d17982c3800c6a4c8226c89c3609fc4c0ab86",
"root":"#6ed2563c110b9830fef84fc23a10e645580faf91",
"parents":[
"#6efa0d336ea87b167b336488aaa87999a4569bdf",
"#9859beb3d5576e7fc9db815139fb22c6cbf9ac43"
],
"updater":[
"guest"
],
"time":1441132232802,
"message":"merge with resolved conflicts",
"type":"commit"
},
"coreObjects":[
{
"1":"#11dcbaa8c6ffeda59b6d07d16fee199d4ced20cb",
"313149126":"#631334e2a457548892986c4cf912bac5073b58f8",
"1675786949":"#745d0a40cc3607cd2e7226ecd2d4de369365751f",
"_id":"#6ed2563c110b9830fef84fc23a10e645580faf91",
"_nullptr":{
"atr":{
"name":"_null_pointer"
}
},
"ovr":{
"":{
"base":"/_nullptr"
},
"/_nullptr":{
"base-inv":[
""
]
},
"/_sets/MetaAspectSet/1453535609":{
"member":"/1"
},
"/1":{
"member-inv":[
"/_sets/MetaAspectSet/1453535609",
"/_sets/MetaAspectSet_68f8146d-b1b7-6c40-3464-f8c070e97e8d/164185714",
"/_meta/children/_sets/items/206643370"
],
"base-inv":[
"/313149126",
"/1675786949"
]
},
"/_sets/MetaAspectSet_68f8146d-b1b7-6c40-3464-f8c070e97e8d/164185714":{
"member":"/1"
},
"/_meta/children/_sets/items/206643370":{
"member":"/1"
},
"/313149126":{
"base":"/1"
},
"/1675786949":{
"base":"/1"
}
},
"atr":{
"_relguid":"03d360729e097866cb4ed0a36ff825f6",
"name":"ROOT"
},
"reg":{
"MetaSheets":[
{
"SetID":"MetaAspectSet_68f8146d-b1b7-6c40-3464-f8c070e97e8d",
"order":0,
"title":"META"
}
],
"ProjectRegistry":{
"FCO_ID":"/1"
},
"usedAddOns":"ConstraintAddOn",
"validPlugins":"PluginGenerator MergeExample",
"validDecorators":"ModelDecorator CircleDecorator MetaDecorator SVGDecorator UMLStateMachineDecorator DefaultDecorator",
"validVisualizers":"ModelEditor METAAspect",
"_sets_":6
},
"_sets":{
"MetaAspectSet":{
"1453535609":{
"reg":{
"_":"_",
"position":{
"x":100,
"y":100
}
}
},
"reg":{
"_":"_"
}
},
"_nullptr":{
"atr":{
"name":"_null_pointer"
}
},
"ovr":{
"":{
"MetaAspectSet":"/_nullptr",
"MetaAspectSet_68f8146d-b1b7-6c40-3464-f8c070e97e8d":"/_nullptr"
},
"/_nullptr":{
"MetaAspectSet-inv":[
""
],
"MetaAspectSet_68f8146d-b1b7-6c40-3464-f8c070e97e8d-inv":[
""
]
}
},
"MetaAspectSet_68f8146d-b1b7-6c40-3464-f8c070e97e8d":{
"164185714":{
"reg":{
"_":"_",
"position":{
"x":100,
"y":100
}
}
},
"reg":{
"_":"_"
}
}
},
"_meta":{
"atr":{
"name":{
"type":"string"
}
},
"children":{
"_sets":{
"items":{
"206643370":{
"reg":{
"_":"_"
},
"atr":{
"min":-1,
"max":-1
}
},
"reg":{
"_":"_"
}
},
"_nullptr":{
"atr":{
"name":"_null_pointer"
}
},
"ovr":{
"":{
"items":"/_nullptr"
},
"/_nullptr":{
"items-inv":[
""
]
}
}
},
"reg":{
"_sets_":4
}
}
}
}
]
}
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{
"message": "branch not found"
}
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
put /projects/{ownerId}/{projectName}/branches/{branchId}
Add a new branch to WebGME. Requires write access for project.
Basic authentication scheme
JWT Bearer with authentication token.
URI Parameters
- ownerId: required(string)
Example:
guest
- projectName: required(string)
Example:
ActivePanels
- branchId: required(string)
Example:
master
Body
Media type: application/json
Type: any
Example:
{ "hash": "#f2a624d9cfbf883c927b04dd45800ba55537dff5" }
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"projectId":"guest+2b",
"branchName":"master",
"commitObject":{
"_id":"#d46d17982c3800c6a4c8226c89c3609fc4c0ab86",
"root":"#6ed2563c110b9830fef84fc23a10e645580faf91",
"parents":[
"#6efa0d336ea87b167b336488aaa87999a4569bdf",
"#9859beb3d5576e7fc9db815139fb22c6cbf9ac43"
],
"updater":[
"guest"
],
"time":1441132232802,
"message":"merge with resolved conflicts",
"type":"commit"
},
"coreObjects":[
{
"1":"#11dcbaa8c6ffeda59b6d07d16fee199d4ced20cb",
"313149126":"#631334e2a457548892986c4cf912bac5073b58f8",
"1675786949":"#745d0a40cc3607cd2e7226ecd2d4de369365751f",
"_id":"#6ed2563c110b9830fef84fc23a10e645580faf91",
"_nullptr":{
"atr":{
"name":"_null_pointer"
}
},
"ovr":{
"":{
"base":"/_nullptr"
},
"/_nullptr":{
"base-inv":[
""
]
},
"/_sets/MetaAspectSet/1453535609":{
"member":"/1"
},
"/1":{
"member-inv":[
"/_sets/MetaAspectSet/1453535609",
"/_sets/MetaAspectSet_68f8146d-b1b7-6c40-3464-f8c070e97e8d/164185714",
"/_meta/children/_sets/items/206643370"
],
"base-inv":[
"/313149126",
"/1675786949"
]
},
"/_sets/MetaAspectSet_68f8146d-b1b7-6c40-3464-f8c070e97e8d/164185714":{
"member":"/1"
},
"/_meta/children/_sets/items/206643370":{
"member":"/1"
},
"/313149126":{
"base":"/1"
},
"/1675786949":{
"base":"/1"
}
},
"atr":{
"_relguid":"03d360729e097866cb4ed0a36ff825f6",
"name":"ROOT"
},
"reg":{
"MetaSheets":[
{
"SetID":"MetaAspectSet_68f8146d-b1b7-6c40-3464-f8c070e97e8d",
"order":0,
"title":"META"
}
],
"ProjectRegistry":{
"FCO_ID":"/1"
},
"usedAddOns":"ConstraintAddOn",
"validPlugins":"PluginGenerator MergeExample",
"validDecorators":"ModelDecorator CircleDecorator MetaDecorator SVGDecorator UMLStateMachineDecorator DefaultDecorator",
"validVisualizers":"ModelEditor METAAspect",
"_sets_":6
},
"_sets":{
"MetaAspectSet":{
"1453535609":{
"reg":{
"_":"_",
"position":{
"x":100,
"y":100
}
}
},
"reg":{
"_":"_"
}
},
"_nullptr":{
"atr":{
"name":"_null_pointer"
}
},
"ovr":{
"":{
"MetaAspectSet":"/_nullptr",
"MetaAspectSet_68f8146d-b1b7-6c40-3464-f8c070e97e8d":"/_nullptr"
},
"/_nullptr":{
"MetaAspectSet-inv":[
""
],
"MetaAspectSet_68f8146d-b1b7-6c40-3464-f8c070e97e8d-inv":[
""
]
}
},
"MetaAspectSet_68f8146d-b1b7-6c40-3464-f8c070e97e8d":{
"164185714":{
"reg":{
"_":"_",
"position":{
"x":100,
"y":100
}
}
},
"reg":{
"_":"_"
}
}
},
"_meta":{
"atr":{
"name":{
"type":"string"
}
},
"children":{
"_sets":{
"items":{
"206643370":{
"reg":{
"_":"_"
},
"atr":{
"min":-1,
"max":-1
}
},
"reg":{
"_":"_"
}
},
"_nullptr":{
"atr":{
"name":"_null_pointer"
}
},
"ovr":{
"":{
"items":"/_nullptr"
},
"/_nullptr":{
"items-inv":[
""
]
}
}
},
"reg":{
"_sets_":4
}
}
}
}
]
}
HTTP status code 403
HTTP status code 404
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
patch /projects/{ownerId}/{projectName}/branches/{branchId}
Update branch within WebGME. Requires write access for project.
Basic authentication scheme
JWT Bearer with authentication token.
URI Parameters
- ownerId: required(string)
Example:
guest
- projectName: required(string)
Example:
ActivePanels
- branchId: required(string)
Example:
master
Body
Media type: application/json
Type: any
Example:
{ "oldHash": "#f2a624d9cfbf883c927b04dd45800ba55537dff5", "newHash": "#4ac76d63da6f50cc5baaa5bfb42c86138edc9396" }
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"projectId":"guest+2b",
"branchName":"master",
"commitObject":{
"_id":"#d46d17982c3800c6a4c8226c89c3609fc4c0ab86",
"root":"#6ed2563c110b9830fef84fc23a10e645580faf91",
"parents":[
"#6efa0d336ea87b167b336488aaa87999a4569bdf",
"#9859beb3d5576e7fc9db815139fb22c6cbf9ac43"
],
"updater":[
"guest"
],
"time":1441132232802,
"message":"merge with resolved conflicts",
"type":"commit"
},
"coreObjects":[
{
"1":"#11dcbaa8c6ffeda59b6d07d16fee199d4ced20cb",
"313149126":"#631334e2a457548892986c4cf912bac5073b58f8",
"1675786949":"#745d0a40cc3607cd2e7226ecd2d4de369365751f",
"_id":"#6ed2563c110b9830fef84fc23a10e645580faf91",
"_nullptr":{
"atr":{
"name":"_null_pointer"
}
},
"ovr":{
"":{
"base":"/_nullptr"
},
"/_nullptr":{
"base-inv":[
""
]
},
"/_sets/MetaAspectSet/1453535609":{
"member":"/1"
},
"/1":{
"member-inv":[
"/_sets/MetaAspectSet/1453535609",
"/_sets/MetaAspectSet_68f8146d-b1b7-6c40-3464-f8c070e97e8d/164185714",
"/_meta/children/_sets/items/206643370"
],
"base-inv":[
"/313149126",
"/1675786949"
]
},
"/_sets/MetaAspectSet_68f8146d-b1b7-6c40-3464-f8c070e97e8d/164185714":{
"member":"/1"
},
"/_meta/children/_sets/items/206643370":{
"member":"/1"
},
"/313149126":{
"base":"/1"
},
"/1675786949":{
"base":"/1"
}
},
"atr":{
"_relguid":"03d360729e097866cb4ed0a36ff825f6",
"name":"ROOT"
},
"reg":{
"MetaSheets":[
{
"SetID":"MetaAspectSet_68f8146d-b1b7-6c40-3464-f8c070e97e8d",
"order":0,
"title":"META"
}
],
"ProjectRegistry":{
"FCO_ID":"/1"
},
"usedAddOns":"ConstraintAddOn",
"validPlugins":"PluginGenerator MergeExample",
"validDecorators":"ModelDecorator CircleDecorator MetaDecorator SVGDecorator UMLStateMachineDecorator DefaultDecorator",
"validVisualizers":"ModelEditor METAAspect",
"_sets_":6
},
"_sets":{
"MetaAspectSet":{
"1453535609":{
"reg":{
"_":"_",
"position":{
"x":100,
"y":100
}
}
},
"reg":{
"_":"_"
}
},
"_nullptr":{
"atr":{
"name":"_null_pointer"
}
},
"ovr":{
"":{
"MetaAspectSet":"/_nullptr",
"MetaAspectSet_68f8146d-b1b7-6c40-3464-f8c070e97e8d":"/_nullptr"
},
"/_nullptr":{
"MetaAspectSet-inv":[
""
],
"MetaAspectSet_68f8146d-b1b7-6c40-3464-f8c070e97e8d-inv":[
""
]
}
},
"MetaAspectSet_68f8146d-b1b7-6c40-3464-f8c070e97e8d":{
"164185714":{
"reg":{
"_":"_",
"position":{
"x":100,
"y":100
}
}
},
"reg":{
"_":"_"
}
}
},
"_meta":{
"atr":{
"name":{
"type":"string"
}
},
"children":{
"_sets":{
"items":{
"206643370":{
"reg":{
"_":"_"
},
"atr":{
"min":-1,
"max":-1
}
},
"reg":{
"_":"_"
}
},
"_nullptr":{
"atr":{
"name":"_null_pointer"
}
},
"ovr":{
"":{
"items":"/_nullptr"
},
"/_nullptr":{
"items-inv":[
""
]
}
}
},
"reg":{
"_sets_":4
}
}
}
}
]
}
HTTP status code 403
HTTP status code 404
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
delete /projects/{ownerId}/{projectName}/branches/{branchId}
Delete branch from WebGME. Requires write access for project.
Basic authentication scheme
JWT Bearer with authentication token.
URI Parameters
- ownerId: required(string)
Example:
guest
- projectName: required(string)
Example:
ActivePanels
- branchId: required(string)
Example:
master
Query Parameters
- force: (boolean)
If true and user.siteAdmin user will be deleted from database
Example:
true
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Retrives an array of the commit history for the branch. Requires read access for project.
get /projects/{ownerId}/{projectName}/branches/{branchId}/commits
Retrives an array of the commit history for the branch. Requires read access for project.
URI Parameters
- ownerId: required(string)
Example:
guest
- projectName: required(string)
Example:
ActivePanels
- branchId: required(string)
Example:
master
Query Parameters
- n: (number)
Maximum number of commits to retrieve (default 100).
Example:
2
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"_id": "#f2a624d9cfbf883c927b04dd45800ba55537dff5",
"root": "#e1721a407ecce45c83b7352a62349cada71056bf",
"parents": [
"#4ac76d63da6f50cc5baaa5bfb42c86138edc9396"
],
"updater": [
"guest"
],
"time": 1449590037764,
"message": "[setRegistry(/1054504320/354493498/496824070/2098980444,,rotation,0)]",
"type": "commit"
},
{
"_id": "#4ac76d63da6f50cc5baaa5bfb42c86138edc9396",
"root": "#6fc60b12e9b17ebb69231fae3356455365d0f8b9",
"parents": [
""
],
"updater": [
"guest"
],
"time": 1449589988631,
"message": "project created",
"type": "commit"
}
]
HTTP status code 403
Retrieves the given state of the project as a webgmex file. Requires read acces of project.
get /projects/{ownerId}/{projectName}/branches/{branchId}/export
Retrieves the given state of the project as a webgmex file. Requires read acces of project.
Retrieves the given state of a model - pointed by the path of its root - as a webgmexm file. Requires read access of project.
get /projects/{ownerId}/{projectName}/branches/{branchId}/export/{nodePath}
Retrieves the given state of a model - pointed by the path of its root - as a webgmexm file. Requires read access of project.
Retrieves the raw data object at given path within the project tree. Requires read access for project.
get /projects/{ownerId}/{projectName}/branches/{branchId}/tree/{nodePath}
Retrieves the raw data object at given path within the project tree. Requires read access for project.
URI Parameters
- ownerId: required(string)
Example:
guest
- projectName: required(string)
Example:
ActivePanels
- branchId: required(string)
Example:
master
- nodePath: required(string)
Example:
1563412505/5585498754
Collection of available tags in WebGME.
Get a list of tags. Requires read access for project.
get /projects/{ownerId}/{projectName}/tags
Get a list of tags. Requires read access for project.
Basic authentication scheme
JWT Bearer with authentication token.
URI Parameters
- ownerId: required(string)
Example:
guest
- projectName: required(string)
Example:
ActivePanels
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"dev":"#6d9f4a36be8339b6841c0ddf74eebdf4a6387288",
"development":"#865778bd9f9f800ffaf280493fd88711531d1012",
"master":"#d46d17982c3800c6a4c8226c89c3609fc4c0ab86",
"merge":"#51228646fe143d04a36fc8fd369e2c1ccadfd173"
}
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Entity representing a tag
Get the tag. Requires read access for project.
Add a new tag to WebGME. Requires write access for project.
Update tag within WebGME. Requires delete access for project.
Delete tag from WebGME. Requires delete access for project.
get /projects/{ownerId}/{projectName}/tags/{tagId}
Get the tag. Requires read access for project.
Basic authentication scheme
JWT Bearer with authentication token.
URI Parameters
- ownerId: required(string)
Example:
guest
- projectName: required(string)
Example:
ActivePanels
- tagId: required(string)
Example:
myTag
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"root": "#20d99ca1c0a2ec8a256d0beda8302d2bc0ddd300",
"parents": [
"#8b2ce483f807d52d44a9377d08ac5a7573ddb07c"
],
"updater": [
"pmeijer"
],
"time": 1448397167677,
"message": "[setRegistry(/1036661779/588886926,,position,[object Object])]",
"type": "commit",
"_id": "#cdfc41958e056e5faf59ff3059394368204a7bbc"
}
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{
"message": "tag not found"
}
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
put /projects/{ownerId}/{projectName}/tags/{tagId}
Add a new tag to WebGME. Requires write access for project.
Basic authentication scheme
JWT Bearer with authentication token.
URI Parameters
- ownerId: required(string)
Example:
guest
- projectName: required(string)
Example:
ActivePanels
- tagId: required(string)
Example:
myTag
Body
Media type: application/json
Type: any
Example:
{ "hash": "#f2a624d9cfbf883c927b04dd45800ba55537dff5" }
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"root": "#20d99ca1c0a2ec8a256d0beda8302d2bc0ddd300",
"parents": [
"#8b2ce483f807d52d44a9377d08ac5a7573ddb07c"
],
"updater": [
"pmeijer"
],
"time": 1448397167677,
"message": "[setRegistry(/1036661779/588886926,,position,[object Object])]",
"type": "commit",
"_id": "#cdfc41958e056e5faf59ff3059394368204a7bbc"
}
HTTP status code 403
HTTP status code 404
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
patch /projects/{ownerId}/{projectName}/tags/{tagId}
Update tag within WebGME. Requires delete access for project.
Basic authentication scheme
JWT Bearer with authentication token.
URI Parameters
- ownerId: required(string)
Example:
guest
- projectName: required(string)
Example:
ActivePanels
- tagId: required(string)
Example:
myTag
Body
Media type: application/json
Type: any
Example:
{ "hash": "#f2a624d9cfbf883c927b04dd45800ba55537dff5" }
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"root": "#20d99ca1c0a2ec8a256d0beda8302d2bc0ddd300",
"parents": [
"#8b2ce483f807d52d44a9377d08ac5a7573ddb07c"
],
"updater": [
"pmeijer"
],
"time": 1448397167677,
"message": "[setRegistry(/1036661779/588886926,,position,[object Object])]",
"type": "commit",
"_id": "#cdfc41958e056e5faf59ff3059394368204a7bbc"
}
HTTP status code 403
HTTP status code 404
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
delete /projects/{ownerId}/{projectName}/tags/{tagId}
Delete tag from WebGME. Requires delete access for project.
Basic authentication scheme
JWT Bearer with authentication token.
URI Parameters
- ownerId: required(string)
Example:
guest
- projectName: required(string)
Example:
ActivePanels
- tagId: required(string)
Example:
myTag
Query Parameters
- force: (boolean)
If true and user.siteAdmin user will be deleted from database
Example:
true
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Retrieves the given state of the project as a webgmex file. Requires read access of project.
get /projects/{ownerId}/{projectName}/tags/{tagId}/export
Retrieves the given state of the project as a webgmex file. Requires read access of project.
Retrieves the given state of a model - pointed by its root path - as a webgmexm file. Requires read access of project.
get /projects/{ownerId}/{projectName}/tags/{tagId}/export/{nodePath}
Retrieves the given state of a model - pointed by its root path - as a webgmexm file. Requires read access of project.
Retrieves the raw data object at given path within the project tree. Requires read access for project.
get /projects/{ownerId}/{projectName}/tags/{tagId}/tree/{nodePath}
Retrieves the raw data object at given path within the project tree. Requires read access for project.
URI Parameters
- ownerId: required(string)
Example:
guest
- projectName: required(string)
Example:
ActivePanels
- tagId: required(string)
Example:
myTag
- nodePath: required(string)
Example:
1563412505/5585498754
Returns with the list of webHooks.
Get a list of hooks. Requires read access for project.
get /projects/{ownerId}/{projectName}/hooks
Get a list of hooks. Requires read access for project.
Basic authentication scheme
JWT Bearer with authentication token.
URI Parameters
- ownerId: required(string)
Example:
guest
- projectName: required(string)
Example:
ActivePanels
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"dev":"#6d9f4a36be8339b6841c0ddf74eebdf4a6387288",
"development":"#865778bd9f9f800ffaf280493fd88711531d1012",
"master":"#d46d17982c3800c6a4c8226c89c3609fc4c0ab86",
"merge":"#51228646fe143d04a36fc8fd369e2c1ccadfd173"
}
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Returns with the webHook information.
Get the hook. Requires read access for project.
Add a new hook to WebGME. Requires write access for project.
Update hook within WebGME. Requires write access for project.
Delete hook from WebGME. Requires write access for project.
get /projects/{ownerId}/{projectName}/hooks/{hookId}
Get the hook. Requires read access for project.
Basic authentication scheme
JWT Bearer with authentication token.
URI Parameters
- ownerId: required(string)
Example:
guest
- projectName: required(string)
Example:
ActivePanels
- hookId: required(string)
Example:
myHook
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"root": "#20d99ca1c0a2ec8a256d0beda8302d2bc0ddd300",
"parents": [
"#8b2ce483f807d52d44a9377d08ac5a7573ddb07c"
],
"updater": [
"pmeijer"
],
"time": 1448397167677,
"message": "[setRegistry(/1036661779/588886926,,position,[object Object])]",
"type": "commit",
"_id": "#cdfc41958e056e5faf59ff3059394368204a7bbc"
}
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{
"message": "hook not found"
}
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
put /projects/{ownerId}/{projectName}/hooks/{hookId}
Add a new hook to WebGME. Requires write access for project.
Basic authentication scheme
JWT Bearer with authentication token.
URI Parameters
- ownerId: required(string)
Example:
guest
- projectName: required(string)
Example:
ActivePanels
- hookId: required(string)
Example:
myHook
Body
Media type: application/json
Type: any
Example:
{ "events": ["commit","branchCreated"], "description": "Information about the hook", "url": "http://address/to/the/hook" }
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"root": "#20d99ca1c0a2ec8a256d0beda8302d2bc0ddd300",
"parents": [
"#8b2ce483f807d52d44a9377d08ac5a7573ddb07c"
],
"updater": [
"pmeijer"
],
"time": 1448397167677,
"message": "[setRegistry(/1036661779/588886926,,position,[object Object])]",
"type": "commit",
"_id": "#cdfc41958e056e5faf59ff3059394368204a7bbc"
}
HTTP status code 403
HTTP status code 404
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
patch /projects/{ownerId}/{projectName}/hooks/{hookId}
Update hook within WebGME. Requires write access for project.
Basic authentication scheme
JWT Bearer with authentication token.
URI Parameters
- ownerId: required(string)
Example:
guest
- projectName: required(string)
Example:
ActivePanels
- hookId: required(string)
Example:
myHook
Body
Media type: application/json
Type: any
Example:
{ "active": false }
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"root": "#20d99ca1c0a2ec8a256d0beda8302d2bc0ddd300",
"parents": [
"#8b2ce483f807d52d44a9377d08ac5a7573ddb07c"
],
"updater": [
"pmeijer"
],
"time": 1448397167677,
"message": "[setRegistry(/1036661779/588886926,,position,[object Object])]",
"type": "commit",
"_id": "#cdfc41958e056e5faf59ff3059394368204a7bbc"
}
HTTP status code 403
HTTP status code 404
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
delete /projects/{ownerId}/{projectName}/hooks/{hookId}
Delete hook from WebGME. Requires write access for project.
Basic authentication scheme
JWT Bearer with authentication token.
URI Parameters
- ownerId: required(string)
Example:
guest
- projectName: required(string)
Example:
ActivePanels
- hookId: required(string)
Example:
myHook
Query Parameters
- force: (boolean)
If true and user.siteAdmin user will be deleted from database
Example:
true
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Squash multi commits into a single one. Requires write access for project.
put /projects/{ownerId}/{projectName}/squash
Squash multi commits into a single one. Requires write access for project.
Basic authentication scheme
JWT Bearer with authentication token.
URI Parameters
- ownerId: required(string)
Example:
guest
- projectName: required(string)
Example:
ActivePanels
Body
Media type: application/json
Type: any
Example:
{
"fromCommit": "#6e41041cf8e6cf3f81039c101b3adfc46ab703d4",
"toCommitOrBranch": "master",
"message": "feature 'A' squashed into a single commit"
}
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Remove user's or organization's access rights to the project. Requires at least one of the following from user; is owner of the project, is admin in the organization that owns the project, or is siteAdmin.
delete /projects/{ownerId}/{projectName}/authorize/{userOrOrgId}
Remove user's or organization's access rights to the project. Requires at least one of the following from user; is owner of the project, is admin in the organization that owns the project, or is siteAdmin.
Grants user or organization access to the project. Requires at least one of the following from user; is owner of the project, is admin in the organization that owns the project, or is siteAdmin.
put /projects/{ownerId}/{projectName}/authorize/{userOrOrgId}/{rights}
Grants user or organization access to the project. Requires at least one of the following from user; is owner of the project, is admin in the organization that owns the project, or is siteAdmin.
get /projects/{ownerId}/{projectName}/compare/{branchOrCommitA}...{branchOrCommitB}
URI Parameters
- ownerId: required(string)
Example:
guest
- projectName: required(string)
Example:
ActivePanels
- branchOrCommitA: required(string)
- branchOrCommitB: required(string)
/status
End points for server status. These paths are only available for siteAdmins when auth is turned on.
Returns a combined object of all different statuses (if add-ons are disabled addOns will be null).
get /status
Returns a combined object of all different statuses (if add-ons are disabled addOns will be null).
Basic authentication scheme
JWT Bearer with authentication token.
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"addOns": {
"guest+ANewProject": {
"initRequested": true,
"closeRequested": false,
"renewingToken": false,
"inStoppedAndStarted": 0,
"branchMonitors": {
"master": {
"startRequested": true,
"stopRequested": false,
"branchIsOpen": true,
"commitHash": "#0a1b4a3c4f1a4e4efcb4914192f227e801f421a3",
"runningAddOns": [],
"lastActivity": 1520290354966
}
}
},
"guest+LogicGates": {
"initRequested": true,
"closeRequested": false,
"renewingToken": false,
"inStoppedAndStarted": 0,
"branchMonitors": {
"master": {
"startRequested": true,
"stopRequested": false,
"branchIsOpen": true,
"commitHash": "#980a3e12e6c77efe51163989222b7f703026bcff",
"runningAddOns": [],
"lastActivity": 1520290366899
}
}
}
},
"serverWorkers": {
"waitingRequests": [],
"workers": [
{
"pid": "3668",
"state": "working",
"request": {
"command": "exportProjectToFile",
"projectId": "guest+ANewProject",
"commitHash": "#0a1b4a3c4f1a4e4efcb4914192f227e801f421a3",
"withAssets": true,
"userId": "hans",
"socketId": "A2Vo2ji9PAxNCqaFAAAG"
}
},
{
"pid": "4692",
"state": "free"
}
]
},
"webSockets": [
{
"socketId": "A2Vo2ji9PAxNCqaFAAAG",
"userId": "hans",
"connectedSince": "Mon Mar 05 2018 16:52:33 GMT-0600 (Central Standard Time)"
},
{
"socketId": "hXhumKK5MuVSbAJHAAAH",
"userId": "olle",
"connectedSince": "Mon Mar 05 2018 16:52:34 GMT-0600 (Central Standard Time)"
},
{
"socketId": "BgKWYImd4d0wSMFYAAAI",
"userId": "guest",
"connectedSince": "Mon Mar 05 2018 16:52:45 GMT-0600 (Central Standard Time)"
},
{
"socketId": "T1PbWEZ_8nxL2hFpAAAJ",
"userId": "guest",
"connectedSince": "Mon Mar 05 2018 16:52:46 GMT-0600 (Central Standard Time)"
},
{
"socketId": "-WydaU_FsQcpCFwqAAAK",
"userId": "ragnar",
"connectedSince": "Mon Mar 05 2018 16:53:50 GMT-0600 (Central Standard Time)"
}
]
}
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Returns status about running addons (404 if add-ons are disabled)
get /status/add-ons
Returns status about running addons (404 if add-ons are disabled)
Basic authentication scheme
JWT Bearer with authentication token.
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"guest+ANewProject": {
"initRequested": true,
"closeRequested": false,
"renewingToken": false,
"inStoppedAndStarted": 0,
"branchMonitors": {
"master": {
"startRequested": true,
"stopRequested": false,
"branchIsOpen": true,
"commitHash": "#0a1b4a3c4f1a4e4efcb4914192f227e801f421a3",
"runningAddOns": [],
"lastActivity": 1520290354966
}
}
},
"guest+LogicGates": {
"initRequested": true,
"closeRequested": false,
"renewingToken": false,
"inStoppedAndStarted": 0,
"branchMonitors": {
"master": {
"startRequested": true,
"stopRequested": false,
"branchIsOpen": true,
"commitHash": "#980a3e12e6c77efe51163989222b7f703026bcff",
"runningAddOns": [],
"lastActivity": 1520290366899
}
}
}
}
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Returns status about running server workers and request queue
get /status/server-workers
Returns status about running server workers and request queue
Basic authentication scheme
JWT Bearer with authentication token.
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"waitingRequests": [],
"workers": [
{
"pid": "3668",
"state": "working",
"request": {
"command": "exportProjectToFile",
"projectId": "guest+ANewProject",
"commitHash": "#0a1b4a3c4f1a4e4efcb4914192f227e801f421a3",
"withAssets": true,
"userId": "hans",
"socketId": "A2Vo2ji9PAxNCqaFAAAG"
}
},
{
"pid": "4692",
"state": "free"
}
]
}
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Returns a list of all currently connected web-sockets
get /status/web-sockets
Returns a list of all currently connected web-sockets
Basic authentication scheme
JWT Bearer with authentication token.
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"socketId": "A2Vo2ji9PAxNCqaFAAAG",
"userId": "hans",
"connectedSince": "Mon Mar 05 2018 16:52:33 GMT-0600 (Central Standard Time)"
},
{
"socketId": "hXhumKK5MuVSbAJHAAAH",
"userId": "olle",
"connectedSince": "Mon Mar 05 2018 16:52:34 GMT-0600 (Central Standard Time)"
},
{
"socketId": "BgKWYImd4d0wSMFYAAAI",
"userId": "guest",
"connectedSince": "Mon Mar 05 2018 16:52:45 GMT-0600 (Central Standard Time)"
},
{
"socketId": "T1PbWEZ_8nxL2hFpAAAJ",
"userId": "guest",
"connectedSince": "Mon Mar 05 2018 16:52:46 GMT-0600 (Central Standard Time)"
},
{
"socketId": "-WydaU_FsQcpCFwqAAAK",
"userId": "ragnar",
"connectedSince": "Mon Mar 05 2018 16:53:50 GMT-0600 (Central Standard Time)"
}
]
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
/decorators
Returns with all available decorators
/seeds
Returns with all available seeds
Returns info about specific seed. Currently only the blobHash of the seed is returned.
get /seeds/{seedName}
Returns info about specific seed. Currently only the blobHash of the seed is returned.
Basic authentication scheme
JWT Bearer with authentication token.
URI Parameters
- seedName: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"blobHash": "da39a3ee5e6b4b0d3255bfef95601890afd80709"
}
HTTP status code 404
Seed does not exist
Secured by basic
Headers
- Authorization: required(string)
Basic authentication base64 encoded username and password
Example:
Basic Z3Vlc3Q6Z3Vlc3Q=
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
Secured by bearer
Headers
- Authorization: required(string)
Token Bearer
Example:
Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38
HTTP status code 401
Authentication required
HTTP status code 403
Forbidden
/visualizers
Returns with all available visualizers
get /visualizers
Returns with all available visualizers
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "ModelEditor",
"title": "Composition",
"panel": "js/Panels/ModelEditor/ModelEditorPanel",
"DEBUG_ONLY": false
},
{
"id": "Block Editor",
"title": "Block Editor",
"panel": "js/Panels/BlockEditor/BlockEditorPanel",
"DEBUG_ONLY": true
},
{
"id": "METAAspect",
"title": "Meta",
"panel": "js/Panels/MetaEditor/MetaEditorPanel",
"DEBUG_ONLY": false
},
{
"id": "SetEditor",
"title": "Set membership",
"panel": "js/Panels/SetEditor/SetEditorPanel",
"DEBUG_ONLY": false
},
{
"id": "Crosscut",
"title": "Crosscut",
"panel": "js/Panels/Crosscut/CrosscutPanel",
"DEBUG_ONLY": false
},
{
"id": "ContainmentGrid",
"title": "Containment Grid - All",
"panel": "js/Panels/Grid/GridPanel",
"DEBUG_ONLY": true
},
{
"id": "ContainmentGridPointers",
"title": "Containment Grid - Pointers",
"panel": "js/Panels/Grid/GridPanelPointers",
"DEBUG_ONLY": true
},
{
"id": "GridSets",
"title": "Set explorer (DEBUG)",
"panel": "js/Panels/Grid/GridPanelSets",
"DEBUG_ONLY": true
},
{
"id": "GraphViz",
"title": "Graph view",
"panel": "js/Panels/GraphViz/GraphVizPanel",
"DEBUG_ONLY": false
}
]
/plugin
Paths '/plugin/*' are deprecated and will be removed! The functionality was moved under '/plugins/*' paths as a harmonization effort among REST paths.
/plugins
Lists all available plugins
get /plugins
Get an array of all metadata associated with the available plugins.
get /plugins/metadata
Get an array of all metadata associated with the available plugins.
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "ConstraintEvaluator",
"name": "Constraint Evaluator",
"version": "1.7.0",
"description": "Plugin for developers to test, evaluate and add custom constraints.",
"icon": {
"src": "",
"class": "glyphicon glyphicon-ok-circle"
},
"disableServerSideExecution": false,
"disableBrowserSideExecution": false,
"writeAccessRequired": true,
"configStructure": [
{
"name": "mode",
"displayName": "Execution mode",
"description": "Select if Constraints.js should be evaluated, generated or populated in model.",
"value": "EvaluateConstraints",
"valueType": "string",
"valueItems": [
"EvaluateConstraints",
"GenerateConstraints",
"PopulateFromConstraints"
]
},
{
"name": "clear",
"displayName": "Clear existing constraints",
"description": "Clear all existing constraints when populating model with constraints.",
"value": false,
"valueType": "boolean"
}
]
},
{
"id": "MinimalWorkingExample",
"name": "Minimal Working Example",
"version": "1.7.0",
"description": "Simple plugin illustrating how to save to a model from a plugin.",
"icon": {
"src": "",
"class": "glyphicon glyphicon-floppy-save"
},
"disableServerSideExecution": false,
"disableBrowserSideExecution": false,
"writeAccessRequired": true,
"configStructure": [
{
"name": "shouldFail",
"displayName": "Should fail",
"description": "Example if the plugin execution fails",
"value": false,
"valueType": "boolean",
"readOnly": false
},
{
"name": "save",
"displayName": "Should save the model",
"description": "Will update the model if true",
"value": true,
"valueType": "boolean",
"readOnly": false
}
]
}
]
Gets the default configuration for the plugin.
get /plugins/{pluginId}/config
Gets the default configuration for the plugin.
URI Parameters
- pluginId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"pluginID": "NewPlugin",
"pluginName": "New Plugin",
"description": "",
"test": true,
"templateType": "None",
"configStructure": false,
"meta": true
}
Gets the conficuration structure for a plugin.
get /plugins/{pluginId}/configStructure
Gets the conficuration structure for a plugin.
URI Parameters
- pluginId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"name": "pluginID",
"displayName": "Unique plugin identifier",
"regex": "^(?!(?:do|if|in|for|let|new|try|var|case|else|enum|eval|false|null|this|true|void|with|break|catch|class|const|super|throw|while|yield|delete|export|import|public|return|static|switch|typeof|default|extends|finally|package|private|continue|debugger|function|arguments|interface|protected|implements|instanceof)$)[a-zA-Z_$][0-9a-zA-Z_$]*",
"regexMessage": "No spaces and special characters allowed. This value is used as the name of the generated plugin class.",
"description": "Unique ID for the plugin.",
"value": "NewPlugin",
"valueType": "string",
"readOnly": false
},
{
"name": "pluginName",
"displayName": "Name",
"description": "Short readable plugin name; spaces are allowed",
"value": "New Plugin",
"valueType": "string",
"readOnly": false
},
{
"name": "description",
"displayName": "Description",
"description": "Optional description of the plugin.",
"value": "",
"valueType": "string",
"readOnly": false
},
{
"name": "test",
"displayName": "Include testing script",
"description": "Generate template for unit-tests.",
"value": true,
"valueType": "boolean",
"readOnly": false
},
{
"name": "templateType",
"displayName": "Example template",
"description": "Ejs template for code generation, also illustrates how to save artifacts using the blobClient.",
"value": "None",
"valueType": "string",
"valueItems": [
"None",
"JavaScript",
"Python",
"CSharp"
],
"readOnly": false
},
{
"name": "configStructure",
"displayName": "Include Configuration Structure.",
"description": "Configuration structure will populate this GUI with controls.",
"value": false,
"valueType": "boolean",
"readOnly": false
},
{
"name": "meta",
"displayName": "Generate META",
"description": "Generates a static listing of the meta objects to facilitate coding.",
"value": true,
"valueType": "boolean",
"readOnly": false
}
]
Gets the metadata associated with the given plugin.
get /plugins/{pluginId}/metadata
Gets the metadata associated with the given plugin.
URI Parameters
- pluginId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"id": "ConfigurationArtifact",
"name": "Configuration and Artifacts",
"version": "2.22.0",
"description": "Illustrates how to setup a configuration for the plugin and how to generate and return artifacts.",
"icon": {
"src": "",
"class": "glyphicon glyphicon-list-alt"
},
"disableServerSideExecution": false,
"disableBrowserSideExecution": false,
"writeAccessRequired": false,
"configStructure": [
{
"name": "species",
"displayName": "Animal Species",
"regex": "^[a-zA-Z]+$",
"regexMessage": "Name can only contain English characters!",
"description": "Which species does the animal belong to.",
"value": "Horse",
"valueType": "string",
"readOnly": false
},
{
"name": "age",
"displayName": "Age",
"description": "How old is the animal.",
"value": 3,
"valueType": "number",
"minValue": 0,
"maxValue": 10000,
"readOnly": false,
"writeAccessRequired": true
},
{
"name": "gender",
"displayName": "Gender distribution",
"description": "What is the ratio between females and males?",
"value": 0.5,
"valueType": "number",
"minValue": 0,
"maxValue": 1,
"increment": 0.01
},
{
"name": "carnivore",
"displayName": "Carnivore",
"description": "Does the animal eat other animals?",
"value": false,
"valueType": "boolean",
"readOnly": false
},
{
"name": "isAnimal",
"displayName": "Is Animal",
"description": "Is this animal an animal? [Read-only]",
"value": true,
"valueType": "boolean",
"readOnly": true
},
{
"name": "classification",
"displayName": "Classification",
"description": "",
"value": "Vertebrates",
"valueType": "string",
"valueItems": [
"Vertebrates",
"Invertebrates",
"Unknown"
]
},
{
"name": "color",
"displayName": "Color",
"description": "The hex color code for the animal.",
"readOnly": false,
"value": "#FF0000",
"regex": "^#([A-Fa-f0-9]{6})$",
"valueType": "string"
},
{
"name": "food",
"displayName": "Food",
"description": "Food preference ordered",
"readOnly": false,
"value": [
"Grass",
"Mushrooms",
"Leaves",
"Antilope",
"Rabbit"
],
"valueType": "sortable",
"valueItems": [
"Grass",
"Mushrooms",
"Leaves",
"Antilope",
"Rabbit"
]
},
{
"name": "file",
"displayName": "File",
"description": "",
"value": "",
"valueType": "asset",
"readOnly": false
}
]
}
Executes a plugin on server side. Returns with a result id.
post /plugins/{pluginId}/execute
Executes a plugin on server side. Returns with a result id.
URI Parameters
- pluginId: required(string)
Body
Media type: application/json
Type: any
Example:
{
"projectId": "guest+MyProject",
"branchName": "master"
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"resultId": "f30f619b-3c80-87b7-3e35-6aec08c4cc14"
}
Runs a plugin on the server side and waits for it to finish.
post /plugins/{pluginId}/run
Runs a plugin on the server side and waits for it to finish.
URI Parameters
- pluginId: required(string)
Body
Media type: application/json
Type: any
Example:
{
"projectId": "guest+MyProject",
"branchName": "master"
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"success": true,
"messages": [],
"commits": [
{
"commitHash": "#f8af7999fd95efbddb7f7b4fc9446f0dac2e33c6",
"branchName": "master",
"status": "SYNCED"
}
],
"artifacts": [
"da47ded7c3391fc46cd84752c829fc383649bc94"
],
"pluginName": "Export, Import and Update Library",
"startTime": "2015-09-24T21:44:16.456Z",
"finishTime": "2015-09-24T21:45:02.047Z",
"error": null
}
Gets a result for this plugin by resultId.
get /plugins/{pluginId}/results/{resultId}
Gets a result for this plugin by resultId.
URI Parameters
- pluginId: required(string)
- resultId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"status": "FINISHED",
"result": {
"success": true,
"messages": [],
"commits": [
{
"commitHash": "#f8af7999fd95efbddb7f7b4fc9446f0dac2e33c6",
"branchName": "master",
"status": "SYNCED"
}
],
"artifacts": [
"da47ded7c3391fc46cd84752c829fc383649bc94"
],
"pluginName": "Export, Import and Update Library",
"startTime": "2015-09-24T21:44:16.456Z",
"finishTime": "2015-09-24T21:45:02.047Z",
"error": null
}
}
/reset
passsword reset functionality related requests
verify a reset request
initiate a reset request (response will only contain a resetHash if e-mail sending is not active for password resets)
update password request
post /reset
initiate a reset request (response will only contain a resetHash if e-mail sending is not active for password resets)
/blob
TO BE MOVED here from /rest/blob
gets a specific metadata descriptor based on the given hash
get /blob/metadata/{metadataHash}
gets a specific metadata descriptor based on the given hash
URI Parameters
- metadataHash: required(string)
views the content that is associated with the METADATA_HASH in the browser, in case the browser cannot display it then the content gets downloaded.
get /blob/view/{metadataHash}
views the content that is associated with the METADATA_HASH in the browser, in case the browser cannot display it then the content gets downloaded.
URI Parameters
- metadataHash: required(string)
returns with the specified file content from a complex object.
get /blob/view/{metadataHash}/path/to/element.json
returns with the specified file content from a complex object.
URI Parameters
- metadataHash: required(string)
downloads the stored file with a name and correct extension, if the content is a complex object then a zip package is returned containing all contents
get /blob/download/{metadataHash}
downloads the stored file with a name and correct extension, if the content is a complex object then a zip package is returned containing all contents
URI Parameters
- metadataHash: required(string)
downloads only a specific file from a complex content
get /blob/download/{metadataHash}/path/to/element.json
downloads only a specific file from a complex content
URI Parameters
- metadataHash: required(string)
post /blob/createFile/{filename}
URI Parameters
- filename: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"39aa77396352b2b19c8cab7450b06791a8652e6e": {
"name": "executor_config.json.zip",
"size": 278,
"mime": "application/zip",
"isPublic": false,
"tags": [],
"content": "f9d5a93b1e76a5ead51d7762c9520e6998911cb5",
"contentType": "object",
"lastModified": "2015-09-09T18:23:28.000Z"
}
}
/executor
TO BE MOVED here from /rest/executor
get /executor/info/{hash}
URI Parameters
- hash: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"hash": "39aa77396352b2b19c8cab7450b06791a8652e6e",
"resultHashes": [],
"resultSuperSet": null,
"userId": [],
"status": "RUNNING",
"createTime": "2015-09-09T18:58:40.877Z",
"startTime": null,
"finishTime": null,
"worker": "Adams-iMac_5436",
"labels": [],
"_id": "aat06FquApMHW4Rj"
}
post /executor/create/{hash}
URI Parameters
- hash: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"hash": "39aa77396352b2b19c8cab7450b06791a8652e6e",
"resultHashes": [],
"resultSuperSet": null,
"userId": [],
"status": "CREATED",
"createTime": "2015-09-09T18:45:22.983Z",
"startTime": null,
"finishTime": null,
"worker": null,
"labels": []
}
post /executor/update/{hash}
URI Parameters
- hash: required(string)
post /executor/cancel/{hash}
URI Parameters
- hash: required(string)