The details of all resources provide by core.
All URL's are in the format: https://<api.domain.com>/<account_name>/<application_name>/<uri>/<uri_params>
All get, post and uri params should be url encoded.
| Name | Description | URI | Method | Post params | Get params | URI params | Body | Permissions | Example |
|---|---|---|---|---|---|---|---|---|---|
| Account create | Create an account | account | POST | name -> account name | Administrator | /apiopenstudio/core/account | |||
| Account delete | Delete an account | account | DELETE | 0 -> account ID | Administrator | /apiopenstudio/core/account/34 | |||
| Account read | Fetch a single or multiple accounts | account | GET | keyword -> filter by name order_by -> order results direction -> order direction |
0 -> account ID | A valid token (but returns results, based on roles) | /apiopenstudio/core/account/64 /apiopenstudio/core/account?kyword=my%20dept&order_by=name&direction=asc |
||
| Account update | Rename an account | account | PUT | 0 -> account ID 1 -> new name |
Administrator | /apiopenstudio/core/account/43/new&20name | |||
| Application create | Create an application | application | POST | accid -> account ID name -> application name |
Administrator Account manager |
/apiopenstudio/core/application | |||
| Application delete | Delete an application | application | DELETE | 0 -> application ID | Administrator Account manager |
/apiopenstudio/core/application/102 | |||
| Application read | Fetch a single or multiple applications | application | GET | account_id -> filter by accid application_id -> filter by appid keyword -> filter by keyword order_by -> order the results direction -> asc or desc |
0 -> application ID 1 -> account ID 1 -> application name |
A valid token (but returns results, based on roles) | /apiopenstudio/core/application/34 /apiopenstudio/core/application//15 /apiopenstudio/core/application///my%20resource /apiopenstudio/core/application?keyword=foobar |
||
| Application update | Update an application | application | PUT | Administrator Account manager |
/apiopenstudio/core/application/33/3/new%name | ||||
| Invite accept | User invite accepted using a token | user/invite/accept | POST | 0 -> User invite accept token | No restrictions | /apiopenstudio/core/user/invite/accept/4i75we4br7ywn3rcfnwi8vyes5tivynesrotyvn | |||
| Invite delete | Delete a user invite | invite | DELETE | 0 -> user invite ID | Administrator Account manager Application manager |
/apiopenstudio/core/invite/4765 | |||
| Invite read | Fetch user invites | invite | GET | iid -> filter by invite ID email -> filter by email order_by -> order by column direction -> order by direction offset -> skip n rows limit -> fetch n rows |
Administrator Account manager Application manager |
/apiopenstudio/core/invite?email=foo%40bar.com | |||
| Invite send | Invite a user or users | user/invite | POST | email -> email/s | Administrator Account manager Application manager |
/apiopenstudio/core/user/invite | |||
| Password reset | Reset a user password | password/reset | POST | email -> email to send the password reset to token -> password reset token password -> new password |
No restrictions | /apiopenstudio/core/password/reset | |||
| Processors | Fetch details of all processors | processors | GET | 0 -> machine name or 'all' | Developer | /apiopenstudio/core/processors/all /apiopenstudio/core/processors/account_read |
|||
| Resource create | Create a resource | resource | POST | name -> name of the resource description -> description of the resource appid -> application ID to associate the resource with method -> request method uri -> resource URI ttl -> caching time format -> json ot yaml format meta -> the security, process and output metadata |
Developer | /apiopenstudio/core/resource | |||
| Resource delete | Delete a resource | resource | DELETE | 0 -> resource ID | Developer | /apiopenstudio/core/resource/453 | |||
| Resource export | Export a resource | resource/export | GET | 0 -> export format 1 -> resource ID |
Developer | /apiopenstudio/core/resource/export/yaml/1345 | |||
| Resource import | Import a resource from a file | resource/import | POST | resource_file -> form post type file | Developer | /apiopenstudio/core/resource/import | |||
| Resource read | Fetch a single or multiple resources | resource | GET | resid -> filter by resource ID accid -> filter by account ID appid -> filter by application ID keyword -> filter by keyword order_by -> order by column direction -> order by direction |
Developer | /apiopenstudio/core/resource?accid=1 | |||
| Resource update | Update a resource | resource | PUT | JSON encoded string of a resource file contents. | Developer | /apiopenstudio/core/resource | |||
| Role create | Create a new role | role | POST | name -> role name | Administrator Account manager Application manager |
/apiopenstudio/core/role | |||
| Role delete | Delete a new role | role | DELETE | 0 -> role ID | Administrator Account manager Application manager |
/apiopenstudio/core/role/33 | |||
| Role read | Fetch a single or multiple roles | role | GET | keyword -> filter by keyword order_by -> order by column direction -> order by direction |
0 -> account ID | Administrator Account manager Application manager Developer |
/apiopenstudio/core/role/54 /apiopenstudio/core/role |
||
| Role update | Update a role | role | PUT | JSON containing role ID and new name, e.g. {"rid": 6, "name": "ive changed"} |
Administrator Account manager Application manager |
/apiopenstudio/core/role | |||
| Token Generate | Generate a JWT token. Token, uid and expires returned. | auth/token | POST | username password |
No restrictions | /apiopenstudio/core/auth/token | |||
| User create | Create a user | user | POST | username password active honorific name_first name_last company website street_address suburb city state country postcode phone_mobile phone_work |
Administrator Account manager Application manager |
/apiopenstudio/core/user | |||
| User delete | Delete a user | user | DELETE | 0 -> User ID | Administrator Account manager Application manager |
/apiopenstudio/core/user/1034 | |||
| User read | Fetch a user | user | GET | uid -> filter by user ID username -> filter by username email -> filter by email keyword -> filter by keyword orderBy -> Order results by column direction -> order by direction |
A valid token | /apiopenstudio/core/login | |||
| User update | Update a user | user | PUT | 0 -> User ID to update | JSON encoded string, containing the following optional attributes:
|
A valid token | /apiopenstudio/core/user | ||
| User role create | Assign a role to a user for an account/application | user/role | POST | uid -> user ID accid -> account ID appid -> application ID rid -> role ID |
Administrator Account manager Application manager |
/apiopenstudio/core/user/role | |||
| User role delete | Delete a role for a user for an account/application | user/role | DELETE | 0 -> user/role ID | Administrator Account manager Application manager |
/apiopenstudio/core/user/role/1024 | |||
| User Role read | Fetch roles | user/role | GET | uid -> filter by user ID accid -> filter by account ID appid -> filter by application ID rid -> filter by role ID order_by -> order results by column direction -> order by direction |
A valid token | /apiopenstudio/core/user/role?accid=45&rid=4 | |||
| Var store create | Create a var store variable | var_store | POST | appid -> application ID key -> variable keyname val -> variable value |
Administrator Account manager Application manager Developer |
/apiopenstudio/core/var_store | |||
| Var store delete | Delete a var store variable | var_store | DELETE | 0 -> variable ID | Administrator Account manager Application manager Developer |
/apiopenstudio/core/var_store/256 | |||
| Var store read | Fetch a single or multiple var store variables where the user has access to the applications vars | var_store | GET | vid -> filter by variable ID appid -> filter by application ID keyword -> filter by keyword order_by ->order results by column direction -> order by direction |
Administrator Account manager Application manager Developer |
/apiopenstudio/core/var_store?appid=758&order_by=key&direction=desc | |||
| Var store update | Update a var store variable | var_store | PUT | 0 -> variable ID | The value to place in the variable | Administrator Account manager Application manager Developer |
/apiopenstudio/core/var_store |