/

HTTP status code 200

Body

Type: application/json

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.

/componentSettings get

get

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

Secured by basic

Basic authentication scheme

Secured by bearer

JWT Bearer with authentication token.

Response
Security

HTTP status code 200

Body

Type: application/json

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: (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: (string)

Token Bearer

Example:

Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38

HTTP status code 401

Authentication required

HTTP status code 403

Forbidden

/componentSettings/{componentId} get

get

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

Secured by basic

Basic authentication scheme

Secured by bearer

JWT Bearer with authentication token.

URI Parameters

componentId: required (string)

HTTP status code 200

Body

Type: application/json

Example:

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

Secured by basic

Headers

Authorization: (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: (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.

/user get delete

get

Returns with the current user

delete

Remove the current user

Returns with the current user

Secured by basic

Basic authentication scheme

Secured by bearer

JWT Bearer with authentication token.

Response
Security

HTTP status code 200

Body

Type: application/json

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: (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: (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/token get

get

Creates and returns a token for the user

Secured by basic

Basic authentication scheme

Secured by bearer

JWT Bearer with authentication token.

Response
Security

HTTP status code 200

Body

Type: application/json

Example:

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

Secured by basic

Headers

Authorization: (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: (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/data get put patch delete

Entity representing a datum

get

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.

put

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

patch

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

delete

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

Secured by basic

Basic authentication scheme

Secured by bearer

JWT Bearer with authentication token.

Response
Security

HTTP status code 200

Body

Type: application/json

Example:

{
  "country": "USA",
  "organization": "Org",
  "name": "Joe Smith"
}

HTTP status code 404

Body

Type: application/json

Example:

{"message": "datum not found" }

Secured by basic

Headers

Authorization: (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: (string)

Token Bearer

Example:

Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38

HTTP status code 401

Authentication required

HTTP status code 403

Forbidden

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

Secured by basic

Basic authentication scheme

Secured by bearer

JWT Bearer with authentication token.

Body

Type: application/json

Schema:

See example

Example:

{
  "country": "USA",
  "organization": "Org",
  "name": "Joe Smith"
}

HTTP status code 200

Body

Type: application/json

Example:

{
  "country": "USA",
  "organization": "Org",
  "name": "Joe Smith"
}

HTTP status code 403

HTTP status code 404

Secured by basic

Headers

Authorization: (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: (string)

Token Bearer

Example:

Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38

HTTP status code 401

Authentication required

HTTP status code 403

Forbidden

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

Secured by basic

Basic authentication scheme

Secured by bearer

JWT Bearer with authentication token.

Body

Type: application/json

Schema:

See example

Example:

{
  "country": "USA"
}

HTTP status code 200

Body

Type: application/json

Example:

{
  "country": "USA",
  "organization": "Org",
  "name": "Joe Smith"
}

HTTP status code 403

HTTP status code 404

Secured by basic

Headers

Authorization: (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: (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 datum from WebGME. Clears out the user's data field (sets it to empty dictionary).

Secured by basic

Basic authentication scheme

Secured by bearer

JWT Bearer with authentication token.

Query Parameters

force: (boolean)
If true and user.siteAdmin user will be deleted from database
Example:
```
true
```

HTTP status code 204

HTTP status code 403

HTTP status code 404

Secured by basic

Headers

Authorization: (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: (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/settings get put patch delete

Entity representing a setting

get

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

put

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

patch

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

delete

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

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

Secured by basic

Basic authentication scheme

Secured by bearer

JWT Bearer with authentication token.

Response
Security

HTTP status code 200

Body

Type: application/json

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

Type: application/json

Example:

{"message": "setting not found" }

Secured by basic

Headers

Authorization: (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: (string)

Token Bearer

Example:

Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38

HTTP status code 401

Authentication required

HTTP status code 403

Forbidden

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

Secured by basic

Basic authentication scheme

Secured by bearer

JWT Bearer with authentication token.

Body

Type: application/json

Schema:

See example

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

Type: application/json

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: (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: (string)

Token Bearer

Example:

Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38

HTTP status code 401

Authentication required

HTTP status code 403

Forbidden

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

Secured by basic

Basic authentication scheme

Secured by bearer

JWT Bearer with authentication token.

Body

Type: application/json

Schema:

See example

Example:

{
  "Plugin_ConfigurationArtifact__0_1_0": {
      "carnivore":false
  },
  "ICorePanel":{
    "consoleWindow":{
      "verticalOrientation":true
    }
  }
}

HTTP status code 200

Body

Type: application/json

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: (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: (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 setting from WebGME. Clears out the user's settings field (sets it to empty dictionary).

Secured by basic

Basic authentication scheme

Secured by bearer

JWT Bearer with authentication token.

Query Parameters

force: (boolean)
If true and user.siteAdmin user will be deleted from database
Example:
```
true
```

HTTP status code 204

HTTP status code 403

HTTP status code 404

Secured by basic

Headers

Authorization: (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: (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/settings/{componentId} get put patch delete

Entity representing a setting

get

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

put

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

patch

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

delete

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

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

Secured by basic

Basic authentication scheme

Secured by bearer

JWT Bearer with authentication token.

URI Parameters

componentId: required (string)

HTTP status code 200

Body

Type: application/json

Example:

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

HTTP status code 404

Body

Type: application/json

Example:

{"message": "setting not found" }

Secured by basic

Headers

Authorization: (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: (string)

Token Bearer

Example:

Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38

HTTP status code 401

Authentication required

HTTP status code 403

Forbidden

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

Secured by basic

Basic authentication scheme

Secured by bearer

JWT Bearer with authentication token.

URI Parameters

componentId: required (string)

Body

Type: application/json

Schema:

See example

Example:

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

HTTP status code 200

Body

Type: application/json

Example:

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

HTTP status code 403

HTTP status code 404

Secured by basic

Headers

Authorization: (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: (string)

Token Bearer

Example:

Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38

HTTP status code 401

Authentication required

HTTP status code 403

Forbidden

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

Secured by basic

Basic authentication scheme

Secured by bearer

JWT Bearer with authentication token.

URI Parameters

componentId: required (string)

Body

Type: application/json

Schema:

See example

Example:

{
  "consoleWindow": {
    "verticalOrientation":false
  }
}

HTTP status code 200

Body

Type: application/json

Example:

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

HTTP status code 403

HTTP status code 404

Secured by basic

Headers

Authorization: (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: (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 setting from WebGME. Clears out the settings for a specific component.

Secured by basic

Basic authentication scheme

Secured by bearer

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
```

HTTP status code 204

HTTP status code 403

HTTP status code 404

Secured by basic

Headers

Authorization: (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: (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.

/users get

get

Collection of available users in WebGME

Secured by basic

Basic authentication scheme

Secured by bearer

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

Type: application/json

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: (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: (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/{username} get put patch delete

get

Retrives the user entry.

put

Create a new user. Requires user.siteAdmin.

patch

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

delete

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

Retrives the user entry.

Secured by basic

Basic authentication scheme

Secured by bearer

JWT Bearer with authentication token.

URI Parameters

username: required (string)

HTTP status code 200

Body

Type: application/json

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: (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: (string)

Token Bearer

Example:

Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38

HTTP status code 401

Authentication required

HTTP status code 403

Forbidden

Create a new user. Requires user.siteAdmin.

Secured by basic

Basic authentication scheme

Secured by bearer

JWT Bearer with authentication token.

URI Parameters

username: required (string)

Body

Type: application/json

Schema:

See example

Example:

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

HTTP status code 200

Body

Type: application/json

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: (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: (string)

Token Bearer

Example:

Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38

HTTP status code 401

Authentication required

HTTP status code 403

Forbidden

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

Secured by basic

Basic authentication scheme

Secured by bearer

JWT Bearer with authentication token.

URI Parameters

username: required (string)

HTTP status code 200

Body

Type: application/json

Example:

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

HTTP status code 403

HTTP status code 404

Secured by basic

Headers

Authorization: (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: (string)

Token Bearer

Example:

Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38

HTTP status code 401

Authentication required

HTTP status code 403

Forbidden

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

Secured by basic

Basic authentication scheme

Secured by bearer

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
```

HTTP status code 204

HTTP status code 403

HTTP status code 404

Secured by basic

Headers

Authorization: (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: (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/{username}/data get put patch delete

Entity representing a datum

get

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.

put

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

patch

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

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

Secured by basic

Basic authentication scheme

Secured by bearer

JWT Bearer with authentication token.

URI Parameters

username: required (string)

HTTP status code 200

Body

Type: application/json

Example:

{
  "country": "USA",
  "organization": "Org",
  "name": "Joe Smith"
}

HTTP status code 404

Body

Type: application/json

Example:

{"message": "datum not found" }

Secured by basic

Headers

Authorization: (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: (string)

Token Bearer

Example:

Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38

HTTP status code 401

Authentication required

HTTP status code 403

Forbidden

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

Secured by basic

Basic authentication scheme

Secured by bearer

JWT Bearer with authentication token.

URI Parameters

username: required (string)

Body

Type: application/json

Schema:

See example

Example:

{
  "country": "USA",
  "organization": "Org",
  "name": "Joe Smith"
}

HTTP status code 200

Body

Type: application/json

Example:

{
  "country": "USA",
  "organization": "Org",
  "name": "Joe Smith"
}

HTTP status code 403

HTTP status code 404

Secured by basic

Headers

Authorization: (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: (string)

Token Bearer

Example:

Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38

HTTP status code 401

Authentication required

HTTP status code 403

Forbidden

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

Secured by basic

Basic authentication scheme

Secured by bearer

JWT Bearer with authentication token.

URI Parameters

username: required (string)

Body

Type: application/json

Schema:

See example

Example:

{
  "country": "USA"
}

HTTP status code 200

Body

Type: application/json

Example:

{
  "country": "USA",
  "organization": "Org",
  "name": "Joe Smith"
}

HTTP status code 403

HTTP status code 404

Secured by basic

Headers

Authorization: (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: (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 datum from WebGME. Clears out the user's data field (sets it to empty dictionary). Requires is current user or user.siteAdmin.

Secured by basic

Basic authentication scheme

Secured by bearer

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
```

HTTP status code 204

HTTP status code 403

HTTP status code 404

Secured by basic

Headers

Authorization: (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: (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/{username}/settings get put patch delete

Entity representing a setting

get

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

put

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

patch

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

delete

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

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

Secured by basic

Basic authentication scheme

Secured by bearer

JWT Bearer with authentication token.

URI Parameters

username: required (string)

HTTP status code 200

Body

Type: application/json

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

Type: application/json

Example:

{"message": "setting not found" }

Secured by basic

Headers

Authorization: (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: (string)

Token Bearer

Example:

Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38

HTTP status code 401

Authentication required

HTTP status code 403

Forbidden

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

Secured by basic

Basic authentication scheme

Secured by bearer

JWT Bearer with authentication token.

URI Parameters

username: required (string)

Body

Type: application/json

Schema:

See example

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

Type: application/json

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: (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: (string)

Token Bearer

Example:

Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38

HTTP status code 401

Authentication required

HTTP status code 403

Forbidden

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

Secured by basic

Basic authentication scheme

Secured by bearer

JWT Bearer with authentication token.

URI Parameters

username: required (string)

Body

Type: application/json

Schema:

See example

Example:

{
  "Plugin_ConfigurationArtifact__0_1_0": {
      "carnivore":false
  },
  "ICorePanel":{
    "consoleWindow":{
      "verticalOrientation":true
    }
  }
}

HTTP status code 200

Body

Type: application/json

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: (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: (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 setting from WebGME. Clears out the user's settings field (sets it to empty dictionary).

Secured by basic

Basic authentication scheme

Secured by bearer

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
```

HTTP status code 204

HTTP status code 403

HTTP status code 404

Secured by basic

Headers

Authorization: (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: (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/{username}/settings/{componentId} get put patch delete

Entity representing a setting

get

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

put

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

patch

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

delete

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

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

Secured by basic

Basic authentication scheme

Secured by bearer

JWT Bearer with authentication token.

URI Parameters

username: required (string)
componentId: required (string)

HTTP status code 200

Body

Type: application/json

Example:

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

HTTP status code 404

Body

Type: application/json

Example:

{"message": "setting not found" }

Secured by basic

Headers

Authorization: (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: (string)

Token Bearer

Example:

Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38

HTTP status code 401

Authentication required

HTTP status code 403

Forbidden

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

Secured by basic

Basic authentication scheme

Secured by bearer

JWT Bearer with authentication token.

URI Parameters

username: required (string)
componentId: required (string)

Body

Type: application/json

Schema:

See example

Example:

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

HTTP status code 200

Body

Type: application/json

Example:

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

HTTP status code 403

HTTP status code 404

Secured by basic

Headers

Authorization: (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: (string)

Token Bearer

Example:

Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38

HTTP status code 401

Authentication required

HTTP status code 403

Forbidden

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

Secured by basic

Basic authentication scheme

Secured by bearer

JWT Bearer with authentication token.

URI Parameters

username: required (string)
componentId: required (string)

Body

Type: application/json

Schema:

See example

Example:

{
  "consoleWindow": {
    "verticalOrientation":false
  }
}

HTTP status code 200

Body

Type: application/json

Example:

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

HTTP status code 403

HTTP status code 404

Secured by basic

Headers

Authorization: (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: (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 setting from WebGME. Clears out the settings for a specific component.

Secured by basic

Basic authentication scheme

Secured by bearer

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
```

HTTP status code 204

HTTP status code 403

HTTP status code 404

Secured by basic

Headers

Authorization: (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: (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.

/orgs get

get

Collection of available organizations in WebGME

Secured by basic

Basic authentication scheme

Secured by bearer

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

Type: application/json

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: (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: (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/{orgId} get put patch delete

get

Retrives organization data including members.

put

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

patch

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

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

Retrives organization data including members.

Secured by basic

Basic authentication scheme

Secured by bearer

JWT Bearer with authentication token.

URI Parameters

orgId: required (string)

HTTP status code 200

Body

Type: application/json

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: (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: (string)

Token Bearer

Example:

Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38

HTTP status code 401

Authentication required

HTTP status code 403

Forbidden

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

Secured by basic

Basic authentication scheme

Secured by bearer

JWT Bearer with authentication token.

URI Parameters

orgId: required (string)

Body

Type: application/json

Schema:

See example

Example:

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

HTTP status code 200

Body

Type: application/json

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: (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: (string)

Token Bearer

Example:

Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38

HTTP status code 401

Authentication required

HTTP status code 403

Forbidden

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.

Secured by basic

Basic authentication scheme

Secured by bearer

JWT Bearer with authentication token.

URI Parameters

orgId: required (string)

Body

Type: application/json

Schema:

See example

Example:

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

HTTP status code 200

Body

Type: application/json

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: (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: (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 an organization. Requires admin in organization or user.siteAdmin.

Secured by basic

Basic authentication scheme

Secured by bearer

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
```

HTTP status code 204

HTTP status code 403

HTTP status code 404

Secured by basic

Headers

Authorization: (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: (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/{orgId}/users/{username} put delete

put

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

delete

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

/orgs/{orgId}/admins/{username} put delete

put

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

delete

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

/projects

Collection of available projects in WebGME.

/projects get

get

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

Secured by basic

Basic authentication scheme

Secured by bearer

JWT Bearer with authentication token.

Response
Security

HTTP status code 200

Body

Type: application/json

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: (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: (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/{ownerId}/{projectName} get put patch delete

Entity representing a project

get

Get the project. Requires read access for project.

put

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

patch

Update project within WebGME. Requires write access for project.

delete

Delete project from WebGME. Requires delete access for project.

Get the project. Requires read access for project.

Secured by basic

Basic authentication scheme

Secured by bearer

JWT Bearer with authentication token.

URI Parameters

ownerId: required (string)
Example:
```
guest
```
projectName: required (string)
Example:
```
ActivePanels
```

HTTP status code 200

Body

Type: application/json

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

Type: application/json

Example:

{"message": "project not found" }

Secured by basic

Headers

Authorization: (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: (string)

Token Bearer

Example:

Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38

HTTP status code 401

Authentication required

HTTP status code 403

Forbidden

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

Secured by basic

Basic authentication scheme

Secured by bearer

JWT Bearer with authentication token.

URI Parameters

ownerId: required (string)
Example:
```
guest
```
projectName: required (string)
Example:
```
ActivePanels
```

Body

Type: application/json

Schema:

See example

Example:

{
  "type": "db",
  "seedName": "me+myOtherProject",
  "seedBranch": "master",
  "ownerId": "myOrganization"
}

HTTP status code 200

Body

Type: application/json

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: (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: (string)

Token Bearer

Example:

Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38

HTTP status code 401

Authentication required

HTTP status code 403

Forbidden

Update project within WebGME. Requires write access for project.

Secured by basic

Basic authentication scheme

Secured by bearer

JWT Bearer with authentication token.

URI Parameters

ownerId: required (string)
Example:
```
guest
```
projectName: required (string)
Example:
```
ActivePanels
```

Body

Type: application/json

Schema:

See example

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

Type: application/json

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: (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: (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 project from WebGME. Requires delete access for project.

Secured by basic

Basic authentication scheme

Secured by bearer

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
```

HTTP status code 204

HTTP status code 403

HTTP status code 404

Secured by basic

Headers

Authorization: (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: (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/{ownerId}/{projectName}/authorize/{userOrOrgId} delete

delete

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.

/projects/{ownerId}/{projectName}/authorize/{userOrOrgId}/{rights} put

put

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.

/projects/{ownerId}/{projectName}/commits get

get

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

Request
Response

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

Type: application/json

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

/projects/{ownerId}/{projectName}/commits/{commitId} get

get

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

Request
Response

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

Type: application/json

Example:

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

HTTP status code 403

/projects/{ownerId}/{projectName}/commits/{commitId}/export get

get

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

/projects/{ownerId}/{projectName}/commits/{commitId}/export/{nodePath} get

get

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

/projects/{ownerId}/{projectName}/commits/{commitId}/tree/{nodePath} get

get

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

Request
Response

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
```

HTTP status code 200

Body

Type: application/json

Example:

{
  "_id": "#41d009f2dc852dbbf783f900085b789b2f35d372",
  "atr": {
    "_relguid": "fa8d13d9e1b0d3477a1f5541ec1c0d3b"
  },
  "reg": {
    "position": {
      "x": 158,
      "y": 229
    }
  }
}

HTTP status code 403

HTTP status code 404

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

get

/projects/{ownerId}/{projectName}/branches get

Collection of available branches in WebGME.

get

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

Secured by basic

Basic authentication scheme

Secured by bearer

JWT Bearer with authentication token.

URI Parameters

ownerId: required (string)
Example:
```
guest
```
projectName: required (string)
Example:
```
ActivePanels
```

HTTP status code 200

Body

Type: application/json

Example:

{
   "dev":"#6d9f4a36be8339b6841c0ddf74eebdf4a6387288",
   "development":"#865778bd9f9f800ffaf280493fd88711531d1012",
   "master":"#d46d17982c3800c6a4c8226c89c3609fc4c0ab86",
   "merge":"#51228646fe143d04a36fc8fd369e2c1ccadfd173"
}

Secured by basic

Headers

Authorization: (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: (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/{ownerId}/{projectName}/branches/{branchId} get put patch delete

Entity representing a branch

get

Get the branch. Requires read access for project.

put

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

patch

Update branch within WebGME. Requires write access for project.

delete

Delete branch from WebGME. Requires write access for project.

Get the branch. Requires read access for project.

Secured by basic

Basic authentication scheme

Secured by bearer

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

Type: application/json

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

Type: application/json

Example:

{"message": "branch not found" }

Secured by basic

Headers

Authorization: (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: (string)

Token Bearer

Example:

Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38

HTTP status code 401

Authentication required

HTTP status code 403

Forbidden

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

Secured by basic

Basic authentication scheme

Secured by bearer

JWT Bearer with authentication token.

URI Parameters

ownerId: required (string)
Example:
```
guest
```
projectName: required (string)
Example:
```
ActivePanels
```
branchId: required (string)
Example:
```
master
```

Body

Type: application/json

Schema:

See example

Example:

{"hash": "#f2a624d9cfbf883c927b04dd45800ba55537dff5"}

HTTP status code 200

Body

Type: application/json

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: (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: (string)

Token Bearer

Example:

Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38

HTTP status code 401

Authentication required

HTTP status code 403

Forbidden

Update branch within WebGME. Requires write access for project.

Secured by basic

Basic authentication scheme

Secured by bearer

JWT Bearer with authentication token.

URI Parameters

ownerId: required (string)
Example:
```
guest
```
projectName: required (string)
Example:
```
ActivePanels
```
branchId: required (string)
Example:
```
master
```

Body

Type: application/json

Schema:

See example

Example:

{"oldHash": "#f2a624d9cfbf883c927b04dd45800ba55537dff5","newHash": "#4ac76d63da6f50cc5baaa5bfb42c86138edc9396"}

HTTP status code 200

Body

Type: application/json

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: (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: (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 branch from WebGME. Requires write access for project.

Secured by basic

Basic authentication scheme

Secured by bearer

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
```

HTTP status code 204

HTTP status code 403

HTTP status code 404

Secured by basic

Headers

Authorization: (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: (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/{ownerId}/{projectName}/branches/{branchId}/commits get

get

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

Request
Response

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

Type: application/json

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

/projects/{ownerId}/{projectName}/branches/{branchId}/export get

get

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

/projects/{ownerId}/{projectName}/branches/{branchId}/export/{nodePath} get

get

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

/projects/{ownerId}/{projectName}/branches/{branchId}/tree/{nodePath} get

get

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

Request
Response

URI Parameters

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

HTTP status code 200

Body

Type: application/json

Example:

{
  "_id": "#41d009f2dc852dbbf783f900085b789b2f35d372",
  "atr": {
    "_relguid": "fa8d13d9e1b0d3477a1f5541ec1c0d3b"
  },
  "reg": {
    "position": {
      "x": 158,
      "y": 229
    }
  }
}

HTTP status code 403

HTTP status code 404

/projects/{ownerId}/{projectName}/tags get

Collection of available tags in WebGME.

get

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

Secured by basic

Basic authentication scheme

Secured by bearer

JWT Bearer with authentication token.

URI Parameters

ownerId: required (string)
Example:
```
guest
```
projectName: required (string)
Example:
```
ActivePanels
```

HTTP status code 200

Body

Type: application/json

Example:

{
   "dev":"#6d9f4a36be8339b6841c0ddf74eebdf4a6387288",
   "development":"#865778bd9f9f800ffaf280493fd88711531d1012",
   "master":"#d46d17982c3800c6a4c8226c89c3609fc4c0ab86",
   "merge":"#51228646fe143d04a36fc8fd369e2c1ccadfd173"
}

Secured by basic

Headers

Authorization: (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: (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/{ownerId}/{projectName}/tags/{tagId} get put patch delete

Entity representing a tag

get

Get the tag. Requires read access for project.

put

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

patch

Update tag within WebGME. Requires delete access for project.

delete

Delete tag from WebGME. Requires delete access for project.

Get the tag. Requires read access for project.

Secured by basic

Basic authentication scheme

Secured by bearer

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

Type: application/json

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

Type: application/json

Example:

{"message": "tag not found" }

Secured by basic

Headers

Authorization: (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: (string)

Token Bearer

Example:

Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38

HTTP status code 401

Authentication required

HTTP status code 403

Forbidden

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

Secured by basic

Basic authentication scheme

Secured by bearer

JWT Bearer with authentication token.

URI Parameters

ownerId: required (string)
Example:
```
guest
```
projectName: required (string)
Example:
```
ActivePanels
```
tagId: required (string)
Example:
```
myTag
```

Body

Type: application/json

Schema:

See example

Example:

{"hash": "#f2a624d9cfbf883c927b04dd45800ba55537dff5"}

HTTP status code 200

Body

Type: application/json

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: (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: (string)

Token Bearer

Example:

Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38

HTTP status code 401

Authentication required

HTTP status code 403

Forbidden

Update tag within WebGME. Requires delete access for project.

Secured by basic

Basic authentication scheme

Secured by bearer

JWT Bearer with authentication token.

URI Parameters

ownerId: required (string)
Example:
```
guest
```
projectName: required (string)
Example:
```
ActivePanels
```
tagId: required (string)
Example:
```
myTag
```

Body

Type: application/json

Schema:

See example

Example:

{"hash": "#f2a624d9cfbf883c927b04dd45800ba55537dff5"}

HTTP status code 200

Body

Type: application/json

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: (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: (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 tag from WebGME. Requires delete access for project.

Secured by basic

Basic authentication scheme

Secured by bearer

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
```

HTTP status code 204

HTTP status code 403

HTTP status code 404

Secured by basic

Headers

Authorization: (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: (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/{ownerId}/{projectName}/tags/{tagId}/export get

get

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

/projects/{ownerId}/{projectName}/tags/{tagId}/export/{nodePath} get

get

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

/projects/{ownerId}/{projectName}/tags/{tagId}/tree/{nodePath} get

get

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

Request
Response

URI Parameters

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

HTTP status code 200

Body

Type: application/json

Example:

{
  "_id": "#41d009f2dc852dbbf783f900085b789b2f35d372",
  "atr": {
    "_relguid": "fa8d13d9e1b0d3477a1f5541ec1c0d3b"
  },
  "reg": {
    "position": {
      "x": 158,
      "y": 229
    }
  }
}

HTTP status code 403

HTTP status code 404

/projects/{ownerId}/{projectName}/hooks get

Returns with the list of webHooks.

get

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

Secured by basic

Basic authentication scheme

Secured by bearer

JWT Bearer with authentication token.

URI Parameters

ownerId: required (string)
Example:
```
guest
```
projectName: required (string)
Example:
```
ActivePanels
```

HTTP status code 200

Body

Type: application/json

Example:

{
   "dev":"#6d9f4a36be8339b6841c0ddf74eebdf4a6387288",
   "development":"#865778bd9f9f800ffaf280493fd88711531d1012",
   "master":"#d46d17982c3800c6a4c8226c89c3609fc4c0ab86",
   "merge":"#51228646fe143d04a36fc8fd369e2c1ccadfd173"
}

Secured by basic

Headers

Authorization: (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: (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/{ownerId}/{projectName}/hooks/{hookId} get put patch delete

Returns with the webHook information.

get

Get the hook. Requires read access for project.

put

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

patch

Update hook within WebGME. Requires write access for project.

delete

Delete hook from WebGME. Requires write access for project.

Get the hook. Requires read access for project.

Secured by basic

Basic authentication scheme

Secured by bearer

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

Type: application/json

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

Type: application/json

Example:

{"message": "hook not found" }

Secured by basic

Headers

Authorization: (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: (string)

Token Bearer

Example:

Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38

HTTP status code 401

Authentication required

HTTP status code 403

Forbidden

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

Secured by basic

Basic authentication scheme

Secured by bearer

JWT Bearer with authentication token.

URI Parameters

ownerId: required (string)
Example:
```
guest
```
projectName: required (string)
Example:
```
ActivePanels
```
hookId: required (string)
Example:
```
myHook
```

Body

Type: application/json

Schema:

See example

Example:

{"events": ["commit","branchCreated"],"description": "Information about the hook","url": "http://address/to/the/hook"}

HTTP status code 200

Body

Type: application/json

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: (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: (string)

Token Bearer

Example:

Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38

HTTP status code 401

Authentication required

HTTP status code 403

Forbidden

Update hook within WebGME. Requires write access for project.

Secured by basic

Basic authentication scheme

Secured by bearer

JWT Bearer with authentication token.

URI Parameters

ownerId: required (string)
Example:
```
guest
```
projectName: required (string)
Example:
```
ActivePanels
```
hookId: required (string)
Example:
```
myHook
```

Body

Type: application/json

Schema:

See example

Example:

{"active": false}

HTTP status code 200

Body

Type: application/json

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: (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: (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 hook from WebGME. Requires write access for project.

Secured by basic

Basic authentication scheme

Secured by bearer

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
```

HTTP status code 204

HTTP status code 403

HTTP status code 404

Secured by basic

Headers

Authorization: (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: (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/{ownerId}/{projectName}/squash put

put

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

Secured by basic

Basic authentication scheme

Secured by bearer

JWT Bearer with authentication token.

Request
Security

URI Parameters

ownerId: required (string)
Example:
```
guest
```
projectName: required (string)
Example:
```
ActivePanels
```

Body

Type: application/json

Example:

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

Secured by basic

Headers

Authorization: (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: (string)

Token Bearer

Example:

Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38

HTTP status code 401

Authentication required

HTTP status code 403

Forbidden

/status

End points for server status. These paths are only available for siteAdmins when auth is turned on.

/status get

get

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

Secured by basic

Basic authentication scheme

Secured by bearer

JWT Bearer with authentication token.

Response
Security

HTTP status code 200

Body

Type: application/json

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: (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: (string)

Token Bearer

Example:

Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38

HTTP status code 401

Authentication required

HTTP status code 403

Forbidden

/status/add-ons get

get

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

Secured by basic

Basic authentication scheme

Secured by bearer

JWT Bearer with authentication token.

Response
Security

HTTP status code 200

Body

Type: application/json

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: (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: (string)

Token Bearer

Example:

Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38

HTTP status code 401

Authentication required

HTTP status code 403

Forbidden

/status/server-workers get

get

Returns status about running server workers and request queue

Secured by basic

Basic authentication scheme

Secured by bearer

JWT Bearer with authentication token.

Response
Security

HTTP status code 200

Body

Type: application/json

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: (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: (string)

Token Bearer

Example:

Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38

HTTP status code 401

Authentication required

HTTP status code 403

Forbidden

/status/web-sockets get

get

Returns a list of all currently connected web-sockets

Secured by basic

Basic authentication scheme

Secured by bearer

JWT Bearer with authentication token.

Response
Security

HTTP status code 200

Body

Type: application/json

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: (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: (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

/decorators get

get

Returns with all available decorators

Response

HTTP status code 200

Body

Type: application/json

Example:

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

/seeds

/seeds get

get

Returns with all available seeds

/seeds/{seedName} get

get

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

Secured by basic

Basic authentication scheme

Secured by bearer

JWT Bearer with authentication token.

URI Parameters

seedName: required (string)

HTTP status code 200

Body

Type: application/json

Example:

{
  "blobHash": "da39a3ee5e6b4b0d3255bfef95601890afd80709"
}

HTTP status code 404

Seed does not exist

Secured by basic

Headers

Authorization: (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: (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

/visualizers get

get

Returns with all available visualizers

Response

HTTP status code 200

Body

Type: application/json

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
   }
]

/plugins

/plugins get

get

Lists all available plugins

Response

HTTP status code 200

Body

Type: application/json

Example:

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

/plugins/metadata get

get

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

Response

HTTP status code 200

Body

Type: application/json

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
      }
    ]
  }
]

/plugins/{pluginId}/config get

get

Gets the default configuration for the plugin.

Request
Response

URI Parameters

pluginId: required (string)

HTTP status code 200

Body

Type: application/json

Example:

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

/plugins/{pluginId}/configStructure get

get

Gets the conficuration structure for a plugin.

Request
Response

URI Parameters

pluginId: required (string)

HTTP status code 200

Body

Type: application/json

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
    }
]

/plugins/{pluginId}/metadata get

get

Gets the metadata associated with the given plugin.

Request
Response

URI Parameters

pluginId: required (string)

HTTP status code 200

Body

Type: application/json

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
    }
  ]
}

/plugins/{pluginId}/execute post

post

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

Request
Response

URI Parameters

pluginId: required (string)

Body

Type: application/json

Example:

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

HTTP status code 200

Body

Type: application/json

Example:

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

/plugins/{pluginId}/run post

post

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

Request
Response

URI Parameters

pluginId: required (string)

Body

Type: application/json

Example:

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

HTTP status code 200

Body

Type: application/json

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
}

/plugins/{pluginId}/results/{resultId} get

get

Gets a result for this plugin by resultId.

Request
Response

URI Parameters

pluginId: required (string)
resultId: required (string)

HTTP status code 200

Body

Type: application/json

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

/blob

TO BE MOVED here from /rest/blob

Request
Response

URI Parameters

filename: required (string)

HTTP status code 200

Body

Type: application/json

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

/blob/createMetadata post

post

/executor

TO BE MOVED here from /rest/executor

/executor get

get

List all jobs

/executor/info/{hash} get

get

Request
Response

URI Parameters

hash: required (string)

HTTP status code 200

Body

Type: application/json

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

/executor/create/{hash} post

post

Request
Response

URI Parameters

hash: required (string)

HTTP status code 200

Body

Type: application/json

Example:

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

WebGME API documentation version 1.0

/

/ get

get /

HTTP status code 200

Body

/componentSettings

/componentSettings get

get /componentSettings

HTTP status code 200

Body

Secured by basic

Headers

HTTP status code 401

HTTP status code 403

Secured by bearer

Headers

HTTP status code 401

HTTP status code 403

/componentSettings/{componentId} get

get /componentSettings/{componentId}

URI Parameters

HTTP status code 200

Body

Secured by basic

Headers

HTTP status code 401

HTTP status code 403

Secured by bearer

Headers

HTTP status code 401

HTTP status code 403

/user

/user get delete

get /user

HTTP status code 200

Body

Secured by basic

Headers

HTTP status code 401

HTTP status code 403

Secured by bearer

Headers

HTTP status code 401

HTTP status code 403

delete /user

HTTP status code 204

Secured by basic

Headers

HTTP status code 401

HTTP status code 403

Secured by bearer

Headers

HTTP status code 401

HTTP status code 403

/user/token get

get /user/token

HTTP status code 200

Body

Secured by basic

Headers

HTTP status code 401

HTTP status code 403

Secured by bearer

Headers

HTTP status code 401

HTTP status code 403

/user/data get put patch delete

get /user/data

HTTP status code 200

Body

HTTP status code 404

Body

Secured by basic

Headers

HTTP status code 401

HTTP status code 403

Secured by bearer

Headers

HTTP status code 401