WebGME (1.0)

Download OpenAPI specification:

WebGME API entry point

Responses

Response samples

200

Content type

application/json

{"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"
}

Returns all component settings defined for the dep

Returns all component settings defined for the deployment, see https://github.com/webgme/webgme/wiki/Component-Settings

Authorizations:

basicNone

Responses

Response samples

200

Content type

application/json

{"Plugin_ConfigurationArtifact__0_1_0": {"species": "Horsie",
"age": 3,
"carnivore": false,
"classification": "Vertebrates",
"color": "#FF0000",
"file": ""
},
"ICorePanel": {"consoleWindow": {"logLevel": "info",
"verticalOrientation": false
}
}
}

Returns a specific component settings defined for

Returns a specific component settings defined for the deployment, see https://github.com/webgme/webgme/wiki/Component-Settings

Authorizations:

basicNone

path Parameters

componentId

required

string

Responses

Response samples

200

Content type

application/json

{"consoleWindow": {"logLevel": "info",
"verticalOrientation": false
}
}

Returns with the current user

Authorizations:

basicNone

Responses

Response samples

200

Content type

application/json

{"_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": { }
}

Remove the current user

Authorizations:

basicNone

Responses

Creates and returns a token for the user

Authorizations:

basicNone

Responses

Response samples

200

Content type

application/json

{"webgmeToken": "eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38"
}

Get the datum. The user data field is an arbitrary

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.

Authorizations:

basicNone

query Parameters

decrypt

boolean

Decrypt the requested data.

Add a new datum to WebGME. Overwrites the data fie

Add a new datum to WebGME. Overwrites the data field.

Authorizations:

basicNone

query Parameters

encrypt

boolean

Encrypt the submitted data before saving.

Responses

Update datum within WebGME. Updates/overwrites the

Update datum within WebGME. Updates/overwrites the user's data with the sent values for matching keys.

Authorizations:

basicNone

query Parameters

encrypt

boolean

Encrypt the submitted data before saving.

Responses

Delete datum from WebGME. Clears out the user's da

Delete datum from WebGME. Clears out the user's data field (sets it to empty dictionary).

Authorizations:

basicNone

Responses

Get the setting. Gets all component-settings for a

Get the setting. Gets all component-settings for a user, see https://github.com/webgme/webgme/wiki/Component-Settings

Authorizations:

basicNone

Add a new setting to WebGME. Overwrites the settin

Add a new setting to WebGME. Overwrites the settings field.

Authorizations:

basicNone

Responses

Update setting within WebGME. Updates/overwrites t

Update setting within WebGME. Updates/overwrites the user's settings with the sent values for matching keys.

Authorizations:

basicNone

Responses

Delete setting from WebGME. Clears out the user's

Delete setting from WebGME. Clears out the user's settings field (sets it to empty dictionary).

Authorizations:

basicNone

Responses

Get the setting. Gets a specific component setting

Get the setting. Gets a specific component settings for a user, see https://github.com/webgme/webgme/wiki/Component-Settings

Authorizations:

basicNone

path Parameters

componentId

required

string

Add a new setting to WebGME. Overwrites the settin

Add a new setting to WebGME. Overwrites the settings field for a specific component.

Authorizations:

basicNone

path Parameters

componentId

required

string

Responses

Update setting within WebGME. Updates/overwrites a

Update setting within WebGME. Updates/overwrites a specific component settings with the sent values for matching keys.

Authorizations:

basicNone

path Parameters

componentId

required

string

Responses

Delete setting from WebGME. Clears out the setting

Delete setting from WebGME. Clears out the settings for a specific component.

Authorizations:

basicNone

path Parameters

componentId

required

string

Responses

Collection of available users in WebGME

Authorizations:

basicNone

query Parameters

includeDisabled	boolean (includeDisabled) Example: includeDisabled=true If true and user.siteAdmin disabled users will be included in response.
displayName	boolean (displayName) Example: displayName=true If true users with display name will be listed (only id and displayName will be in the response).

Responses

Response samples

200

Content type

application/json

[{"_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": { }
}
]

Retrives the user entry.

Authorizations:

basicNone

path Parameters

username

required

string

Responses

Response samples

200

Content type

application/json

{"_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": { }
}

Create a new user. Requires user.siteAdmin.

Create a new user. Requires user.siteAdmin.

Authorizations:

basicNone

path Parameters

username

required

string

Request Body schema: application/json

any

Responses

Request samples

Payload

Content type

application/json

{"password": "demo",
"email": "a@example.com",
"canCreate": true,
"siteAdmin": true
}

Response samples

200

Content type

application/json

{"_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": { }
}

Updates the user if user.siteAdmin or same

Updates the user if user.siteAdmin or same user. If {disabled ":" false} given and user.siteAdmin disabled user will be re-enabled.

Authorizations:

basicNone

path Parameters

username

required

string

Responses

Response samples

200

Content type

application/json

{"password": "wordpass",
"email": "a@example.com",
"canCreate": true,
"siteAdmin": true
}

Deletes the user. Requires user.siteAdmin o

Deletes the user. Requires user.siteAdmin or same user.

Authorizations:

basicNone

path Parameters

username

required

string

query Parameters

force

boolean (force)

Example: force=true

If true and user.siteAdmin user at username will be permanently deleted from database.

Responses

Get the datum. The user data field is an arbitrary

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.

Authorizations:

basicNone

path Parameters

username

required

string

Add a new datum to WebGME. Overwrites the user's d

Add a new datum to WebGME. Overwrites the user's data field. Requires is current user or user.siteAdmin.

Authorizations:

basicNone

path Parameters

username

required

string

Responses

Update datum within WebGME. Updates/overwrites the

Update datum within WebGME. Updates/overwrites the user's data with the sent values for matching keys. Requires is current user or user.siteAdmin.

Authorizations:

basicNone

path Parameters

username

required

string

Responses

Delete datum from WebGME. Clears out the user's da

Delete datum from WebGME. Clears out the user's data field (sets it to empty dictionary). Requires is current user or user.siteAdmin.

Authorizations:

basicNone

path Parameters

username

required

string

Responses

Get the setting. Gets all component-settings for a

Get the setting. Gets all component-settings for a user, see https://github.com/webgme/webgme/wiki/Component-Settings

Authorizations:

basicNone

path Parameters

username

required

string

Add a new setting to WebGME. Overwrites the settin

Add a new setting to WebGME. Overwrites the settings field.

Authorizations:

basicNone

path Parameters

username

required

string

Responses

Update setting within WebGME. Updates/overwrites t

Update setting within WebGME. Updates/overwrites the user's settings with the sent values for matching keys.

Authorizations:

basicNone

path Parameters

username

required

string

Responses

Delete setting from WebGME. Clears out the user's

Delete setting from WebGME. Clears out the user's settings field (sets it to empty dictionary).

Authorizations:

basicNone

path Parameters

username

required

string

Responses

Get the setting. Gets a specific component setting

Get the setting. Gets a specific component settings for a user, see https://github.com/webgme/webgme/wiki/Component-Settings

Authorizations:

basicNone

path Parameters

username required	string
componentId required	string

Add a new setting to WebGME. Overwrites the settin

Add a new setting to WebGME. Overwrites the settings field for a specific component.

Authorizations:

basicNone

path Parameters

username required	string
componentId required	string

Responses

Update setting within WebGME. Updates/overwrites a

Update setting within WebGME. Updates/overwrites a specific component settings with the sent values for matching keys.

Authorizations:

basicNone

path Parameters

username required	string
componentId required	string

Responses

Delete setting from WebGME. Clears out the setting

Delete setting from WebGME. Clears out the settings for a specific component.

Authorizations:

basicNone

path Parameters

username required	string
componentId required	string

Responses

Collection of available organizations in WebGME

Authorizations:

basicNone

query Parameters

includeDisabled

boolean (includeDisabled)

Example: includeDisabled=true

If true and user.siteAdmin disabled organizations will be included in response.

Responses

Response samples

200

Content type

application/json

[{"_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": { }
}
]

Retrives organization data including members.

Authorizations:

basicNone

path Parameters

orgId

required

string

Responses

Response samples

200

Content type

application/json

{"_id": "webgme",
"projects": { },
"type": "Organization",
"admins": ["pelleBlom"
],
"info": {"description": "My organization",
"webpage": "https://org.org"
},
"users": ["pelleBlom"
]
}

Create a new organization. Requires user.canCre

Create a new organization. Requires user.canCreate or user.siteAdmin.

Authorizations:

basicNone

path Parameters

orgId

required

string

Request Body schema: application/json

any

Responses

Request samples

Payload

Content type

application/json

{"info": {"description": "My organization",
"webpage": "https://org.org"
}
}

Response samples

200

Content type

application/json

{"_id": "webgme",
"projects": { },
"type": "Organization",
"admins": ["pelleBlom"
],
"info": {"description": "My organization",
"webpage": "https://org.org"
},
"users": ["pelleBlom"
]
}

Updates the organization info if given which requi

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.

Authorizations:

basicNone

path Parameters

orgId

required

string

Request Body schema: application/json

any

Responses

Request samples

Payload

Content type

application/json

{"info": {"description": "My organization",
"webpage": "https://org.org"
}
}

Response samples

200

Content type

application/json

{"_id": "webgme",
"projects": { },
"type": "Organization",
"admins": ["pelleBlom"
],
"info": {"description": "My organization",
"webpage": "https://org.org"
},
"users": ["pelleBlom"
]
}

Delete an organization. Requires admin in organiza

Delete an organization. Requires admin in organization or user.siteAdmin.

Authorizations:

basicNone

path Parameters

orgId

required

string

query Parameters

force

boolean (force)

Example: force=true

If true and user.siteAdmin the organization will be permanently deleted from database.

Responses

Adds user to the organization. Requires admin in o

Adds user to the organization. Requires admin in organization or user.siteAdmin.

Authorizations:

basicNone

path Parameters

orgId required	string
username required	string

Responses

Delete user from the organization. Requires admin

Delete user from the organization. Requires admin in organization or user.siteAdmin.

Authorizations:

basicNone

path Parameters

orgId required	string
username required	string

Responses

Make user admin for the organization. Requires adm

Make user admin for the organization. Requires admin in organization or user.siteAdmin.

Authorizations:

basicNone

path Parameters

orgId required	string
username required	string

Responses

Remove user from admins of the organization. Requi

Remove user from admins of the organization. Requires admin in organization or user.siteAdmin.

Authorizations:

basicNone

path Parameters

orgId required	string
username required	string

Responses

Get a list of projects. Only lists the projects wh

Get a list of projects. Only lists the projects where the user has at least read access.

Authorizations:

basicNone

Get the project. Requires read access for p

Get the project. Requires read access for project.

Authorizations:

basicNone

path Parameters

ownerId required	string Example: guest
projectName required	string Example: ActivePanels

Add a new project to WebGME. Requires user.canC

Add a new project to WebGME. Requires user.canCreate.

Authorizations:

basicNone

path Parameters

ownerId required	string Example: guest
projectName required	string Example: ActivePanels

Responses

Update project within WebGME. Requires write</b

Update project within WebGME. Requires write access for project.

Authorizations:

basicNone

path Parameters

ownerId required	string Example: guest
projectName required	string Example: ActivePanels

Responses

Delete project from WebGME. Requires delete

Delete project from WebGME. Requires delete access for project.

Authorizations:

basicNone

path Parameters

ownerId required	string Example: guest
projectName required	string Example: ActivePanels

Responses

Retrives an array of latested commits made to the

Retrives an array of latested commits made to the project. Requires read access for project.

path Parameters

ownerId required	string Example: guest
projectName required	string Example: ActivePanels

query Parameters

n	number (n) Example: n=2 Maximum number of commits to retrieve (default 100).

Responses

Response samples

200

Content type

application/json

[{"_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"
}
]

Retrieves the commit object associated with the co

Retrieves the commit object associated with the commitId. Requires read access for project.

path Parameters

ownerId required	string Example: guest
projectName required	string Example: ActivePanels
commitId required	string Example: b83ee8d50034fc96f006176bba516e68ce50838a Commit hash, with or without URL-encoded ''#''.

Responses

Response samples

200

Content type

application/json

{"root": "#20d99ca1c0a2ec8a256d0beda8302d2bc0ddd300",
"parents": ["#8b2ce483f807d52d44a9377d08ac5a7573ddb07c"
],
"updater": ["pmeijer"
],
"time": 1448397167677,
"message": "[setRegistry(/1036661779/588886926,,position,[object Object])]",
"type": "commit",
"_id": "#cdfc41958e056e5faf59ff3059394368204a7bbc"
}

Retrieves the given state of the project as a webg

Retrieves the given state of the project as a webgmex file. Requires read access for project.

path Parameters

ownerId required	string Example: guest
projectName required	string Example: ActivePanels
commitId required	string Example: b83ee8d50034fc96f006176bba516e68ce50838a Commit hash, with or without URL-encoded ''#''.

Responses

Retrieves the given state of a model - pointed by

Retrieves the given state of a model - pointed by the path of its root node - as a webgmexm file. Requires read access for project.

path Parameters

ownerId required	string Example: guest
projectName required	string Example: ActivePanels
commitId required	string Example: b83ee8d50034fc96f006176bba516e68ce50838a Commit hash, with or without URL-encoded ''#''.
nodePath required	string Example: 1aB/CdE2

Responses

Retrieves the raw data object at given path within

Retrieves the raw data object at given path within the project tree. Requires read access for project.

path Parameters

ownerId required	string Example: guest
projectName required	string Example: ActivePanels
commitId required	string Example: b83ee8d50034fc96f006176bba516e68ce50838a Commit hash, with or without URL-encoded ''#''.
nodePath required	string Example: 1563412505/5585498754

Responses

Get a list of branches. Requires read acces

Get a list of branches. Requires read access for project.

Authorizations:

basicNone

path Parameters

ownerId required	string Example: guest
projectName required	string Example: ActivePanels

Get the branch. Requires read access for pr

Get the branch. Requires read access for project.

Authorizations:

basicNone

path Parameters

ownerId required	string Example: guest
projectName required	string Example: ActivePanels
branchId required	string Example: master

Add a new branch to WebGME. Requires write

Add a new branch to WebGME. Requires write access for project.

Authorizations:

basicNone

path Parameters

ownerId required	string Example: guest
projectName required	string Example: ActivePanels
branchId required	string Example: master

Responses

Update branch within WebGME. Requires write

Update branch within WebGME. Requires write access for project.

Authorizations:

basicNone

path Parameters

ownerId required	string Example: guest
projectName required	string Example: ActivePanels
branchId required	string Example: master

Responses

Delete branch from WebGME. Requires write a

Delete branch from WebGME. Requires write access for project.

Authorizations:

basicNone

path Parameters

ownerId required	string Example: guest
projectName required	string Example: ActivePanels
branchId required	string Example: master

Responses

Retrives an array of the commit history for the br

Retrives an array of the commit history for the branch. Requires read access for project.

path Parameters

ownerId required	string Example: guest
projectName required	string Example: ActivePanels
branchId required	string Example: master

query Parameters

n	number (n) Example: n=2 Maximum number of commits to retrieve (default 100).

Responses

Response samples

200

Content type

application/json

[{"_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"
}
]

Retrieves the given state of the project as a webg

Retrieves the given state of the project as a webgmex file. Requires read acces of project.

path Parameters

ownerId required	string Example: guest
projectName required	string Example: ActivePanels
branchId required	string Example: master

Responses

Retrieves the given state of a model - pointed by

Retrieves the given state of a model - pointed by the path of its root - as a webgmexm file. Requires read access of project.

path Parameters

ownerId required	string Example: guest
projectName required	string Example: ActivePanels
branchId required	string Example: master
nodePath required	string Example: a2B/b3C

Responses

Retrieves the raw data object at given path within

Retrieves the raw data object at given path within the project tree. Requires read access for project.

path Parameters

ownerId required	string Example: guest
projectName required	string Example: ActivePanels
branchId required	string Example: master
nodePath required	string Example: 1563412505/5585498754

Responses

Get a list of tags. Requires read access fo

Get a list of tags. Requires read access for project.

Authorizations:

basicNone

path Parameters

ownerId required	string Example: guest
projectName required	string Example: ActivePanels

Get the tag. Requires read access for proje

Get the tag. Requires read access for project.

Authorizations:

basicNone

path Parameters

ownerId required	string Example: guest
projectName required	string Example: ActivePanels
tagId required	string Example: myTag

Add a new tag to WebGME. Requires write acc

Add a new tag to WebGME. Requires write access for project.

Authorizations:

basicNone

path Parameters

ownerId required	string Example: guest
projectName required	string Example: ActivePanels
tagId required	string Example: myTag

Responses

Update tag within WebGME. Requires delete a

Update tag within WebGME. Requires delete access for project.

Authorizations:

basicNone

path Parameters

ownerId required	string Example: guest
projectName required	string Example: ActivePanels
tagId required	string Example: myTag

Responses

Delete tag from WebGME. Requires delete acc

Delete tag from WebGME. Requires delete access for project.

Authorizations:

basicNone

path Parameters

ownerId required	string Example: guest
projectName required	string Example: ActivePanels
tagId required	string Example: myTag

Responses

Retrieves the given state of the project as a webg

Retrieves the given state of the project as a webgmex file. Requires read access of project.

path Parameters

ownerId required	string Example: guest
projectName required	string Example: ActivePanels
tagId required	string Example: myTag

Responses

Retrieves the given state of a model - pointed by

Retrieves the given state of a model - pointed by its root path - as a webgmexm file. Requires read access of project.

path Parameters

ownerId required	string Example: guest
projectName required	string Example: ActivePanels
tagId required	string Example: myTag
nodePath required	string Example: 23BC/aD42

Responses

Retrieves the raw data object at given path within

Retrieves the raw data object at given path within the project tree. Requires read access for project.

path Parameters

ownerId required	string Example: guest
projectName required	string Example: ActivePanels
tagId required	string Example: myTag
nodePath required	string Example: 1563412505/5585498754

Responses

Get a list of hooks. Requires read access f

Get a list of hooks. Requires read access for project.

Authorizations:

basicNone

path Parameters

ownerId required	string Example: guest
projectName required	string Example: ActivePanels

Get the hook. Requires read access for proj

Get the hook. Requires read access for project.

Authorizations:

basicNone

path Parameters

ownerId required	string Example: guest
projectName required	string Example: ActivePanels
hookId required	string Example: myHook

Add a new hook to WebGME. Requires write ac

Add a new hook to WebGME. Requires write access for project.

Authorizations:

basicNone

path Parameters

ownerId required	string Example: guest
projectName required	string Example: ActivePanels
hookId required	string Example: myHook

Responses

Update hook within WebGME. Requires write a

Update hook within WebGME. Requires write access for project.

Authorizations:

basicNone

path Parameters

ownerId required	string Example: guest
projectName required	string Example: ActivePanels
hookId required	string Example: myHook

Responses

Delete hook from WebGME. Requires write acc

Delete hook from WebGME. Requires write access for project.

Authorizations:

basicNone

path Parameters

ownerId required	string Example: guest
projectName required	string Example: ActivePanels
hookId required	string Example: myHook

Responses

Squash multi commits into a single one. Requires <

Squash multi commits into a single one. Requires write access for project.

Authorizations:

basicNone

path Parameters

ownerId required	string Example: guest
projectName required	string Example: ActivePanels

Request Body schema: application/json

any

Request samples

Payload

Content type

application/json

{"fromCommit": "#6e41041cf8e6cf3f81039c101b3adfc46ab703d4",
"toCommitOrBranch": "master",
"message": "feature 'A' squashed into a single commit"
}

Remove user''s or organization''s access rights to

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.

path Parameters

ownerId required	string Example: guest
projectName required	string Example: ActivePanels
userOrOrgId required	string Example: demoUser

Responses

Grants user or organization access to the project.

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.

path Parameters

ownerId required	string Example: guest
projectName required	string Example: ActivePanels
userOrOrgId required	string Example: demoUser
rights required	string Example: rwd Combination of r-read, w-write, d-delete

Responses

/projects/{ownerId}/{projectName}/compare/{branchOrCommitA}...{branchOrCommitB}

path Parameters

ownerId required	string Example: guest
projectName required	string Example: ActivePanels
branchOrCommitA required	string
branchOrCommitB required	string

Returns a combined object of all different statuse

Returns a combined object of all different statuses (if add-ons are disabled addOns will be null).

Authorizations:

basicNone

Responses

Response samples

200

Content type

application/json

{"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)"
}
]
}

Returns status about running addons (404 if add-on

Returns status about running addons (404 if add-ons are disabled)

Authorizations:

basicNone

Responses

Response samples

200

Content type

application/json

{"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
}
}
}
}

Returns status about running server workers and re

Returns status about running server workers and request queue

Authorizations:

basicNone

Responses

Response samples

200

Content type

application/json

{"waitingRequests": [ ],
"workers": [{"pid": "3668",
"state": "working",
"request": {"command": "exportProjectToFile",
"projectId": "guest+ANewProject",
"commitHash": "#0a1b4a3c4f1a4e4efcb4914192f227e801f421a3",
"withAssets": true,
"userId": "hans",
"socketId": "A2Vo2ji9PAxNCqaFAAAG"
}
},
{"pid": "4692",
"state": "free"
}
]
}

Returns a list of all currently connected web-sock

Returns a list of all currently connected web-sockets

Authorizations:

basicNone

Responses

Response samples

200

Content type

application/json

[{"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)"
}
]

Returns with all available decorators

Responses

Response samples

200

Content type

application/json

["CircleDecorator",
"DefaultDecorator",
"MetaDecorator",
"ModelDecorator",
"SVGDecorator",
"UMLStateMachineDecorator"
]

Returns with all available seeds

Responses

Response samples

200

Content type

application/json

["ActivePanels",
"EmptyProject",
"EmptyWithConstraint",
"SignalFlowSystem"
]

Returns info about specific seed. Currently only t

Returns info about specific seed. Currently only the blobHash of the seed is returned.

Authorizations:

basicNone

path Parameters

seedName

required

string

Responses

Response samples

200

Content type

application/json

{"blobHash": "da39a3ee5e6b4b0d3255bfef95601890afd80709"
}

Returns with all available visualizers

Responses

Response samples

200

Content type

application/json

[{"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
}
]

Lists all available plugins

Responses

Response samples

200

Content type

application/json

["AddOnGenerator",
"ConfigurationArtifact",
"ExecutorPlugin",
"ExportImport",
"MergeExample",
"MetaGMEParadigmImporter",
"MinimalWorkingExample",
"PluginGenerator",
"VisualizerGenerator"
]

Get an array of all metadata associated with the a

Get an array of all metadata associated with the available plugins.

Responses

Response samples

200

Content type

application/json

{"value": [{"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.

path Parameters

pluginId

required

string

Responses

Response samples

200

Content type

application/json

{"pluginID": "NewPlugin",
"pluginName": "New Plugin",
"description": "",
"test": true,
"templateType": "None",
"configStructure": false,
"meta": true
}

Gets the conficuration structure for a plugin.

path Parameters

pluginId

required

string

Responses

Response samples

200

Content type

application/json

{"value": [{"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

Gets the metadata associated with the given plugin.

path Parameters

pluginId

required

string

Responses

Response samples

200

Content type

application/json

{"value": {"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 r

Executes a plugin on server side. Returns with a result id.

path Parameters

pluginId

required

string

Request Body schema: application/json

any

Responses

Request samples

Payload

Content type

application/json

{"projectId": "guest+MyProject",
"branchName": "master"
}

Response samples

200

Content type

application/json

{"resultId": "f30f619b-3c80-87b7-3e35-6aec08c4cc14"
}

Runs a plugin on the server side and waits for it

Runs a plugin on the server side and waits for it to finish.

path Parameters

pluginId

required

string

Request Body schema: application/json

any

Responses

Request samples

Payload

Content type

application/json

{"projectId": "guest+MyProject",
"branchName": "master"
}

Response samples

200

Content type

application/json

{"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.

path Parameters

pluginId required	string
resultId required	string

Responses

Response samples

200

Content type

application/json

{"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
}
}

verify a reset request

query Parameters

userId required	string Example: userId=myWebgmeLogin id of user in question
resetHash required	string Example: resetHash=someRandomCharacters id of the reset request

Responses

initiate a reset request (response will only conta

initiate a reset request (response will only contain a resetHash if e-mail sending is not active for password resets)

Request Body schema: application/json

any

Responses

Request samples

Payload

Content type

application/json

{"userId": "myLittleUserName"
}

Response samples

200

Content type

application/json

{"resetHash": "someRandomCharacters"
}

update password request

Request Body schema: application/json

any

Responses

Request samples

Payload

Content type

application/json

{"userId": "myVeryOwnUserName",
"resetHash": "myValidResetRequestId",
"newPassword": "myNewAndSafePassword"
}

lists all metadata

gets a specific metadata descriptor based on the g

gets a specific metadata descriptor based on the given hash

path Parameters

metadataHash

required

string

/blob/createMetadata

views the content that is associated with the META

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.

path Parameters

metadataHash

required

string

returns with the specified file content from a com

returns with the specified file content from a complex object.

path Parameters

metadataHash

required

string

downloads the stored file with a name and correct

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

path Parameters

metadataHash

required

string

downloads only a specific file from a complex cont

downloads only a specific file from a complex content

path Parameters

metadataHash

required

string

/blob/createFile/{filename}

path Parameters

filename

required

string

Responses

Response samples

200

Content type

application/json

{"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"
}
}

List all jobs

/executor/worker

/executor/info/{hash}

path Parameters

hash

required

string

Responses

Response samples

200

Content type

application/json

{"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"
}

/executor/create/{hash}

path Parameters

hash

required

string

Responses

Response samples

200

Content type

application/json

{"hash": "39aa77396352b2b19c8cab7450b06791a8652e6e",
"resultHashes": [ ],
"resultSuperSet": null,
"userId": [ ],
"status": "CREATED",
"createTime": "2015-09-09T18:45:22.983Z",
"startTime": null,
"finishTime": null,
"worker": null,
"labels": [ ]
}

/executor/update/{hash}

path Parameters

hash

required

string

/executor/cancel/{hash}

path Parameters

hash

required

string

WebGME (1.0)

WebGME API entry point

Responses

Response samples

Returns all component settings defined for the dep

Authorizations:

Responses

Response samples

Returns a specific component settings defined for

Authorizations:

path Parameters

Responses

Response samples

Returns with the current user

Authorizations:

Responses

Response samples

Remove the current user

Authorizations:

Responses

Creates and returns a token for the user

Authorizations:

Responses

Response samples

Get the datum. The user data field is an arbitrary

Authorizations:

query Parameters

Add a new datum to WebGME. Overwrites the data fie

Authorizations:

query Parameters

Responses

Update datum within WebGME. Updates/overwrites the

Authorizations:

query Parameters

Responses

Delete datum from WebGME. Clears out the user's da

Authorizations:

Responses

Get the setting. Gets all component-settings for a

Authorizations:

Add a new setting to WebGME. Overwrites the settin

Authorizations:

Responses

Update setting within WebGME. Updates/overwrites t

Authorizations:

Responses

Delete setting from WebGME. Clears out the user's

Authorizations:

Responses

Get the setting. Gets a specific component setting

Authorizations:

path Parameters

Add a new setting to WebGME. Overwrites the settin

Authorizations:

path Parameters

Responses

Update setting within WebGME. Updates/overwrites a

Authorizations:

path Parameters

Responses

Delete setting from WebGME. Clears out the setting

Authorizations:

path Parameters

Responses

Collection of available users in WebGME

Authorizations:

query Parameters

Responses

Response samples

Retrives the user entry.

Authorizations:

path Parameters

Responses

Response samples

Create a new user. Requires <b>user.siteAdmin</b>.

Authorizations:

path Parameters

Request Body schema: application/json

Responses

Request samples