API documentation

Examples

GET /api/organizations
200
{
  "total": 2,
  "subtotal": 2,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "created_at": "2019-11-07 08:55:48 UTC",
      "updated_at": "2019-11-07 08:55:48 UTC",
      "id": 447626441,
      "name": "org275",
      "title": "org275",
      "description": null
    },
    {
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "created_at": "2019-11-07 08:55:48 UTC",
      "updated_at": "2019-11-07 08:55:48 UTC",
      "id": 447626444,
      "name": "org276",
      "title": "org276",
      "description": null
    }
  ]
}

Params

Param name	Description
location_id optional	Set the current location context for the request Validations: Must be a Integer
organization_id optional	Set the current organization context for the request Validations: Must be a Integer
search optional	filter results Validations: Must be a String
order optional	Sort field and order, eg. ‘id DESC’ Validations: Must be a String
page optional	Page number, starting at 1 Validations: Must be a number.
per_page optional	Number of results per page to return Validations: Must be a number.

Examples

GET /api/organizations/447626445
200
{
  "select_all_types": [],
  "description": null,
  "created_at": "2019-11-07 08:49:08 UTC",
  "updated_at": "2019-11-07 08:49:08 UTC",
  "ancestry": null,
  "parent_id": null,
  "parent_name": null,
  "id": 447626445,
  "name": "org224",
  "title": "org224",
  "users": [],
  "smart_proxies": [],
  "subnets": [],
  "compute_resources": [],
  "media": [],
  "config_templates": [],
  "ptables": [],
  "provisioning_templates": [],
  "domains": [],
  "realms": [],
  "environments": [],
  "hostgroups": [],
  "locations": [],
  "hosts_count": 0,
  "parameters": [
    {
      "priority": 10,
      "created_at": "2019-11-07 08:49:08 UTC",
      "updated_at": "2019-11-07 08:49:08 UTC",
      "id": 767575239,
      "name": "foo",
      "parameter_type": "string",
      "value": "*****"
    }
  ]
}

Params

Param name	Description
location_id optional	Set the current location context for the request Validations: Must be a Integer
organization_id optional	Set the current organization context for the request Validations: Must be a Integer
show_hidden_parameters optional	Display hidden parameter values Validations: Must be one of: `true`, `false`, `1`, `0`.
id required	Validations: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

Examples

POST /api/organizations
{
  "organization": {
    "name": "XgebCcjbes",
    "description": "𫲭𑰤𐘋쏰𤖊𨫬𡤵𥸈𢒌尭볞𬡬𧬑ꍁ霨𨀌龙𘧡𝚮𤡉錿䥻𤜀𥳰𩢟둮頚𘜏𤥷𤷂𦣗嗀殺㧑𤊆葞䚇𑰪ⱇ𥪜𬆁𢧤𗲚𥏽𡕯𥌝𐪌轠赦셉𥚜꼄𡐓𓉳𢂚𠠧𦠙𒍀𗀜𬁙妇崇膆㣯𘦗𣍒𦦌𪽄햦𢫗𗛈㶿𠓟ﶯꗳ옢𐀜孫𡛦𨠵Б𡃙𘚪𬗁ꆗ𗝣삃𗍃夰砊𐛀𧆈𬨝𬠚𬮾骄𐤪吾𗔖䊜𠕂𦃵𖦎襎䳞𗴫𖨩茢닣ᶬ𬤝𠂅𑆕𥃐䝁ט𘛪𦂗𤫥其𩖄𘎇𨛁𘣡㥼𨩷𦦜抩𡀩ꒀ𦂷𗌜쓧瘖𠸃𢷫𥓙ߦ𐍆𫗣찟𫊤𣑪𠒈𦃚𨋝𐱇鐗𪱥𦄨緵𩡻ᯟﳥ縲붗永𤳿𪰀𣌢谠𗰤𘢏ಳ𤇠𦘲𗼖㝒𫷿ꤿ뜈𥈟𨄄𢴃畾ࠓ𠈮菤ꐈ響𣩣𩞃𤞊𬆧ꋑ𗣬𪞺𦻈㟴𬔌趝𫰵眲𫆙錳䍢𓂋砤𣌿𐁙𪾥𧁁𧆊𨦺똕俏𐢝賺烲𬥳𪨽𨌻𩱏𬇖럜𧠷𪬨𫃼幵𣏑𬭘𫙬𒔵夕𫓟𩍲𧪍𩼅𐐞括鸸𨬑𣅊𤢱㥴㼻畠𩯼𪹋Ǔ樬犷햙𢪥ꤻศ𣪜𩐕𦾞𧰰䃾𘐼𥍆𥳟𧱵䝌𗢔𠧩栒𡽕ᐰ튏怊㘒𗼋肪𪑟𫙿𐓅𫠚梮𡧚䔿悽𖦱츦ൠ𬚦𡁘𠑼噊𑢴ᦽ𤚋ﺲ𪑫𥝵썭𬉫𤚦𨂦敒𘓣𩡯햲𨞴𓐋𥄘𬛳𧃰펑柷瓩氀𥣾𣲝ঀ𪱐𬕠𩢭𡳯ȭ𨜱𡲥폕𪋴ᱝ슐銆慮𩠋𢚋𩫄𘑔𝘚𣙹𐛓𧻢𫇴𡱱髺𤳝𥰧𗑜𩋨㶴粄뭸𡚔𫷵𠷉棿覱楷䤳𪨉勞𘁹嵒촃𢝬ꠊ𠟏䧪鉳鬣𣳝㡕ꇝἤ𨓕𝓿𪎩𬗌𨧯𧒈𨰐𤥾𢔏𡔊𠈫擣𣋝𬺅𬱈𥯈𝗓娿𤖇𬵕𤀺𠥸ꨑ𠴜鲋垅庹𧃯𥲠릌𨀣䠫𬟤𝜒𢁨鱯ᆊ𗫓ᇇ𦁂𡖝𬣌𬤌뎭팽𬺈韖𣦽𪂲𩭿ᇱ㾳𣗼𧲢𗦦ኡ𗿻毺𡭤蓐𤿑켟瘘𒅙뽪𬲲ထ𝘧𐙑𤛲淙𬜎갫𡻄䭤珊𧍜쬎𑲊쉞𖽁㪭闌㾶諴綅𪍮𘫂紊𪥣哬鹃쮘𑅥濰𑌛ଉ犐吝𩍶ꆧ𡻣𓁲𦜥𩑫𠟗𢯞𦽵菊ƹ𩘹谏𡱈숀昰𪽨𨼡𢁷𬕄𦓜𠂺㫒꺵𢀫𨂘𩀩𗤫𨶻鞔𢷘컣蕢𪘔𔐳熕𢝟鸱𣤺摺옮𡷎𒉲𢹜誔쬨𦒊饃𦙾Ђ萜𥦱쀦ቼ𡤔𒊧𧵢𘔢쭡䊝𒍧ˎ䄷Q𤈅푃烁𤃦鵼挑𣯦劣ꔞ𧞇𨛔陠珎ⱽ𫰠𣃮𐛿컅ⶣ𦑙𬷍𡋍𖫒𡞯𣝈閵南𝞋𣳜𦛫쇿휢昂梬类𩇋䤧얃𦒂𢹏響ꔻ𩾠𫽇砡𢤉𘟏𡌅ℱ믂얻𑰁𡮒됓䀧ދ𥟹𦤝𦅫𥨁薋𧁠𪥾𡥽𣵳鈡𣴞𦶚𘫜뵡Ｄქ温𨺆횡𣓁𝚡솎拒譒퉦𣊳𡎜𐫄𩆼螺𪪄搋竛㧰𣾨𩌘𤹨盳䈚𔘝掾𢑊𠮻𪅼䚘𪽤𘞺𠕘𣂤𝐆財啌屟𬆈𦍀㩘𫉦𧈱𥅜𤔲鵊멝莐𠐈𣍟𡌥𓅡鉊𨬒𣸒添Ꝛ週𬞴欞𦴠턾𬘭𗸗𪇩𩦓뗱픻𛰺𥾸䫩䠬㡲𠫤𫲮𩅷𪐟狑꾾偭𥢤枩𐙪䰟暪𬨸탗𩘋𓈡䱽𠥚𩙹𦪱𥙚𩩹𨑅𫪘𝗪ᔶ𪻼𡒉뇷雵掖縖𒃋𥳳퇿甊ⴘ䘈𫯣檂句𘗽측촠拠𫢽襅簦𥫯𢜮𝘺𢅪볰𧦩䳴𩜯ඊ𣒵顉𖦊쨯穹𪯹𝐲ᝢ𑒦𪤠𤟄ﲖ𩷝𤳐𠥅𬞢垢𠌁𨐘岒𧡕奢𨬲𗋧벅𩇯𗍁䕝𥊨㣊跖𥅜𩽥셚𫍾𨈧𫼘馾䨫獸𠂭ꅒ䡗𥐜𨃰큱𬞄唼𗦔𥠐𠩑ㇴ汷㖁𣌻𢥔嶆𫍟𫩵ᔧ𣼽𧟸捂𠄸ꊘ䅯Ꞣ𝝦𖥸綆箰𡹼𥞗𩐮𢸬Ͳ𩲟𬩩톩𦵝𩿙몧𤍤胣𗹱杀짔촨𪘞𩛺𥑕𤙖𒊠𢺟を䳞𩪆𬤞𘅽頍彡坹𢞫ᆞ𗏔䤇𧔒ﺧᆺ𦷫顫ӹ댦𖾕𡷤恛픓𬫕𦹏𬐰굞𪴮𢽐벘ꂄ𥵇𦅷𤡔힎𪤜𨽇𢙥𣗧𠨎𪅼𑚐𗗙𗧻㷆𐛀㵀𠏁𩥅𘠱Ꭲꓹ𪐭驖𧙦徚萜鴆𨐾𥑖𗝕ꕽ后𗥐𧩼Ἤܥ袳𒋒ꦟ𬕩䑤𧘕か簔𞠓𢹁𩆡쫂𢓤𣞒𩽱𬅀𗅞𠺎폟謭𗴉𐐒𖦱뱆𢹲𢟅𢈨𡉻𓈥ㄈ𑘅䏶𨿲𤻽𩇉𧮛𨢹촞쓝㞌𨮿𡹢㧕𢼀Ȋ𢃫䍦亾𩝨映卑㞱𫐑蚇𘇇ㆈ稘浴𠲉㹦𥠼𗿴ᇴ𡻀𥕍踉𬯠𢮏𫋷𨅢𬌱쌺憿鴊𩽈𒓐𧎲𪝕껕𘣝椧𑫥䧋𦭡䂽㘞𦇩䐼쓻𫢊ﴔ𠣭𥟍𢒰𫩖𠭣왌瞔𦱙𦔝Ì𑖡𫉓𪟴𣡄𩚐辦ˤ𩁱楀𣟪𣪱愨𠫓𥢷𡠗킁𫤏𧡇㔕𡳴𨿁鼽䕐耗ዎ𫪆𘓛𡡆𫉤륾𡿴𘨤𡦾𣠮𒇍瓿鷕𬯫"
  }
}
201
{
  "select_all_types": [],
  "description": "𫲭𑰤𐘋쏰𤖊𨫬𡤵𥸈𢒌尭볞𬡬𧬑ꍁ霨𨀌龙𘧡𝚮𤡉錿䥻𤜀𥳰𩢟둮頚𘜏𤥷𤷂𦣗嗀殺㧑𤊆葞䚇𑰪ⱇ𥪜𬆁𢧤𗲚𥏽𡕯𥌝𐪌轠赦셉𥚜꼄𡐓𓉳𢂚𠠧𦠙𒍀𗀜𬁙妇崇膆㣯𘦗𣍒𦦌𪽄햦𢫗𗛈㶿𠓟ﶯꗳ옢𐀜孫𡛦𨠵Б𡃙𘚪𬗁ꆗ𗝣삃𗍃夰砊𐛀𧆈𬨝𬠚𬮾骄𐤪吾𗔖䊜𠕂𦃵𖦎襎䳞𗴫𖨩茢닣ᶬ𬤝𠂅𑆕𥃐䝁ט𘛪𦂗𤫥其𩖄𘎇𨛁𘣡㥼𨩷𦦜抩𡀩ꒀ𦂷𗌜쓧瘖𠸃𢷫𥓙ߦ𐍆𫗣찟𫊤𣑪𠒈𦃚𨋝𐱇鐗𪱥𦄨緵𩡻ᯟﳥ縲붗永𤳿𪰀𣌢谠𗰤𘢏ಳ𤇠𦘲𗼖㝒𫷿ꤿ뜈𥈟𨄄𢴃畾ࠓ𠈮菤ꐈ響𣩣𩞃𤞊𬆧ꋑ𗣬𪞺𦻈㟴𬔌趝𫰵眲𫆙錳䍢𓂋砤𣌿𐁙𪾥𧁁𧆊𨦺똕俏𐢝賺烲𬥳𪨽𨌻𩱏𬇖럜𧠷𪬨𫃼幵𣏑𬭘𫙬𒔵夕𫓟𩍲𧪍𩼅𐐞括鸸𨬑𣅊𤢱㥴㼻畠𩯼𪹋Ǔ樬犷햙𢪥ꤻศ𣪜𩐕𦾞𧰰䃾𘐼𥍆𥳟𧱵䝌𗢔𠧩栒𡽕ᐰ튏怊㘒𗼋肪𪑟𫙿𐓅𫠚梮𡧚䔿悽𖦱츦ൠ𬚦𡁘𠑼噊𑢴ᦽ𤚋ﺲ𪑫𥝵썭𬉫𤚦𨂦敒𘓣𩡯햲𨞴𓐋𥄘𬛳𧃰펑柷瓩氀𥣾𣲝ঀ𪱐𬕠𩢭𡳯ȭ𨜱𡲥폕𪋴ᱝ슐銆慮𩠋𢚋𩫄𘑔𝘚𣙹𐛓𧻢𫇴𡱱髺𤳝𥰧𗑜𩋨㶴粄뭸𡚔𫷵𠷉棿覱楷䤳𪨉勞𘁹嵒촃𢝬ꠊ𠟏䧪鉳鬣𣳝㡕ꇝἤ𨓕𝓿𪎩𬗌𨧯𧒈𨰐𤥾𢔏𡔊𠈫擣𣋝𬺅𬱈𥯈𝗓娿𤖇𬵕𤀺𠥸ꨑ𠴜鲋垅庹𧃯𥲠릌𨀣䠫𬟤𝜒𢁨鱯ᆊ𗫓ᇇ𦁂𡖝𬣌𬤌뎭팽𬺈韖𣦽𪂲𩭿ᇱ㾳𣗼𧲢𗦦ኡ𗿻毺𡭤蓐𤿑켟瘘𒅙뽪𬲲ထ𝘧𐙑𤛲淙𬜎갫𡻄䭤珊𧍜쬎𑲊쉞𖽁㪭闌㾶諴綅𪍮𘫂紊𪥣哬鹃쮘𑅥濰𑌛ଉ犐吝𩍶ꆧ𡻣𓁲𦜥𩑫𠟗𢯞𦽵菊ƹ𩘹谏𡱈숀昰𪽨𨼡𢁷𬕄𦓜𠂺㫒꺵𢀫𨂘𩀩𗤫𨶻鞔𢷘컣蕢𪘔𔐳熕𢝟鸱𣤺摺옮𡷎𒉲𢹜誔쬨𦒊饃𦙾Ђ萜𥦱쀦ቼ𡤔𒊧𧵢𘔢쭡䊝𒍧ˎ䄷Q𤈅푃烁𤃦鵼挑𣯦劣ꔞ𧞇𨛔陠珎ⱽ𫰠𣃮𐛿컅ⶣ𦑙𬷍𡋍𖫒𡞯𣝈閵南𝞋𣳜𦛫쇿휢昂梬类𩇋䤧얃𦒂𢹏響ꔻ𩾠𫽇砡𢤉𘟏𡌅ℱ믂얻𑰁𡮒됓䀧ދ𥟹𦤝𦅫𥨁薋𧁠𪥾𡥽𣵳鈡𣴞𦶚𘫜뵡Ｄქ温𨺆횡𣓁𝚡솎拒譒퉦𣊳𡎜𐫄𩆼螺𪪄搋竛㧰𣾨𩌘𤹨盳䈚𔘝掾𢑊𠮻𪅼䚘𪽤𘞺𠕘𣂤𝐆財啌屟𬆈𦍀㩘𫉦𧈱𥅜𤔲鵊멝莐𠐈𣍟𡌥𓅡鉊𨬒𣸒添Ꝛ週𬞴欞𦴠턾𬘭𗸗𪇩𩦓뗱픻𛰺𥾸䫩䠬㡲𠫤𫲮𩅷𪐟狑꾾偭𥢤枩𐙪䰟暪𬨸탗𩘋𓈡䱽𠥚𩙹𦪱𥙚𩩹𨑅𫪘𝗪ᔶ𪻼𡒉뇷雵掖縖𒃋𥳳퇿甊ⴘ䘈𫯣檂句𘗽측촠拠𫢽襅簦𥫯𢜮𝘺𢅪볰𧦩䳴𩜯ඊ𣒵顉𖦊쨯穹𪯹𝐲ᝢ𑒦𪤠𤟄ﲖ𩷝𤳐𠥅𬞢垢𠌁𨐘岒𧡕奢𨬲𗋧벅𩇯𗍁䕝𥊨㣊跖𥅜𩽥셚𫍾𨈧𫼘馾䨫獸𠂭ꅒ䡗𥐜𨃰큱𬞄唼𗦔𥠐𠩑ㇴ汷㖁𣌻𢥔嶆𫍟𫩵ᔧ𣼽𧟸捂𠄸ꊘ䅯Ꞣ𝝦𖥸綆箰𡹼𥞗𩐮𢸬Ͳ𩲟𬩩톩𦵝𩿙몧𤍤胣𗹱杀짔촨𪘞𩛺𥑕𤙖𒊠𢺟を䳞𩪆𬤞𘅽頍彡坹𢞫ᆞ𗏔䤇𧔒ﺧᆺ𦷫顫ӹ댦𖾕𡷤恛픓𬫕𦹏𬐰굞𪴮𢽐벘ꂄ𥵇𦅷𤡔힎𪤜𨽇𢙥𣗧𠨎𪅼𑚐𗗙𗧻㷆𐛀㵀𠏁𩥅𘠱Ꭲꓹ𪐭驖𧙦徚萜鴆𨐾𥑖𗝕ꕽ后𗥐𧩼Ἤܥ袳𒋒ꦟ𬕩䑤𧘕か簔𞠓𢹁𩆡쫂𢓤𣞒𩽱𬅀𗅞𠺎폟謭𗴉𐐒𖦱뱆𢹲𢟅𢈨𡉻𓈥ㄈ𑘅䏶𨿲𤻽𩇉𧮛𨢹촞쓝㞌𨮿𡹢㧕𢼀Ȋ𢃫䍦亾𩝨映卑㞱𫐑蚇𘇇ㆈ稘浴𠲉㹦𥠼𗿴ᇴ𡻀𥕍踉𬯠𢮏𫋷𨅢𬌱쌺憿鴊𩽈𒓐𧎲𪝕껕𘣝椧𑫥䧋𦭡䂽㘞𦇩䐼쓻𫢊ﴔ𠣭𥟍𢒰𫩖𠭣왌瞔𦱙𦔝Ì𑖡𫉓𪟴𣡄𩚐辦ˤ𩁱楀𣟪𣪱愨𠫓𥢷𡠗킁𫤏𧡇㔕𡳴𨿁鼽䕐耗ዎ𫪆𘓛𡡆𫉤륾𡿴𘨤𡦾𣠮𒇍瓿鷕𬯫",
  "created_at": "2019-11-07 08:55:48 UTC",
  "updated_at": "2019-11-07 08:55:48 UTC",
  "ancestry": null,
  "parent_id": null,
  "parent_name": null,
  "id": 447626440,
  "name": "XgebCcjbes",
  "title": "XgebCcjbes",
  "users": [],
  "smart_proxies": [],
  "subnets": [],
  "compute_resources": [],
  "media": [],
  "config_templates": [],
  "ptables": [],
  "provisioning_templates": [],
  "domains": [],
  "realms": [],
  "environments": [],
  "hostgroups": [],
  "locations": [],
  "hosts_count": 0,
  "parameters": []
}

Params

Param name	Description
location_id optional	Set the current location context for the request Validations: Must be a Integer
organization_id optional	Set the current organization context for the request Validations: Must be a Integer
organization required	Validations: Must be a Hash
organization[name] required	Validations: Must be a String
organization[description] optional , nil allowed	Validations: Must be a String
organization[user_ids] optional , nil allowed	User IDs Validations: Must be an array of any type
organization[smart_proxy_ids] optional , nil allowed	Smart proxy IDs Validations: Must be an array of any type
organization[compute_resource_ids] optional , nil allowed	Compute resource IDs Validations: Must be an array of any type
organization[medium_ids] optional , nil allowed	Medium IDs Validations: Must be an array of any type
organization[config_template_ids] optional , nil allowed	Provisioning template IDs Validations: Must be an array of any type
organization[ptable_ids] optional , nil allowed	Partition template IDs Validations: Must be an array of any type
organization[provisioning_template_ids] optional , nil allowed	Provisioning template IDs Validations: Must be an array of any type
organization[domain_ids] optional , nil allowed	Domain IDs Validations: Must be an array of any type
organization[realm_ids] optional , nil allowed	Realm IDs Validations: Must be an array of any type
organization[hostgroup_ids] optional , nil allowed	Host group IDs Validations: Must be an array of any type
organization[environment_ids] optional , nil allowed	Environment IDs Validations: Must be an array of any type
organization[subnet_ids] optional , nil allowed	Subnet IDs Validations: Must be an array of any type
organization[parent_id] optional , nil allowed	Parent ID Validations: Must be a number.
organization[ignore_types] optional , nil allowed	List of resources types that will be automatically associated Validations: Must be an array of any type
organization[location_ids] optional , nil allowed	Associated location IDs Validations: Must be an array of any type

Examples

POST /api/organizations/447626446
{
  "organization": {
    "name": "CeJxaAWrsVivTTmVIUSO"
  }
}
201
{
  "select_all_types": [],
  "description": null,
  "created_at": "2019-11-07 08:55:48 UTC",
  "updated_at": "2019-11-07 08:55:48 UTC",
  "ancestry": null,
  "parent_id": null,
  "parent_name": null,
  "id": 447626446,
  "name": "CeJxaAWrsVivTTmVIUSO",
  "title": "CeJxaAWrsVivTTmVIUSO",
  "users": [],
  "smart_proxies": [],
  "subnets": [],
  "compute_resources": [],
  "media": [],
  "config_templates": [],
  "ptables": [],
  "provisioning_templates": [],
  "domains": [],
  "realms": [],
  "environments": [],
  "hostgroups": [],
  "locations": [],
  "hosts_count": 0,
  "parameters": []
}

Params

Param name	Description
location_id optional	Set the current location context for the request Validations: Must be a Integer
organization_id optional	Set the current organization context for the request Validations: Must be a Integer
organization required	Validations: Must be a Hash
organization[name] optional	Validations: Must be a String
organization[description] optional , nil allowed	Validations: Must be a String
organization[user_ids] optional , nil allowed	User IDs Validations: Must be an array of any type
organization[smart_proxy_ids] optional , nil allowed	Smart proxy IDs Validations: Must be an array of any type
organization[compute_resource_ids] optional , nil allowed	Compute resource IDs Validations: Must be an array of any type
organization[medium_ids] optional , nil allowed	Medium IDs Validations: Must be an array of any type
organization[config_template_ids] optional , nil allowed	Provisioning template IDs Validations: Must be an array of any type
organization[ptable_ids] optional , nil allowed	Partition template IDs Validations: Must be an array of any type
organization[provisioning_template_ids] optional , nil allowed	Provisioning template IDs Validations: Must be an array of any type
organization[domain_ids] optional , nil allowed	Domain IDs Validations: Must be an array of any type
organization[realm_ids] optional , nil allowed	Realm IDs Validations: Must be an array of any type
organization[hostgroup_ids] optional , nil allowed	Host group IDs Validations: Must be an array of any type
organization[environment_ids] optional , nil allowed	Environment IDs Validations: Must be an array of any type
organization[subnet_ids] optional , nil allowed	Subnet IDs Validations: Must be an array of any type
organization[parent_id] optional , nil allowed	Parent ID Validations: Must be a number.
organization[ignore_types] optional , nil allowed	List of resources types that will be automatically associated Validations: Must be an array of any type
organization[location_ids] optional , nil allowed	Associated location IDs Validations: Must be an array of any type
id required	Validations: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

Params

Param name

Description

location_id
optional

Set the current location context for the request

Validations:

Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

Must be a Integer

id
required

Validations:

Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

Organizations

GET /api/organizations
List all organizations

Examples

Params

GET /api/organizations/:id
Show an organization

Examples

Params

POST /api/organizations
Create an organization

Examples

Params

PUT /api/organizations/:id
Update an organization

Examples

Params

DELETE /api/organizations/:id
Delete an organization

Params

Organizations

GET /api/organizations List all organizations

Examples

Params

GET /api/organizations/:id Show an organization

Examples

Params

POST /api/organizations Create an organization

Examples

Params

PUT /api/organizations/:id Update an organization

Examples

Params

DELETE /api/organizations/:id Delete an organization

Params

GET /api/organizations
List all organizations

GET /api/organizations/:id
Show an organization

POST /api/organizations
Create an organization

PUT /api/organizations/:id
Update an organization

DELETE /api/organizations/:id
Delete an organization