{"openapi":"3.0.0","info":{"title":"RCAC API","version":"0.0.1"},"servers":[{"url":"https:\/\/www.rcac.purdue.edu\/api","description":"Production server"}],"components":{"parameters":{"limitParam":{"name":"limit","in":"query","description":"Number of records to return per page","required":false,"schema":{"type":"integer","format":"int32"}},"pageParam":{"name":"page","in":"query","description":"","required":false,"schema":{"type":"integer","format":"int32"}}},"securitySchemes":{"api_token":{"type":"apiKey","name":"api_token","in":"header"}}},"paths":{"\/contactreports\/comments":{"get":{"description":"Display a listing of contact reports comments","parameters":[{"in":"query","name":"contactreportid","description":"ID of contact report","required":false,"schema":{"type":"integer","default":0}},{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","description":"Number of result per page.","type":"integer","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"datetimecreated","enum":["id","datetimecreated","datetimeremoved"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"desc","enum":["asc","desc"]}}]},"post":{"description":"Create a contact report comment","parameters":[],"responses":{"201":{"description":"Successful entry creation","content":{"application\/json":{"example":{"id":1,"contactreportid":1,"userid":1234,"comment":"Example comment","stemmedcomment":"example comment","notice":0,"datetimecreated":"2021-09-14 13:01:55","formatteddate":"Sep 14, 2021&nbsp; 1:01pm","formattedcomment":"<p>Example comment<\/p>","username":"John Doe","api":"https:\/\/example.org\/api\/contactreports\/comments\/1"}}}},"401":{"description":"Unauthorized"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"comment":{"description":"The comment being made","type":"string","default":null},"contactreportid":{"description":"ID of the contact report","type":"integer","default":null},"userid":{"description":"User ID","type":"integer","default":0},"notice":{"description":"Notification state","type":"integer","default":0}},"required":["comment","contactreportid"]}}}}}},"\/contactreports\/comments\/{id}":{"get":{"description":"Retrieve a contact report comment","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry modification","content":{"application\/json":{"example":{"id":1,"contactreportid":1,"userid":1234,"comment":"Example comment","stemmedcomment":"example comment","notice":0,"datetimecreated":"2021-09-14 13:01:55","formatteddate":"Sep 14, 2021&nbsp; 1:01pm","formattedcomment":"<p>Example comment<\/p>","username":"John Doe","api":"https:\/\/example.org\/api\/contactreports\/comments\/1"}}}},"404":{"description":"Record not found"}}},"put":{"description":"Update a contact report comment","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"202":{"description":"Successful entry modification","content":{"application\/json":{"example":{"id":1,"contactreportid":1,"userid":1234,"comment":"Example comment","stemmedcomment":"example comment","notice":0,"datetimecreated":"2021-09-14 13:01:55","formatteddate":"Sep 14, 2021&nbsp; 1:01pm","formattedcomment":"<p>Example comment<\/p>","username":"John Doe","api":"https:\/\/example.org\/api\/contactreports\/comments\/1"}}}},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"comment":{"description":"The comment being made","type":"string","default":null},"contactreportid":{"description":"ID of the contact report","type":"integer","default":null},"userid":{"description":"User ID","type":"integer","default":null},"notice":{"description":"Notification state","type":"integer","default":null}},"required":[]}}}}},"delete":{"description":"Delete a contact report comment","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/contactreports\/followgroups":{"get":{"description":"Display a listing of contact reports followgroups","parameters":[{"in":"query","name":"groupid","description":"Group ID","required":false,"schema":{"type":"integer","default":0}},{"in":"query","name":"userid","description":"User ID","required":false,"schema":{"type":"integer","default":0}},{"in":"query","name":"limit","description":"Number of result per page.","type":"integer","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"datecreated","enum":["id","userid","datecreated","targetuserid"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"desc","enum":["asc","desc"]}}]},"post":{"description":"Create a group following","parameters":[],"responses":{"201":{"description":"Successful entry creation","content":{"application\/json":{"example":{"id":1,"groupid":20,"userid":1234,"userrequestid":0,"membertype":10,"owner":0,"datecreated":"2021-09-03T05:44:38.000000Z","dateremoved":null,"datelastseen":null,"notice":0,"api":"https:\/\/example.org\/api\/contactreports\/followgroups\/1"}}}},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"groupid":{"description":"ID of group being followed","type":"integer","default":null},"userid":{"description":"User ID of follower","type":"integer","default":"Current user's ID"}},"required":[]}}}}}},"\/contactreports\/followgroups\/{id}":{"get":{"description":"Retrieve a group following record","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read","content":{"application\/json":{"example":{"id":1,"groupid":20,"userid":1234,"userrequestid":0,"membertype":10,"owner":0,"datecreated":"2021-09-03T05:44:38.000000Z","dateremoved":null,"datelastseen":null,"notice":0,"api":"https:\/\/example.org\/api\/contactreports\/followgroups\/1"}}}},"404":{"description":"Record not found"}}},"put":{"description":"Update a group following","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry modification","content":{"application\/json":{"example":{"id":1,"groupid":20,"userid":1234,"userrequestid":0,"membertype":10,"owner":0,"datecreated":"2021-09-03T05:44:38.000000Z","dateremoved":null,"datelastseen":null,"notice":0,"api":"https:\/\/example.org\/api\/contactreports\/followgroups\/1"}}}},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"groupid":{"description":"ID of group being followed","type":"integer","default":null},"userid":{"description":"ID of user following the group","type":"integer","default":null}},"required":[]}}}}},"delete":{"description":"Delete a group following","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/contactreports\/followusers":{"get":{"description":"Display a listing of contact reports user followings","parameters":[{"in":"query","name":"targetuserid","description":"Target User ID","required":false,"schema":{"type":"integer","default":0}},{"in":"query","name":"userid","description":"User ID","required":false,"schema":{"type":"integer","default":0}},{"in":"query","name":"limit","description":"Number of result per page.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"datecreated","enum":["id","userid","datecreated","targetuserid"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"desc","enum":["asc","desc"]}}]},"post":{"description":"Create a contact report user following","parameters":[],"responses":{"201":{"description":"Successful entry creation","content":{"application\/json":{"example":{"id":1,"userid":1,"targetuserid":2,"membertype":10,"datecreated":"2021-09-01 09:12:01","dateremoved":null,"datelastseen":null,"api":"https:\/\/example.org\/api\/contactreports\/followusers\/1"}}}},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"targetuserid":{"description":"User ID to follow","type":"integer","default":null},"userid":{"description":"User ID of follower","type":"integer","default":"Current user's ID"}},"required":["targetuserid"]}}}}}},"\/contactreports\/followusers\/{id}":{"get":{"description":"Retrieve a contact report user following","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read","content":{"application\/json":{"example":{"id":1,"userid":1,"targetuserid":2,"membertype":10,"datecreated":"2021-09-01 09:12:01","dateremoved":null,"datelastseen":null,"api":"https:\/\/example.org\/api\/contactreports\/followusers\/1"}}}},"404":{"description":"Record not found"}}},"put":{"description":"Update a contact report user following","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry modification","content":{"application\/json":{"example":{"id":1,"userid":1,"targetuserid":2,"membertype":10,"datecreated":"2021-09-01 09:12:01","dateremoved":null,"datelastseen":null,"api":"https:\/\/example.org\/api\/contactreports\/followusers\/1"}}}},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"targetuserid":{"description":"User ID to follow","type":"integer","default":null},"userid":{"description":"User ID of follower","type":"integer","default":null}},"required":[]}}}}},"delete":{"description":"Delete a contact report user following","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/contactreports":{"get":{"description":"Display a listing of contact reports","parameters":[{"in":"query","name":"limit","description":"Number of result per page.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"type","description":"Contact Report type ID","required":false,"schema":{"type":"integer"}},{"in":"query","name":"group","description":"Filter by group ID","required":false,"schema":{"type":"integer"}},{"in":"query","name":"start","description":"Timestamp (YYYY-MM-DD or YYYY-MM-DD hh:mm:ss) for records on or after that date","required":false,"schema":{"type":"string","format":"date","example":"2021-01-30"}},{"in":"query","name":"stop","description":"Timestamp (YYYY-MM-DD or YYYY-MM-DD hh:mm:ss) for records before that date","required":false,"schema":{"type":"string","format":"date","example":"2021-01-30"}},{"in":"query","name":"people","description":"Filter by people associated with reports. Comma-separated list of usernames, emails, or user IDs","required":false,"schema":{"type":"string","example":"person1,person2,person3"}},{"in":"query","name":"resource","description":"Filter by resources associated with reports. Comma-separated list of resource IDs","required":false,"schema":{"type":"string","example":"1,2,3"}},{"in":"query","name":"tag","description":"Filter by tags associated with reports. Comma-separated list of tags","required":false,"schema":{"type":"string","example":"tag1,tag2,tag3"}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"notice","description":"Filter by notice value","required":false,"schema":{"type":"integer"}},{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"datetimecreated","enum":["id","report","datetimecreated"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"desc","enum":["asc","desc"]}}]},"post":{"description":"Create a contact report","parameters":[],"responses":{"201":{"description":"Successful entry creation","content":{"application\/json":{"example":{"id":5830,"groupid":142,"userid":61344,"report":"Example text","stemmedreport":"eexample ttext","datetimecontact":"2021-09-03T04:00:00.000000Z","datetimecreated":"2021-09-03T20:01:44.000000Z","notice":23,"datetimegroupid":null,"contactreporttypeid":3,"formatteddate":"September 3, 2021 4:01pm","formattedreport":"<p>Example text.<\/p>","comments":[],"subscribed":1,"subscribedcommentid":0,"type":{"id":3,"name":"Personal Meeting","timeperiodid":1,"timeperiodcount":7,"timeperiodlimit":14,"waitperiodid":0,"waitperiodcount":0},"username":"John Doe","users":[{"id":9342,"contactreportid":5830,"userid":56907,"datetimecreated":"2021-09-03T20:01:44.000000Z","datetimelastnotify":null,"name":"Gerhard Klimeck"},{"id":9343,"contactreportid":5830,"userid":81163,"datetimecreated":"2021-09-03T20:01:44.000000Z","datetimelastnotify":null,"name":"Erik S Gough"}],"groupname":"Lorem Ipsum","resources":[{"id":106819,"contactreportid":5830,"resourceid":110,"name":"Geddes"},{"id":106820,"contactreportid":5830,"resourceid":92,"name":"Gilbreth"}],"tags":[],"age":1200675,"api":"https:\/\/example.org\/api\/contactreports\/5830","url":"https:\/\/example.org\/contactreports\/5830"}}}},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"datetimecontact":{"description":"Timestamp (YYYY-MM-DD or YYYY-MM-DD hh:mm:ss) of the contact","type":"string","default":null},"groupid":{"description":"ID of the associated group","type":"integer","default":0},"datetimegroupid":{"description":"Timestamp (YYYY-MM-DD or YYYY-MM-DD hh:mm:ss) of the contact","type":"string","default":null},"userid":{"description":"ID of the user creating the entry","type":"integer","default":0},"contactreporttypeid":{"description":"Type ID for the entry","type":"integer","default":0},"report":{"description":"The report text","type":"string","default":null},"notice":{"description":"Notice state","type":"integer","default":0}},"required":["datetimecontact","report"]}}}}}},"\/contactreports\/preview":{"post":{"description":"Parse submitted text to see the final result","parameters":[],"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"body":{"description":"Unformatted text","type":"string","default":null}},"required":["body"]}}}}}},"\/contactreports\/{id}":{"get":{"description":"Retrieve a contact report","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read","content":{"application\/json":{"example":{"id":5830,"groupid":142,"userid":61344,"report":"Example text","stemmedreport":"eexample ttext","datetimecontact":"2021-09-03T04:00:00.000000Z","datetimecreated":"2021-09-03T20:01:44.000000Z","notice":23,"datetimegroupid":null,"contactreporttypeid":3,"formatteddate":"September 3, 2021 4:01pm","formattedreport":"<p>Example text.<\/p>","comments":[],"subscribed":1,"subscribedcommentid":0,"type":{"id":3,"name":"Personal Meeting","timeperiodid":1,"timeperiodcount":7,"timeperiodlimit":14,"waitperiodid":0,"waitperiodcount":0},"username":"John Doe","users":[{"id":9342,"contactreportid":5830,"userid":56907,"datetimecreated":"2021-09-03T20:01:44.000000Z","datetimelastnotify":null,"name":"Gerhard Klimeck"},{"id":9343,"contactreportid":5830,"userid":81163,"datetimecreated":"2021-09-03T20:01:44.000000Z","datetimelastnotify":null,"name":"Erik S Gough"}],"groupname":"Lorem Ipsum","resources":[{"id":106819,"contactreportid":5830,"resourceid":110,"name":"Geddes"},{"id":106820,"contactreportid":5830,"resourceid":92,"name":"Gilbreth"}],"tags":[],"age":1200675,"api":"https:\/\/example.org\/api\/contactreports\/5830","url":"https:\/\/example.org\/contactreports\/5830"}}}},"404":{"description":"Record not found"}}},"put":{"description":"Update a contact report","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry modification","content":{"application\/json":{"example":{"id":5830,"groupid":142,"userid":61344,"report":"Example text","stemmedreport":"eexample ttext","datetimecontact":"2021-09-03T04:00:00.000000Z","datetimecreated":"2021-09-03T20:01:44.000000Z","notice":23,"datetimegroupid":null,"contactreporttypeid":3,"formatteddate":"September 3, 2021 4:01pm","formattedreport":"<p>Example text.<\/p>","comments":[],"subscribed":1,"subscribedcommentid":0,"type":{"id":3,"name":"Personal Meeting","timeperiodid":1,"timeperiodcount":7,"timeperiodlimit":14,"waitperiodid":0,"waitperiodcount":0},"username":"John Doe","users":[{"id":9342,"contactreportid":5830,"userid":56907,"datetimecreated":"2021-09-03T20:01:44.000000Z","datetimelastnotify":null,"name":"Gerhard Klimeck"},{"id":9343,"contactreportid":5830,"userid":81163,"datetimecreated":"2021-09-03T20:01:44.000000Z","datetimelastnotify":null,"name":"Erik S Gough"}],"groupname":"Lorem Ipsum","resources":[{"id":106819,"contactreportid":5830,"resourceid":110,"name":"Geddes"},{"id":106820,"contactreportid":5830,"resourceid":92,"name":"Gilbreth"}],"tags":[],"age":1200675,"api":"https:\/\/example.org\/api\/contactreports\/5830","url":"https:\/\/example.org\/contactreports\/5830"}}}},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"datetimecontact":{"description":"Timestamp (YYYY-MM-DD or YYYY-MM-DD hh:mm:ss) of the contact","type":"string","default":null},"groupid":{"description":"ID of the associated group","type":"integer","default":null},"report":{"description":"The report text","type":"string","default":null},"contactreporttypeid":{"description":"Type ID for the entry","type":"integer","default":0},"notice":{"description":"Notice state","type":"integer","default":0}},"required":[]}}}}},"delete":{"description":"Delete a contact report","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/contactreports\/types":{"get":{"description":"Display a listing of contact report types","parameters":[{"in":"query","name":"tagresources","description":"Filter by `tagresources` value","required":false,"schema":{"type":"integer"}},{"in":"query","name":"location","description":"Filter by `location` value","required":false,"schema":{"type":"integer"}},{"in":"query","name":"future","description":"Filter by `future` value","required":false,"schema":{"type":"integer"}},{"in":"query","name":"ongoing","description":"Filter by `ongoing` value","required":false,"schema":{"type":"integer"}},{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","description":"Number of result per page.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"datetimecreated","enum":["id","motd","datetimecreated","datetimeremoved"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"desc","enum":["asc","desc"]}}]},"post":{"description":"Create a contact report type","parameters":[],"responses":{"201":{"description":"Successful entry creation","content":{"application\/json":{"example":{"id":1,"name":"Examples","timeperiodid":0,"timeperiodcount":0,"timeperiodlimit":0,"waitperiodid":0,"waitperiodcount":0,"reports_count":442,"api":"https:\/\/example.org\/api\/contactreports\/types\/1"}}}},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"comment":{"description":"The comment being made","type":"string","default":null},"name":{"description":"The name of the type","type":"string","default":null},"timeperiodid":{"description":"ID of a timeperiod","type":"integer","default":0},"timeperiodcount":{"description":"Number of time periods","type":"integer","default":0},"timeperiodlimit":{"description":"Timeperiod limit","type":"integer","default":0},"waitperiodid":{"description":"ID of a timeperiod","type":"integer","default":0},"waitperiodcount":{"description":"Number of wait periods","type":"integer","default":0}},"required":["comment"]}}}}}},"\/contactreports\/types\/{id}":{"get":{"description":"Read a contact report type","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read","content":{"application\/json":{"example":{"id":1,"name":"Examples","timeperiodid":0,"timeperiodcount":0,"timeperiodlimit":0,"waitperiodid":0,"waitperiodcount":0,"reports_count":442,"api":"https:\/\/example.org\/api\/contactreports\/types\/1"}}}},"404":{"description":"Record not found"}}},"put":{"description":"Update a contact report type","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry modification","content":{"application\/json":{"example":{"id":1,"name":"Examples","timeperiodid":0,"timeperiodcount":0,"timeperiodlimit":0,"waitperiodid":0,"waitperiodcount":0,"reports_count":442,"api":"https:\/\/example.org\/api\/contactreports\/types\/1"}}}},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"The name of the type","type":"string","default":null},"timeperiodid":{"description":"ID of a timeperiod","type":"integer","default":null},"timeperiodcount":{"description":"Number of time periods","type":"integer","default":null},"timeperiodlimit":{"description":"Timeperiod limit","type":"integer","default":null},"waitperiodid":{"description":"ID of a timeperiod","type":"integer","default":null},"waitperiodcount":{"description":"Number of wait periods","type":"integer","default":null}},"required":[]}}}}},"delete":{"description":"Delete a contact report type","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/api":{"get":{"description":"Display API schema","parameters":[]}},"\/courses":{"get":{"description":"Display a listing of entries","parameters":[{"in":"query","name":"userid","description":"Owner user ID","required":false,"schema":{"type":"integer"}},{"in":"query","name":"groupid","description":"Group ID","required":false,"schema":{"type":"integer"}},{"in":"query","name":"resourceid","description":"Resource ID","required":false,"schema":{"type":"integer"}},{"in":"query","name":"deptartment","description":"Department code","required":false,"schema":{"type":"string","maxLength":4,"example":"STAT"}},{"in":"query","name":"notice","description":"Notice state","required":false,"schema":{"type":"integer","default":null}},{"in":"query","name":"start","description":"Filter entries scheduled on or after this date","required":false,"schema":{"type":"string","format":"date-time","example":"2021-01-30T08:30:00Z"}},{"in":"query","name":"stop","description":"Filter entries scheduled to end before this date","required":false,"schema":{"type":"string","format":"date-time","example":"2021-01-30T08:30:00Z"}},{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","description":"Number of result per page.","required":false,"schema":{"type":"integer","default":25}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"name","enum":["id","name","owneruserid","unixgroup","unixid","deptartment"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","type":"string","required":false,"default":"asc","schema":{"type":"string","default":"asc","enum":["asc","desc"]}}]},"post":{"description":"Create a new entry","parameters":[],"responses":{"201":{"description":"Successful entry creation","content":{"application\/json":{"example":{"id":1,"crn":"10023","department":"AAE","coursenumber":"33400","classname":"Aerodynamics","resourceid":70,"notice":0,"datetimestart":"2017-08-21T04:00:00.000000Z","datetimestop":"2017-12-16T05:00:00.000000Z","semester":"Fall 2017","groupid":0,"userid":1234,"datetimeremoved":null,"datetimecreated":"2017-07-21T17:01:39.000000Z","studentcount":0,"reference":"","api":"https:\/\/example.org\/api\/courses\/56","members":[]}}}},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"crn":{"description":"Course CRN","type":"string","default":null},"classname":{"description":"Class name","type":"string","default":null},"coursenumber":{"description":"Course number","type":"string","default":null},"userid":{"description":"Owner user ID","type":"integer","default":null},"groupid":{"description":"Group ID","type":"integer","default":null},"resourceid":{"description":"Resource ID","type":"integer","default":null},"deptartment":{"description":"Department ID","type":"string","default":null},"datetimestart":{"description":"Start date of the entry","type":"string","default":null},"datetimestop":{"description":"End date of the entry","type":"string","default":null}},"required":["classname","resourceid","datetimestart","datetimestop"]}}}}}},"\/courses\/{id}":{"get":{"description":"Retrieve an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read","content":{"application\/json":{"example":{"id":1,"crn":"10023","department":"AAE","coursenumber":"33400","classname":"Aerodynamics","resourceid":70,"notice":0,"datetimestart":"2017-08-21T04:00:00.000000Z","datetimestop":"2017-12-16T05:00:00.000000Z","semester":"Fall 2017","groupid":0,"userid":1234,"datetimeremoved":null,"datetimecreated":"2017-07-21T17:01:39.000000Z","studentcount":0,"reference":"","api":"https:\/\/example.org\/api\/courses\/56","members":[{"id":87,"classaccountid":56,"userid":12346,"membertype":1,"datetimestart":"2017-08-21T04:00:00.000000Z","datetimestop":"2017-12-16T05:00:00.000000Z","notice":0,"datetimecreated":"2017-07-21T17:01:40.000000Z","datetimeremoved":null,"api":"https:\/\/example.org\/api\/courses\/members\/87","user":{"id":12346,"name":"Fu Bar","username":"fubar"}},{"id":87,"classaccountid":56,"userid":12347,"membertype":1,"datetimestart":"2017-08-21T04:00:00.000000Z","datetimestop":"2017-12-16T05:00:00.000000Z","notice":0,"datetimecreated":"2017-07-21T17:01:40.000000Z","datetimeremoved":null,"api":"https:\/\/example.org\/api\/courses\/members\/88","user":{"id":12347,"name":"Lorrie Ipsum","username":"ipsuml"}}]}}}},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}}},"put":{"description":"Update an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry modification","content":{"application\/json":{"example":{"id":1,"crn":"10023","department":"AAE","coursenumber":"33400","classname":"Aerodynamics","resourceid":70,"notice":0,"datetimestart":"2017-08-21T04:00:00.000000Z","datetimestop":"2017-12-16T05:00:00.000000Z","semester":"Fall 2017","groupid":0,"userid":1234,"datetimeremoved":null,"datetimecreated":"2017-07-21T17:01:39.000000Z","studentcount":0,"reference":"","api":"https:\/\/example.org\/api\/courses\/56","members":[{"id":87,"classaccountid":56,"userid":12346,"membertype":1,"datetimestart":"2017-08-21T04:00:00.000000Z","datetimestop":"2017-12-16T05:00:00.000000Z","notice":0,"datetimecreated":"2017-07-21T17:01:40.000000Z","datetimeremoved":null,"api":"https:\/\/example.org\/api\/courses\/members\/87","user":{"id":12346,"name":"Fu Bar","username":"fubar"}},{"id":87,"classaccountid":56,"userid":12347,"membertype":1,"datetimestart":"2017-08-21T04:00:00.000000Z","datetimestop":"2017-12-16T05:00:00.000000Z","notice":0,"datetimecreated":"2017-07-21T17:01:40.000000Z","datetimeremoved":null,"api":"https:\/\/example.org\/api\/courses\/members\/88","user":{"id":12347,"name":"Lorrie Ipsum","username":"ipsuml"}}]}}}},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"crn":{"description":"Course CRN","type":"string","default":null},"classname":{"description":"Class name","type":"string","default":null},"coursenumber":{"description":"Course number","type":"string","default":null},"userid":{"description":"Owner user ID","type":"integer","default":null},"groupid":{"description":"Group ID","type":"integer","default":null},"resourceid":{"description":"Resource ID","type":"integer","default":null},"deptartment":{"description":"Department ID","type":"string","default":null},"datetimestart":{"description":"Start date of the entry","type":"string","default":null},"datetimestop":{"description":"End date of the entry","type":"string","default":null}},"required":[]}}}}},"delete":{"description":"Delete an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/courses\/sync":{"get":{"description":"Sync users with account info","parameters":[]}},"\/courses\/enrollments":{"get":{"description":"Lookup enrollments for a class","parameters":[{"in":"query","name":"crn","description":"Course CRN","required":false,"schema":{"type":"string"}},{"in":"query","name":"classid","description":"Course ID","required":true,"schema":{"type":"string"}}]}},"\/courses\/members":{"get":{"description":"Display a listing of entries","parameters":[{"in":"query","name":"classaccountid","description":"Class account ID","required":false,"schema":{"type":"integer","default":0}},{"in":"query","name":"membertype","description":"Member type ID","required":false,"schema":{"type":"integer","default":0}},{"in":"query","name":"userid","description":"User ID","required":false,"schema":{"type":"integer","default":0}},{"in":"query","name":"notice","description":"Notice status","required":false,"schema":{"type":"integer","default":0}},{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"search"}},{"in":"query","name":"limit","description":"Number of result per page.","type":"integer","required":false,"schema":{"type":"integer","default":25}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"default":"name","schema":{"type":"string","default":"name","enum":["id","name","owneruserid","unixgroup","unixid"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","type":"string","required":false,"default":"asc","schema":{"type":"string","default":"asc","enum":["asc","desc"]}}]},"post":{"description":"Create a new entry","parameters":[],"responses":{"201":{"description":"Successful entry creation","content":{"application\/json":{"example":{"id":1,"classaccountid":1,"userid":1234,"membertype":1,"datetimestart":"2016-08-22T04:00:00.000000Z","datetimestop":"2016-12-17T05:00:00.000000Z","notice":0,"datetimecreated":"2016-08-19T04:02:01.000000Z","datetimeremoved":null,"api":"https:\/\/example.org\/api\/courses\/members\/1","user":{"id":1234,"name":"Jane Doe","username":"jdoe"}}}}},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"classaccountid":{"description":"Class account ID","type":"integer","default":null},"membertype":{"description":"Member type ID","type":"integer","default":null},"userid":{"description":"User ID","type":"integer","default":null},"datetimestart":{"description":"Datetime (YYYY-MM-DD hh:mm:ss) user enrollment starts","type":"string","default":null},"datetimestop":{"description":"Datetime (YYYY-MM-DD hh:mm:ss) user enrollment stops","type":"string","default":null},"notice":{"description":"Notice state","type":"integer","default":null}},"required":["classaccountid","userid"]}}}}}},"\/courses\/members\/{id}":{"get":{"description":"Retrieve an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read","content":{"application\/json":{"example":{"id":1,"classaccountid":1,"userid":1234,"membertype":1,"datetimestart":"2016-08-22T04:00:00.000000Z","datetimestop":"2016-12-17T05:00:00.000000Z","notice":0,"datetimecreated":"2016-08-19T04:02:01.000000Z","datetimeremoved":null,"api":"https:\/\/example.org\/api\/courses\/members\/1","user":{"id":1234,"name":"Jane Doe","username":"jdoe"}}}}},"404":{"description":"Record not found"}}},"put":{"description":"Update an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry modification","content":{"application\/json":{"example":{"id":1,"classaccountid":1,"userid":1234,"membertype":1,"datetimestart":"2016-08-22T04:00:00.000000Z","datetimestop":"2016-12-17T05:00:00.000000Z","notice":0,"datetimecreated":"2016-08-19T04:02:01.000000Z","datetimeremoved":null,"api":"https:\/\/example.org\/api\/courses\/members\/1","user":{"id":1234,"name":"Jane Doe","username":"jdoe"}}}}},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"classaccountid":{"description":"Class account ID","type":"integer","default":0},"membertype":{"description":"Member type ID","type":"integer","default":0},"userid":{"description":"User ID","type":"integer","default":0},"datetimestart":{"description":"Datetime (YYYY-MM-DD hh:mm:ss) user enrollment starts","type":"string","default":null},"datetimestop":{"description":"Datetime (YYYY-MM-DD hh:mm:ss) user enrollment stops","type":"string","default":null},"notice":{"description":"Notice state","type":"integer","default":null}},"required":[]}}}}},"delete":{"description":"Delete an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/courses\/members\/import":{"post":{"description":"Import","parameters":[],"responses":{"201":{"description":"Successful entry creation","content":{"application\/json":{"example":{"data":[{"id":1,"classaccountid":1,"userid":1234,"membertype":1,"datetimestart":"2016-08-22T04:00:00.000000Z","datetimestop":"2016-12-17T05:00:00.000000Z","notice":0,"datetimecreated":"2016-08-19T04:02:01.000000Z","datetimeremoved":null,"api":"https:\/\/example.org\/api\/courses\/members\/1","user":{"id":1234,"name":"Jane Doe","username":"jdoe"}},{"id":2,"classaccountid":1,"userid":1235,"membertype":1,"datetimestart":"2016-08-22T04:00:00.000000Z","datetimestop":"2016-12-17T05:00:00.000000Z","notice":0,"datetimecreated":"2016-08-19T04:02:01.000000Z","datetimeremoved":null,"api":"https:\/\/example.org\/api\/courses\/members\/2","user":{"id":1235,"name":"Jimmy Doe","username":"jimmyd"}}]}}}},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"id":{"description":"Class account ID","type":"integer","default":null},"file":{"description":"File to be uploaded","type":"array","default":null}},"required":["id","file"]}}}}}},"\/finder\/facets":{"get":{"description":"Display a listing of entries","parameters":[{"in":"query","name":"parentid","description":"Parent department ID","required":false,"schema":{"type":"integer","default":0}},{"in":"query","name":"limit","description":"Number of result per page.","type":"integer","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"order","description":"Field to sort results by.","type":"string","required":false,"schema":{"type":"string","default":"datetimecreated","enum":["id","motd","datetimecreated","datetimeremoved"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","type":"string","required":false,"default":"desc","schema":{"type":"string","default":"asc","enum":["asc","desc"]}}]},"post":{"description":"Create a new entry","parameters":[],"responses":{"201":{"description":"Successful entry creation","content":{"application\/json":{"example":{"id":1,"name":"Is your dataset restricted to U.S. persons only?","control_type":"radio","parent":0,"weight":1,"status":1,"description":"<p>Export controlled data (ITAR\/EAR) are restricted by law to U.S. persons only. This means that non-U.S. persons including international students or individuals from foreign countries are barred from accessing this data.<\/p>\r\n\r\n<p>Contact <a href=\"https:\/\/yourinstitution\/research\/regulatory-affairs\/\";>Regulatory Affairs<\/a> for more information.<\/p>\r\n","created_at":"2021-04-28T12:27:39.000000Z","updated_at":"2021-04-28T12:27:39.000000Z","deleted_at":null,"api":"https:\/\/example.org\/api\/finder\/facets\/11"}}}},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"Facet name","type":"string","default":null},"parentid":{"description":"Parent department ID","type":"integer","default":null}},"required":["name"]}}}}}},"\/finder\/facets\/{id}":{"get":{"description":"Retrieve an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read","content":{"application\/json":{"example":{"id":1,"name":"Is your dataset restricted to U.S. persons only?","control_type":"radio","parent":0,"weight":1,"status":1,"description":"<p>Export controlled data (ITAR\/EAR) are restricted by law to U.S. persons only. This means that non-U.S. persons including international students or individuals from foreign countries are barred from accessing this data.<\/p>\r\n\r\n<p>Contact <a href=\"https:\/\/yourinstitution\/research\/regulatory-affairs\/\";>Regulatory Affairs<\/a> for more information.<\/p>\r\n","created_at":"2021-04-28T12:27:39.000000Z","updated_at":"2021-04-28T12:27:39.000000Z","deleted_at":null,"api":"https:\/\/example.org\/api\/finder\/facets\/11"}}}},"404":{"description":"Record not found"}}},"put":{"description":"Update an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"202":{"description":"Successful entry modification","content":{"application\/json":{"example":{"id":1,"name":"Is your dataset restricted to U.S. persons only?","control_type":"radio","parent":0,"weight":1,"status":1,"description":"<p>Export controlled data (ITAR\/EAR) are restricted by law to U.S. persons only. This means that non-U.S. persons including international students or individuals from foreign countries are barred from accessing this data.<\/p>\r\n\r\n<p>Contact <a href=\"https:\/\/yourinstitution\/research\/regulatory-affairs\/\";>Regulatory Affairs<\/a> for more information.<\/p>\r\n","created_at":"2021-04-28T12:27:39.000000Z","updated_at":"2021-04-28T12:27:39.000000Z","deleted_at":null,"api":"https:\/\/example.org\/api\/finder\/facets\/11"}}}},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"Facet name","type":"string","default":null},"parentid":{"description":"Parent department ID","type":"integer","default":null}},"required":[]}}}}},"delete":{"description":"Delete an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/finder\/fields":{"get":{"description":"Display a listing of entries","parameters":[{"in":"query","name":"status","description":"Published status","required":false,"schema":{"type":"integer","default":0}},{"in":"query","name":"limit","description":"Number of result per page.","type":"integer","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"order","description":"Field to sort results by.","type":"string","required":false,"schema":{"type":"string","default":"label","enum":["id","name","label","created_at","deleted_at"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","type":"string","required":false,"default":"desc","schema":{"type":"string","default":"asc","enum":["asc","desc"]}}]},"post":{"description":"Create a new entry","parameters":[],"responses":{"201":{"description":"Successful entry creation","content":{"application\/json":{"example":{"id":4,"name":"cost","label":"Cost","weight":3,"status":1,"created_at":"2021-04-28T11:34:01.000000Z","updated_at":"2021-04-28T11:34:01.000000Z","deleted_at":null,"services_count":15,"api":"https:\/\/example.org\/api\/finder\/fields\/4"}}}},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"Field name","type":"string","default":null},"label":{"description":"Field label","type":"string","default":null},"weight":{"description":"Field weight","type":"integer","default":null},"status":{"description":"Published state of the record","type":"integer","default":1}},"required":["name","label"]}}}}}},"\/finder\/fields\/{id}":{"get":{"description":"Retrieve an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read","content":{"application\/json":{"example":{"id":4,"name":"cost","label":"Cost","weight":3,"status":1,"created_at":"2021-04-28T11:34:01.000000Z","updated_at":"2021-04-28T11:34:01.000000Z","deleted_at":null,"services_count":15,"api":"https:\/\/example.org\/api\/finder\/fields\/4"}}}},"404":{"description":"Record not found"}}},"put":{"description":"Update an entry","parameters":[],"responses":{"202":{"description":"Successful entry modification","content":{"application\/json":{"example":{"id":4,"name":"cost","label":"Cost","weight":3,"status":1,"created_at":"2021-04-28T11:34:01.000000Z","updated_at":"2021-04-28T11:34:01.000000Z","deleted_at":null,"services_count":15,"api":"https:\/\/example.org\/api\/finder\/fields\/4"}}}},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"Field name","type":"string","default":null},"label":{"description":"Field label","type":"string","default":null},"weight":{"description":"Field weight","type":"integer","default":null},"status":{"description":"Published state of the record","type":"integer","default":1}},"required":[]}}}}},"delete":{"description":"Delete an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/finder\/settings":{"get":{"description":"Get settings","parameters":[],"responses":{"200":{"description":"Successful entry modification","content":{"application\/json":{"example":{"name":"Finder","title":"Data Storage Solutions Finder","subtitle":"This tool will offer recommendations of solutions appropriate to your usage needs and the data security constraints.","question_header":"Answer these questions to help identify storage solutions and services that are most suitable for your needs.","service_header":"Select data storage solutions you would like to compare in details.","chart_header":"Select data storage solutions you would like to compare.","email_form_header":"This is the email email_form","email_address":"help@example.org","email_name":"Example Org","main_header":"Main Header","button_select_all":"Select All","button_clear_selections":"Clear Selections"}}}}}}},"\/finder\/servicelist":{"get":{"description":"Get service list","parameters":[],"responses":{"200":{"description":"Successful entry modification","content":{"application\/json":{"example":[{"id":14,"title":"Amazon Drive","summary":"A personal cloud storage platform hosted by Amazon.","facet_matches":[4,7,10,13,15],"field_data":{"field_also_known_as":{"value":"<p><span>Amazon Clouddrive, Amazon Photos<\/span><\/p>\r\n","label":"Also Known As","weight":12},"field_capacity_details":{"value":"<p><span>Free basic tier (5 GB), several paid plans<\/span>.<\/p>\r\n","label":"Capacity Details","weight":1},"field_cost":{"value":"<p><span>Free (5 GB), paid.<\/span><\/p>\r\n","label":"Cost","weight":3}}},{"id":8,"title":"Box Research Lab Folder","summary":"Box Research Lab Folder","facet_matches":[3,4,7,10,13,15,16],"field_data":{"field_also_known_as":{"value":"<p>Box, Box.com<\/p>\r\n","label":"Also Known As","weight":12},"field_capacity_details":{"value":"<p>Box provides unlimited storage space, however individual files may not exceed 15 GB.<\/p>\r\n","label":"Capacity Details","weight":1},"field_cost":{"value":"<p>Free<\/p>\r\n","label":"Cost","weight":3}}}]}}}}}},"\/finder\/facettree":{"get":{"description":"Get facet tree","parameters":[],"responses":{"200":{"description":"Successful entry modification","content":{"application\/json":{"example":[{"id":11,"name":"Is your dataset restricted to U.S. persons only?","control_type":"radio","parent":0,"weight":1,"selected":false,"description":"<p>Export controlled data (ITAR\/EAR) are restricted by law to U.S. persons only. This means that non-U.S. persons including international students or individuals from foreign countries are barred from accessing this data.<\/p>\r\n\r\n<p>Contact <a href=\"https:\/\/yourinstitution\/research\/regulatory-affairs\/\";>Regulatory Affairs<\/a> for more information.<\/p>\r\n","choices":[{"id":12,"name":"Yes","control_type":null,"parent":11,"weight":0,"description":null},{"id":13,"name":"No","control_type":null,"parent":11,"weight":1,"description":null}]},{"id":8,"name":"Will your project utilize a community cluster?","control_type":"radio","parent":0,"weight":2,"selected":false,"description":"<p><a href=\"https:\/\/yourinstitution\/services\/communityclusters\/\";>Community clusters<\/a> provide cost effective computing resources for researchers to run tasks requiring large amounts of computing resources.<\/p>\r\n\r\n<p>For more information on community clusters, <a href=\"mailto:yourinstitution\">contact Your Institution<\/a>.<\/p>\r\n","choices":[{"id":9,"name":"Yes","control_type":null,"parent":8,"weight":0,"description":null},{"id":10,"name":"No","control_type":null,"parent":8,"weight":1,"description":null}]}]}}}}}},"\/finder\/sendmail":{"post":{"description":"Send an email","parameters":[],"responses":{"200":{"description":"Successful entry creation","content":{"application\/json":{"example":"Your message has been sent."}}}}}},"\/finder\/services":{"get":{"description":"Display a listing of entries","parameters":[{"in":"query","name":"parentid","description":"Parent department ID","required":false,"schema":{"type":"integer","default":0}},{"in":"query","name":"limit","description":"Number of result per page.","type":"integer","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"state","description":"Published or unpublished state or entries.","type":"string","required":false,"schema":{"type":"string","default":"published","enum":["published","unpublished"]}},{"in":"query","name":"order","description":"Field to sort results by.","type":"string","required":false,"schema":{"type":"string","default":"title","enum":["id","title","summary","created_at"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","type":"string","required":false,"default":"desc","schema":{"type":"string","default":"asc","enum":["asc","desc"]}}]},"post":{"description":"Create a new entry","parameters":[],"responses":{"201":{"description":"Successful entry creation","content":{"application\/json":{"example":{"id":14,"title":"Amazon Drive","summary":"A personal cloud storage platform hosted by Amazon.","status":1,"created_at":"2021-04-28T11:20:01.000000Z","updated_at":"2021-04-28T11:20:01.000000Z","deleted_at":null,"api":"https:\/\/example.org\/api\/finder\/services\/14"}}}},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"title":{"description":"Service title","type":"string","default":null},"summary":{"description":"Short description of the service","type":"string","default":null},"status":{"description":"Published or unpublished status","type":"integer","default":1}},"required":["title"]}}}}}},"\/finder\/services\/{id}":{"get":{"description":"Retrieve an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read","content":{"application\/json":{"example":{"id":14,"title":"Amazon Drive","summary":"A personal cloud storage platform hosted by Amazon.","status":1,"created_at":"2021-04-28T11:20:01.000000Z","updated_at":"2021-04-28T11:20:01.000000Z","deleted_at":null,"api":"https:\/\/example.org\/api\/finder\/services\/14"}}}},"404":{"description":"Record not found"}}},"put":{"description":"Update an entry","parameters":[],"responses":{"202":{"description":"Successful entry modification","content":{"application\/json":{"example":{"id":14,"title":"Amazon Drive","summary":"A personal cloud storage platform hosted by Amazon.","status":1,"created_at":"2021-04-28T11:20:01.000000Z","updated_at":"2021-04-28T11:20:01.000000Z","deleted_at":null,"api":"https:\/\/example.org\/api\/finder\/services\/14"}}}},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"title":{"description":"Service title","type":"string","default":null},"summary":{"description":"Short description of the service","type":"string","default":null},"status":{"description":"Published or unpublished status","type":"integer","default":1},"fields":{"description":"Fields for a service","type":"array","default":null}},"required":[]}}}}},"delete":{"description":"Delete an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/groups\/departments":{"get":{"description":"Display a listing of entries","parameters":[{"in":"query","name":"parentid","description":"Parent department ID","required":false,"schema":{"type":"integer","default":0}},{"in":"query","name":"limit","description":"Number of result per page.","type":"integer","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"order","description":"Field to sort results by.","type":"string","required":false,"schema":{"type":"string","default":"datetimecreated","enum":["id","motd","datetimecreated","datetimeremoved"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","type":"string","required":false,"default":"desc","schema":{"type":"string","default":"asc","enum":["asc","desc"]}}]},"post":{"description":"Create a new entry","parameters":[],"responses":{"201":{"description":"Successful entry creation","content":{"application\/json":{"example":{"id":1103,"parentid":1100,"name":"Academic Computing","groups_count":0,"api":"https:\/\/example.org\/api\/groups\/departments\/1103"}}}},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"Department name","type":"string","default":null},"parentid":{"description":"Parent department ID","type":"integer","default":null}},"required":["name"]}}}}}},"\/groups\/departments\/{id}":{"get":{"description":"Retrieve an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read","content":{"application\/json":{"example":{"id":1103,"parentid":1100,"name":"Academic Computing","groups_count":0,"api":"https:\/\/example.org\/api\/groups\/departments\/1103"}}}},"404":{"description":"Record not found"}}},"put":{"description":"Update an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"202":{"description":"Successful entry modification","content":{"application\/json":{"example":{"id":1103,"parentid":1100,"name":"Academic Computing","groups_count":0,"api":"https:\/\/example.org\/api\/groups\/departments\/1103"}}}},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"Department name","type":"string","default":null},"parentid":{"description":"Parent department ID","type":"integer","default":null}},"required":[]}}}}},"delete":{"description":"Delete an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/groups\/fieldsofscience":{"get":{"description":"Display a listing of entries","parameters":[{"in":"query","name":"parentid","description":"Parent department ID","required":false,"schema":{"type":"integer","default":0}},{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","description":"Number of result per page.","type":"integer","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"datetimecreated","enum":["id","motd","datetimecreated","datetimeremoved"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","type":"string","required":false,"default":"desc","schema":{"type":"string","default":"asc","enum":["asc","desc"]}}]},"post":{"description":"Create a new entry","parameters":[],"responses":{"201":{"description":"Successful entry creation","content":{"application\/json":{"example":{"id":1103,"parentid":1100,"name":"Agricultural Biotechnology","groups_count":0,"api":"https:\/\/example.org\/api\/groups\/fieldsofscience\/1103"}}}},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"Field of science name","type":"string","default":null},"parentid":{"description":"Parent field of science ID","type":"integer","default":1}},"required":["name"]}}}}}},"\/groups\/fieldsofscience\/{id}":{"get":{"description":"Retrieve an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read","content":{"application\/json":{"example":{"id":1103,"parentid":1100,"name":"Agricultural Biotechnology","groups_count":0,"api":"https:\/\/example.org\/api\/groups\/fieldsofscience\/1103"}}}},"404":{"description":"Record not found"}}},"put":{"description":"Update an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"202":{"description":"Successful entry modification","content":{"application\/json":{"example":{"id":1103,"parentid":1100,"name":"Agricultural Biotechnology","groups_count":0,"api":"https:\/\/example.org\/api\/groups\/fieldsofscience\/1103"}}}},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"Field of science name","type":"string","default":null},"parentid":{"description":"Parent field of science ID","type":"integer","default":null}},"required":[]}}}}},"delete":{"description":"Delete an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/groups\/{group}\/departments":{"get":{"description":"Display a listing of entries","parameters":{"1":{"in":"query","name":"limit","description":"Number of result per page.","type":"integer","required":false,"schema":{"type":"integer","default":20}},"2":{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},"3":{"in":"query","name":"order","description":"Field to sort results by.","type":"string","required":false,"schema":{"type":"string","default":"datetimecreated","enum":["id","motd","datetimecreated","datetimeremoved"]}},"4":{"in":"query","name":"order_dir","description":"Direction to sort results by.","type":"string","required":false,"default":"desc","schema":{"type":"string","default":"asc","enum":["asc","desc"]}}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"group":{"description":"Group ID","type":"integer","default":null}},"required":["group"]}}}}},"post":{"description":"Create a new entry","parameters":[],"responses":{"201":{"description":"Successful entry creation","content":{"application\/json":{"example":{"id":18,"groupid":1,"collegedeptid":103,"percentage":100,"api":"https:\/\/example.org\/api\/groups\/1\/departments\/18"}}}},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"Department name","type":"string","default":null},"parentid":{"description":"Parent department ID","type":"integer","default":null}},"required":["name"]}}}}}},"\/groups\/{group}\/departments\/{id}":{"get":{"description":"Retrieve an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read","content":{"application\/json":{"example":{"id":18,"groupid":1,"collegedeptid":103,"percentage":100,"api":"https:\/\/example.org\/api\/groups\/1\/departments\/18"}}}},"404":{"description":"Record not found"}}},"put":{"description":"Update an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"202":{"description":"Successful entry modification","content":{"application\/json":{"example":{"id":18,"groupid":1,"collegedeptid":103,"percentage":100,"api":"https:\/\/example.org\/api\/groups\/1\/departments\/18"}}}},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"Department name","type":"string","default":null},"parentid":{"description":"Parent department ID","type":"integer","default":null}},"required":[]}}}}},"delete":{"description":"Delete an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/groups\/{group}\/fieldsofscience":{"get":{"description":"Display a listing of entries","parameters":{"1":{"in":"query","name":"limit","description":"Number of result per page.","type":"integer","required":false,"schema":{"type":"integer","default":20}},"2":{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},"3":{"in":"query","name":"order","description":"Field to sort results by.","type":"string","required":false,"schema":{"type":"string","default":"datetimecreated","enum":["id","motd","datetimecreated","datetimeremoved"]}},"4":{"in":"query","name":"order_dir","description":"Direction to sort results by.","type":"string","required":false,"default":"desc","schema":{"type":"string","default":"asc","enum":["asc","desc"]}}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"group":{"description":"Group ID","type":"integer","default":null}},"required":["group"]}}}}},"post":{"description":"Create a new entry","parameters":[],"responses":{"201":{"description":"Successful entry creation","content":{"application\/json":{"example":{"id":18,"groupid":1,"fieldofscienceid":103,"newid":0,"percentage":100,"api":"https:\/\/example.org\/api\/groups\/1\/fieldsofscience\/18"}}}},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"FieldOfScience name","type":"string","default":null},"parentid":{"description":"Parent department ID","type":"integer","default":null}},"required":["name"]}}}}}},"\/groups\/{group}\/fieldsofscience\/{id}":{"get":{"description":"Retrieve an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read","content":{"application\/json":{"example":{"id":18,"groupid":1,"fieldofscienceid":103,"newid":0,"percentage":100,"api":"https:\/\/example.org\/api\/groups\/1\/fieldsofscience\/18"}}}},"404":{"description":"Record not found"}}},"put":{"description":"Update an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"202":{"description":"Successful entry modification","content":{"application\/json":{"example":{"id":18,"groupid":1,"fieldofscienceid":103,"newid":0,"percentage":100,"api":"https:\/\/example.org\/api\/groups\/1\/fieldsofscience\/18"}}}},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"FieldOfScience name","type":"string","default":null},"parentid":{"description":"Parent department ID","type":"integer","default":null}},"required":[]}}}}},"delete":{"description":"Delete an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/groups":{"get":{"description":"Display a listing of entries","parameters":[{"in":"query","name":"owneruserid","description":"Owner user ID","required":false,"schema":{"type":"integer","default":0}},{"in":"query","name":"department","description":"Filter by a department ID","required":false,"schema":{"type":"integer","default":0}},{"in":"query","name":"fieldofscience","description":"Filter by a Field of Science ID","required":false,"schema":{"type":"integer","default":0}},{"in":"query","name":"state","description":"Entry state","required":false,"schema":{"type":"string","default":"active","enum":["active","trashed","*"]}},{"in":"query","name":"unixgroup","description":"Unix group name","required":false,"schema":{"type":"string"}},{"in":"query","name":"unixid","description":"Unix ID","required":false,"schema":{"type":"integer","default":0}},{"in":"query","name":"datetimecreated","description":"Created on or after the given timestamp","required":false,"schema":{"type":"date","default":null}},{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","description":"Number of result per page.","type":"integer","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"default":"name","schema":{"type":"string","default":"name","enum":["id","name","owneruserid","unixgroup","unixid","datetimecreated"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","type":"string","required":false,"default":"asc","schema":{"type":"string","default":"asc","enum":["asc","desc"]}}]},"post":{"description":"Create a new entry","parameters":[],"responses":{"201":{"description":"Successful entry creation","content":{"application\/json":{"example":{"id":1,"name":"My Research Group","owneruserid":0,"unixgroup":"mrg","unixid":0,"githuborgname":"","datetimecreated":"2021-01-07T14:13:17.000000Z","datetimeremoved":null,"cascademanagers":1,"api":"https:\/\/example.org\/api\/groups\/1","department":[{"id":3541,"groupid":1,"collegedeptid":313,"percentage":100,"api":"https:\/\/example.org\/api\/groups\/departments\/3541"}]}}}},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"Group name","type":"string","default":null},"description":{"description":"Group description","type":"string","default":null},"unixgroup":{"description":"Unix group name","type":"string","default":null},"unixid":{"description":"Unix ID","type":"integer","default":0},"cascademanagers":{"description":"Cascade manager memberships","type":"integer","default":1},"prefix_unixgroup":{"description":"Enforce custom unix groups are prefixed","type":"integer","default":1}},"required":["name"]}}}}}},"\/groups\/{id}":{"get":{"description":"Retrieve an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read","content":{"application\/json":{"example":{"id":1,"name":"My Research Group","owneruserid":0,"unixgroup":"mrg","unixid":0,"githuborgname":"","datetimecreated":"2021-01-07T14:13:17.000000Z","datetimeremoved":null,"cascademanagers":1,"api":"https:\/\/example.org\/api\/groups\/1","department":[{"id":3541,"groupid":1,"collegedeptid":313,"percentage":100,"api":"https:\/\/example.org\/api\/groups\/departments\/3541"}]}}}},"404":{"description":"Record not found"}}},"put":{"description":"Update an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"202":{"description":"Successful entry modification","content":{"application\/json":{"example":{"id":1,"name":"My Research Group","owneruserid":0,"unixgroup":"mrg","unixid":0,"githuborgname":"","datetimecreated":"2021-01-07T14:13:17.000000Z","datetimeremoved":null,"cascademanagers":1,"api":"https:\/\/example.org\/api\/groups\/1","department":[{"id":3541,"groupid":1,"collegedeptid":313,"percentage":100,"api":"https:\/\/example.org\/api\/groups\/departments\/3541"}]}}}},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"Group name","type":"string","default":null},"description":{"description":"Group description","type":"string","default":null},"unixgroup":{"description":"Unix group name","type":"string","default":null},"unixid":{"description":"Unix ID","type":"integer","default":null},"cascademanagers":{"description":"Cascade manager memberships","type":"integer","default":1},"prefix_unixgroup":{"description":"Enforce custom unix groups are prefixed","type":"integer","default":1}},"required":[]}}}}},"delete":{"description":"Delete an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/groups\/members":{"get":{"description":"Display a listing of entries","parameters":[{"in":"query","name":"limit","description":"Number of result per page.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"groupid","description":"Group ID","required":false,"schema":{"type":"integer","default":0}},{"in":"query","name":"userid","description":"User ID","required":false,"schema":{"type":"integer","default":0}},{"in":"query","name":"membertype","description":"Member type","required":false,"schema":{"type":"integer","default":0,"enum":["1 (members)","2 (managers)","3 (viewers)","4 (pending)"]}},{"in":"query","name":"state","description":"State","required":false,"schema":{"type":"string","default":"active","enum":["active","trashed","all"]}},{"in":"query","name":"userrequestid","description":"User request ID","required":false,"schema":{"type":"integer","default":0}},{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"name","enum":["id","groupid","userid","membertype","datecreated","dateremoved"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"default":"asc","schema":{"type":"string","default":"asc","enum":["asc","desc"]}}]},"post":{"description":"Create a new entry","parameters":[],"responses":{"201":{"description":"Successful entry creation","content":{"application\/json":{"example":{"id":43,"groupid":1,"userid":1234,"userrequestid":0,"membertype":2,"owner":1,"datecreated":"2011-03-08T13:46:42.000000Z","dateremoved":null,"datelastseen":null,"notice":0,"api":"https:\/\/example.org\/api\/groups\/members\/43818","user":{"id":1234,"name":"Jane Doe","username":"janedoe","unixid":43674,"datecreated":"2021-06-17T17:07:05.000000Z","dateremoved":null}}}}},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"groupid":{"description":"Group ID","type":"integer","default":null},"userid":{"description":"User ID","type":"integer","default":null},"membertype":{"description":"Member type","type":"integer","default":null},"userrequestid":{"description":"User request ID","type":"integer","default":null}},"required":["groupid","userid"]}}}}}},"\/groups\/members\/{id}":{"get":{"description":"Retrieve an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read","content":{"application\/json":{"example":{"id":43,"groupid":1,"userid":1234,"userrequestid":0,"membertype":2,"owner":1,"datecreated":"2011-03-08T13:46:42.000000Z","dateremoved":null,"datelastseen":null,"notice":0,"api":"https:\/\/example.org\/api\/groups\/members\/43818","user":{"id":1234,"name":"Jane Doe","username":"janedoe","unixid":43674,"datecreated":"2021-06-17T17:07:05.000000Z","dateremoved":null}}}}},"404":{"description":"Record not found"}}},"put":{"description":"Update an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"202":{"description":"Successful entry modification","content":{"application\/json":{"example":{"id":43,"groupid":1,"userid":1234,"userrequestid":0,"membertype":2,"owner":1,"datecreated":"2011-03-08T13:46:42.000000Z","dateremoved":null,"datelastseen":null,"notice":0,"api":"https:\/\/example.org\/api\/groups\/members\/43818","user":{"id":1234,"name":"Jane Doe","username":"janedoe","unixid":43674,"datecreated":"2021-06-17T17:07:05.000000Z","dateremoved":null}}}}},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"membertype":{"description":"Member type","type":"integer","default":null},"userrequestid":{"description":"User request ID","type":"integer","default":null}},"required":[]}}}}},"delete":{"description":"Delete an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/groups\/motd":{"get":{"description":"Display a listing of entries","parameters":[{"in":"query","name":"limit","description":"Number of result per page.","type":"integer","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"group_id","description":"Group ID","required":false,"schema":{"type":"integer","default":0}},{"in":"query","name":"search","description":"A word or phrase to search for.","type":"string","required":false,"schema":{"type":"string"}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"datetimecreated","enum":["id","motd","datetimecreated","datetimeremoved"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"desc","enum":["asc","desc"]}}]},"post":{"description":"Create a new entry","parameters":[],"responses":{"201":{"description":"Successful entry creation","content":{"application\/json":{"example":{"id":13,"groupid":1,"motd":"This is the J Does research space","datetimecreated":"2021-06-08T10:17:02.000000Z","datetimeremoved":null,"api":"https:\/\/example.org\/api\/groups\/motd\/131"}}}},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"motd":{"description":"Message of the day","type":"string","default":null},"groupid":{"description":"Group ID","type":"integer","default":0}},"required":["motd","groupid"]}}}}}},"\/groups\/motd\/{id}":{"get":{"description":"Retrieve an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read","content":{"application\/json":{"example":{"id":13,"groupid":1,"motd":"This is the J Does research space","datetimecreated":"2021-06-08T10:17:02.000000Z","datetimeremoved":null,"api":"https:\/\/example.org\/api\/groups\/motd\/131"}}}},"404":{"description":"Record not found"}}},"put":{"description":"Update an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"202":{"description":"Successful entry modification","content":{"application\/json":{"example":{"id":13,"groupid":1,"motd":"This is the J Does research space","datetimecreated":"2021-06-08T10:17:02.000000Z","datetimeremoved":null,"api":"https:\/\/example.org\/api\/groups\/motd\/131"}}}},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"motd":{"description":"Message of the day","type":"string","default":null},"groupid":{"description":"Group ID","type":"integer","default":0}},"required":["motd"]}}}}},"delete":{"description":"Delete an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/unixgroups\/members":{"get":{"description":"Display a listing of entries","parameters":[{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"unixgroupid","description":"Unix Group ID","required":false,"schema":{"type":"integer"}},{"in":"query","name":"userid","description":"User ID","required":false,"schema":{"type":"integer"}},{"in":"query","name":"limit","description":"Number of result per page.","type":"integer","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","type":"string","required":false,"schema":{"type":"string","default":"datetimecreated","enum":["id","motd","datetimecreated","datetimeremoved"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","type":"string","required":false,"default":"desc","schema":{"type":"string","default":"asc","enum":["asc","desc"]}}]},"post":{"description":"Create a new entry","parameters":[],"responses":{"201":{"description":"Successful entry creation","content":{"application\/json":{"example":{"id":2,"unixgroupid":1,"userid":1234,"datetimecreated":"2021-02-03T18:36:02.000000Z","datetimeremoved":null,"notice":0,"username":"janedoe","name":"Jane Doe","api":"https:\/\/example.org\/api\/unixgroups\/members\/39372"}}}},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"unixgroupid":{"description":"Unix group ID","type":"integer","default":null},"userid":{"description":"User ID or username","type":"integer","default":null},"notice":{"description":"Notice state","type":"integer","default":null}},"required":["unixgroupid","userid"]}}}}}},"\/unixgroups\/members\/{id}":{"get":{"description":"Retrieve an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read","content":{"application\/json":{"example":{"id":2,"unixgroupid":1,"userid":1234,"datetimecreated":"2021-02-03T18:36:02.000000Z","datetimeremoved":null,"notice":0,"username":"janedoe","name":"Jane Doe","api":"https:\/\/example.org\/api\/unixgroups\/members\/39372"}}}},"404":{"description":"Record not found"}}},"put":{"description":"Update an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"202":{"description":"Successful entry modification","content":{"application\/json":{"example":{"id":2,"unixgroupid":1,"userid":1234,"datetimecreated":"2021-02-03T18:36:02.000000Z","datetimeremoved":null,"notice":0,"username":"janedoe","name":"Jane Doe","api":"https:\/\/example.org\/api\/unixgroups\/members\/39372"}}}},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"notice":{"description":"Notice state","type":"integer","default":null}},"required":[]}}}}},"delete":{"description":"Delete an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/unixgroups":{"get":{"description":"Display a listing of entries","parameters":[{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"groupid","description":"Group ID","required":false,"schema":{"type":"integer","default":0}},{"in":"query","name":"limit","description":"Number of result per page.","type":"integer","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","type":"string","required":false,"schema":{"type":"string","default":"datetimecreated","enum":["id","motd","datetimecreated","datetimeremoved"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","type":"string","required":false,"default":"desc","schema":{"type":"string","default":"asc","enum":["asc","desc"]}}]},"post":{"description":"Create a new entry","parameters":[],"responses":{"201":{"description":"Successful entry creation","content":{"application\/json":{"example":{"id":1,"groupid":1,"unixgid":27395,"shortname":"rcs20130","longname":"jdoes","datetimecreated":"2021-02-03T15:46:34.000000Z","datetimeremoved":null,"api":"https:\/\/example.org\/api\/unixgroups\/4039","members":[{"id":1,"unixgroupid":1,"userid":1235,"datetimecreated":"2021-02-03T18:35:43.000000Z","datetimeremoved":null,"notice":0,"username":"jimmyd","name":"Jimmy Doe","api":"https:\/\/example.org\/api\/unixgroups\/members\/39371"},{"id":2,"unixgroupid":1,"userid":1234,"datetimecreated":"2021-02-03T18:36:02.000000Z","datetimeremoved":null,"notice":0,"username":"janedoe","name":"Jane Doe","api":"https:\/\/example.org\/api\/unixgroups\/members\/39372"}]}}}},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"groupid":{"description":"Group ID","type":"integer","default":null},"longname":{"description":"Long name","type":"string","default":null},"shortname":{"description":"Short name","type":"string","default":null},"unixgid":{"description":"Unix group system ID","type":"integer","default":null}},"required":["groupid","longname"]}}}}}},"\/unixgroups\/{id}":{"get":{"description":"Retrieve an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read","content":{"application\/json":{"example":{"id":1,"groupid":1,"unixgid":27395,"shortname":"rcs20130","longname":"jdoes","datetimecreated":"2021-02-03T15:46:34.000000Z","datetimeremoved":null,"api":"https:\/\/example.org\/api\/unixgroups\/4039","members":[{"id":1,"unixgroupid":1,"userid":1235,"datetimecreated":"2021-02-03T18:35:43.000000Z","datetimeremoved":null,"notice":0,"username":"jimmyd","name":"Jimmy Doe","api":"https:\/\/example.org\/api\/unixgroups\/members\/39371"},{"id":2,"unixgroupid":1,"userid":1234,"datetimecreated":"2021-02-03T18:36:02.000000Z","datetimeremoved":null,"notice":0,"username":"janedoe","name":"Jane Doe","api":"https:\/\/example.org\/api\/unixgroups\/members\/39372"}]}}}},"404":{"description":"Record not found"}}},"put":{"description":"Update an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"202":{"description":"Successful entry modification","content":{"application\/json":{"example":{"id":1,"groupid":1,"unixgid":27395,"shortname":"rcs20130","longname":"jdoes","datetimecreated":"2021-02-03T15:46:34.000000Z","datetimeremoved":null,"api":"https:\/\/example.org\/api\/unixgroups\/4039","members":[{"id":1,"unixgroupid":1,"userid":1235,"datetimecreated":"2021-02-03T18:35:43.000000Z","datetimeremoved":null,"notice":0,"username":"jimmyd","name":"Jimmy Doe","api":"https:\/\/example.org\/api\/unixgroups\/members\/39371"},{"id":2,"unixgroupid":1,"userid":1234,"datetimecreated":"2021-02-03T18:36:02.000000Z","datetimeremoved":null,"notice":0,"username":"janedoe","name":"Jane Doe","api":"https:\/\/example.org\/api\/unixgroups\/members\/39372"}]}}}},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"longname":{"description":"Long name","type":"string","default":null},"shortname":{"description":"Short name","type":"string","default":null},"unixgid":{"description":"Unix group system ID","type":"integer","default":null}},"required":[]}}}}},"delete":{"description":"Delete an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/history":{"get":{"description":"Display a listing of entries","parameters":[{"in":"query","name":"action","description":"Action taken.","required":false,"schema":{"type":"string","enum":["create","update","delete"]}},{"in":"query","name":"type","description":"The type of item (model name) that the action was taken on.","required":false,"schema":{"type":"search"}},{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"search"}},{"in":"query","name":"limit","description":"Number of result per page.","type":"integer","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"created_at","enum":["id","created_at","action"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]}}]}},"\/history\/{id}":{"get":{"description":"Retrieve an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read","content":{"application\/json":{"example":{"id":270955,"user_id":1234,"historable_id":51685,"historable_type":"App\\Modules\\Queues\\Models\\User","historable_table":"queueusers","action":"updated","old":{"notice":2},"new":{"notice":0},"created_at":"2021-11-18T18:14:07.000000Z","updated_at":"2021-11-18T18:14:07.000000Z","api":"https:\/\/example.org\/api\/history\/270955"}}}},"404":{"description":"Record not found"}}}},"\/logs":{"get":{"description":"Display a listing of entries","parameters":[{"in":"query","name":"action","description":"Action taken.","required":false,"schema":{"type":"string","enum":["create","update","delete"]}},{"in":"query","name":"type","description":"The type of item (model name) that the action was taken on.","required":false,"schema":{"type":"string"}},{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","description":"Number of result per page.","type":"integer","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"created_at","enum":["id","created_at","action"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]}}]}},"\/logs\/{id}":{"get":{"description":"Read a log entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read","content":{"application\/json":{"example":{"id":870,"datetime":"2021-11-30T13:21:03.000000Z","ip":"127.0.0.1","hostname":"","userid":1234,"status":200,"transportmethod":"GET","servername":"example.org","uri":"\/admin\/history\/activity","app":"ui","classname":"ActivityController","classmethod":"index","objectid":"","payload":"Mozilla\/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit\/605.1.15 (KHTML, like Gecko) Version\/15.0 Safari\/605.1.15","groupid":-2,"targetuserid":-2,"targetobjectid":-2,"api":"https:\/\/example.org\/api\/logs\/8703798"}}}},"404":{"description":"Record not found"}}}},"\/impact\/constants":{"get":{"description":"Display a listing of constants","parameters":[{"in":"query","name":"search","description":"A word or phrase to search for.","type":"string","required":false,"default":"","schema":{"type":"string"}},{"in":"query","name":"limit","description":"Number of result per page.","type":"integer","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","type":"integer","required":false,"default":1,"schema":{"type":"string"}},{"in":"query","name":"order","description":"Field to sort results by.","type":"string","required":false,"default":"datetimecreated","allowedValues":"id, motd, datetimecreated, datetimeremoved","schema":{"type":"string"}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","type":"string","required":false,"default":"desc","schema":{"type":"string","default":"asc","enum":["asc","desc"]}}]},"post":{"description":"Create a constant","parameters":[],"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"Constant name","type":"string","default":null},"value":{"description":"Value","type":"string","default":null},"impacttableid":{"description":"Impact table ID","type":"integer","default":null}},"required":["name","value","impacttableid"]}}}}}},"\/impact\/constants\/{id}":{"get":{"description":"Retrieve a constant","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}]},"put":{"description":"Update a constant","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"Constant name","type":"string","default":null},"value":{"description":"Value","type":"string","default":null},"impacttableid":{"description":"Impact table ID","type":"integer","default":null}},"required":[]}}}}},"delete":{"description":"Delete a constant","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}]}},"\/impact":{"get":{"description":"Display a listing of entries","parameters":[{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","description":"Number of result per page.","type":"integer","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","type":"integer","required":false,"default":1,"schema":{"type":"string"}},{"in":"query","name":"order","description":"Field to sort results by.","type":"string","required":false,"default":"datetimecreated","allowedValues":"id, motd, datetimecreated, datetimeremoved","schema":{"type":"string"}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","type":"string","required":false,"default":"desc","schema":{"type":"string","default":"asc","enum":["asc","desc"]}}]},"post":{"description":"Create an entry","parameters":[],"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"Impact name","type":"string","default":null},"value":{"description":"Value","type":"string","default":null},"impacttableid":{"description":"Impact table ID","type":"integer","default":null}},"required":["name","value","impacttableid"]}}}}}},"\/impact\/{id}":{"get":{"description":"Retrieve an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}]},"put":{"description":"Update an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"Impact name","type":"string","default":null},"value":{"description":"Value","type":"string","default":null},"impacttableid":{"description":"Impact table ID","type":"integer","default":null}},"required":[]}}}}},"delete":{"description":"Delete an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}]}},"\/impact\/tables":{"get":{"description":"Display a listing of tables","parameters":[{"in":"query","name":"search","description":"A word or phrase to search for.","type":"string","required":false,"default":"","schema":{"type":"string"}},{"in":"query","name":"limit","description":"Number of result per page.","type":"integer","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","type":"integer","required":false,"default":1,"schema":{"type":"string"}},{"in":"query","name":"order","description":"Field to sort results by.","type":"string","required":false,"default":"datetimecreated","allowedValues":"id, motd, datetimecreated, datetimeremoved","schema":{"type":"string"}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","type":"string","required":false,"default":"desc","schema":{"type":"string","default":"asc","enum":["asc","desc"]}}]},"post":{"description":"Create a new table","parameters":[],"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"Table name","type":"string","default":null},"columnname":{"description":"Column name","type":"string","default":null},"updatekey":{"description":"Update key","type":"string","default":null}},"required":["name"]}}}}}},"\/impact\/tables\/{id}":{"get":{"description":"Retrieve an issue","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}]},"put":{"description":"Update an issue","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"Table name","type":"string","default":null},"columnname":{"description":"Column name","type":"string","default":null},"updatekey":{"description":"Update key","type":"string","default":null}},"required":[]}}}}},"delete":{"description":"Delete an issue","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}]}},"\/issues\/comments":{"get":{"description":"Display a listing of issues comments","parameters":[{"in":"query","name":"issueid","description":"ID of issue","required":false,"schema":{"type":"integer","default":0}},{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","description":"Number of result per page.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"datetimecreated","enum":["id","issueid","userid","notice","datetimecreated","datetimeremoved"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]}}]},"post":{"description":"Create a issue comment","parameters":[],"responses":{"201":{"description":"Successful entry creation","content":{"application\/json":{"example":{"id":1,"issueid":3,"userid":1234,"comment":"Updated the config settings.","stemmedcomment":"uupdate tthe cconfig ssettings","datetimecreated":"2021-10-25T20:24:30.000000Z","resolution":1,"formatteddate":"October 25, 2021 4:24pm","formattedcomment":"<p>Updated the config settings.<\/p>","username":"John Doe","api":"https:\/\/example.org\/api\/issues\/comments\/1"}}}},"401":{"description":"Unauthorized"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"comment":{"description":"The comment being made","type":"string","default":null},"issueid":{"description":"ID of the issue","type":"integer","default":null},"resolution":{"description":"IS this the official resolution to the issue?","type":"integer","default":null}},"required":["comment","issueid"]}}}}}},"\/issues\/comments\/{id}":{"get":{"description":"Retrieve an issue comment","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry creation","content":{"application\/json":{"example":{"id":1,"issueid":3,"userid":1234,"comment":"Updated the config settings.","stemmedcomment":"uupdate tthe cconfig ssettings","datetimecreated":"2021-10-25T20:24:30.000000Z","resolution":1,"formatteddate":"October 25, 2021 4:24pm","formattedcomment":"<p>Updated the config settings.<\/p>","username":"John Doe","api":"https:\/\/example.org\/api\/issues\/comments\/1"}}}},"404":{"description":"Record not found"}}},"put":{"description":"Update an issue comment","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"202":{"description":"Successful entry modification","content":{"application\/json":{"example":{"id":1,"issueid":3,"userid":1234,"comment":"Updated the config settings.","stemmedcomment":"uupdate tthe cconfig ssettings","datetimecreated":"2021-10-25T20:24:30.000000Z","resolution":1,"formatteddate":"October 25, 2021 4:24pm","formattedcomment":"<p>Updated the config settings.<\/p>","username":"John Doe","api":"https:\/\/example.org\/api\/issues\/comments\/1"}}}},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"comment":{"description":"The comment being made","type":"string","default":null},"issueid":{"description":"ID of the issue","type":"integer","default":null},"resolution":{"description":"IS this the official resolution to the issue?","type":"integer","default":null}},"required":[]}}}}},"delete":{"description":"Delete an issue comment","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/issues":{"get":{"description":"Display a listing of issues","parameters":[{"in":"query","name":"limit","description":"Number of result per page.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"datetimecreated","enum":["id","issuetodoid","userid","datetimecreated","datetimeremoved"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]}}]},"post":{"description":"Create a new issue","parameters":[],"responses":{"201":{"description":"Successful entry creation","content":{"application\/json":{"example":{"id":1,"issueid":3,"userid":1234,"report":"An LDAP misconfiguration on these systems was causing centralservices to get overloaded and slow down responding to queries that resulted in sluggishness with Data Depot","stemmedreport":"AAn lldap mmisconfigur oon tthese ssystem wwa ccaus ccentralservic tto gget ooverload aand sslow ddown rrespond tto qqueri tthat rresult iin ssluggish wwith ddata ddepot ","datetimecreated":"2021-10-25T20:24:30.000000Z","resolution":1,"formatteddate":"October 25, 2021 4:24pm","formattedreport":"<p>An LDAP misconfiguration on these systems was causing centralservices to get overloaded and slow down responding to queries that resulted in sluggishness with Data Depot<\/p>","username":"John Doe","comments":[],"resources":[],"age":10707683,"api":"https:\/\/example.org\/issues\/1"}}}},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"report":{"description":"Report text","type":"string","default":null},"datetimecreated":{"description":"Timestamp (YYYY-MM-DD or YYYY-MM-DD hh:mm:ss) of the issue","type":"string","default":null},"userid":{"description":"ID of the user creating the entry","type":"integer","default":null},"issuetodo":{"description":"Is this a To-Do item?","type":"integer","default":null}},"required":["report","datetimecreated"]}}}}}},"\/issues\/{id}":{"get":{"description":"Retrieve an issue","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry creation","content":{"application\/json":{"example":{"id":1,"issueid":3,"userid":1234,"report":"An LDAP misconfiguration on these systems was causing centralservices to get overloaded and slow down responding to queries that resulted in sluggishness with Data Depot","stemmedreport":"AAn lldap mmisconfigur oon tthese ssystem wwa ccaus ccentralservic tto gget ooverload aand sslow ddown rrespond tto qqueri tthat rresult iin ssluggish wwith ddata ddepot ","datetimecreated":"2021-10-25T20:24:30.000000Z","resolution":1,"formatteddate":"October 25, 2021 4:24pm","formattedreport":"<p>An LDAP misconfiguration on these systems was causing centralservices to get overloaded and slow down responding to queries that resulted in sluggishness with Data Depot<\/p>","username":"John Doe","comments":[],"resources":[],"age":10707683,"api":"https:\/\/example.org\/issues\/1"}}}},"404":{"description":"Record not found"}}},"put":{"description":"Update an issue","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"202":{"description":"Successful entry modification","content":{"application\/json":{"example":{"id":1,"issueid":3,"userid":1234,"report":"An LDAP misconfiguration on these systems was causing centralservices to get overloaded and slow down responding to queries that resulted in sluggishness with Data Depot","stemmedreport":"AAn lldap mmisconfigur oon tthese ssystem wwa ccaus ccentralservic tto gget ooverload aand sslow ddown rrespond tto qqueri tthat rresult iin ssluggish wwith ddata ddepot ","datetimecreated":"2021-10-25T20:24:30.000000Z","resolution":1,"formatteddate":"October 25, 2021 4:24pm","formattedreport":"<p>An LDAP misconfiguration on these systems was causing centralservices to get overloaded and slow down responding to queries that resulted in sluggishness with Data Depot<\/p>","username":"John Doe","comments":[],"resources":[],"age":10707683,"api":"https:\/\/example.org\/issues\/1"}}}},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"report":{"description":"Report text","type":"string","default":null},"datetimecreated":{"description":"Timestamp (YYYY-MM-DD or YYYY-MM-DD hh:mm:ss) of the issue","type":"string","default":null},"issuetodo":{"description":"Is this a To-Do item?","type":"integer","default":null}},"required":[]}}}}},"delete":{"description":"Delete an issue","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/issues\/todos":{"get":{"description":"Display a listing of to-dos","parameters":[{"in":"query","name":"limit","description":"Number of result per page.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"datetimecreated","enum":["id","name","userid","datetimecreated","datetimeremoved","recurringtimeperiodid"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]}}]},"post":{"description":"Create a new to-do","parameters":[],"responses":{"201":{"description":"Successful entry creation","content":{"application\/json":{"example":{"id":1,"userid":1234,"name":"Check for emails for SSL certs expiring","description":"","recurringtimeperiodid":1,"datetimecreated":"2021-10-25T20:24:30.000000Z","datetimeremoved":null,"api":"https:\/\/example.org\/api\/issues\/todos\/1"}}}},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"Name of the To-Do item","type":"string","default":null},"description":{"description":"Description of the To-Do item","type":"string","default":null},"recurringtimeperiodid":{"description":"Recurring timeperiod ID","type":"integer","default":null},"userid":{"description":"User ID","type":"integer","default":null}},"required":["name","description"]}}}}}},"\/issues\/todos\/{id}":{"get":{"description":"Retrieve a to-do","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry creation","content":{"application\/json":{"example":{"id":1,"userid":1234,"name":"Check for emails for SSL certs expiring","description":"","recurringtimeperiodid":1,"datetimecreated":"2021-10-25T20:24:30.000000Z","datetimeremoved":null,"api":"https:\/\/example.org\/api\/issues\/todos\/1"}}}},"404":{"description":"Record not found"}}},"put":{"description":"Update a to-do","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"202":{"description":"Successful entry modification","content":{"application\/json":{"example":{"id":1,"userid":1234,"name":"Check for emails for SSL certs expiring","description":"","recurringtimeperiodid":1,"datetimecreated":"2021-10-25T20:24:30.000000Z","datetimeremoved":null,"api":"https:\/\/example.org\/api\/issues\/todos\/1"}}}},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"Name of the To-Do item","type":"string","default":null},"description":{"description":"Description of the To-Do item","type":"string","default":null},"recurringtimeperiodid":{"description":"Recurring timeperiod ID","type":"integer","default":null}},"required":[]}}}}},"delete":{"description":"Delete a to-do","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/knowledge\/feedback":{"get":{"description":"Display a listing of feedback","parameters":[{"in":"query","name":"user_id","description":"The user ID of the feedback submitter.","required":false,"schema":{"type":"integer","default":0}},{"in":"query","name":"target_id","description":"The page association the feedback is related to.","required":false,"schema":{"type":"integer","default":0}},{"in":"query","name":"type","description":"The type of feedback.","required":false,"schema":{"type":"string","default":null,"enum":["positive","neutral","negative"]}},{"in":"query","name":"start","description":"Feedback created on or after this datetime.","required":false,"schema":{"type":"string","default":"","format":"date-time","example":"2021-01-30T08:30:00Z"}},{"in":"query","name":"stop","description":"Feedback created before this datetime.","required":false,"schema":{"type":"string","default":"","format":"date-time","example":"2021-01-30T08:30:00Z"}},{"in":"query","name":"ip","description":"The IP address of the feedback submitter.","required":false,"schema":{"type":"string","default":""}},{"in":"query","name":"search","description":"A word or phrase to search for in feedback comments.","required":false,"schema":{"type":"string","default":""}},{"in":"query","name":"limit","description":"Number of result per page.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"created_at","enum":["id","created_at","ip","user_id","target_id","type"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]}}]},"post":{"description":"Create an entry","parameters":[],"responses":{"201":{"description":"Successful entry creation","content":{"application\/json":{"example":{"id":1,"target_id":5020,"ip":"10.195.27.2","type":"positive","user_id":0,"created_at":"2021-03-04T23:29:24.000000Z","updated_at":"2021-03-04T23:29:24.000000Z","comments":"Testing the helpful commments","api":"https:\/\/example.org\/api\/knowledge\/feedback\/1"}}}},"401":{"description":"Unauthorized"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"user_id":{"description":"ID of user making the feedback","type":"integer","default":null},"target_id":{"description":"Targetted page association ID","type":"integer","default":null},"comments":{"description":"User comments","type":"string","default":null},"type":{"description":"Type of feedback (e.g., positive, nuetral, negative)","type":"string","default":null}},"required":["target_id","type"]}}}}}},"\/knowledge\/feedback\/{id}":{"get":{"description":"Retrieve an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read","content":{"application\/json":{"example":{"id":1,"target_id":5020,"ip":"10.195.27.2","type":"positive","user_id":0,"created_at":"2021-03-04T23:29:24.000000Z","updated_at":"2021-03-04T23:29:24.000000Z","comments":"Testing the helpful commments","api":"https:\/\/example.org\/api\/knowledge\/feedback\/1"}}}},"404":{"description":"Record not found"}}},"put":{"description":"Update an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"202":{"description":"Successful entry modification","content":{"application\/json":{"example":{"id":1,"target_id":5020,"ip":"10.195.27.2","type":"positive","user_id":0,"created_at":"2021-03-04T23:29:24.000000Z","updated_at":"2021-03-04T23:45:01.000000Z","comments":"Updated comment","api":"https:\/\/example.org\/api\/knowledge\/feedback\/1"}}}},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"comments":{"description":"User comments","type":"string","default":null},"type":{"description":"Type of feedback (e.g., positive, nuetral, negative)","type":"string","default":null}},"required":[]}}}}},"delete":{"description":"Retrieve an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/knowledge":{"get":{"description":"Display a listing of articles","parameters":[{"in":"query","name":"parent","description":"Parent page ID.","required":false,"schema":{"type":"integer","default":0}},{"in":"query","name":"access","description":"Access level.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"state","description":"The page state.","required":false,"schema":{"type":"string","default":"published","enum":["published","archived","unpublished","trashed"]}},{"in":"query","name":"search","description":"A word or phrase to search for in feedback comments.","required":false,"schema":{"type":"string","default":""}},{"in":"query","name":"limit","description":"Number of result per page.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"created_at","enum":["id","created_at","ip","user_id","target_id","type"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]}}]},"post":{"description":"Create an entry","parameters":[],"responses":{"201":{"description":"Successful entry creation","content":{"application\/json":{"example":{"id":1,"parent_id":0,"page_id":1,"lft":0,"rgt":1,"level":0,"path":"","state":1,"access":1,"page":{"id":1,"title":"User Guides","alias":"kb","created_at":"2020-05-28T16:57:38.000000Z","updated_at":"2021-10-22T18:40:52.000000Z","deleted_at":null,"state":1,"access":1,"content":"<p>Here you will find all the user guides.<\/p>","params":[],"main":1,"snippet":0},"api":"https:\/\/example.org\/api\/knowledge\/1","url":"https:\/\/example.org\/knowledge"}}}},"401":{"description":"Unauthorized"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"title":{"description":"Title","type":"string","default":null},"slug":{"description":"URL slug. If not provided, one is genereated from the title.","type":"string","default":null},"content":{"description":"Content","type":"string","default":null},"state":{"description":"Published state","type":"integer","default":1},"access":{"description":"Access level","type":"integer","default":1},"parent_id":{"description":"Parent page ID","type":"integer","default":0},"tags":{"description":"A comma-separated list of keywords or phrases","type":"string","default":null}},"required":["title","content"]}}}}}},"\/knowledge\/{id}":{"get":{"description":"Retrieve an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read","content":{"application\/json":{"example":{"id":1,"parent_id":0,"page_id":1,"lft":0,"rgt":1,"level":0,"path":"","state":1,"access":1,"page":{"id":1,"title":"User Guides","alias":"kb","created_at":"2020-05-28T16:57:38.000000Z","updated_at":"2021-10-22T18:40:52.000000Z","deleted_at":null,"state":1,"access":1,"content":"<p>Here you will find all the user guides.<\/p>","params":[],"main":1,"snippet":0},"api":"https:\/\/example.org\/api\/knowledge\/1","url":"https:\/\/example.org\/knowledge"}}}},"404":{"description":"Record not found"}}},"put":{"description":"Update an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"202":{"description":"Successful entry modification","content":{"application\/json":{"example":{"id":1,"parent_id":0,"page_id":1,"lft":0,"rgt":1,"level":0,"path":"","state":1,"access":1,"page":{"id":1,"title":"User Guides","alias":"kb","created_at":"2020-05-28T16:57:38.000000Z","updated_at":"2021-10-22T18:40:52.000000Z","deleted_at":null,"state":1,"access":1,"content":"<p>Here you will find all the user guides. Look around all you like.<\/p>","params":[],"main":1,"snippet":0},"api":"https:\/\/example.org\/api\/knowledge\/1","url":"https:\/\/example.org\/knowledge"}}}},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"title":{"description":"Title","type":"string","default":null},"slug":{"description":"URL slug. If not provided, one is genereated from the title.","type":"string","default":null},"content":{"description":"Content","type":"string","default":null},"state":{"description":"Published state","type":"integer","default":1},"access":{"description":"Access level","type":"integer","default":1},"parent_id":{"description":"Parent page ID","type":"integer","default":0},"tags":{"description":"A comma-separated list of keywords or phrases. Pass an empty value to unset all tags.","type":"string","default":null}},"required":[]}}}}},"delete":{"description":"Retrieve an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/knowledge\/diff":{"delete":{"description":"See a diff between two entries","parameters":[{"in":"query","name":"oldid","description":"Entry identifier","required":true,"schema":{"type":"integer"}},{"in":"query","name":"newid","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful diff between entries"},"404":{"description":"Record not found"}}}},"\/knowledge\/snippets":{"get":{"description":"Display a listing of articles","parameters":[{"in":"query","name":"parent","description":"Parent page ID.","required":false,"schema":{"type":"integer","default":0}},{"in":"query","name":"access","description":"Access level.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"state","description":"The page state.","required":false,"schema":{"type":"string","default":"published","enum":["published","unpublished","trashed"]}},{"in":"query","name":"search","description":"A word or phrase to search for in feedback comments.","required":false,"schema":{"type":"string","default":""}},{"in":"query","name":"limit","description":"Number of result per page.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"created_at","enum":["id","created_at","ip","user_id","target_id","type"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]}}]},"post":{"description":"Create an entry","parameters":[],"responses":{"201":{"description":"Successful entry modification","content":{"application\/json":{"example":{"id":1,"parent_id":0,"page_id":1,"lft":0,"rgt":1,"level":1,"path":"storage","state":1,"access":1,"page":{"id":1,"title":"File Storage and Transfer","alias":"storage","created_at":"2020-05-28T16:57:38.000000Z","updated_at":"2021-10-22T18:40:52.000000Z","deleted_at":null,"state":1,"access":1,"content":"<p>File Storage and Transfer for ${resource.name}.<\/p>","params":[],"main":1,"snippet":0},"api":"https:\/\/example.org\/api\/knowledge\/snippets\/1"}}}},"401":{"description":"Unauthorized"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"title":{"description":"Title","type":"string","default":null},"slug":{"description":"URL slug","type":"string","default":null},"content":{"description":"Content","type":"string","default":null},"state":{"description":"Published state","type":"integer","default":1},"access":{"description":"Access level","type":"integer","default":1},"parent_id":{"description":"Parent page ID","type":"integer","default":null}},"required":["title","content"]}}}}}},"\/knowledge\/snippets\/{id}":{"get":{"description":"Retrieve an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry modification","content":{"application\/json":{"example":{"id":1,"parent_id":0,"page_id":1,"lft":0,"rgt":1,"level":1,"path":"storage","state":1,"access":1,"page":{"id":1,"title":"File Storage and Transfer","alias":"storage","created_at":"2020-05-28T16:57:38.000000Z","updated_at":"2021-10-22T18:40:52.000000Z","deleted_at":null,"state":1,"access":1,"content":"<p>File Storage and Transfer for ${resource.name}.<\/p>","params":[],"main":1,"snippet":0},"api":"https:\/\/example.org\/api\/knowledge\/snippets\/1"}}}},"404":{"description":"Record not found"}}},"put":{"description":"Update an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"202":{"description":"Successful entry modification","content":{"application\/json":{"example":{"id":1,"parent_id":0,"page_id":1,"lft":0,"rgt":1,"level":1,"path":"storage","state":1,"access":1,"page":{"id":1,"title":"File Storage and Transfer","alias":"storage","created_at":"2020-05-28T16:57:38.000000Z","updated_at":"2021-10-22T18:40:52.000000Z","deleted_at":null,"state":1,"access":1,"content":"<p>File Storage and Transfer for ${resource.name}.<\/p>","params":[],"main":1,"snippet":0},"api":"https:\/\/example.org\/api\/knowledge\/snippets\/1"}}}},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"title":{"description":"Title","type":"string","default":null},"slug":{"description":"URL slug. If not provided, one is genereated from the title.","type":"string","default":null},"content":{"description":"Content","type":"string","default":null},"state":{"description":"Published state","type":"integer","default":1},"access":{"description":"Access level","type":"integer","default":1},"parent_id":{"description":"Parent page ID","type":"integer","default":0}},"required":[]}}}}},"delete":{"description":"Delete an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/listeners":{"get":{"description":"Display a listing of entries","parameters":[{"in":"query","name":"state","description":"Listener enabled\/disabled state","required":false,"schema":{"type":"string","default":"published","enum":["published","unpublished"]}},{"in":"query","name":"limit","description":"Number of result per page.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"folder","enum":["id","name","element","folder","state","access","ordering"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"desc","enum":["asc","desc"]}}]},"post":{"description":"Create a new entry","parameters":[],"responses":{"201":{"description":"Successful entry creation","content":{"application\/json":{"example":{"id":10042,"name":"Content - OpenGraph","type":"listener","element":"opengraph","folder":"content","client_id":0,"enabled":1,"access":1,"protected":1,"params":[],"checked_out":61344,"checked_out_time":"2021-11-17T21:58:24.000000Z","ordering":11,"updated_at":null,"updated_by":0,"editor":"Jane Doe","access_level":"Public","api":"https:\/\/example.org\/api\/listeners\/10042"}}}},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"Name","type":"string","default":null},"element":{"description":"Element","type":"string","default":null},"folder":{"description":"Folder (listener group)","type":"string","default":null},"enabled":{"description":"Enabled","type":"integer","default":0},"access":{"description":"Access","type":"integer","default":1},"params":{"description":"List of params","type":"array","default":null}},"required":["name","element","folder"]}}}}}},"\/listeners\/{id}":{"get":{"description":"Retrieve an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read","content":{"application\/json":{"example":{"id":10042,"name":"Content - OpenGraph","type":"listener","element":"opengraph","folder":"content","client_id":0,"enabled":1,"access":1,"protected":1,"params":[],"checked_out":61344,"checked_out_time":"2021-11-17T21:58:24.000000Z","ordering":11,"updated_at":null,"updated_by":0,"editor":"Jane Doe","access_level":"Public","api":"https:\/\/example.org\/api\/listeners\/10042"}}}},"404":{"description":"Record not found"}}},"put":{"description":"Update an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"202":{"description":"Successful entry modification","content":{"application\/json":{"example":{"id":10042,"name":"Content - OpenGraph","type":"listener","element":"opengraph","folder":"content","client_id":0,"enabled":1,"access":1,"protected":1,"params":[],"checked_out":61344,"checked_out_time":"2021-11-17T21:58:24.000000Z","ordering":11,"updated_at":null,"updated_by":0,"editor":"Jane Doe","access_level":"Public","api":"https:\/\/example.org\/api\/listeners\/10042"}}}},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"Name","type":"string","default":null},"element":{"description":"Element","type":"string","default":null},"folder":{"description":"Folder (listener group)","type":"string","default":null},"enabled":{"description":"Enabled","type":"integer","default":null},"access":{"description":"Access","type":"integer","default":null},"params":{"description":"List of params","type":"array","default":null}},"required":[]}}}}},"delete":{"description":"Delete an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/mail":{"get":{"description":"Display a listing of entries","parameters":[],"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"search":{"description":"A word or phrase to search for.","type":"string","default":null},"limit":{"description":"Number of result per page.","type":"integer","default":20},"page":{"description":"Number of where to start returning results.","type":"integer","default":1},"order":{"description":"Field to sort results by.","type":"string","default":"sent_at"},"order_dir":{"description":"Direction to sort results by.","type":"string","default":"asc"}},"required":[]}}}}},"post":{"description":"Create a new entry","parameters":[],"responses":{"201":{"description":"Successful entry creation","content":{"application\/json":{"example":{"id":2,"subject":"Scratch Filesystem Purge Policy Violation","body":"Don't violate our policies!","template":0,"alert":"info","created_at":"2022-05-24 12:31:01","updated_at":null,"deleted_at":null,"sent_at":"2022-05-24 12:31:01","sent_by":1234,"api":"https:\/\/example.org\/api\/mailer\/2"}}}},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"Short label for templates","type":"string","default":null},"subject":{"description":"Message subject","type":"string","default":null},"body":{"description":"Message contents, formatted using MarkDown","type":"string","default":null},"template":{"description":"If the message is a template or not","type":"integer","default":0},"alert":{"description":"An alert level to use for styling HTML portions of emails","type":"string","default":null}},"required":["subject"]}}}}}},"\/mailer\/{id}":{"get":{"description":"Retrieve an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read","content":{"application\/json":{"example":{"id":2,"subject":"Scratch Filesystem Purge Policy Violation","body":"Don't violate our policies!","template":0,"alert":"info","created_at":"2022-05-24 12:31:01","updated_at":null,"deleted_at":null,"sent_at":"2022-05-24 12:31:01","sent_by":1234,"api":"https:\/\/example.org\/api\/mailer\/2"}}}},"404":{"description":"Record not found"}}},"put":{"description":"Update an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"202":{"description":"Successful entry modification","content":{"application\/json":{"example":{"id":2,"subject":"Scratch Filesystem Purge Policy Violation","body":"Don't violate our policies!","template":0,"alert":"info","created_at":"2022-05-24 12:31:01","updated_at":null,"deleted_at":null,"sent_at":"2022-05-24 12:31:01","sent_by":1234,"api":"https:\/\/example.org\/api\/mailer\/2"}}}},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"Short label for templates","type":"string","default":null},"subject":{"description":"Message subject","type":"string","default":null},"body":{"description":"Message contents, formatted using MarkDown","type":"string","default":null},"template":{"description":"If the message is a template or not","type":"integer","default":0},"alert":{"description":"An alert level to use for styling HTML portions of emails","type":"string","default":null}},"required":[]}}}}},"delete":{"description":"Delete an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/mailer\/send":{"post":{"description":"Post a message","parameters":[],"responses":{"200":{"description":"Successful entry read","content":{"application\/json":{"example":{"id":2,"subject":"Scratch Filesystem Purge Policy Violation","body":"Don't violate our policies!","template":0,"alert":"info","created_at":"2022-05-24 12:31:01","updated_at":null,"deleted_at":null,"sent_at":"2022-05-24 12:31:01","sent_by":1234,"api":"https:\/\/example.org\/api\/mailer\/2"}}}},"404":{"description":"Record not found"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"subject":{"description":"Message subject","type":"string","default":null},"body":{"description":"Message body","type":"string","default":null},"user":{"description":"A comma-separated list of user IDs, usernames, or email addresses","type":"string","default":null},"group":{"description":"A comma-separated list of group IDs to email all users in those groups","type":"string","default":null},"role":{"description":"A comma-separated list of role IDs to email all users in those roles","type":"string","default":null},"fromemail":{"description":"An email address the message is from. Defaults to global site setting.","type":"string","default":null},"fromname":{"description":"A name the message is from. Defaults to global site setting.","type":"string","default":null},"cc":{"description":"A comma-separated list of user IDs or email addresses","type":"string","default":null},"bcc":{"description":"A comma-separated list of user IDs or email addresses","type":"string","default":null},"alert":{"description":"An alert level to use for styling HTML portions of emails","type":"string","default":null}},"required":["subject","body","user"]}}}}}},"":{"":{"description":"Revoke a user's QOS assignment.","parameters":[]}},"\/media\/folder":{"get":{"description":"Display a listing of files","parameters":[{"in":"query","name":"path","description":"Path","required":true,"schema":{"type":"string"}}]},"post":{"description":"Create a directory","parameters":[],"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"disk":{"description":"Storage disk","type":"string","default":"public"},"path":{"description":"Path to create new directory in","type":"string","default":null},"name":{"description":"Folder name","type":"string","default":null}},"required":["name"]}}}}},"put":{"description":"Update a directory","parameters":[],"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"disk":{"description":"Storage disk","type":"string","default":"public"},"before":{"description":"Original folder path","type":"string","default":null},"after":{"description":"Renamed folder path","type":"string","default":null}},"required":["before","after"]}}}}}},"\/media\/folder\/delete":{"delete":{"description":"Delete a folder","parameters":[{"in":"query","name":"disk","description":"Storage disk","required":false,"schema":{"type":"string","default":"public"}},{"in":"query","name":"path","description":"Folder path","required":true,"schema":{"type":"string"}}]}},"\/media":{"get":{"description":"Display a listing of files","parameters":[{"in":"query","name":"disk","description":"Storage disk","required":false,"schema":{"type":"string","default":"public"}},{"in":"query","name":"path","description":"Which folder to get tree of","required":false,"schema":{"type":"string","default":"\/"}}]}},"\/media\/tree":{"get":{"description":"Get directory tree","parameters":[{"in":"query","name":"folder","description":"Which folder to get tree of","required":true,"schema":{"type":"string"}}]}},"\/media\/layout":{"get":{"description":"Get directory tree","parameters":[{"in":"query","name":"layout","description":"Which view layout to return","required":true,"schema":{"type":"string"}}]}},"\/media\/upload":{"post":{"description":"Upload","parameters":[],"responses":{"201":{"description":"Successful entry creation"},"401":{"description":"Unauthorized"},"415":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"disk":{"description":"Filesystem disk","type":"string","default":null},"path":{"description":"File path to upload the file to","type":"string","default":null},"file":{"description":"File to be uploaded","type":"array","default":null},"overwrite":{"description":"Overwrite existing file of the same name","type":"bool","default":null}},"required":["file"]}}}}}},"\/media\/move":{"put":{"description":"Rename\/move a file","parameters":[],"responses":{"202":{"description":"Successful entry modification"},"404":{"description":"Record not found"},"422":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"disk":{"description":"Filesystem disk","type":"string","default":null},"before":{"description":"Source file path","type":"string","default":null},"after":{"description":"Destination file path","type":"string","default":null}},"required":["before","after"]}}}}}},"\/media\/delete":{"delete":{"description":"Delete a file","parameters":[],"responses":{"204":{"description":"Successful deletion"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"disk":{"description":"Filesystem disk","type":"string","default":null},"items":{"description":"A list of file paths","type":"array","default":null}},"required":["items"]}}}}}},"\/media\/download":{"get":{"description":"Download a file","parameters":[],"responses":{"200":{"description":"Successful entry download"},"404":{"description":"File not found"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"disk":{"description":"Filesystem disk","type":"string","default":null},"path":{"description":"File path","type":"string","default":null}},"required":["path"]}}}}}},"\/media\/url":{"get":{"description":"Get file URL","parameters":[],"responses":{"200":{"description":"Successful entry download"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"disk":{"description":"Filesystem disk","type":"string","default":null},"path":{"description":"File path","type":"string","default":null}},"required":["path"]}}}}}},"\/menus\/items":{"get":{"description":"Display a listing of entries","parameters":[],"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"state":{"description":"Listener enabled\/disabled state","type":"string","default":null},"limit":{"description":"Number of result per page.","type":"integer","default":20},"page":{"description":"Number of where to start returning results.","type":"string","default":null},"search":{"description":"A word or phrase to search for.","type":"string","default":null},"order":{"description":"Field to sort results by.","type":"string","default":null},"order_dir":{"description":"Direction to sort results by.","type":"string","default":"asc"}},"required":[]}}}}},"post":{"description":"Create a new entry","parameters":[],"responses":{"201":{"description":"Successful entry creation","content":{"application\/json":{"example":{"id":9,"menutype":"about","title":"About Us","alias":"about","note":"","path":"about","link":"about","type":"module","parent_id":1,"level":1,"state":1,"module_id":22,"ordering":0,"checked_out":0,"checked_out_time":null,"access":1,"params":[],"lft":23,"rgt":24,"home":0,"language":"*","client_id":0,"editor":null,"componentname":"pages","access_level":"Public","name":"pages","published":1,"item_type":"pages","api":"https:\/\/example.org\/api\/menus\/items\/9"}}}},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"title":{"description":"Menu item text","type":"string","default":null},"type":{"description":"Menu type","type":"string","default":null},"parent_id":{"description":"Parent menu item ID","type":"integer","default":0}},"required":["title"]}}}}}},"\/menus\/items\/{id}":{"get":{"description":"Retrieve an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read","content":{"application\/json":{"example":{"id":9,"menutype":"about","title":"About Us","alias":"about","note":"","path":"about","link":"about","type":"module","parent_id":1,"level":1,"state":1,"module_id":22,"ordering":0,"checked_out":0,"checked_out_time":null,"access":1,"params":[],"lft":23,"rgt":24,"home":0,"language":"*","client_id":0,"editor":null,"componentname":"pages","access_level":"Public","name":"pages","published":1,"item_type":"pages","api":"https:\/\/example.org\/api\/menus\/items\/9"}}}},"404":{"description":"Record not found"}}},"put":{"description":"Update an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"202":{"description":"Successful entry modification","content":{"application\/json":{"example":{"id":9,"menutype":"about","title":"About Us","alias":"about","note":"","path":"about","link":"about","type":"module","parent_id":1,"level":1,"state":1,"module_id":22,"ordering":0,"checked_out":0,"checked_out_time":null,"access":1,"params":[],"lft":23,"rgt":24,"home":0,"language":"*","client_id":0,"editor":null,"componentname":"pages","access_level":"Public","name":"pages","published":1,"item_type":"pages","api":"https:\/\/example.org\/api\/menus\/items\/9"}}}},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"title":{"description":"Menu item text","type":"string","default":null},"type":{"description":"Menu type","type":"string","default":null},"parent_id":{"description":"Parent menu item ID","type":"integer","default":0}},"required":[]}}}}},"delete":{"description":"Delete an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/menus\/items\/reorder":{"post":{"description":"Save the order for items","parameters":[],"responses":{"204":{"description":"Successful entry updates"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"id":{"description":"A list of ordering values","type":"array","default":null}},"required":["id","id"]}}}}}},"\/menus":{"get":{"description":"Display a listing of entries","parameters":{"0":{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},"2":{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}}},"responses":{"200":{"description":"Successful list cread","content":{"application\/json":{"example":{"data":[{"id":2,"menutype":"about","title":"About","description":"About Side Menu","client_id":0,"created_at":null,"updated_at":null,"deleted_at":null,"items_count":12,"counts":{"published":0,"unpublished":0,"trashed":0},"api":"https:\/\/example.org\/api\/menus\/2"}]}}}}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"limit":{"description":"Number of result per page.","type":"integer","default":20},"order":{"description":"Field to sort results by.","type":"string","default":"menutype"},"order_dir":{"description":"Direction to sort results by.","type":"string","default":"asc"}},"required":[]}}}}},"post":{"description":"Create a new entry","parameters":[],"responses":{"201":{"description":"Successful entry creation","content":{"application\/json":{"example":{"id":2,"menutype":"about","title":"About","description":"About Side Menu","client_id":0,"created_at":null,"updated_at":null,"deleted_at":null,"items_count":12,"counts":{"published":0,"unpublished":0,"trashed":0},"api":"https:\/\/example.org\/api\/menus\/2"}}}},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"title":{"description":"Menu title","type":"string","default":null},"description":{"description":"A description of the menu","type":"string","default":null},"client_id":{"description":"Client (admin = 1|site = 0) ID","type":"integer","default":0},"menutype":{"description":"A short alias for the menu. If none provided, one will be generated from the title.","type":"string","default":null}},"required":["title"]}}}}}},"\/menus\/{id}":{"get":{"description":"Retrieve an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read","content":{"application\/json":{"example":{"id":2,"menutype":"about","title":"About","description":"About Side Menu","client_id":0,"created_at":null,"updated_at":null,"deleted_at":null,"items_count":12,"counts":{"published":0,"unpublished":0,"trashed":0},"api":"https:\/\/example.org\/api\/menus\/2"}}}},"404":{"description":"Record not found"}}},"put":{"description":"Update an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"202":{"description":"Successful entry modification","content":{"application\/json":{"example":{"id":2,"menutype":"about","title":"About","description":"About Side Menu","client_id":0,"created_at":null,"updated_at":null,"deleted_at":null,"items_count":12,"counts":{"published":0,"unpublished":0,"trashed":0},"api":"https:\/\/example.org\/api\/menus\/2"}}}},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"title":{"description":"Menu title","type":"string","default":null},"description":{"description":"A description of the menu","type":"string","default":null},"client_id":{"description":"Client (admin = 1|site = 0) ID","type":"integer","default":0},"menutype":{"description":"A short alias for the menu. If none provided, one will be generated from the title.","type":"string","default":null}},"required":[]}}}}},"delete":{"description":"Delete an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/messages":{"get":{"description":"Display a listing of entries","parameters":[{"in":"query","name":"state","description":"Message state","required":false,"schema":{"type":"string","default":"pending","enum":["pending","complete","incomplete"]}},{"in":"query","name":"start","description":"Submitted datetime start","required":false,"schema":{"type":"string","format":"date-time","example":"2021-01-30T08:30:00Z"}},{"in":"query","name":"stop","description":"Submitted datetime end","required":false,"schema":{"type":"string","format":"date-time","example":"2021-01-30T08:30:00Z"}},{"in":"query","name":"returnstatus","description":"Filter by return status","required":false,"schema":{"type":"integer"}},{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","description":"Number of result per page.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"datetimecreated","enum":["id","userid","messagequeuetypeid","messagequeueoptionsid","pid","datetimesubmitted","datetimestarted","datetimecompleted","returnstatus"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"desc","enum":["asc","desc"]}}]},"post":{"description":"Create an entry","parameters":[],"responses":{"201":{"description":"Successful entry creation","content":{"application\/json":{"example":{"id":341137,"userid":1234,"messagequeuetypeid":1,"targetobjectid":98686,"messagequeueoptionsid":0,"datetimesubmitted":"2021-11-16T19:00:42.000000Z","datetimestarted":null,"datetimecompleted":null,"pid":0,"returnstatus":0,"output":"","type":{"id":1,"name":"get gpfs quota","resourceid":64,"classname":"storagedir"},"api":"https:\/\/example.org\/api\/messages\/341137","target":"\/foo\/bar"}}}},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"messagequeuetypeid":{"description":"Message type ID.","type":"integer","default":null},"targetobjectid":{"description":"Target object ID","type":"integer","default":null},"messagequeueoptionsid":{"description":"Message options ID","type":"integer","default":0},"userid":{"description":"User ID","type":"integer","default":0}},"required":["messagequeuetypeid","targetobjectid"]}}}}}},"\/messages\/{id}":{"get":{"description":"Retrieve an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read","content":{"application\/json":{"example":{"id":341137,"userid":1234,"messagequeuetypeid":1,"targetobjectid":98686,"messagequeueoptionsid":0,"datetimesubmitted":"2021-11-16T19:00:42.000000Z","datetimestarted":null,"datetimecompleted":null,"pid":0,"returnstatus":0,"output":"","type":{"id":1,"name":"get gpfs quota","resourceid":64,"classname":"storagedir"},"api":"https:\/\/example.org\/api\/messages\/341137","target":"\/foo\/bar"}}}},"404":{"description":"Record not found"}}},"put":{"description":"Update an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"202":{"description":"Successful entry modification","content":{"application\/json":{"example":{"id":341137,"userid":1234,"messagequeuetypeid":1,"targetobjectid":98686,"messagequeueoptionsid":0,"datetimesubmitted":"2021-11-16T19:00:42.000000Z","datetimestarted":null,"datetimecompleted":null,"pid":0,"returnstatus":0,"output":"","type":{"id":1,"name":"get gpfs quota","resourceid":64,"classname":"storagedir"},"api":"https:\/\/example.org\/api\/messages\/341137","target":"\/foo\/bar"}}}},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"messagequeuetypeid":{"description":"Message type ID.","type":"integer","default":null},"targetobjectid":{"description":"Target object ID","type":"integer","default":null},"messagequeueoptionsid":{"description":"Message options ID","type":"integer","default":null},"userid":{"description":"User ID","type":"integer","default":null},"pid":{"description":"Process ID","type":"integer","default":null},"datetimestarted":{"description":"Datetime started","type":"string","default":null},"datetimecompleted":{"description":"Datetime completed","type":"string","default":null},"returnstatus":{"description":"Return status code","type":"integer","default":null},"output":{"description":"Process output","type":"string","default":null},"started":{"description":"Starting processing","type":"integer","default":null},"completed":{"description":"Ending processing","type":"integer","default":null},"retry":{"description":"Number of minutes to retry in","type":"integer","default":0}},"required":[]}}}}},"delete":{"description":"Delete an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/messages\/types":{"get":{"description":"Display a listing of entries","parameters":[{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"resourceid","description":"Resource ID","required":false,"schema":{"type":"integer"}},{"in":"query","name":"classname","description":"Class name","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","description":"Number of result per page.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","enum":["id","resourceid","name","classname"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]}}]},"post":{"description":"Create an entry","parameters":[],"responses":{"201":{"description":"Successful entry creation","content":{"application\/json":{"example":{"id":1,"name":"get gpfs quota","resourceid":64,"classname":"storagedir","api":"https:\/\/example.org\/api\/messages\/types\/1"}}}},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"Name","type":"string","default":null},"classname":{"description":"Class name","type":"string","default":null},"resourceid":{"description":"Resource ID","type":"integer","default":0}},"required":["name"]}}}}}},"\/messages\/types\/{id}":{"get":{"description":"Retrieve an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read","content":{"application\/json":{"example":{"id":1,"name":"get gpfs quota","resourceid":64,"classname":"storagedir","api":"https:\/\/example.org\/api\/messages\/types\/1"}}}},"404":{"description":"Record not found"}}},"put":{"description":"Update an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"202":{"description":"Successful entry modification","content":{"application\/json":{"example":{"id":1,"name":"get gpfs quota","resourceid":64,"classname":"storagedir","api":"https:\/\/example.org\/api\/messages\/types\/1"}}}},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"Name","type":"string","default":null},"classname":{"description":"Class name","type":"string","default":null},"resourceid":{"description":"Resource ID","type":"integer","default":null}},"required":[]}}}}},"delete":{"description":"Delete an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/news":{"get":{"description":"Display a listing of news articles","parameters":[{"in":"query","name":"start","description":"Filter entries scheduled on or after this date","required":false,"schema":{"type":"string","format":"date-time","example":"2021-01-30T08:30:00Z"}},{"in":"query","name":"stop","description":"Filter entries scheduled to end before this date","required":false,"schema":{"type":"string","format":"date-time","example":"2021-01-30T08:30:00Z"}},{"in":"query","name":"type","description":"New type ID","required":false,"schema":{"type":"integer","default":"null"}},{"in":"query","name":"state","description":"The article state.","required":false,"schema":{"type":"string","default":"published","enum":["published","unpublished"]}},{"in":"query","name":"resource","description":"A comma-separated list of associated resource IDs to filter by","required":false,"schema":{"type":"string","example":"1,2,3,4"}},{"in":"query","name":"location","description":"A location to filter entries by.","required":false,"schema":{"type":"string"}},{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","description":"Number of result per page.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"datetimecreated","enum":["id","headline","datetimecreated"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"desc","enum":["asc","desc"]}}]},"post":{"description":"Create a news article","parameters":[],"responses":{"201":{"description":"Successful entry creation"},"401":{"description":"Unauthorized"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"headline":{"description":"The entry's headline","type":"string","default":null},"body":{"description":"The entry's body","type":"string","default":null},"newstypeid":{"description":"ID of the news type","type":"integer","default":null},"published":{"description":"Published state","type":"integer","default":1},"template":{"description":"If entry is a template or not","type":"integer","default":0},"datetimenews":{"description":"Start date and time","type":"string","default":null},"datetimenewsend":{"description":"Stop date and time","type":"string","default":null},"location":{"description":"Entry location","type":"string","default":null},"url":{"description":"URL for the entry","type":"string","default":null}},"required":["headline","body","newstypeid","datetimenews"]}}}}}},"\/news\/{id}":{"get":{"description":"Read a news article","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read"},"404":{"description":"Record not found"}}},"put":{"description":"Update a news article","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"202":{"description":"Successful entry modification"},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"headline":{"description":"The entry's headline","type":"string","default":null},"body":{"description":"The entry's body","type":"string","default":null},"newstypeid":{"description":"ID of the news type","type":"integer","default":null},"published":{"description":"Published state","type":"integer","default":1},"template":{"description":"If entry is a template or not","type":"integer","default":0},"datetimenews":{"description":"Start date and time","type":"string","default":null},"datetimenewsend":{"description":"Stop date and time","type":"string","default":null},"location":{"description":"Entry location","type":"string","default":null},"url":{"description":"URL for the entry","type":"string","default":null}},"required":[]}}}}},"delete":{"description":"Delete a news article","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/news\/{id}\/views":{"get":{"description":"Retrieve news article view stats","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read"}}}},"\/news\/preview":{"post":{"description":"Preview a news article","parameters":[],"responses":{"201":{"description":"Successful entry preparation"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"body":{"description":"The entry's body","type":"string","default":null},"vars":{"description":"A list of key\/value pairs for variable replacement in the body text","type":"array","default":null}},"required":["body"]}}}}}},"\/news\/{id}\/email":{"post":{"description":"Email a news article","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"202":{"description":"Successful email"},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"headline":{"description":"Optional alternate article headline","type":"string","default":null},"body":{"description":"Optional alternate article body","type":"string","default":null},"resources":{"description":"A list of resource IDs to send the email to mailing lists.","type":"array","default":null},"associations":{"description":"A list of user IDs to send the email to. If none provided, Resource mailing lists are used instead.","type":"array","default":null}},"required":[]}}}}}},"\/news\/associations":{"get":{"description":"Display a listing of news article types","parameters":[{"in":"query","name":"tagresources","description":"Filter by types that allow articles to tag resources","required":false,"schema":{"type":"integer"}},{"in":"query","name":"location","description":"Filter by types that allow articles to set location","required":false,"schema":{"type":"integer"}},{"in":"query","name":"future","description":"Filter by types that allow articles to set future","required":false,"schema":{"type":"integer"}},{"in":"query","name":"ongoing","description":"Filter by types that allow articles to set ongoing","required":false,"schema":{"type":"integer"}},{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","description":"Number of result per page.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"datetimecreated","enum":["id","motd","datetimecreated","datetimeremoved"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"desc","enum":["asc","desc"]}}],"responses":{"200":{"description":"Successful entries lookup","content":{"application\/json":{"example":{"data":[{"id":"1","name":"Examples","tagresources":0,"tagusers":1,"location":1,"future":1,"calendar":1,"url":1,"api":"https:\/\/example.com\/api\/news\/types\/1"},{"id":"2","name":"Outages and Maintenance","tagresources":1,"tagusers":0,"location":0,"future":1,"calendar":1,"url":0,"api":"https:\/\/example.com\/api\/news\/types\/2"}],"links":{"first":"https:\/\/example.com\/api\/news\/types?limit=20&order=name&order_dir=asc&page=1","last":"https:\/\/example.com\/api\/news\/types?limit=20&order=name&order_dir=asc&page=1","prev":null,"next":null},"meta":{"current_page":1,"from":1,"last_page":1,"path":"https:\/\/example.com\/api\/news\/types","per_page":20,"to":2,"total":2}}}}},"415":{"description":"Invalid data"}}},"post":{"description":"Create a news associations","parameters":[],"responses":{"200":{"description":"Successful entry creation","content":{"application\/json":{"example":{"id":1,"associd":1234,"assoctype":"user","newsid":1,"comment":"Examples","api":"https:\/\/example.com\/api\/news\/associations\/1"}}}},"415":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"associd":{"description":"The association ID","type":"integer","default":null},"assoctype":{"description":"The association type","type":"string","default":null},"newsid":{"description":"The news article ID","type":"integer","default":null},"comment":{"description":"Comment \/ notes","type":"string","default":null}},"required":["associd","assoctype","newsid"]}}}}}},"\/news\/associations\/{id}":{"get":{"description":"Read a news associations","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read","content":{"application\/json":{"example":{"id":1,"associd":1234,"assoctype":"user","newsid":1,"comment":"Examples","api":"https:\/\/example.com\/api\/news\/associations\/1"}}}},"404":{"description":"Record not found"}}},"put":{"description":"Update a news association","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry modification","content":{"application\/json":{"example":{"id":1,"associd":1234,"assoctype":"user","newsid":1,"comment":"Examples","api":"https:\/\/example.com\/api\/news\/associations\/1"}}}},"404":{"description":"Record not found"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"associd":{"description":"The association ID","type":"integer","default":null},"assoctype":{"description":"The association type","type":"string","default":null},"newsid":{"description":"The news article ID","type":"integer","default":null},"comment":{"description":"Comment \/ notes","type":"string","default":null}},"required":[]}}}}},"delete":{"description":"Delete a news associations","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/news\/slack":{"post":{"description":"Proccess Slack interactions","parameters":[{"in":"query","name":"tagresources","description":"Filter by types that allow articles to tag resources","required":false,"schema":{"type":"integer"}},{"in":"query","name":"location","description":"Filter by types that allow articles to set location","required":false,"schema":{"type":"integer"}},{"in":"query","name":"future","description":"Filter by types that allow articles to set future","required":false,"schema":{"type":"integer"}},{"in":"query","name":"ongoing","description":"Filter by types that allow articles to set ongoing","required":false,"schema":{"type":"integer"}},{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","description":"Number of result per page.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"datetimecreated","enum":["id","motd","datetimecreated","datetimeremoved"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"desc","enum":["asc","desc"]}}],"responses":{"200":{"description":"Successful entries lookup","content":{"application\/json":{"example":{"message":"Text"}}}},"415":{"description":"Invalid data"}}}},"\/news\/types":{"get":{"description":"Display a listing of news article types","parameters":[{"in":"query","name":"tagresources","description":"Filter by types that allow articles to tag resources","required":false,"schema":{"type":"integer"}},{"in":"query","name":"location","description":"Filter by types that allow articles to set location","required":false,"schema":{"type":"integer"}},{"in":"query","name":"future","description":"Filter by types that allow articles to set future","required":false,"schema":{"type":"integer"}},{"in":"query","name":"ongoing","description":"Filter by types that allow articles to set ongoing","required":false,"schema":{"type":"integer"}},{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","description":"Number of result per page.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"datetimecreated","enum":["id","motd","datetimecreated","datetimeremoved"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"desc","enum":["asc","desc"]}}],"responses":{"200":{"description":"Successful entries lookup","content":{"application\/json":{"example":{"data":[{"id":"1","name":"Examples","tagresources":0,"tagusers":1,"location":1,"future":1,"calendar":1,"url":1,"api":"https:\/\/example.com\/api\/news\/types\/1"},{"id":"2","name":"Outages and Maintenance","tagresources":1,"tagusers":0,"location":0,"future":1,"calendar":1,"url":0,"api":"https:\/\/example.com\/api\/news\/types\/2"}],"links":{"first":"https:\/\/example.com\/api\/news\/types?limit=20&order=name&order_dir=asc&page=1","last":"https:\/\/example.com\/api\/news\/types?limit=20&order=name&order_dir=asc&page=1","prev":null,"next":null},"meta":{"current_page":1,"from":1,"last_page":1,"path":"https:\/\/example.com\/api\/news\/types","per_page":20,"to":2,"total":2}}}}},"415":{"description":"Invalid data"}}},"post":{"description":"Create a news article type","parameters":[],"responses":{"200":{"description":"Successful entry creation","content":{"application\/json":{"example":{"id":"1","name":"Examples","tagresources":0,"tagusers":1,"location":1,"future":1,"calendar":1,"url":1,"parentid":0,"state":"upcoming","order_dir":"desc","api":"https:\/\/example.com\/api\/news\/types\/1"}}}},"415":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"The name of the type","type":"string","default":null},"alias":{"description":"A URL-friendly alias for the type. If none provided, one will be generated from the `name`.","type":"string","default":null},"tagresources":{"description":"Allow articles to tag resources","type":"integer","default":0},"tagusers":{"description":"Allow articles to tag users","type":"integer","default":0},"location":{"description":"Allow articles to set location","type":"integer","default":0},"future":{"description":"Allow articles to set future","type":"integer","default":0},"ongoing":{"description":"Allow articles to set ongoing","type":"integer","default":0},"url":{"description":"A URL associated with the news article","type":"integer","default":0},"parentid":{"description":"Parent type ID","type":"integer","default":null},"state":{"description":"Default filter for listings","type":"string","default":null},"order_dir":{"description":"Default sorting direction for listings","type":"string","default":null}},"required":["name"]}}}}}},"\/news\/types\/{id}":{"get":{"description":"Read a news article type","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read","content":{"application\/json":{"example":{"id":"1","name":"Examples","tagresources":0,"tagusers":1,"location":1,"future":1,"calendar":1,"url":1,"parentid":0,"state":"upcoming","order_dir":"desc","api":"https:\/\/example.com\/api\/news\/types\/1"}}}},"404":{"description":"Record not found"}}},"put":{"description":"Update a news article type","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry modification","content":{"application\/json":{"example":{"id":"1","name":"Examples","tagresources":0,"tagusers":1,"location":1,"future":1,"calendar":1,"url":1,"parentid":0,"state":"upcoming","order_dir":"desc","api":"https:\/\/example.com\/api\/news\/types\/1"}}}},"404":{"description":"Record not found"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"The name of the type","type":"string","default":null},"alias":{"description":"A URL-friendly alias for the type. If none provided, one will be generated from the `name`.","type":"string","default":null},"tagresources":{"description":"Allow articles to tag resources","type":"integer","default":null},"tagusers":{"description":"Allow articles to tag users","type":"integer","default":null},"location":{"description":"Allow articles to set location","type":"integer","default":null},"future":{"description":"Allow articles to set future","type":"integer","default":null},"ongoing":{"description":"Allow articles to set ongoing","type":"integer","default":null},"url":{"description":"A URL associated with the news article","type":"integer","default":null},"parentid":{"description":"Parent type ID","type":"integer","default":null},"state":{"description":"Default filter for listings","type":"string","default":null},"order_dir":{"description":"Default sorting direction for listings","type":"string","default":null}},"required":[]}}}}},"delete":{"description":"Delete a news article type","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/news\/{news_id}\/updates":{"get":{"description":"Display a listing of news article updates","parameters":[{"in":"path","name":"news_id","description":"News article identifier","required":true,"schema":{"type":"integer"}},{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","description":"Number of result per page.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"datetimecreated","enum":["id","datetimecreated","datetimeremoved"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"desc","enum":["asc","desc"]}}]},"post":{"description":"Create a news article update","parameters":[{"in":"path","name":"news_id","description":"News article identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry creation","content":{"application\/json":{"example":{"id":1,"userid":12344,"edituserid":12345,"datetimecreated":"2021-01-27 20:03:51","datetimeedited":null,"datetimeremoved":null,"body":"Example text","newsid":1}}}},"404":{"description":"Record not found"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"body":{"description":"The update being made","type":"string","default":null},"newsid":{"description":"News article ID","type":"integer","default":null}},"required":["body","newsid"]}}}}}},"\/news\/{news_id}\/updates\/{id}":{"get":{"description":"Read a news article update","parameters":[{"in":"path","name":"news_id","description":"News article identifier","required":true,"schema":{"type":"integer"}},{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Entry found","content":{"application\/json":{"example":{"id":1,"userid":12344,"edituserid":12345,"datetimecreated":"2021-01-27 20:03:51","datetimeedited":null,"datetimeremoved":null,"body":"Example text","newsid":1}}}},"404":{"description":"Record not found"}}},"put":{"description":"Update a news article update","parameters":[{"in":"path","name":"news_id","description":"News article identifier","required":true,"schema":{"type":"integer"}},{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry modification","content":{"application\/json":{"example":{"id":1,"userid":12344,"edituserid":12345,"datetimecreated":"2021-01-27 20:03:51","datetimeedited":"2021-01-28 13:40:01","datetimeremoved":null,"body":"Example text that was edited","newsid":1}}}},"404":{"description":"Record not found"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"body":{"description":"Contents of the update","type":"string","default":null}},"required":[]}}}}},"delete":{"description":"Delete a news article update","parameters":[{"in":"path","name":"news_id","description":"News article identifier","required":true,"schema":{"type":"integer"}},{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/orders\/accounts":{"get":{"description":"Display a listing of entries","parameters":[{"in":"query","name":"category","description":"Orders that have products int he specified category.","required":false,"schema":{"type":"integer"}},{"in":"query","name":"start","description":"Orders created on or after this datetime.","required":false,"schema":{"type":"string","format":"date-time","example":"2021-01-30T08:30:00Z"}},{"in":"query","name":"end","description":"Orders created before this datetime.","required":false,"schema":{"type":"string","format":"date-time","example":"2021-01-30T08:30:00Z"}},{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","description":"Number of result per page.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"datetimecreated","enum":["id","datetimecreated","datetimeremoved","amount","datetimeapproved","datetimedenied","datetimepaid"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"desc","enum":["asc","desc"]}}]},"post":{"description":"Create a new entry","parameters":[],"responses":{"201":{"description":"Successful entry creation"},"401":{"description":"Unauthorized"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"orderid":{"description":"Order ID","type":"integer","default":null},"amount":{"description":"Amount, formatted or not","type":"string","default":null},"purchasefund":{"description":"Purchase fund","type":"string","default":null},"purchasecostcenter":{"description":"Purchase cost center","type":"string","default":null},"purchaseorder":{"description":"Purchase order","type":"string","default":null},"purchaseio":{"description":"Purchase IO","type":"string","default":null},"purchasewbse":{"description":"Purchase WBSE","type":"string","default":null},"budgetjustification":{"description":"Budget justification","type":"string","default":null},"approveruserid":{"description":"Approver user ID","type":"integer","default":null}},"required":["orderid","amount"]}}}}}},"\/orders\/accounts\/{id}":{"get":{"description":"Retrieve an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read"},"404":{"description":"Record not found"}}},"put":{"description":"Update an entry","parameters":[],"responses":{"202":{"description":"Successful entry modification"},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"amount":{"description":"Amount, formatted or not","type":"string","default":null},"purchasefund":{"description":"Purchase fund","type":"string","default":null},"purchasecostcenter":{"description":"Purchase cost center","type":"string","default":null},"purchaseorder":{"description":"Purchase order","type":"string","default":null},"purchaseio":{"description":"Purchase IO","type":"string","default":null},"purchasewbse":{"description":"Purchase WBSE","type":"string","default":null},"budgetjustification":{"description":"Budget justification","type":"string","default":null},"approveruserid":{"description":"Approver user ID","type":"integer","default":null},"approved":{"description":"Has the payment been approved?","type":"boolean","default":null},"paid":{"description":"Has the payment been paid?","type":"boolean","default":null},"denied":{"description":"Has the payment been denied?","type":"boolean","default":null},"reset":{"description":"Reset paid\/denied status?","type":"boolean","default":null},"datetimepaymentdoc":{"description":"Timestamp for the payment doc","type":"string","default":null},"paymentdocid":{"description":"Payment doc ID","type":"boolean","default":null},"notice":{"description":"Notice state","type":"integer","default":null},"deniedreason":{"description":"Denied reason","type":"string","default":null}},"required":[]}}}}},"delete":{"description":"Delete an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/orders\/approvers":{"get":{"description":"Display a listing of entries","parameters":[{"in":"query","name":"departmentid","description":"Department ID.","required":false,"schema":{"type":"integer"}},{"in":"query","name":"userid","description":"Approver user ID.","required":false,"schema":{"type":"integer"}},{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","description":"Number of result per page.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"datetimecreated","enum":["id","datetimecreated","datetimeremoved","amount","datetimeapproved","datetimedenied","datetimepaid"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"desc","enum":["asc","desc"]}}]},"post":{"description":"Create a new entry","parameters":[],"responses":{"201":{"description":"Successful entry creation"},"401":{"description":"Unauthorized"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"departmentid":{"description":"Department ID","type":"integer","default":null},"userid":{"description":"Approver user ID","type":"integer","default":null}},"required":["departmentid","userid"]}}}}}},"\/orders\/approvers\/{id}":{"get":{"description":"Retrieve an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read"},"404":{"description":"Record not found"}}},"put":{"description":"Update an entry","parameters":[],"responses":{"202":{"description":"Successful entry modification"},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"departmentid":{"description":"Department ID","type":"integer","default":null},"userid":{"description":"Approver user ID","type":"integer","default":null}},"required":["departmentid","userid"]}}}}},"delete":{"description":"Delete an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/orders\/cart":{"get":{"description":"Display a listing of entries","parameters":[]},"post":{"description":"Create a new entry","parameters":[],"responses":{"201":{"description":"Successful entry creation"},"401":{"description":"Unauthorized"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"quantity":{"description":"Quantity","type":"integer","default":null},"price":{"description":"Price","type":"integer","default":null}},"required":["quantity","price"]}}}}}},"\/orders\/cart\/{id}":{"get":{"description":"Retrieve an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read"},"404":{"description":"Record not found"}}},"put":{"description":"Update an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"202":{"description":"Successful entry modification"},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"quantity":{"description":"Quantity","type":"integer","default":null},"price":{"description":"Price","type":"integer","default":null}},"required":["quantity"]}}}}},"delete":{"description":"Delete an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/orders\/categories":{"get":{"description":"Display a listing of entries","parameters":[{"in":"query","name":"state","description":"Order category state.","required":false,"schema":{"type":"string","default":"published","enum":["all","published","trashed"]}},{"in":"query","name":"parent","description":"Parent category ID.","required":false,"schema":{"type":"integer","default":0}}],"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"search":{"description":"A word or phrase to search for.","type":"string","default":null},"limit":{"description":"Number of result per page.","type":"integer","default":20},"page":{"description":"Number of where to start returning results.","type":"integer","default":1},"order":{"description":"Field to sort results by.","type":"string","default":"id"},"order_dir":{"description":"Direction to sort results by.","type":"string","default":"asc"}},"required":[]}}}}},"post":{"description":"Create a new entry","parameters":[],"responses":{"201":{"description":"Successful entry creation"},"401":{"description":"Unauthorized"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"Category name.","type":"string","default":null},"description":{"description":"Longer description of the category","type":"string","default":null},"sequence":{"description":"Category order","type":"integer","default":null},"parentordercategoryid":{"description":"Parent category ID","type":"integer","default":1}},"required":["name"]}}}}}},"\/orders\/categories\/{id}":{"get":{"description":"Retrieve an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read"},"404":{"description":"Record not found"}}},"put":{"description":"Update an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"202":{"description":"Successful entry modification"},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"Category name.","type":"string","default":null},"description":{"description":"Longer description of the category","type":"string","default":null},"sequence":{"description":"Category order","type":"integer","default":null},"parentordercategoryid":{"description":"Parent category ID","type":"integer","default":null}},"required":[]}}}}},"delete":{"description":"Delete an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/orders\/items":{"get":{"description":"Display a listing of entries","parameters":[{"in":"query","name":"state","description":"Order state.","required":false,"schema":{"type":"string","default":"datetimecreated","enum":["active [pending_payment, pending_boassignment, pending_collection, pending_approval, pending_fulfillment]","canceled","complete"]}},{"in":"query","name":"category","description":"Orders that have products int he specified category.","required":false,"schema":{"type":"integer"}},{"in":"query","name":"start","description":"Orders created on or after this datetime.","required":false,"schema":{"type":"string","format":"date-time","example":"2021-01-30T08:30:00Z"}},{"in":"query","name":"end","description":"Orders created before this datetime.","required":false,"schema":{"type":"string","format":"date-time","example":"2021-01-30T08:30:00Z"}},{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","description":"Number of result per page.","type":"integer","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"datetimecreated","enum":["id","datetimecreated"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]}}]},"post":{"description":"Create a new entry","parameters":[],"responses":{"201":{"description":"Successful entry creation"},"401":{"description":"Unauthorized"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"orderid":{"description":"Order ID","type":"integer","default":null},"orderproductid":{"description":"Order product ID","type":"integer","default":null},"quantity":{"description":"Quantity","type":"integer","default":null},"price":{"description":"Price","type":"integer","default":null},"origunitprice":{"description":"Original unit price","type":"integer","default":null},"origorderitemid":{"description":"Original order item ID (recurring order)","type":"integer","default":null},"timeperiodcount":{"description":"Original order timeperiod count (recurring order)","type":"integer","default":null}},"required":["orderid","orderproductid","quantity","price","origunitprice"]}}}}}},"\/orders\/items\/{id}":{"get":{"description":"Retrieve an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read"},"404":{"description":"Record not found"}}},"put":{"description":"Update an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":false,"schema":{"type":"integer"}}],"responses":{"202":{"description":"Successful entry modification"},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"quantity":{"description":"Quantity","type":"integer","default":null},"price":{"description":"Price","type":"integer","default":null},"datetimecreated":{"description":"Date time created (restricted to managers)","type":"string","default":null},"datetimefulfilled":{"description":"Date time fulfilled","type":"string","default":null},"timeperiodcount":{"description":"Original order timeperiod count (recurring order)","type":"integer","default":null}},"required":[]}}}}},"delete":{"description":"Delete an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/orders\/sequence\/{id}":{"get":{"description":"Get recurring item sequence","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read"},"404":{"description":"Record not found"}}}},"\/orders":{"get":{"description":"Display a listing of entries","parameters":[{"in":"query","name":"state","description":"Order state.","required":false,"schema":{"type":"string","default":"active","enum":["active [pending_payment, pending_boassignment, pending_collection, pending_approval, pending_fulfillment]","caceled","complete"]}},{"in":"query","name":"category","description":"Orders that have products in the specified category.","type":"integer","required":false,"schema":{"type":"integer","default":0}},{"in":"query","name":"start","description":"Orders created on or after this datetime.","required":false,"schema":{"type":"string","format":"date (YYYY-MM-DD HH:mm:ss)"}},{"in":"query","name":"end","description":"Orders created before this datetime.","required":false,"schema":{"type":"string","format":"date (YYYY-MM-DD HH:mm:ss)"}},{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","description":"Number of result per page.","type":"integer","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"created_at","enum":["id","created_at"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]}}],"responses":{"current_page":1,"data":[],"first_page_url":"https:\/\/yourhost\/api\/orders?page=1","from":1,"last_page":2,"last_page_url":"https:\/\/yourhost\/api\/orders?page=2","next_page_url":"https:\/\/yourhost\/api\/orders?page=2","path":"https:\/\/yourhost\/api\/widgets","per_page":3,"prev_page_url":null,"to":3,"total":5}},"post":{"description":"Create a new entry","parameters":[],"responses":{"201":{"description":"Successful entry creation"},"401":{"description":"Unauthorized"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"userid":{"description":"User ID","type":"integer","default":null},"groupid":{"description":"Group ID","type":"integer","default":null},"usernotes":{"description":"User notes","type":"string","default":null},"staffnotes":{"description":"Staff notes","type":"string","default":null},"notices":{"description":"Notice state","type":"integer","default":null}},"required":["userid"]}}}}}},"\/orders\/{id}":{"get":{"description":"Retrieve an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read"},"404":{"description":"Record not found"}}},"put":{"description":"Update an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"202":{"description":"Successful entry modification"},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"userid":{"description":"User ID","type":"integer","default":null},"groupid":{"description":"Group ID","type":"integer","default":null},"usernotes":{"description":"User notes","type":"string","default":null},"staffnotes":{"description":"Staff notes","type":"string","default":null},"notices":{"description":"Notice state","type":"integer","default":null}},"required":[]}}}}},"delete":{"description":"Delete an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/orders\/products":{"get":{"description":"Display a listing of entries","parameters":[{"in":"query","name":"state","description":"Order category state.","required":false,"schema":{"type":"string","default":"published","enum":["all","published","trashed"]}},{"in":"query","name":"parent","description":"Parent category ID.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","description":"Number of result per page.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"created_at","enum":["id","created_at"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","type":"string","required":false,"default":"asc","schema":{"type":"string","default":"asc","enum":["asc","desc"]}}]},"post":{"description":"Create a new entry","parameters":[],"responses":{"201":{"description":"Successful entry creation"},"401":{"description":"Unauthorized"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"Product name.","type":"string","default":null},"description":{"description":"Longer description of the category","type":"string","default":null},"mou":{"description":"Memorandum of Undertsanding","type":"string","default":null},"unit":{"description":"Product unit","type":"string","default":null},"unitprice":{"description":"Price per unit","type":"integer","default":0},"sequence":{"description":"Product order","type":"integer","default":null},"ordercategoryid":{"description":"Category ID","type":"integer","default":null},"recurringtimeperiodid":{"description":"Recurring time period ID","type":"integer","default":0},"restricteddata":{"description":"Restricted data","type":"integer","default":0},"resourceid":{"description":"Resource ID","type":"integer","default":0},"terms":{"description":"Terms","type":"string","default":null}},"required":["name","ordercategoryid"]}}}}}},"\/orders\/products\/{id}":{"get":{"description":"Retrieve an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read"},"404":{"description":"Record not found"}}},"put":{"description":"Update an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"202":{"description":"Successful entry modification"},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"Product name.","type":"string","default":null},"description":{"description":"Longer description of the category","type":"string","default":null},"mou":{"description":"Memorandum of Undertsanding","type":"string","default":null},"unit":{"description":"Product unit","type":"string","default":null},"unitprice":{"description":"Price per unit","type":"integer","default":0},"sequence":{"description":"Product order","type":"integer","default":null},"ordercategoryid":{"description":"Category ID","type":"integer","default":null},"recurringtimeperiodid":{"description":"Recurring time period ID","type":"integer","default":0},"restricteddata":{"description":"Restricted data","type":"integer","default":0},"resourceid":{"description":"Resource ID","type":"integer","default":0},"terms":{"description":"Terms","type":"string","default":null}},"required":[]}}}}},"delete":{"description":"Delete an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/pages":{"get":{"description":"Display a listing of entries","parameters":[{"in":"query","name":"limit","description":"Number of result per page.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":0}},{"in":"query","name":"state","description":"Article state.","required":false,"schema":{"type":"integer","default":"published","enum":["published","unpublished","trashed","all"]}},{"in":"query","name":"access","description":"Article access value.","schema":{"type":"integer","default":1},"required":false},{"in":"query","name":"search","description":"A word or phrase to search for.","schema":{"type":"string","default":null},"required":false},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"title","enum":["id","title","alias","created_at","updated_at"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]}}]},"post":{"description":"Create an entry","parameters":[],"responses":{"201":{"description":"Successful entry creation"},"401":{"description":"Unauthorized"},"422":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"title":{"description":"Title","type":"string","default":null},"slug":{"description":"URL slug","type":"string","default":null},"content":{"description":"Content","type":"string","default":null},"state":{"description":"Published state","type":"integer","default":1},"access":{"description":"Access level","type":"integer","default":1},"publish_up":{"description":"Start publishing (defaults to created time)","type":"string","default":null},"publish_down":{"description":"Stop publishing","type":"string","default":null},"parent_id":{"description":"Parent page ID","type":"integer","default":null}},"required":["title","content"]}}}}}},"\/pages\/{id}":{"get":{"description":"Retrieve an entry","parameters":[{"in":"query","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read"},"404":{"description":"Record not found"}}},"put":{"description":"Update an entry","parameters":[{"in":"query","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"202":{"description":"Successful entry modification"},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"title":{"description":"Title","type":"string","default":null},"slug":{"description":"URL slug","type":"string","default":null},"content":{"description":"Content","type":"string","default":null},"state":{"description":"Published state","type":"integer","default":1},"access":{"description":"Access level","type":"integer","default":1},"publish_up":{"description":"Start publishing (defaults to created time)","type":"string","default":null},"publish_down":{"description":"Stop publishing","type":"string","default":null},"parent_id":{"description":"Parent page ID","type":"integer","default":null}},"required":[]}}}}},"delete":{"description":"Delete an entry","parameters":[{"in":"query","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/publications":{"get":{"description":"Display a listing of entries","parameters":[],"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"client_id":{"description":"Client (admin = 1|site = 0) ID","type":"integer","default":"0"},"search":{"description":"A word or phrase to search for.","type":"string","default":null},"limit":{"description":"Number of result per page.","type":"integer","default":20},"page":{"description":"Number of where to start returning results.","type":"integer","default":1},"order":{"description":"Field to sort results by.","type":"string","default":"published_at"},"order_dir":{"description":"Direction to sort results by.","type":"string","default":"asc"}},"required":[]}}}}},"post":{"description":"Create a new entry","parameters":[],"responses":{"201":{"description":"Successful entry creation","content":{"application\/json":{"example":{"id":2,"title":"Praesent commodo cursus magna, vel scelerisque nisl consectetur et.","type_id":10,"author":"John Smith","editor":null,"url":null,"series":null,"booktitle":null,"edition":null,"chapter":null,"issuetitle":null,"journal":null,"issue":null,"volume":null,"number":null,"pages":null,"publisher":null,"address":null,"institution":null,"organization":null,"school":null,"crossref":null,"isbn":null,"doi":null,"note":null,"state":1,"published_at":"2022-06-01 00:00:00","created_at":"2022-06-20T17:59:21.000000Z","updated_at":"2022-06-20T17:59:21.000000Z","deleted_at":null,"filename":"","tags":["foo","bar"],"api":"https:\/\/example.org\/api\/publications\/2"}}}},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"type_id":{"description":"Type ID","type":"integer","default":0},"title":{"description":"Title","type":"string","default":null},"author":{"description":"Authors","type":"string","default":null},"editor":{"description":"Editors","type":"string","default":null},"url":{"description":"URL","type":"string","default":null},"series":{"description":"Series","type":"string","default":null},"booktitle":{"description":"Book title","type":"string","default":null},"edition":{"description":"Edition","type":"string","default":null},"chapter":{"description":"Chapter","type":"string","default":null},"issuetitle":{"description":"Issue title","type":"string","default":null},"journal":{"description":"Journal","type":"string","default":null},"issue":{"description":"Issue","type":"string","default":null},"volume":{"description":"Volume","type":"string","default":null},"number":{"description":"Number","type":"string","default":null},"pages":{"description":"Pages","type":"string","default":null},"publisher":{"description":"Publisher","type":"string","default":null},"address":{"description":"Address","type":"string","default":null},"institution":{"description":"Institution","type":"string","default":null},"organization":{"description":"Organization","type":"string","default":null},"school":{"description":"School","type":"string","default":null},"crossref":{"description":"Cross-ref","type":"string","default":null},"isbn":{"description":"ISBN","type":"string","default":null},"doi":{"description":"DOI","type":"string","default":null},"note":{"description":"Note","type":"string","default":null},"state":{"description":"State","type":"integer","default":null},"published_at":{"description":"Published at","type":"string","default":null},"tags":{"description":"A list of tags to apply to the entry","type":"array","default":null}},"required":["title"]}}}}}},"\/publications\/{id}":{"get":{"description":"Retrieve an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read","content":{"application\/json":{"example":{"id":2,"title":"Praesent commodo cursus magna, vel scelerisque nisl consectetur et.","type_id":10,"author":"John Smith","editor":null,"url":null,"series":null,"booktitle":null,"edition":null,"chapter":null,"issuetitle":null,"journal":null,"issue":null,"volume":null,"number":null,"pages":null,"publisher":null,"address":null,"institution":null,"organization":null,"school":null,"crossref":null,"isbn":null,"doi":null,"note":null,"state":1,"published_at":"2022-06-01 00:00:00","created_at":"2022-06-20T17:59:21.000000Z","updated_at":"2022-06-20T17:59:21.000000Z","deleted_at":null,"filename":"","tags":["foo","bar"],"api":"https:\/\/example.org\/api\/publications\/2"}}}},"404":{"description":"Record not found"}}},"put":{"description":"Update an entry","parameters":[],"responses":{"202":{"description":"Successful entry modification","content":{"application\/json":{"example":{"id":2,"title":"Praesent commodo cursus magna, vel scelerisque nisl consectetur et.","type_id":10,"author":"John Smith","editor":null,"url":null,"series":null,"booktitle":null,"edition":null,"chapter":null,"issuetitle":null,"journal":null,"issue":null,"volume":null,"number":null,"pages":null,"publisher":null,"address":null,"institution":null,"organization":null,"school":null,"crossref":null,"isbn":null,"doi":null,"note":null,"state":1,"published_at":"2022-06-01 00:00:00","created_at":"2022-06-20T17:59:21.000000Z","updated_at":"2022-06-20T17:59:21.000000Z","deleted_at":null,"filename":"","tags":["foo","bar"],"api":"https:\/\/example.org\/api\/publications\/2"}}}},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"type_id":{"description":"Type ID","type":"integer","default":0},"title":{"description":"Title","type":"string","default":null},"author":{"description":"Authors","type":"string","default":null},"editor":{"description":"Editors","type":"string","default":null},"url":{"description":"URL","type":"string","default":null},"series":{"description":"Series","type":"string","default":null},"booktitle":{"description":"Book title","type":"string","default":null},"edition":{"description":"Edition","type":"string","default":null},"chapter":{"description":"Chapter","type":"string","default":null},"issuetitle":{"description":"Issue title","type":"string","default":null},"journal":{"description":"Journal","type":"string","default":null},"issue":{"description":"Issue","type":"string","default":null},"volume":{"description":"Volume","type":"string","default":null},"number":{"description":"Number","type":"string","default":null},"pages":{"description":"Pages","type":"string","default":null},"publisher":{"description":"Publisher","type":"string","default":null},"address":{"description":"Address","type":"string","default":null},"institution":{"description":"Institution","type":"string","default":null},"organization":{"description":"Organization","type":"string","default":null},"school":{"description":"School","type":"string","default":null},"crossref":{"description":"Cross-ref","type":"string","default":null},"isbn":{"description":"ISBN","type":"string","default":null},"doi":{"description":"DOI","type":"string","default":null},"note":{"description":"Note","type":"string","default":null},"state":{"description":"State","type":"integer","default":null},"published_at":{"description":"Published at","type":"string","default":null},"tags":{"description":"A list of tags to apply to the entry","type":"array","default":null}},"required":["title"]}}}}},"delete":{"description":"Delete an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/publications\/types":{"get":{"description":"Display a listing of entries","parameters":[],"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"search":{"description":"A word or phrase to search for.","type":"string","default":null},"limit":{"description":"Number of result per page.","type":"integer","default":20},"page":{"description":"Number of where to start returning results.","type":"integer","default":1},"order":{"description":"Field to sort results by.","type":"string","default":"name"},"order_dir":{"description":"Direction to sort results by.","type":"string","default":"asc"}},"required":[]}}}}},"post":{"description":"Create a new entry","parameters":[],"responses":{"201":{"description":"Successful entry creation","content":{"application\/json":{"example":{"id":9,"name":"Journal","alias":"journal","api":"https:\/\/example.org\/api\/publications\/types\/9"}}}},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"Name","type":"string","default":null},"alias":{"description":"Alias","type":"string","default":null}},"required":["name"]}}}}}},"\/publications\/types\/{id}":{"get":{"description":"Retrieve an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read","content":{"application\/json":{"example":{"id":9,"name":"Journal","alias":"journal","api":"https:\/\/example.org\/api\/publications\/types\/9"}}}},"404":{"description":"Record not found"}}},"put":{"description":"Update an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"202":{"description":"Successful entry modification","content":{"application\/json":{"example":{"id":9,"name":"Journal","alias":"journal","api":"https:\/\/example.org\/api\/publications\/types\/9"}}}},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"Name","type":"string","default":null},"alias":{"description":"Alias","type":"string","default":null}},"required":[]}}}}},"delete":{"description":"Delete an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/allocations\/{hostname?}":{"get":{"description":"Display a listing of allocations.","parameters":[{"in":"path","name":"hostname","description":"Scheduler hostname.","required":false,"schema":{"type":"string"}},{"in":"query","name":"format","description":"Output format. JSON is the default but output can be formatted to accommodate schedulers such as SLURM.","required":false,"schema":{"type":"string","enum":["json","slurmcfg"]}}]}},"\/allocations":{"post":{"description":"Create an allocation","parameters":[],"responses":{"201":{"description":"Successful entry creation"},"401":{"description":"Unauthorized"},"409":{"description":"Invalid data"}}}},"\/allocations\/{id}":{"put":{"description":"Update an allocation","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"201":{"description":"Successful entry creation"},"401":{"description":"Unauthorized"},"409":{"description":"Invalid data"}}},"delete":{"description":"Delete an allocation","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/queues\/loans":{"get":{"description":"Display a listing of loans for a queue","parameters":[{"in":"query","name":"queueid","description":"ID of the queue the loan whent to","required":false,"schema":{"type":"integer"}},{"in":"query","name":"lenderqueueid","description":"ID of the lender queue","required":false,"schema":{"type":"integer"}},{"in":"query","name":"state","description":"Sate of the loan.","required":false,"schema":{"type":"string","enum":["ended","ongoing"]}},{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","description":"Number of result to return.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"datetimestart","enum":["id","queueid","lenderqueueid","datetimestart","datetimestop"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]}}]},"post":{"description":"Create a queue loan","parameters":[],"responses":{"201":{"description":"Successful entry creation"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"queueid":{"description":"ID of the queue being loaned to","type":"integer","default":null},"lenderqueueid":{"description":"ID of the queue being loaned","type":"integer","default":null},"datetimestart":{"description":"Date\/time of when the loan starts","type":"string","default":null},"datetimestop":{"description":"Date\/time of when the loan stops","type":"string","default":null},"nodecount":{"description":"Node count","type":"integer","default":null},"corecount":{"description":"Core count","type":"integer","default":null},"serviceunits":{"description":"Service units","type":"float","default":null},"comment":{"description":"Comments on this loan","type":"string","default":null}},"required":["queueid","lenderqueueid","datetimestart","nodecount","corecount"]}}}}}},"\/queues\/loans\/{id}":{"get":{"description":"Read a queue loan","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read"},"404":{"description":"Record not found"}}},"put":{"description":"Update a queue loan","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry modification"},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"datetimestart":{"description":"Date\/time of when the loan starts","type":"string","default":null},"datetimestop":{"description":"Date\/time of when the loan stops","type":"string","default":null},"nodecount":{"description":"Node count","type":"integer","default":null},"corecount":{"description":"Core count","type":"integer","default":null},"serviceunits":{"description":"Service units","type":"float","default":null},"comment":{"description":"Comments on this loan","type":"string","default":null}},"required":[]}}}}},"delete":{"description":"Delete a queue loan","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/queues\/qos":{"get":{"description":"Display a listing of QoS","parameters":[{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"hostname","description":"A scheduler hostname","required":false,"schema":{"type":"string"}},{"in":"query","name":"priority","description":"Filter by priority level.","required":false,"schema":{"type":"integer"}},{"in":"query","name":"scheduler_id","description":"Filter by scheduler ID. If unknown, can use hostname.","required":false,"schema":{"type":"integer"}},{"in":"query","name":"format","description":"Output format. JSON is the default but output can be formatted to accommodate schedulers such as SLURM.","required":false,"schema":{"type":"string","enum":["json","slurmcfg"]}},{"in":"query","name":"limit","description":"Number of result to return.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"name","enum":["id","name","schedulerid","datetimestart","datetimestop"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]}}]},"post":{"description":"Create a QoS","parameters":[],"responses":{"201":{"description":"Successful entry creation"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"scheduler_id":{"description":"Associate the QoS to a specific scheduler","type":"integer","default":null},"name":{"description":"Entry name","type":"string","default":null},"description":{"description":"Entry description","type":"string","default":null},"flags":{"description":"Comma-separated list of flags","type":"string","default":null},"max_jobs_pa":{"description":"Max jobs per account","type":"integer","default":null},"max_jobs_per_user":{"description":"Max jobs per user","type":"integer","default":null},"max_jobs_accrue_pa":{"description":"Max jobs accrueable per account","type":"integer","default":null},"max_jobs_accrue_pu":{"description":"Max jobs accrueable per user","type":"integer","default":null},"max_submit_jobs_pa":{"description":"Max jobs submittable per account","type":"integer","default":null},"max_submit_jobs_per_user":{"description":"Max jobs submittable per user","type":"integer","default":null},"max_tres_pj":{"description":"Max TRES per job","type":"string","default":null},"max_tres_pn":{"description":"Max TRES per node","type":"string","default":null},"max_tres_pu":{"description":"Max TRES per user","type":"string","default":null},"max_tres_pa":{"description":"Max TRES per account","type":"string","default":null},"max_tres_mins_pj":{"description":"Max TRES minutes per job","type":"integer","default":null},"max_tres_run_mins_pa":{"description":"Max TRES run minutes per account","type":"integer","default":null},"max_tres_run_mins_pu":{"description":"Max TRES run minutes per user","type":"integer","default":null},"min_tres_pj":{"description":"Minimum TRES per job","type":"string","default":null},"max_wall_duration_per_job":{"description":"Max wall duration per job","type":"integer","default":null},"grp_jobs":{"description":"Group jobs","type":"integer","default":null},"grp_jobs_accrue":{"description":"Accrueable Group jobs","type":"integer","default":null},"grp_submit_jobs":{"description":"Group submit jobs","type":"integer","default":null},"grp_tres":{"description":"Group TRES","type":"string","default":null},"grp_tres_mins":{"description":"Group TRES minutes","type":"integer","default":null},"grp_tres_run_mins":{"description":"Group TRES run minutes","type":"integer","default":null},"grp_wall":{"description":"Group walltime in minutes","type":"integer","default":null},"preempt":{"description":"Preempt","type":"string","default":null},"preempt_mode":{"description":"Preempt mode","type":"integer","default":null},"preempt_exempt_time":{"description":"Preempt exempt time (in minutes)","type":"integer","default":null},"priority":{"description":"The act of 'stopping' one or more 'low-priority' jobs to let a 'high-priority' job run.","type":"integer","default":null},"usage_factor":{"description":"Usage factor","type":"string","default":null},"usage_thres":{"description":"Usage threshold","type":"string","default":null},"limit_factor":{"description":"Limit factor","type":"string","default":null},"grace_time":{"description":"Grace time in minutes","type":"integer","default":null}},"required":["scheduler_id","name"]}}}}}},"\/queues\/qos\/{id}":{"get":{"description":"Read a QoS","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read"},"404":{"description":"Record not found"}}},"put":{"description":"Update a QoS","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry modification"},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"scheduler_id":{"description":"Associate the QoS to a specific scheduler","type":"integer","default":null},"name":{"description":"Entry name","type":"string","default":null},"description":{"description":"Entry description","type":"string","default":null},"flags":{"description":"Comma-separated list of flags","type":"string","default":null},"max_jobs_pa":{"description":"Max jobs per account","type":"integer","default":null},"max_jobs_per_user":{"description":"Max jobs per user","type":"integer","default":null},"max_jobs_accrue_pa":{"description":"Max jobs accrueable per account","type":"integer","default":null},"max_jobs_accrue_pu":{"description":"Max jobs accrueable per user","type":"integer","default":null},"max_submit_jobs_pa":{"description":"Max jobs submittable per account","type":"integer","default":null},"max_submit_jobs_per_user":{"description":"Max jobs submittable per user","type":"integer","default":null},"max_tres_pj":{"description":"Max TRES per job","type":"string","default":null},"max_tres_pn":{"description":"Max TRES per node","type":"string","default":null},"max_tres_pu":{"description":"Max TRES per user","type":"string","default":null},"max_tres_pa":{"description":"Max TRES per account","type":"string","default":null},"max_tres_mins_pj":{"description":"Max TRES minutes per job","type":"integer","default":null},"max_tres_run_mins_pa":{"description":"Max TRES run minutes per account","type":"integer","default":null},"max_tres_run_mins_pu":{"description":"Max TRES run minutes per user","type":"integer","default":null},"min_tres_pj":{"description":"Minimum TRES per job","type":"string","default":null},"max_wall_duration_per_job":{"description":"Max wall duration per job","type":"integer","default":null},"grp_jobs":{"description":"Group jobs","type":"integer","default":null},"grp_jobs_accrue":{"description":"Accrueable Group jobs","type":"integer","default":null},"grp_submit_jobs":{"description":"Group submit jobs","type":"integer","default":null},"grp_tres":{"description":"Group TRES","type":"string","default":null},"grp_tres_mins":{"description":"Group TRES minutes","type":"integer","default":null},"grp_tres_run_mins":{"description":"Group TRES run minutes","type":"integer","default":null},"grp_wall":{"description":"Group walltime in minutes","type":"integer","default":null},"preempt":{"description":"Preempt","type":"string","default":null},"preempt_mode":{"description":"Preempt mode","type":"integer","default":null},"preempt_exempt_time":{"description":"Preempt exempt time (in minutes)","type":"integer","default":null},"priority":{"description":"The act of 'stopping' one or more 'low-priority' jobs to let a 'high-priority' job run.","type":"integer","default":null},"usage_factor":{"description":"Usage factor","type":"string","default":null},"usage_thres":{"description":"Usage threshold","type":"string","default":null},"limit_factor":{"description":"Limit factor","type":"string","default":null},"grace_time":{"description":"Grace time in minutes","type":"integer","default":null}},"required":[]}}}}},"delete":{"description":"Delete a QoS","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/queues":{"get":{"description":"Display a listing of the queue.","parameters":[{"in":"query","name":"expand","description":"Comma-separated list of associated objects, such as group and resource, to include. Members, purchases, and loans are always included.","required":false,"schema":{"type":"string","default":"subresource","enum":["all","group","resource","subresource","schedulerpolicy","scheduler"]}},{"in":"query","name":"state","description":"Queue state.","required":false,"schema":{"type":"string","default":"enabled","enum":["enabled","active","disabled","trashed"]}},{"in":"query","name":"type","description":"Queue type ID.","required":false,"schema":{"type":"integer","default":0}},{"in":"query","name":"scheduler","description":"Scheduler type ID.","required":false,"schema":{"type":"integer","default":0}},{"in":"query","name":"resource","description":"Resource ID.","required":false,"schema":{"type":"integer","default":0}},{"in":"query","name":"subresource","description":"Subresource ID.","required":false,"schema":{"type":"integer","default":0}},{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","description":"Number of result to return.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"datetimecreated","enum":["id","name","datetimecreated","datetimeremoved","queuetype","schedulerid","subresourceid","schedulerpolicyid","cluster"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"desc","enum":["asc","desc"]}}]},"post":{"description":"Create a queue","parameters":[],"responses":{"201":{"description":"Successful entry creation"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"schedulerid":{"description":"Scheduler ID","type":"integer","default":null},"subresourceid":{"description":"Subresource ID","type":"integer","default":null},"name":{"description":"The name of the queue","type":"string","default":null},"groupid":{"description":"Group ID","type":"integer","default":null},"queuetype":{"description":"Queue type","type":"integer","default":null},"automatic":{"description":"Automatic","type":"integer","default":null},"free":{"description":"Free","type":"integer","default":null},"schedulerpolicyid":{"description":"Scheduler Policy ID","type":"integer","default":null},"enabled":{"description":"Enabled","type":"integer","default":null},"started":{"description":"Started","type":"integer","default":null},"reservation":{"description":"Reservation","type":"integer","default":null},"cluster":{"description":"Cluster","type":"string","default":null},"priority":{"description":"Priority","type":"integer","default":null},"defaultwalltime":{"description":"Default walltime","type":"integer","default":null},"maxjobsqueued":{"description":"Max Jobs Queued","type":"integer","default":null},"maxjobsqueueduser":{"description":"Max Jobs Queued User","type":"integer","default":null},"maxjobsrun":{"description":"Max Jobs Run","type":"integer","default":null},"maxjobsrunuser":{"description":"Max Jobs Run User","type":"integer","default":null},"maxjobscore":{"description":"Max Jobs Core","type":"integer","default":null},"nodecoresdefault":{"description":"Default nodes core","type":"integer","default":null},"nodecoresmin":{"description":"Nodes core min","type":"integer","default":null},"nodecoresmax":{"description":"Nodes core max","type":"integer","default":null},"nodememmin":{"description":"Node memory max","type":"string","default":null},"aclusersenabled":{"description":"ACL Users enabled","type":"integer","default":null},"aclgroups":{"description":"Comma-separated list of ACL Groups","type":"string","default":null},"maxijobfactor":{"description":"Max ijob factor","type":"integer","default":null},"maxijobuserfactor":{"description":"Max ijob user factor","type":"integer","default":null},"shared":{"description":"Shared qeue","type":"integer","default":0}},"required":["name"]}}}}}},"\/queues\/{id}":{"get":{"description":"Read a queue","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}},{"in":"query","name":"expand","description":"Comma-separated list of associated objects, such as group and resource, to include. Members, purchases, and loans are always included.","required":false,"schema":{"type":"string","default":"subresource","enum":["all","group","resource","subresource","schedulerpolicy","scheduler"]}}],"responses":{"200":{"description":"Successful entry read"},"404":{"description":"Record not found"}}},"put":{"description":"Update a queue","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry modification"},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"schedulerid":{"description":"Scheduler ID","type":"integer","default":null},"subresourceid":{"description":"Subresource ID","type":"integer","default":null},"name":{"description":"The name of the queue","type":"string","default":null},"groupid":{"description":"Group ID","type":"integer","default":null},"queuetype":{"description":"Queue type","type":"integer","default":null},"automatic":{"description":"Automatic","type":"integer","default":null},"free":{"description":"Free","type":"integer","default":null},"schedulerpolicyid":{"description":"Scheduler Policy ID","type":"integer","default":null},"enabled":{"description":"Enabled","type":"integer","default":null},"started":{"description":"Started","type":"integer","default":null},"reservation":{"description":"Reservation","type":"integer","default":null},"cluster":{"description":"Cluster","type":"string","default":null},"priority":{"description":"Priority","type":"integer","default":null},"defaultwalltime":{"description":"Default walltime","type":"integer","default":null},"maxjobsqueued":{"description":"Max Jobs Queued","type":"integer","default":null},"maxjobsqueueduser":{"description":"Max Jobs Queued User","type":"integer","default":null},"maxjobsrun":{"description":"Max Jobs Run","type":"integer","default":null},"maxjobsrunuser":{"description":"Max Jobs Run User","type":"integer","default":null},"maxjobscore":{"description":"Max Jobs Core","type":"integer","default":null},"nodecoresdefault":{"description":"Default nodes core","type":"integer","default":null},"nodecoresmin":{"description":"Nodes core min","type":"integer","default":null},"nodecoresmax":{"description":"Nodes core max","type":"integer","default":null},"nodememmin":{"description":"Node memory max","type":"string","default":null},"aclusersenabled":{"description":"ACL Users enabled","type":"integer","default":null},"aclgroups":{"description":"Comma-separated list of ACL Groups","type":"string","default":null},"maxijobfactor":{"description":"Max ijob factor","type":"integer","default":null},"maxijobuserfactor":{"description":"Max ijob user factor","type":"integer","default":null},"shared":{"description":"Shared qeue","type":"integer","default":0}},"required":[]}}}}},"delete":{"description":"Delete a queue","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/queues\/schedulerpolicies":{"get":{"description":"Display a listing of queue schedulers","parameters":[{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","description":"Number of result to return.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"name","enum":["id","name","code"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"desc","enum":["asc","desc"]}}]},"post":{"description":"Create a queue scheduler policy","parameters":[],"responses":{"201":{"description":"Successful entry creation"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"The policy name","type":"string","default":null},"code":{"description":"Short name","type":"string","default":null}},"required":["name"]}}}}}},"\/queues\/schedulerpolicies\/{id}":{"get":{"description":"Read a queue scheduler policy","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read"},"404":{"description":"Record not found"}}},"put":{"description":"Update a queue scheduler policy","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry modification"},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"The policy name","type":"string","default":null},"code":{"description":"Short name","type":"string","default":null}},"required":[]}}}}},"delete":{"description":"Delete a queue scheduler policy","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/queues\/schedulerreservations":{"get":{"description":"Display a listing of queue scheduler reservations","parameters":[{"in":"query","name":"scheduler","description":"Scheduler ID to filter by.","required":false,"schema":{"type":"integer"}},{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","description":"Number of result to return.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"name","enum":["id","name","schedulerid","datetimestart","datetimestop"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]}}]},"post":{"description":"Create a queue scheduler reservation","parameters":[],"responses":{"201":{"description":"Successful entry creation"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"schedulerid":{"description":"Scheduler ID","type":"integer","default":null},"name":{"description":"Entry name","type":"string","default":null},"nodes":{"description":"Comma-separated list of node names","type":"string","default":null},"datetimestart":{"description":"Date\/time of when the reservation starts","type":"string","default":null},"datetimestop":{"description":"Date\/time of when the reservation stops","type":"string","default":null}},"required":["name","datetimestart"]}}}}}},"\/queues\/schedulerreservations\/{id}":{"get":{"description":"Read a queue scheduler reservation","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read"},"404":{"description":"Record not found"}}},"put":{"description":"Update a queue scheduler policy","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry modification"},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"schedulerid":{"description":"Scheduler ID","type":"integer","default":null},"name":{"description":"Entry name","type":"string","default":null},"nodes":{"description":"Comma-separated list of node names","type":"string","default":null},"datetimestart":{"description":"Date\/time of when the reservation starts","type":"string","default":null},"datetimestop":{"description":"Date\/time of when the reservation stops","type":"string","default":null}},"required":[]}}}}},"delete":{"description":"Delete a queue scheduler reservation","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/queues\/schedulers":{"get":{"description":"Display a listing of queue schedulers","parameters":[{"in":"query","name":"queuesubresourceid","description":"Filter by queue subresource ID","required":false,"schema":{"type":"integer"}},{"in":"query","name":"batchsystem","description":"Filter by batchsystem ID","required":false,"schema":{"type":"integer"}},{"in":"query","name":"schedulerpolicyid","description":"Filter by scheduler policy ID","required":false,"schema":{"type":"integer"}},{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","description":"Number of result to return.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"id","enum":["id","queuesubresourceid","hostname","batchsystem","schedulerpolicyid","datetimecreated","datetimeremoved"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]}}]},"post":{"description":"Create a scheduler","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"201":{"description":"Successful entry creation"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"queuesubresourceid":{"description":"Queue subresource ID","type":"integer","default":null},"hostname":{"description":"Hostname","type":"string","default":null},"batchsystem":{"description":"Batchsystem ID","type":"integer","default":null},"schedulerpolocyid":{"description":"Scheduler Policy ID","type":"integer","default":null},"defaultmaxwalltime":{"description":"Default max wall time","type":"integer","default":null},"datetimedraindown":{"description":"Drain timestamp","type":"string","default":null}},"required":["queuesubresourceid","hostname","defaultmaxwalltime"]}}}}}},"\/queues\/schedulers\/{id}":{"get":{"description":"Read a scheduler","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read"},"404":{"description":"Record not found"}}},"put":{"description":"Update a scheduler","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry modification"},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"queuesubresourceid":{"description":"Queue subresource ID","type":"integer","default":null},"hostname":{"description":"Hostname","type":"string","default":null},"batchsystem":{"description":"Batchsystem ID","type":"integer","default":null},"schedulerpolocyid":{"description":"Scheduler Policy ID","type":"integer","default":null},"defaultmaxwalltime":{"description":"Default max wall time in seconds","type":"integer","default":null},"datetimedraindown":{"description":"Drain timestamp","type":"string","default":null},"datetimelastimportstart":{"description":"Last import started timestamp","type":"string","default":null},"datetimelastimportstop":{"description":"Last import finished timestamp","type":"string","default":null}},"required":[]}}}}},"delete":{"description":"Delete a scheduler","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/queues\/sizes":{"get":{"description":"Display a listing of queue sizes","parameters":[{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","description":"Number of result to return.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"datetimestart","enum":["id","queueid","sellerqueueid","datetimestart","datetimestop"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]}}]},"post":{"description":"Create a queue size","parameters":[],"responses":{"201":{"description":"Successful entry creation"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"queueid":{"description":"ID of the queue being sold to","type":"integer","default":null},"sellerqueueid":{"description":"ID of the seller queue","type":"integer","default":null},"datetimestart":{"description":"Date\/time of when the loan starts","type":"string","default":null},"datetimestop":{"description":"Date\/time of when the loan stops","type":"string","default":null},"nodecount":{"description":"Node count","type":"integer","default":null},"corecount":{"description":"Core count","type":"integer","default":null},"comment":{"description":"Comment","type":"string","default":null},"serviceunits":{"description":"Service units","type":"float","default":null}},"required":["queueid","sellerqueueid","datetimestart","nodecount","corecount"]}}}}}},"\/queues\/sizes\/{id}":{"get":{"description":"Read a queue size","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read"},"404":{"description":"Record not found"}}},"put":{"description":"Update a queue size","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry modification"},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"queueid":{"description":"ID of the queue being sold to","type":"integer","default":null},"sellerqueueid":{"description":"ID of the seller queue","type":"integer","default":null},"datetimestart":{"description":"Date\/time of when the loan starts","type":"string","default":null},"datetimestop":{"description":"Date\/time of when the loan stops","type":"string","default":null},"nodecount":{"description":"Node count","type":"integer","default":null},"corecount":{"description":"Core count","type":"integer","default":null},"comment":{"description":"Comment","type":"string","default":null},"serviceunits":{"description":"Service units","type":"float","default":null}},"required":[]}}}}},"delete":{"description":"Delete a queue size","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/queues\/types":{"get":{"description":"Display a listing of queue types.","parameters":{"1":{"in":"query","name":"limit","description":"Number of result to return.","required":false,"schema":{"type":"integer","default":20}},"2":{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},"3":{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"datetimestart","enum":["id","name"]}},"4":{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]}}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"search":{"description":"A word or phrase to search for.","type":"string","default":null}},"required":[]}}}}},"post":{"description":"Create a queue type","parameters":[],"responses":{"201":{"description":"Successful entry creation"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"The name of the queue type","type":"string","default":null}},"required":["name"]}}}}}},"\/queues\/types\/{id}":{"get":{"description":"Read a queue type","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read"},"404":{"description":"Record not found"}}},"put":{"description":"Update a queue type","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry modification"},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"The name of the queue type","type":"string","default":null}},"required":["name"]}}}}},"delete":{"description":"Delete a queue type","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/queues\/requests":{"get":{"description":"Display a listing of entries","parameters":[{"in":"query","name":"userid","description":"User ID","required":false,"schema":{"type":"integer"}},{"in":"query","name":"queueid","description":"Queue ID","required":false,"schema":{"type":"integer"}},{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","description":"Number of result to return.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"datetimecreated","enum":["id","userid","datetimecreated"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"desc","enum":["asc","desc"]}}]},"post":{"description":"Create a new entry","parameters":[],"responses":{"201":{"description":"Successful entry creation"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"userid":{"description":"User ID","type":"integer","default":null},"comment":{"description":"Comment","type":"string","default":null},"queues":{"description":"Queues requesting access to","type":"array","default":null},"resources":{"description":"Resources requesting access to","type":"array","default":null},"group":{"description":"Group requesting access to","type":"integer","default":null}},"required":["userid"]}}}}}},"\/queues\/requests\/{id}":{"get":{"description":"Retrieve an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read"},"404":{"description":"Record not found"}}},"put":{"description":"Update an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry modification"},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"userid":{"description":"User ID","type":"integer","default":null},"comment":{"description":"Comment","type":"string","default":null}},"required":[]}}}}},"delete":{"description":"Delete an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/queues\/users":{"get":{"description":"Display a listing of queue users.","parameters":[{"in":"query","name":"queueid","description":"A queue ID to filter by.","required":false,"schema":{"type":"integer"}},{"in":"query","name":"userid","description":"A user ID to filter by.","required":false,"schema":{"type":"integer"}},{"in":"query","name":"membertype","description":"A member type ID to filter by.","required":false,"schema":{"type":"integer"}},{"in":"query","name":"notice","description":"A notice state to filter by.","required":false,"schema":{"type":"integer"}},{"in":"query","name":"limit","description":"Number of result to return.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"datetimecreated","enum":["id","userid","queueid","membertype","datetimecreated","datetimeremoved","notice"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]}}]},"post":{"description":"Create a queue user","parameters":[],"responses":{"201":{"description":"Successful entry creation"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"queueid":{"description":"Queue ID","type":"integer","default":null},"userid":{"description":"User ID","type":"integer","default":null},"userrequestid":{"description":"User Request ID","type":"integer","default":null},"membertype":{"description":"Member type ID","type":"integer","default":1}},"required":["queueid","userid"]}}}}}},"\/queues\/users\/{id}":{"get":{"description":"Read a queue user","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read"},"404":{"description":"Record not found"}}},"put":{"description":"Update a queue user","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry modification"},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"queueid":{"description":"Queue ID","type":"integer","default":null},"userid":{"description":"User ID","type":"integer","default":null},"userrequestid":{"description":"User Request ID","type":"integer","default":null},"membertype":{"description":"Member type ID","type":"integer","default":1},"datetimelastseen":{"description":"The datetime the user was last seen","type":"string","default":null},"notice":{"description":"The notice state","type":"integer","default":null}},"required":["queueid","userid"]}}}}},"delete":{"description":"Delete a queue user","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/queues\/walltimes":{"get":{"description":"Display a listing of queue walltimes.","parameters":[{"in":"query","name":"queueid","description":"Queue ID to filter by","required":false,"schema":{"type":"integer"}},{"in":"query","name":"datetimestart","description":"Items that start after this date","required":false,"schema":{"type":"string","format":"date-time","example":"2021-01-30T08:30:00Z"}},{"in":"query","name":"datetimestop","description":"Items that stop before this date","required":false,"schema":{"type":"string","format":"date-time","example":"2021-01-30T08:30:00Z"}},{"in":"query","name":"limit","description":"Number of result to return.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"id","enum":["id","queueid","datetimestart","datetimestop","walltime"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]}}]},"post":{"description":"Create a queue walltime","parameters":[],"responses":{"201":{"description":"Successful entry creation"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"queueid":{"description":"The ID of owning queue","type":"integer","default":null},"datetimestart":{"description":"The start time","type":"string","default":"Now"},"datetimestop":{"description":"The stop time","type":"string","default":null},"walltime":{"description":"Walltime in seconds","type":"integer","default":null}},"required":["queueid","walltime"]}}}}}},"\/queues\/walltimes\/{id}":{"get":{"description":"Read a queue walltime","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read"},"404":{"description":"Record not found"}}},"put":{"description":"Update a queue walltime","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry modification"},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"datetimestart":{"description":"The start time","type":"string","default":null},"datetimestop":{"description":"The stop time","type":"string","default":null},"walltime":{"description":"Walltime in seconds","type":"integer","default":null}},"required":[]}}}}},"delete":{"description":"Delete a queue walltime","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/resources\/batchsystems":{"get":{"description":"Display a listing of batchsystems.","parameters":[{"in":"query","name":"limit","description":"Number of result to return.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"name","enum":["id","name"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"desc","enum":["asc","desc"]}}]},"post":{"description":"Create a batchsystem","parameters":[],"responses":{"201":{"description":"Successful entry creation"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"The name of the batch system","type":"string","default":null}},"required":[]}}}}}},"\/resources\/batchsystems\/{id}":{"get":{"description":"Read a batchsystem","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read"},"404":{"description":"Record not found"}}},"put":{"description":"Update a batchsystem","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry modification"},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"The name of the batch system","type":"string","default":null}},"required":[]}}}}},"delete":{"description":"Delete a batchsystem","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/resources\/members\/{id}":{"get":{"description":"Retrieve list of active users for a resource","parameters":[{"in":"path","name":"id","description":"Resource ID","required":true,"schema":{"type":"integer","example":"99"}},{"in":"query","name":"membertype","description":"Filter by group member type","required":false,"schema":{"type":"string","default":null,"enum":["2","manager"]}},{"in":"query","name":"datecreated","description":"Filter for records created after the specified date","required":false,"schema":{"type":"string","default":null,"format":"date-time","example":"2021-01-30T08:30:00Z"}}],"responses":{"200":{"description":"Successful entry read"},"404":{"description":"Record not found"}}}},"\/resources\/members":{"post":{"description":"Create a resource member association","parameters":[],"responses":{"201":{"description":"Successful entry creation"},"403":{"description":"Forbidden"},"404":{"description":"User or Resource record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"user":{"description":"User ID","type":"integer","default":null},"resource":{"description":"Resource ID","type":"integer","default":null},"loginShell":{"description":"Login shell","type":"string","default":null},"pilogin":{"description":"PI's username","type":"string","default":null},"piid":{"description":"PI's user ID","type":"integer","default":null}},"required":["user","resource"]}}}}}},"\/resources\/members\/{user id}.{resource id}":{"get":{"description":"Read a resource member status","parameters":[{"in":"path","name":"user id.resource id","description":"User ID and Resource ID separated by a period","required":true,"schema":{"type":"string","example":"12345.67"}}],"responses":{"200":{"description":"Successful entry read"},"403":{"description":"Forbidden"},"404":{"description":"Record not found"},"415":{"description":"Missing or invalid ID format"}}},"delete":{"description":"Delete a member\/resource association","parameters":[{"in":"path","name":"user id.resource id","description":"User ID and Resource ID separated by a period","required":true,"schema":{"type":"string","example":"12345.67"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"},"403":{"description":"Forbidden"},"412":{"description":"User is still a member of one or more queues for the resource"},"415":{"description":"Missing or invalid ID format"}}}},"\/resources":{"get":{"description":"Display a listing of the resource.","parameters":[{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"type","description":"Filter by resource type ID","required":false,"schema":{"type":"integer"}},{"in":"query","name":"state","description":"Filter by state","required":false,"schema":{"type":"string","default":"active","enum":["active","inactive","all"]}},{"in":"query","name":"limit","description":"Number of result to return.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"name","enum":["id","name","datetimecreated","datetimeremoved","parentid"]}},{"in":"query","name":"order_dir","description":"Direction to order results by.","type":"string","required":false,"default":"desc","schema":{"type":"string","default":"asc","enum":["asc","desc"]}}]},"post":{"description":"Create a resource","parameters":[],"responses":{"201":{"description":"Successful entry creation"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"The name of the resource type","type":"string","default":null},"parentid":{"description":"Parent resource ID","type":"integer","default":0},"resourcetype":{"description":"Resource type ID","type":"integer","default":null},"producttype":{"description":"Product type ID","type":"integer","default":0},"rolename":{"description":"An alias containing only alpha-numeric characters, dashes, and underscores","type":"string","default":null},"listname":{"description":"An alias containing only alpha-numeric characters, dashes, and underscores","type":"string","default":null},"description":{"description":"A short description of the resource","type":"string","default":null}},"required":["name","resourcetype"]}}}}}},"\/resources\/{id}":{"get":{"description":"Read a resource","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}]},"put":{"description":"Update a resource","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry modification"},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"The name of the resource type","type":"string","default":null},"parentid":{"description":"Parent resource ID","type":"integer","default":null},"resourcetype":{"description":"Resource type ID","type":"integer","default":null},"producttype":{"description":"Product type ID","type":"integer","default":null},"rolename":{"description":"An alias containing only alpha-numeric characters, dashes, and underscores","type":"string","default":null},"listname":{"description":"An alias containing only alpha-numeric characters, dashes, and underscores","type":"string","default":null},"description":{"description":"A short description of the resource","type":"string","default":null}},"required":[]}}}}},"delete":{"description":"Delete a resource","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/resources\/subresources\/":{"get":{"description":"Display a listing of the resource.","parameters":[{"in":"query","name":"state","description":"Filter by state","required":false,"schema":{"type":"string","default":"active","enum":["active","trashed","all"]}},{"in":"query","name":"resource","description":"Filter by resource ID","required":false,"schema":{"type":"integer"}},{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","description":"Number of result to return.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"name","enum":["id","name","datetimecreated","datetimeremoved","parentid"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"desc","enum":["asc","desc"]}}]},"post":{"description":"Create a resource","parameters":[],"responses":{"201":{"description":"Successful entry creation"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"resourceid":{"description":"ID of the parent resource","type":"integer","default":null},"name":{"description":"The name of the sub-resource","type":"string","default":null},"cluster":{"description":"Cluster name","type":"string","default":null},"nodecores":{"description":"Number of node cores","type":"integer","default":0},"nodemem":{"description":"Memory per node","type":"string","default":null},"nodegpus":{"description":"Number of GPUs per node","type":"integer","default":0},"nodeattributes":{"description":"Node attributes","type":"string","default":null},"description":{"description":"Short description of the sub-resource","type":"string","default":null},"notice":{"description":"Notification status","type":"integer","default":0},"queuestatus":{"description":"Queue status","type":"integer","default":null}},"required":["resourceid","name","cluster"]}}}}}},"\/resources\/subresources\/{id}":{"get":{"description":"Read a resource","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read"},"404":{"description":"Record not found"}}},"put":{"description":"Update a resource","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry modification"},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"The name of the sub-resource","type":"string","default":null},"cluster":{"description":"Cluster name","type":"string","default":null},"nodecores":{"description":"Number of node cores","type":"integer","default":null},"nodemem":{"description":"Memory per node","type":"string","default":null},"nodegpus":{"description":"Number of GPUs per node","type":"integer","default":null},"nodeattributes":{"description":"Node attributes","type":"string","default":null},"description":{"description":"Short description of the sub-resource","type":"string","default":null},"notice":{"description":"Notification status","type":"integer","default":null},"queuestatus":{"description":"Queue status","type":"integer","default":null}},"required":[]}}}}},"delete":{"description":"Delete a resource","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/resources\/types":{"get":{"description":"Display a listing of resource types.","parameters":[{"in":"query","name":"limit","description":"Number of result to return.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"name","enum":["id","name","description"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"desc","enum":["asc","desc"]}}]},"post":{"description":"Create a resource type","parameters":[],"responses":{"201":{"description":"Successful entry creation","content":{"application\/json":{"example":{"id":1,"name":"New type","resources_count":0,"api":"https:\/\/yourhost\/api\/resources\/types\/1"}}}},"401":{"description":"Unauthorized"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"The name of the resource type","type":"string","default":null},"description":{"description":"A short description of the resource type","type":"string","default":null},"facets":{"description":"A list of facet fields","type":"array","default":null}},"required":["name"]}}}}}},"\/resources\/types\/{id}":{"get":{"description":"Read a resource type","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read","content":{"application\/json":{"example":{"id":1,"name":"Compute","resources_count":34,"api":"https:\/\/yourhost\/api\/resources\/types\/1"}}}},"404":{"description":"Record not found"}}},"put":{"description":"Update a resource type","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"202":{"description":"Successful entry modification","content":{"application\/json":{"example":{"id":1,"name":"Updated type","resources_count":34,"api":"https:\/\/yourhost\/api\/resources\/types\/1"}}}},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"The name of the resource type","type":"string","default":null},"description":{"description":"A short description of the resource type","type":"string","default":null},"facets":{"description":"A list of facet fields","type":"array","default":null}},"required":["name"]}}}}},"delete":{"description":"Delete a resource type","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/search":{"get":{"description":"Display a listing of articles","parameters":[{"in":"query","name":"search","description":"A word or phrase to search for in feedback comments.","required":false,"schema":{"type":"string","default":""}},{"in":"query","name":"limit","description":"Number of result per page.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"created_at","enum":["id","created_at","ip","user_id","target_id","type"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]}}]}},"\/software":{"get":{"description":"Display a listing of entries","parameters":[],"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"type_id":{"description":"Filter by application type ID","type":"integer","default":"0"},"resource_id":{"description":"Filter by resource ID","type":"integer","default":"0"},"state":{"description":"Filter by state, if permissions allow. Otherwise, only accepted value is published.","type":"string","default":"published"},"search":{"description":"A word or phrase to search for.","type":"string","default":null},"limit":{"description":"Number of result per page.","type":"integer","default":20},"page":{"description":"Number of where to start returning results.","type":"integer","default":1},"order":{"description":"Field to sort results by.","type":"string","default":"published_at"},"order_dir":{"description":"Direction to sort results by.","type":"string","default":"asc"}},"required":[]}}}}},"post":{"description":"Create a new entry","parameters":[],"responses":{"201":{"description":"Successful entry creation","content":{"application\/json":{"example":{"id":2,"alias":"gcc","title":"GCC","description":"GCC compiler","content":"<p>Detailed info here.<\/p>","type_id":1,"created_at":"2023-09-20 14:23:01","updated_at":null,"deleted_at":null,"api":"https:\/\/example.org\/api\/software\/2"}}}},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"type_id":{"description":"Type ID","type":"integer","default":0},"title":{"description":"Title","type":"string","default":null},"alias":{"description":"Alias","type":"string","default":null},"description":{"description":"Short description","type":"string","default":null},"content":{"description":"Detailed info","type":"string","default":null}},"required":["type_id","title"]}}}}}},"\/software\/{id}":{"get":{"description":"Retrieve an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read","content":{"application\/json":{"example":{"id":2,"alias":"gcc","title":"GCC","description":"GCC compiler","content":"<p>Detailed info here.<\/p>","type_id":1,"created_at":"2023-09-20 14:23:01","updated_at":null,"deleted_at":null,"api":"https:\/\/example.org\/api\/software\/2"}}}},"404":{"description":"Record not found"}}},"put":{"description":"Update an entry","parameters":[],"responses":{"202":{"description":"Successful entry modification","content":{"application\/json":{"example":{"id":2,"alias":"gcc","title":"GCC","description":"GCC compiler","content":"<p>Detailed info here.<\/p>","type_id":1,"created_at":"2023-09-20 14:23:01","updated_at":null,"deleted_at":null,"api":"https:\/\/example.org\/api\/software\/2"}}}},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"type_id":{"description":"Type ID","type":"integer","default":0},"title":{"description":"Title","type":"string","default":null},"alias":{"description":"Alias","type":"string","default":null},"description":{"description":"Short description","type":"string","default":null},"content":{"description":"Detailed info","type":"string","default":null}},"required":[]}}}}},"delete":{"description":"Delete an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/software\/types":{"get":{"description":"Display a listing of entries","parameters":[],"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"search":{"description":"A word or phrase to search for.","type":"string","default":null},"limit":{"description":"Number of result per page.","type":"integer","default":20},"page":{"description":"Number of where to start returning results.","type":"integer","default":1},"order":{"description":"Field to sort results by.","type":"string","default":"name"},"order_dir":{"description":"Direction to sort results by.","type":"string","default":"asc"}},"required":[]}}}}},"post":{"description":"Create a new entry","parameters":[],"responses":{"201":{"description":"Successful entry creation","content":{"application\/json":{"example":{"id":9,"title":"Journal","alias":"journal","api":"https:\/\/example.org\/api\/software\/types\/9"}}}},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"title":{"description":"Title","type":"string","default":null},"alias":{"description":"Alias","type":"string","default":null}},"required":["title"]}}}}}},"\/software\/types\/{id}":{"get":{"description":"Retrieve an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read","content":{"application\/json":{"example":{"id":9,"title":"Journal","alias":"journal","api":"https:\/\/example.org\/api\/software\/types\/9"}}}},"404":{"description":"Record not found"}}},"put":{"description":"Update an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"202":{"description":"Successful entry modification","content":{"application\/json":{"example":{"id":9,"name":"Journal","alias":"journal","api":"https:\/\/example.org\/api\/software\/types\/9"}}}},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"title":{"description":"Title","type":"string","default":null},"alias":{"description":"Alias","type":"string","default":null}},"required":[]}}}}},"delete":{"description":"Delete an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/storage\/directories":{"get":{"description":"Display a listing of the resource.","parameters":[{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"resourceid","description":"ID of the resource to filter by.","required":false,"schema":{"type":"integer"}},{"in":"query","name":"storageresourceid","description":"ID of the storage resource to filter by.","required":false,"schema":{"type":"integer"}},{"in":"query","name":"groupid","description":"ID of the group to filter by.","required":false,"schema":{"type":"integer"}},{"in":"query","name":"parentstoragedirid","description":"ID of the parent directory to filter by.","required":false,"schema":{"type":"integer"}},{"in":"query","name":"state","description":"State of entries to retrieve.","required":false,"schema":{"type":"string","default":"active","enum":["*","active","inactive"]}},{"in":"query","name":"quota","description":"Filter by if a quota is set on the directory","required":false,"schema":{"type":"string","default":null,"enum":["true","false"]}},{"in":"query","name":"limit","description":"Number of result per page.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"path","enum":["id","resourceid","groupid","parentstoragedirid","name","path","datetimecreated","datetimeremoved","bytes"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]}}]},"post":{"description":"Create an entry","parameters":[],"responses":{"201":{"description":"Successful entry creation"},"401":{"description":"Unauthorized"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"Directory name","type":"string","default":null},"resourceid":{"description":"Resource id","type":"integer","default":null},"groupid":{"description":"Group id","type":"integer","default":null},"bytes":{"description":"Byes","type":"string","default":null},"parentstorageid":{"description":"Parent directory ID","type":"integer","default":0},"owneruserid":{"description":"Owner user ID","type":"integer","default":null},"unixgroupid":{"description":"Unix Group ID","type":"integer","default":null},"ownerread":{"description":"Owner read permission","type":"integer","default":null},"groupread":{"description":"Group read permission","type":"integer","default":null},"groupwrite":{"description":"Group write permission","type":"integer","default":null},"publicread":{"description":"Public read permission","type":"integer","default":null},"publicwrite":{"description":"Public write permission","type":"integer","default":null},"autouser":{"description":"Auto user","type":"integer","default":null},"files":{"description":"Files","type":"integer","default":null},"autouserunixgroupid":{"description":"Auto user Unix Group ID","type":"integer","default":null},"storageresourceid":{"description":"Storage Resource ID","type":"integer","default":null}},"required":["name","resourceid","groupid","bytes","unixgroupid"]}}}}}},"\/storage\/directories\/{id}":{"get":{"description":"Read a resource","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read"},"404":{"description":"Record not found"}}},"put":{"description":"Update a resource","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":false,"schema":{"type":"integer"}}],"responses":{"202":{"description":"Successful entry modification"},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"Directory name","type":"string","default":null},"resourceid":{"description":"Resource id","type":"integer","default":null},"groupid":{"description":"Group id","type":"integer","default":null},"bytes":{"description":"Bytes","type":"string","default":null},"parentstorageid":{"description":"Parent directory ID","type":"integer","default":0},"owneruserid":{"description":"Owner user ID","type":"integer","default":null},"unixgroupid":{"description":"Unix Group ID","type":"integer","default":null},"ownerread":{"description":"Owner read permission","type":"integer","default":null},"groupread":{"description":"Group read permission","type":"integer","default":null},"groupwrite":{"description":"Group write permission","type":"integer","default":null},"publicread":{"description":"Public read permission","type":"integer","default":null},"publicwrite":{"description":"Public write permission","type":"integer","default":null},"autouser":{"description":"Auto user","type":"integer","default":null},"files":{"description":"Files","type":"integer","default":null},"autouserunixgroupid":{"description":"Auto user Unix Group ID","type":"integer","default":null},"storageresourceid":{"description":"Storage Resource ID","type":"integer","default":null}},"required":[]}}}}},"delete":{"description":"Delete a storage directory","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/storage\/loans":{"get":{"description":"Display a listing of entries","parameters":[{"in":"query","name":"resourceid","description":"Resource ID to filter by","required":false,"schema":{"type":"integer"}},{"in":"query","name":"groupid","description":"Group ID to filter by","required":false,"schema":{"type":"integer"}},{"in":"query","name":"lendergroupid","description":"Lender group ID to filter by","required":false,"schema":{"type":"integer"}},{"in":"query","name":"limit","description":"Number of result to return.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":0}},{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"datetimestart","enum":["id","resourceid","groupid","datetimestart","datetimestop","bytes","lendergroupid"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"desc","enum":["asc","desc"]}}]},"post":{"description":"Create an entry","parameters":[],"responses":{"201":{"description":"Successful entry creation"},"401":{"description":"Unauthorized"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"resourceid":{"description":"Resource ID","type":"integer","default":null},"groupid":{"description":"Group id","type":"integer","default":null},"lendergroupid":{"description":"Lender Group id","type":"integer","default":null},"datetimestart":{"description":"Start date","type":"string","default":null},"datetimestop":{"description":"Stop date","type":"string","default":null}},"required":["resourceid","groupid","datetimestart"]}}}}}},"\/storage\/loans\/{id}":{"get":{"description":"Read an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read"},"404":{"description":"Record not found"}}},"put":{"description":"Update an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"202":{"description":"Successful entry modification"},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"resourceid":{"description":"Resource ID","type":"integer","default":null},"groupid":{"description":"Group id","type":"integer","default":null},"lendergroupid":{"description":"Lender Group id","type":"integer","default":null},"datetimestart":{"description":"Start date","type":"string","default":null},"datetimestop":{"description":"Stop date","type":"string","default":null}},"required":[]}}}}},"delete":{"description":"Delete an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/storage\/notifications\/types":{"get":{"description":"Display a listing of notification types.","parameters":[{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","description":"Number of result to return.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"name","enum":["id","name"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]}}]},"post":{"description":"Create a notification type.","parameters":[],"responses":{"201":{"description":"Successful entry creation"},"401":{"description":"Unauthorized"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"The name of the notification type","type":"string","default":null},"defaulttimeperiodid":{"description":"ID of the default time period for notifications of this type","type":"integer","default":0},"valuetype":{"description":"ID of the default time period for notifications of this type","type":"integer","default":null}},"required":["name","valuetype"]}}}}}},"\/storage\/notifications\/types\/{id}":{"get":{"description":"Read a notification type.","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read"},"404":{"description":"Record not found"}}},"put":{"description":"Update a notification type.","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"202":{"description":"Successful entry modification"},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"The name of the notification type","type":"string","default":null},"defaulttimeperiodid":{"description":"ID of the default time period for notifications of this type","type":"integer","default":null},"valuetype":{"description":"ID of the default time period for notifications of this type","type":"integer","default":null}},"required":[]}}}}},"delete":{"description":"Delete a notification type.","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/storage\/notifications":{"get":{"description":"Display a listing of notifications.","parameters":[{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"enabled","description":"Enabled state of the notifications","required":false,"schema":{"type":"string","default":"-1","enum":["-1","0","1"]}},{"in":"query","name":"storagedirquotanotificationtypeid","description":"ID of the notification type to filter by.","required":false,"schema":{"type":"integer"}},{"in":"query","name":"storagedirid","description":"ID of the storage directory to filter by.","required":false,"schema":{"type":"integer"}},{"in":"query","name":"userid","description":"ID of the user to filter by.","required":false,"schema":{"type":"integer"}},{"in":"query","name":"timeperiodid","description":"ID of the timeperiod to filter by","required":false,"schema":{"type":"integer","default":"-1"}},{"in":"query","name":"limit","description":"Number of result to return.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":0}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"datetimestart","enum":["id","storagedirid","userid","datetimecreated","datetimeremoved","enabled","notice"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"desc","enum":["asc","desc"]}}]},"post":{"description":"Create a notification.","parameters":[],"responses":{"201":{"description":"Successful entry creation"},"401":{"description":"Unauthorized"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"storagedirid":{"description":"Storage directory ID","type":"integer","default":null},"userid":{"description":"User ID","type":"integer","default":null},"storagedirquotanotificationtypeid":{"description":"Storage quota notification type ID","type":"integer","default":null},"value":{"description":"Notification threshold","type":"integer","default":null},"timeperiodid":{"description":"Time period ID","type":"integer","default":null},"periods":{"description":"Periods","type":"integer","default":null},"notice":{"description":"Notice state","type":"integer","default":null},"enabled":{"description":"Enabled state","type":"integer","default":1},"datetimelastnotify":{"description":"Last notified timestamp","type":"string","default":null}},"required":["storagedirid","userid","storagedirquotanotificationtypeid","value"]}}}}}},"\/storage\/notifications\/{id}":{"get":{"description":"Read a notification.","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read"},"404":{"description":"Record not found"}}},"put":{"description":"Update a notification.","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"202":{"description":"Successful entry modification"},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"userid":{"description":"User ID","type":"integer","default":null},"storagedirquotanotificationtypeid":{"description":"Storage quota notification type ID","type":"integer","default":null},"value":{"description":"Notification threshold","type":"integer","default":null},"timeperiodid":{"description":"Time period ID","type":"integer","default":null},"periods":{"description":"Periods","type":"integer","default":null},"notice":{"description":"Notice state","type":"integer","default":null},"enabled":{"description":"Enabled state","type":"integer","default":1},"datetimelastnotify":{"description":"Last notified timestamp","type":"string","default":null},"nextreport":{"description":"When the next report should be","type":"string","default":null}},"required":[]}}}}},"delete":{"description":"Delete a notification.","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/storage\/purchases":{"get":{"description":"Display a listing of entries","parameters":[{"in":"query","name":"resourceid","description":"A Resource ID to filter by.","required":false,"schema":{"type":"integer"}},{"in":"query","name":"groupid","description":"A Group ID to filter by.","required":false,"schema":{"type":"integer"}},{"in":"query","name":"sellergroupid","description":"A selling Group ID to filter by.","required":false,"schema":{"type":"integer"}},{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","description":"Number of result to return.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"datetimestart","enum":["id","resourceid","groupid","datetimestart","datetimestop","bytes","sellergroupid"]}}],"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"order_dir":{"description":"Direction to sort results by.","type":"string","default":"desc"}},"required":[]}}}}},"post":{"description":"Create an entry","parameters":[],"responses":{"201":{"description":"Successful entry creation"},"401":{"description":"Unauthorized"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"resourceid":{"description":"Resource ID","type":"integer","default":null},"groupid":{"description":"ID of group making the purchase","type":"integer","default":null},"sellergroupid":{"description":"ID of seller group","type":"integer","default":null},"datetimestart":{"description":"Timestamp for when the purchase starts","type":"string","default":null},"datetimestop":{"description":"Timestamp for when the purchase stops","type":"string","default":null},"bytes":{"description":"Amount of space in bytes being purchases","type":"integer","default":null},"comment":{"description":"Comments\/notes","type":"string","default":null}},"required":["resourceid","groupid","sellergroupid","datetimestart","bytes"]}}}}}},"\/storage\/purchases\/{id}":{"get":{"description":"Read an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read"},"404":{"description":"Record not found"}}},"put":{"description":"Update an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"202":{"description":"Successful entry modification"},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"resourceid":{"description":"Resource ID","type":"integer","default":null},"groupid":{"description":"ID of group making the purchase","type":"integer","default":null},"sellergroupid":{"description":"ID of seller group","type":"integer","default":null},"datetimestart":{"description":"Timestamp for when the purchase starts","type":"string","default":"Now"},"datetimestop":{"description":"Timestamp for when the purchase stops","type":"string","default":null},"bytes":{"description":"Amount of space in bytes being purchases","type":"integer","default":null},"comment":{"description":"Comments\/notes","type":"string","default":null}},"required":[]}}}}},"delete":{"description":"Delete an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/storage\/quotas\/{username?}":{"get":{"description":"Display a listing of quotas for a user.","parameters":[{"in":"path","name":"username","description":"User username to retrieve data for","required":false,"schema":{"type":"string","default":"Current user's username"}}],"responses":{"200":{"description":"Successful entry list"}}}},"\/storage":{"get":{"description":"Display a listing of storage resources.","parameters":[{"in":"query","name":"state","description":"Record state.","required":false,"schema":{"type":"string","default":"active","enum":["active","inactive","all"]}},{"in":"query","name":"parentresourceid","description":"Parent resource ID","required":false,"schema":{"type":"integer"}},{"in":"query","name":"groupmanaged","description":"Storage can be managed by group managers","required":false,"schema":{"type":"integer"}},{"in":"query","name":"autouserdir","description":"Auto create user directories","required":false,"schema":{"type":"integer"}},{"in":"query","name":"getquotatypeid","description":"Quota message type ID","required":false,"schema":{"type":"integer"}},{"in":"query","name":"createtypeid","description":"Create message type ID","required":false,"schema":{"type":"integer"}},{"in":"query","name":"limit","description":"Number of result to return.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"datetimecreated","enum":["id","name","path","datetimecreated","datetimeremoved","parentresourceid"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]}}]},"post":{"description":"Create a storage resource","parameters":[],"responses":{"201":{"description":"Successful entry creation"},"401":{"description":"Unauthorized"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"The name of the storage resource","type":"string","default":null},"path":{"description":"The storage resource base path","type":"string","default":null},"parentresourceid":{"description":"The parent resource's ID","type":"integer","default":null},"import":{"description":"Import","type":"boolean","default":null},"importhostname":{"description":"Import hostname","type":"string","default":null},"autouserdir":{"description":"Auto create user directory","type":"boolean","default":null},"defaultquotaspace":{"description":"Default quota space in bytes","type":"integer","default":null},"defaultquotafile":{"description":"Default number of files","type":"integer","default":null},"getquotatypeid":{"description":"Get Quota message type ID","type":"integer","default":null},"createtypeid":{"description":"Create Quota message type ID","type":"integer","default":null},"groupmanaged":{"description":"Groups can manage directory structure and permissions","type":"integer","default":null}},"required":["name","path"]}}}}}},"\/storage\/{id}":{"get":{"description":"Read a storage resource","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read"},"404":{"description":"Record not found"}}},"put":{"description":"Update a storage resource","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"202":{"description":"Successful entry modification"},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"The name of the storage resource","type":"string","default":null},"path":{"description":"The storage resource base path","type":"string","default":null},"parentresourceid":{"description":"The parent resource's ID","type":"integer","default":null},"import":{"description":"Import","type":"boolean","default":null},"importhostname":{"description":"Import hostname","type":"string","default":null},"autouserdir":{"description":"Auto create user directory","type":"boolean","default":null},"defaultquotaspace":{"description":"Default quota space in bytes","type":"integer","default":null},"defaultquotafile":{"description":"Default number of files","type":"integer","default":null},"getquotatypeid":{"description":"Get Quota message type ID","type":"integer","default":null},"createtypeid":{"description":"Create Quota message type ID","type":"integer","default":null},"groupmanaged":{"description":"Groups can manage directory structure and permissions","type":"integer","default":null}},"required":[]}}}}},"delete":{"description":"Delete a storage resource","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/storage\/usage":{"get":{"description":"Display a listing of entries","parameters":[{"in":"query","name":"storagedirid","description":"Storage directory ID","required":false,"schema":{"type":"integer"}}]},"post":{"description":"Create an entry","parameters":[],"responses":{"201":{"description":"Successful entry creation"},"401":{"description":"Unauthorized"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"storagedirid":{"description":"Storage directory ID","type":"integer","default":null},"quota":{"description":"Quota value","type":"integer","default":null},"space":{"description":"Space value","type":"integer","default":null},"filequota":{"description":"File quota value","type":"integer","default":null},"files":{"description":"Files value","type":"integer","default":null}},"required":["storagedirid","quota"]}}}}}},"\/storage\/usage\/{id}":{"get":{"description":"Read an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read"},"404":{"description":"Record not found"}}},"put":{"description":"Update an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"202":{"description":"Successful entry modification"},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"storagedirid":{"description":"Storage directory ID","type":"integer","default":null},"quota":{"description":"Quota value","type":"integer","default":null},"space":{"description":"Space value","type":"integer","default":null},"filequota":{"description":"File quota value","type":"integer","default":null},"files":{"description":"Files value","type":"integer","default":null}},"required":[]}}}}},"delete":{"description":"Delete an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/storage\/usage\/batch\/{resource}\/{dir}":{"post":{"description":"Process a batch list of usage","parameters":[],"responses":{"201":{"description":"Successful entry creation"},"401":{"description":"Unauthorized"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"file":{"description":"Storage directory ID","type":"integer","default":null}},"required":["file"]}}}}}},"\/tags":{"get":{"description":"Display a listing of entries","parameters":[{"in":"query","name":"limit","description":"Number of result per page.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"state","description":"Tag state.","required":false,"schema":{"type":"string","default":"active","enum":["active","trashed"]}},{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"domain","description":"Namespace for tags","required":false,"schema":{"type":"string"}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"name","enum":["id","name","slug","created_at"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]}}]},"post":{"description":"Create a new entry","parameters":[],"responses":{"201":{"description":"Successful entry creation","content":{"application\/json":{"example":{"id":1,"parent_id":0,"slug":"anaconda","name":"Anaconda","domain":"crm","created_at":"2021-07-13T20:38:57.000000Z","created_by":98254,"updated_at":"2021-07-13T20:38:57.000000Z","updated_by":0,"deleted_at":null,"deleted_by":0,"tagged_count":0,"alias_count":0,"api":"https:\/\/example.org\/api\/tags\/1"}}}},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"Tag to be created.","type":"string","default":null},"slug":{"description":"Normalized text (alpha-numeric, no punctuation)","type":"string","default":null},"domain":{"description":"Namespace for tag","type":"string","default":null},"parent_id":{"description":"Parent tag ID. Set this to create an alias for that tag.","type":"integer","default":null}},"required":["name"]}}}}}},"\/tags\/{id}":{"get":{"description":"Retrieve an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read","content":{"application\/json":{"example":{"id":1,"parent_id":0,"slug":"anaconda","name":"Anaconda","domain":"crm","created_at":"2021-07-13T20:38:57.000000Z","created_by":98254,"updated_at":"2021-07-13T20:38:57.000000Z","updated_by":0,"deleted_at":null,"deleted_by":0,"tagged_count":0,"alias_count":0,"api":"https:\/\/example.org\/api\/tags\/1"}}}},"404":{"description":"Record not found"}}},"put":{"description":"Update an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"202":{"description":"Successful entry modification","content":{"application\/json":{"example":{"id":1,"parent_id":0,"slug":"anaconda","name":"Anaconda","domain":"crm","created_at":"2021-07-13T20:38:57.000000Z","created_by":98254,"updated_at":"2021-07-13T20:38:57.000000Z","updated_by":0,"deleted_at":null,"deleted_by":0,"tagged_count":0,"alias_count":0,"api":"https:\/\/example.org\/api\/tags\/1"}}}},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"Tag text","type":"string","default":null},"slug":{"description":"Normalized text (alpha-numeric, no punctuation)","type":"string","default":null},"domain":{"description":"Namespace for tag","type":"string","default":null},"aliases":{"description":"Comma-separated list of aliases or alternatives","type":"string","default":null}},"required":[]}}}}},"delete":{"description":"Delete an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful deletion"},"404":{"description":"Record not found"}}}},"\/themes":{"get":{"description":"Display a listing of entries","parameters":[{"in":"query","name":"client_id","description":"Client (admin = 1|site = 0) ID","required":false,"schema":{"type":"integer","default":0,"enum":[0,1]}},{"in":"query","name":"element","description":"Theme element name.","required":false,"schema":{"type":"string"}},{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","description":"Number of result per page.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"title","enum":["id","title"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"desc","enum":["asc","desc"]}}]},"post":{"description":"Create a new entry","parameters":[],"responses":{"201":{"description":"Successful entry creation","content":{"application\/json":{"example":{"id":1,"name":"Admin (default)","type":"theme","element":"admin","folder":"","client_id":1,"enabled":1,"access":1,"protected":1,"params":[],"checked_out":0,"checked_out_time":null,"ordering":0,"updated_at":null,"updated_by":0}}}},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"Theme name","type":"string","default":null},"element":{"description":"Theme directory name","type":"string","default":null},"enabled":{"description":"Is the theme enabled?","type":"integer","default":0},"client_id":{"description":"Client (admin = 1|site = 0) ID","type":"integer","default":null}},"required":["name","element"]}}}}}},"\/themes\/{id}":{"get":{"description":"Retrieve an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read","content":{"application\/json":{"example":{"id":1,"name":"Admin (default)","type":"theme","element":"admin","folder":"","client_id":1,"enabled":1,"access":1,"protected":1,"params":[],"checked_out":0,"checked_out_time":null,"ordering":0,"updated_at":null,"updated_by":0}}}},"404":{"description":"Record not found"}}},"put":{"description":"Update an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"202":{"description":"Successful entry modification","content":{"application\/json":{"example":{"id":1,"name":"Admin (default)","type":"theme","element":"admin","folder":"","client_id":1,"enabled":1,"access":1,"protected":1,"params":[],"checked_out":0,"checked_out_time":null,"ordering":0,"updated_at":null,"updated_by":0}}}},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"Theme name","type":"string","default":null},"enabled":{"description":"Is the theme enabled?","type":"integer","default":0}},"required":[]}}}}},"delete":{"description":"Delete an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful deletion"},"404":{"description":"Record not found"}}}},"\/users\/facets":{"get":{"description":"Display a listing of entries","parameters":[{"in":"query","name":"user_id","description":"User to retrieve facets for.","required":true,"schema":{"type":"integer"}},{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","description":"Number of result per page.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"datetimecreated","enum":["id","datetimecreated","datetimeremoved"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"desc","enum":["asc","desc"]}}]},"post":{"description":"Create a new entry","parameters":[],"responses":{"201":{"description":"Successful entry creation"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"key":{"description":"Facet name","type":"string","default":null},"value":{"description":"Facet value","type":"string","default":null},"user_id":{"description":"User ID","type":"integer","default":0},"access":{"description":"View level ID","type":"integer","default":0},"locked":{"description":"Is the value editable?","type":"boolean","default":0}},"required":["key","value","user_id"]}}}}}},"\/users\/facets\/{id}":{"get":{"description":"Retrieve an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful entry read"},"404":{"description":"Record not found"}}},"put":{"description":"Update an entry","parameters":[],"responses":{"204":{"description":"Successful entry modification"},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"value":{"description":"Facet value","type":"string","default":null},"access":{"description":"View level ID","type":"integer","default":null}},"required":["value"]}}}}},"delete":{"description":"Delete an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful deletion"},"404":{"description":"Record not found"}}}},"\/users\/levels":{"get":{"description":"Display a listing of entries","parameters":[{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","description":"Number of result per page.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"datetimecreated","enum":["id","datetimecreated","datetimeremoved"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"desc","enum":["asc","desc"]}}],"responses":{"200":{"description":"Successful creation","content":{"application\/json":{"example":{"data":[{"id":1,"title":"Public","ordering":0,"rules":[1],"api":"https:\/\/yourhost\/api\/users\/levels\/1"},{"id":2,"title":"Registered","ordering":1,"rules":[2,8],"api":"https:\/\/yourhost\/api\/users\/levels\/2"}]}}}}}},"post":{"description":"Create a new entry","parameters":[],"responses":{"200":{"description":"Successful creation","content":{"application\/json":{"example":{"id":7,"title":"Example","ordering":7,"rules":[2,3,4],"api":"https:\/\/yourhost\/api\/users\/levels\/7"}}}},"404":{"description":"Record not found"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"title":{"description":"Access level title","type":"string","default":null},"rules":{"description":"A list of role IDs","type":"array","default":null}},"required":["title","rules"]}}}}}},"\/users\/levels\/{id}":{"get":{"description":"Retrieve an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful update","content":{"application\/json":{"example":{"id":7,"title":"Example","ordering":7,"rules":[2,3,4],"api":"https:\/\/yourhost\/api\/users\/levels\/7"}}}},"404":{"description":"Record not found"}}},"put":{"description":"Update an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful update","content":{"application\/json":{"example":{"id":7,"title":"Example","ordering":7,"rules":[2,3,4,5],"api":"https:\/\/yourhost\/api\/users\/levels\/7"}}}},"404":{"description":"Record not found"},"415":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"title":{"description":"Access level title","type":"string","default":null},"rules":{"description":"A list of role IDs","type":"array","default":null}},"required":[]}}}}},"delete":{"description":"Delete an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful deletion"},"404":{"description":"Record not found"}}}},"\/users\/notes":{"get":{"description":"Display a listing of entries","parameters":[{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","description":"Number of result per page.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"datetimecreated","enum":["id","datetimecreated","datetimeremoved"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"desc","enum":["asc","desc"]}}]},"post":{"description":"Create a new entry","parameters":[],"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"subject":{"description":"Subject of the note","type":"string","default":null},"body":{"description":"Body of the note","type":"string","default":null},"user_id":{"description":"User ID","type":"integer","default":null}},"required":["subject","user_id"]}}}}}},"\/users\/notes\/{id}":{"get":{"description":"Retrieve an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}]},"put":{"description":"Update an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"subject":{"description":"Subject of the note","type":"string","default":null},"body":{"description":"Note content","type":"string","default":null}},"required":[]}}}}},"delete":{"description":"Delete an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful deletion"},"404":{"description":"Record not found"}}}},"\/users\/notifications":{"get":{"description":"Display a listing of entries","parameters":[{"in":"query","name":"user_id","description":"User the notifications are for.","required":false,"schema":{"type":"integer"}},{"in":"query","name":"read","description":"Find notifications amrked as read","required":false,"schema":{"type":"integer"}},{"in":"query","name":"unread","description":"Find notifications amrked as unread","required":false,"schema":{"type":"integer"}},{"in":"query","name":"read","description":"Find notifications amrked as read","required":false,"schema":{"type":"integer"}},{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","description":"Number of result per page.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"datetimecreated","enum":["id","datetimecreated","datetimeremoved"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"desc","enum":["asc","desc"]}}]}},"\/users\/notifications\/{id}":{"get":{"description":"Retrieve an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}]},"put":{"description":"Update an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"subject":{"description":"Subject of the note","type":"string","default":null},"body":{"description":"Note content","type":"string","default":null}},"required":[]}}}}},"delete":{"description":"Delete an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful deletion"},"404":{"description":"Record not found"}}}},"\/users\/notifications\/mark-all-as-unread":{"put":{"description":"Update all entries as unread","parameters":[],"responses":{"201":{"description":"Successful deletion"}}}},"\/users\/permissions":{"get":{"description":"Display a listing of entries","parameters":[{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","description":"Number of result per page.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"id","enum":["id","name"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"desc","enum":["asc","desc"]}}]}},"\/users\/permissions\/{id}":{"post":{"description":"Create a new entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"params":{"description":"A list of permissions.","type":"array","default":null}},"required":["params"]}}}}},"delete":{"description":"Delete an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful deletion"},"404":{"description":"Record not found"},"500":{"description":"Error deleting record"}}}},"\/users\/roles":{"get":{"description":"Display a listing of entries","parameters":[{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","description":"Number of result per page.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"name","enum":["id","name"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]}}]},"post":{"description":"Create a new entry","parameters":[],"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"title":{"description":"Role title","type":"string","default":null},"parent_id":{"description":"Parent role ID","type":"integer","default":0}},"required":["title"]}}}}}},"\/users\/roles\/{id}":{"get":{"description":"Retrieve an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}]},"put":{"description":"Update an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"title":{"description":"Role title","type":"string","default":null},"parent_id":{"description":"Parent role ID","type":"integer","default":0}},"required":[]}}}}},"delete":{"description":"Delete an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}]}},"\/users":{"get":{"description":"Display a listing of entries","parameters":[{"in":"query","name":"search","description":"A word or phrase to search for.","type":"string","required":false,"default":"","schema":{"type":"string"}},{"in":"query","name":"role_id","description":"Filter by a role ID.","required":false,"schema":{"type":"integer"}},{"in":"query","name":"limit","description":"Number of result per page.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","type":"integer","required":false,"default":1,"schema":{"type":"string"}},{"in":"query","name":"order","description":"Field to sort results by.","type":"string","required":false,"default":"datetimecreated","allowedValues":"id, motd, datetimecreated, datetimeremoved","schema":{"type":"string"}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]}}]},"post":{"description":"Create a new entry","parameters":[],"responses":{"201":{"description":"Successful entry creation"},"401":{"description":"Unauthorized"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"User name","type":"string","default":null},"email":{"description":"Email address","type":"string","default":null}},"required":[]}}}}}},"\/users\/{id}":{"get":{"description":"Retrieve an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}},{"in":"query","name":"module_permissions","description":"A comma-separated list of modules to grab permissions from","required":false,"schema":{"type":"string","example":"news,users,resources"}}],"responses":{"200":{"description":"Successful entry read"},"404":{"description":"Record not found"}}},"put":{"description":"Update an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"202":{"description":"Successful entry modification"},"404":{"description":"Record not found"},"409":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"name":{"description":"User name","type":"string","default":null},"api_token":{"description":"API token","type":"string","default":null},"puid":{"description":"Organization ID","type":"integer","default":null},"username":{"description":"Username","type":"string","default":null},"unixid":{"description":"Unix user ID","type":"integer","default":null},"datelastseen":{"description":"Last time the user logged in","type":"string","default":null},"roles":{"description":"A list of Role IDs to apply to the user","type":"array","default":null}},"required":[]}}}}},"delete":{"description":"Delete an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful entry deletion"},"404":{"description":"Record not found"}}}},"\/widgets":{"get":{"description":"Display a listing of entries","parameters":[{"in":"query","name":"client_id","description":"Client (admin = 1|site = 0) ID","required":false,"schema":{"type":"integer","default":null,"enum":[0,1]}},{"in":"query","name":"search","description":"A word or phrase to search for.","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","description":"Number of result per page.","required":false,"schema":{"type":"integer","default":20}},{"in":"query","name":"page","description":"Number of where to start returning results.","required":false,"schema":{"type":"integer","default":1}},{"in":"query","name":"order","description":"Field to sort results by.","required":false,"schema":{"type":"string","default":"datetimecreated","enum":["id","motd","datetimecreated","datetimeremoved"]}},{"in":"query","name":"order_dir","description":"Direction to sort results by.","required":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]}}],"responses":{"200":{"description":"List of widgets","content":{"application\/json":{"example":{"current_page":1,"data":[{"id":17,"title":"Breadcrumbs","note":"","content":"","ordering":1,"position":"breadcrumbs","checked_out":0,"checked_out_time":null,"publish_up":null,"publish_down":null,"published":1,"module":"breadcrumbs","access":1,"showtitle":1,"params":{"showHere":"0","showHome":"1","homeText":"Home","showLast":"1","separator":"\/","moduleclass_sfx":null,"cache":"1","cache_time":"900","cachemode":"itemid"},"client_id":0,"language":"*","language_title":null,"editor":"Shawn M Rice","access_level":"Public","pages":0,"name":"breadcrumbs","api":"https:\/\/yourhost\/api\/widgets\/17","menu_assignment":0,"can":{"edit":false,"delete":false}},{"id":132,"title":"Science Highlights","note":"","content":"","ordering":1,"position":"featureLeft","checked_out":0,"checked_out_time":null,"publish_up":null,"publish_down":null,"published":1,"module":"news","access":1,"showtitle":0,"params":{"catid":"3","item_title":"0","link_titles":null,"item_heading":"h4","showLastSeparator":"1","readmore":"1","limit":"5","ordering":"published","direction":"DESC","layout":null,"moduleclass_sfx":null,"cache":"0","cache_time":"900","cachemode":"itemid"},"client_id":0,"language":"*","language_title":null,"editor":"Shawn M Rice","access_level":"Public","pages":100,"name":"news","api":"https:\/\/yourhost\/api\/widgets\/132","menu_assignment":1,"can":{"edit":false,"delete":false}},{"id":134,"title":"Announcements","note":"","content":"","ordering":1,"position":"featureRight","checked_out":0,"checked_out_time":null,"publish_up":null,"publish_down":null,"published":1,"module":"news","access":1,"showtitle":0,"params":{"catid":"2","item_title":"0","link_titles":null,"item_heading":"h4","showLastSeparator":"1","readmore":"1","limit":"5","ordering":"published","direction":"DESC","layout":null,"moduleclass_sfx":null,"cache":"0","cache_time":"900","cachemode":"itemid"},"client_id":0,"language":"*","language_title":null,"editor":null,"access_level":"Public","pages":0,"name":"news","api":"https:\/\/yourhost\/api\/widgets\/134","menu_assignment":1,"can":{"edit":false,"delete":false}}],"first_page_url":"https:\/\/yourhost\/api\/widgets?page=1","from":1,"last_page":2,"last_page_url":"https:\/\/yourhost\/api\/widgets?page=2","next_page_url":"https:\/\/yourhost\/api\/widgets?page=2","path":"https:\/\/yourhost\/api\/widgets","per_page":3,"prev_page_url":null,"to":3,"total":5}}}}}},"post":{"description":"Create a new entry","parameters":[],"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"title":{"description":"Widget title","type":"string","default":null},"position":{"description":"Widget position","type":"string","default":null},"widget":{"description":"The type of widget","type":"string","default":null},"params":{"description":"A list of key value pairs","type":"array","default":null},"menu":{"description":"A list of menu item assignments","type":"array","default":null}},"required":["title","position","widget"]}}}}}},"\/widgets\/{id}":{"get":{"description":"Retrieve an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful record lookup","content":{"application\/json":{"example":{"id":134,"title":"Announcements","note":"","content":"","ordering":1,"position":"featureRight","checked_out":0,"checked_out_time":null,"publish_up":null,"publish_down":null,"published":1,"module":"news","access":1,"showtitle":0,"params":{"catid":"2","item_title":"0","link_titles":null,"item_heading":"h4","showLastSeparator":"1","readmore":"1","limit":"5","ordering":"published","direction":"DESC","layout":null,"moduleclass_sfx":null,"cache":"0","cache_time":"900","cachemode":"itemid"},"client_id":0,"language":"*","language_title":null,"editor":null,"access_level":"Public","pages":0,"name":"news","api":"https:\/\/yourhost\/api\/widgets\/134","menu_assignment":1,"can":{"edit":false,"delete":false}}}}},"404":{"description":"Record not found"}}},"put":{"description":"Update an entry","parameters":[],"responses":{"200":{"description":"Successful record update","content":{"application\/json":{"example":{"id":134,"title":"Announcements","note":"","content":"","ordering":1,"position":"featureRight","checked_out":0,"checked_out_time":null,"publish_up":null,"publish_down":null,"published":1,"module":"news","access":1,"showtitle":0,"params":{"catid":"2","item_title":"0","link_titles":null,"item_heading":"h4","showLastSeparator":"1","readmore":"1","limit":"5","ordering":"published","direction":"DESC","layout":null,"moduleclass_sfx":null,"cache":"0","cache_time":"900","cachemode":"itemid"},"client_id":0,"language":"*","language_title":null,"editor":null,"access_level":"Public","pages":0,"name":"news","api":"https:\/\/yourhost\/api\/widgets\/134","menu_assignment":1,"can":{"edit":false,"delete":false}}}}},"404":{"description":"Record not found"},"415":{"description":"Invalid data"}},"requestBody":{"content":{"*\/*":{"schema":{"type":"object","properties":{"title":{"description":"Widget title","type":"string","default":null},"position":{"description":"Widget position","type":"string","default":null},"widget":{"description":"The type of widget","type":"string","default":null},"params":{"description":"A list of key value pairs","type":"array","default":null},"menu":{"description":"A list of menu item assignments","type":"array","default":null}},"required":[]}}}}},"delete":{"description":"Delete an entry","parameters":[{"in":"path","name":"id","description":"Entry identifier","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Successful deletion"},"404":{"description":"Record not found"}}}}}}