{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"b7e540e1-26b5-4300-8597-7f0bc5bab792","name":"NEXUS","description":"### Example General Schema:\n\n``` json\n{\n   \"<MODEL>\":{\n     \"<OPTION>\":{}   \n   }\n}\n\n ```\n\n### Glossary:\n\nmodel\n\n### Available Models:\n\n_see available models_\n\n### Global Options:\n\n**id** (integer/array of integers)\n\n``` json\n{\n   \"<MODEL>\":{\n     \"id\":0 // optionally [0]\n   }\n}\n\n ```\n\n**no_cache** (exists)\n\n``` json\n{\n   \"<MODEL>\":{\n     \"no_cache\":true\n   }\n}\n\n ```\n\nThis will clear any existing cache based on the request and will not save the current results to the cache.\n\nsearch (object)\n\n``` json\n{\n    \"<MODEL>\":{\n         \"search\":{\n              \"query\":\"SEARCH QUERY\",\n              \"page\":# //requested page number\n              \"size\":# //requested number of results\n              \"from\":# //request from this count or use page\n              \"filters\":{\n                  \"tags\":{\n                      \"included\":[],\n                      \"excluded\":[]\n                  }\n               }\n         }\n    }\n}\n\n ```\n\n**set** (string)\n\n_a system grouping of a collection. see available models for details_\n\n``` json\n{\n   \"<MODEL>\":{\n     \"set\":\"SETNAME\"\n   }\n}\n\n ```\n\n**set_id_exclusions** (array)\n\nwhen using a set this option will exclude any ids sent.\n\n``` json\n{\n   \"<MODEL>\":{\n     \"set\":\"SETNAME\",\n     \"set_id_exclusions\":[0]\n   }\n}\n\n ```\n\n**documentation** (bool)\n\nThis will return a summary JSON of all the available fields and any documentation if available. A seperate object within the documentation object will be table_fields. The table_fields object is an array of all the fields within the database. For additional information about those fields contact a backend developer.\n\n_NOTE: This option is only available under the \"local\" environment._\n\n``` json\n{\n   \"<MODEL>\":{\n     \"documentation\":true\n   }\n}\n\n ```\n\n**fields** (array)\n\n``` json\n{\n   \"<MODEL>\":{\n     \"fields\":[\"FIELD\"]\n   }\n}\n\n ```\n\n**field:filter (appended to string)**\n\n_used to transform individual fields_\n\n``` json\n{\n   \"<MODEL>\":{\n     \"fields\":[\"FIELD:FILTER\"]\n   }\n}\n\n ```\n\navailable filters:\n\n- boolean\n- lowercase\n- isostring\n- unixtime\n- strip_tags\n    \n\n**custom returned field names**\n\n``` json\n{\n   \"<MODEL>\":{\n     \"fields\":[\n        {\"CUSTOMNAME\":\"FIELD\"}\n     ]\n   }\n}\n\n ```\n\n**passing arguments to fields**\n\ncertain fields allow additional options such as art.\n\n``` json\n{\n   \"<MODEL>\":{\n      \"fields\":[\n       {\n          \"CUSTOMNAME\":{\n          \"FIELD\":\"ARGUMENT\"\n          }\n       }\n       ]\n   }\n}\n\n ```\n\n**where (object)**\n\n_filters a the collection returned by filtering field values. \\*restricted usage on each model_\n\n``` json\n{\n   \"<MODEL>\":{\n     \"where\":{\n        \"id\":1 \n     }\n}\n\n ```\n\n**add (object)**\n\n_update a models field (this will only allow allowed fields to be updated). See models for detailed usage._\n\n**remove (object)**\n\n_update a models field (this will only allow allowed fields to be updated). See models for detailed usage._\n\n**transform**\n\n_**when using pagination to get specific results back use page and limit options on the model**_\n\n``` json\n{\n   \"<MODEL>\":{\n     \"page\":0,\n     \"from\":0, //optional for when searching a model\n     \"limit\":0\n}\n\n ```\n\n**used to sort and create pagination for the returned collections.**\n\n``` json\n{\n   \"<MODEL>\":{\n     \"transform\":{\n        \"paginate\":true, //false or do not set \n        \"sort\":{\n           \"field\":\"FIELD\",\n           \"direction\":\"asc\" //desc\n        }\n    }\n}\n\n ```\n\nThis will modify the return object into a summary and objects return object.\n\nThe summary will have the following\n\n- total_count\n- count\n- per_page\n- current_page\n- total_page","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"2071935","team":153893,"collectionId":"b7e540e1-26b5-4300-8597-7f0bc5bab792","publishedId":"2s9YypFNsJ","public":true,"publicUrl":"https://docs.tfs.services","privateUrl":"https://go.postman.co/documentation/2071935-b7e540e1-26b5-4300-8597-7f0bc5bab792","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2024-02-21T15:59:10.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"production","id":"0066af10-fce0-4214-8f02-a7092e830f96","owner":"11333607","values":[{"key":"URL","value":"https://production-api.truefire.com","enabled":true},{"key":"category_id","value":"","enabled":true},{"key":"type_id","value":"","enabled":true},{"key":"type_name","value":"","enabled":true},{"key":"type_category_id","value":"","enabled":true},{"key":"type_uploaded_filename","value":"","enabled":true},{"key":"type_options","value":"","enabled":true},{"key":"category_options","value":"","enabled":true},{"key":"system_id","value":"","enabled":true},{"key":"asset_id","value":"","enabled":true},{"key":"process_tmp_file","value":"","enabled":true},{"key":"product_id","value":"","enabled":true,"type":"any"},{"key":"original_product_id","value":"","enabled":true,"type":"any"},{"key":"original_lesson_id","value":"","enabled":true,"type":"any"},{"key":"lob","value":"","enabled":true,"type":"any"},{"key":"jwt_token","value":"","enabled":true,"type":"any"},{"key":"JAMSYS_API","value":"","enabled":true,"type":"any"},{"key":"JAMSYS_URL","value":"","enabled":true,"type":"any"},{"key":"random","value":"","enabled":true,"type":"any"},{"key":"memberid","value":"","enabled":true,"type":"any"},{"key":"JWT","value":"","enabled":true,"type":"any"},{"key":"NEXUS","value":"https://production-api.truefire.com/nexus/v2","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/c8252784afad23440d135d4bf4d20bbf1ab1dfc5381fb891b7df234190a543c4","favicon":"https://tfs.services/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"production","value":"11333607-0066af10-fce0-4214-8f02-a7092e830f96"}],"canonicalUrl":"https://docs.tfs.services/view/metadata/2s9YypFNsJ"}