Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Request MethodIDActionResulting FunctionPermission RequiredURL ExampleNotesExample Response
POSTn creategroups::create/groupsInsert a new groups entry.groups_create.json
GETy readgroups::read/groups/{id}Returns a groups details.groups_read.json
PATCHy updategroups::update/groups/{id}Update an attribute of a groups entry.groups_update.json
DELETEy deletegroups::delete/groups/{id}Delete a groups entry. 
GETn collectiongroups::read/groupsReturns a list of groups.groups_collection.json
POSTnimportimportgroups::create/groups/importImport multiple groups using a CSV. 

Web Application Routes

In addition to the above, when access Open-AudIT using a web browser.

Request MethodIDActionResulting FunctionPermission RequiredURL ExampleNotes 
GETncreatecreate_formgroups::create/groups/createDisplays a standard web form for submission to POST /groups. 
GETyupdateupdate_formgroups::update/groups/{id}/updateShow the group details with the option to update attributes using PATCH to /groups/{id} 
GETnimportimport_formgroups::create/groups/importDisplays a standard web form for submission to POST /groups/import. 
POSTnimportimportgroups::create/groups/importImport multiple groups using a CSV.