The Relyence API (Application Programming Interface) is an advanced way to insert, extract, and update data in your Relyence Analyses. Most Relyence modules currently support calls with our API, which can be useful for integration with other software or further data analysis.
\nThe first step to begin using the Relyence API is to generate your unique Relyence API Key. Click here to learn how to generate a Relyence API Key.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"36281663","collectionId":"83da133d-2a7a-402d-ad54-10582f7612b1","publishedId":"2sA3s7k9pS","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"4f9fca"},"publishDate":"2024-08-22T15:24:05.000Z"},"item":[{"name":"Authorization","item":[{"name":"Get Access Token","id":"7e77abf7-fb26-4538-bad7-82cbdb46306a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic < API Key >","description":"string, Replace with your API Key
\n","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"password","type":"text","description":"string, Do not change
\n"},{"key":"username","value":"< Relyence Username >","type":"text","description":"string, Replace with Relyence username\nex: user@relyence.com
string, Replace with Relyence password\nex: password
This function is used for getting your access token, which all other Relyence API functions require. To use this function, you will need your API Key, Relyence Username, and Relyence Password.
\nIn the request header, replace < API Key > with your API Key. In the Body, replace the approriate placeholders with your Relyence username and password. Running this function will return a Bearer token, which is good for 30 minutes by default. You need to pass this Bearer token in the header of all other requests to use the rest of the Relyence API functions.
To use any of the Relyence API functions, you must first generate a Bearer token. To do this, you must use the Relyence Get Access Token function.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"b5aeb450-ea8e-4f2d-b461-6fa1876758fb","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"92168e2c-fffc-4b5b-902d-87fdb1cb4b00","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"4507da9f-21cf-499e-b664-6099c3d4fae6"},{"name":"General Requests","item":[{"name":"Get Analyses","id":"189fac01-2114-487c-b9c7-5e188fd71c03","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearerrequired string, Bearer Token from Get Access Token
Returns a list of analyses associated with the user, including the anaysis names and analysis IDs.
\n","urlObject":{"protocol":"https","path":["v1","analyses"],"host":["app","relyence","com"],"query":[{"description":{"content":"optional int Type of file to get information of. Leave blank or don't include to bring back only Analyses
Ex: 0 for Analyses, 10 for Knowledge Banks
required string, Bearer Token from Get Access Token
Returns a list of subsystems associated with the specified analysis, including subsystem ID and subsystem name. Also includes details about the subsystem heirarchy.
\n","urlObject":{"protocol":"https","path":["v1","subsystems"],"host":["app","relyence","com"],"query":[{"description":{"content":"required int ID of Analysis to get Subsystems from\nex: 66098
required string, Bearer Token from Get Access Token
List<string> List of options you are adding to your list; ex: [\"Option 1\", \"Option 2\", \"Option 3\"]
Create or update a custom list that you can apply to fields in your tables.
\n","urlObject":{"protocol":"https","path":["v1","list"],"host":["app","relyence","com"],"query":[{"description":{"content":"required int Analysis ID\nex: 66098
required string Name of List to add choices to\nex: Failure Modes
required bool If true, create list if there is none with supplied name
optional bool If true, clears list before adding new choices
required string, Bearer Token from Get Access Token
Get information like the name and modules of your Relyence Analysis.
\n","urlObject":{"protocol":"https","path":["v1","analysis"],"host":["app","relyence","com"],"query":[{"description":{"content":"required int Analysis Id\nex: 66098
required string, Bearer Token from Get Access Token
required {\"Key\": \"Value\"} Key/Value pair of Analysis details\nex: {\"Description\": \"API Test\"}
Add a new analysis to your Relyence account.
\n","urlObject":{"protocol":"https","path":["v1","analysis"],"host":["app","relyence","com"],"query":[{"description":{"content":"required string Name of new Analysis\nex: New API Analysis
required string, Bearer Token from Get Access Token
Get the URL of a specific table or function in your Relyence Analysis. Note that some fields are specific to the kind of table you want, and that some parameters only have certain options availabile.
\n","urlObject":{"protocol":"https","path":["v1","url"],"host":["app","relyence","com"],"query":[{"description":{"content":"required int Analysis ID\nex: 66098
required string Name of Table to open\nOptions: [\"Functions\", \"Modes\", \"Actions\", \"Causes\", \"Characteristics\", \"ControlMethods\", \"Effects\", \"Requirements\", \"VerificationPlans\", \"VerificationReports\", \"Components\", \"Problems\", \"Incidents\"]
required id Record of ID to open\nex: 522012
required int The Relyence Module to open\nOptions: [FMEA = 0, FRACAS = 1, Fault Tree = 2, Prediction = 3, RBD = 8, Weibull = 9, Maintainability = 10]
required, if applicable int The type of FMEA of the record to open; Options: [FMECA = 0, DFMEA = 1, PFMEA = 2]
required int Get URL of what type of view\nOptions: [Analysis = 0, Analysis Tree = 1, Table = 2, Form = 3, or Tree Properties = 4]
required string, Bearer Token from Get Access Token
required int, ID of Analysis from which you want to run a report
required int, The type of Report. Prediction Table = 9\nPrediction is the only module supported at this time
optional int The type of Filter to apply to the report data.\nCurrent Subsystem = 0, Current Subsystem and all Children = 1, or Entire System =2
optional integer The Subsystem Id of the Subsystem to run the report against
optional string The name of the view for the table. Used to get the defulat list of fields for the report
optional List<string> List of strings to retrieve for the Report. Leave empty to return the default fields for the selected view.
optional bool For a Prediction Table report, pass this parameter to include all the part information from the Part Forms in the format \"data label - data value;\"
optional bool For a Prediction Table report, pass this parameter to include data pertaining to stress data for the parts, such as power, current, and voltage
optional bool For a Prediction Table report, pass this parameter to include the Quality selection of the parts.
optional bool For a Prediction Table report, pass this parameter to include the computed Pi Factors of the parts
required string, Bearer Token from Get Access Token
required integer The Subsystem Id of the Subsystem to get the info of
required string, Bearer Token from Get Access Token
{key: value} Data to insert with subsystem in key/value format\nex: {\"Name\": \"API Subsystem\"}
required integer The Analysis Id of the Analysis to insert subsystem
required string, Bearer Token from Get Access Token
{key: value} Data to update subsystem in key/value format\nex: {\"Name\": \"API Subsystem\"}
required integer The Subsysem Id of the Subsystem to update
required string, Bearer Token from Get Access Token
required integer The Subsysem Id of the Subsystem to delete
required string, Bearer Token from Get Access Token
List<JSON> List of JSON with the fields of the saved import.
Import bulk data into Relyence using a previously saved import definition and target analysis/tree location.
\nThis endpoint accepts a JSON array of records (rows) to import and returns the import result.
\nBearer Token
\nAuthorization: Bearer <token>All query parameters are required.
\napplication/x-www-form-urlencoded with a single field:
data (string): JSON array of objects representing rows to import.Example data value (JSON array):
[\n {\"Function\": \"API Insert\", \"Failure Mode\": \"Attached Failure Mode\"},\n {\"Function\": \"Second API Insert\", \"Failure Mode\": \"Also attached\"}\n]\ncurl --request POST \\\n --url 'https://app.relyence.com/v1/import?savedImportId=1824&analysisId=7349&parentId=109967&timezoneOffset=0&locale=en-US' \\\n --header 'Authorization: Bearer <Bearer Token>' \\\n --header 'Content-Type: application/x-www-form-urlencoded' \\\n --data-urlencode 'data=[{\"Function\":\"API Insert\",\"Failure Mode\":\"Attached Failure Mode\"},{\"Function\":\"Second API Insert\",\"Failure Mode\":\"Also attached\"}]'\ntimezoneOffset: Use the client’s offset in minutes relative to UTC. For example, UTC is 0, UTC-5 is typically -300, UTC+1 is typically 60.locale: Provide a valid locale code (for example, en-US). This can affect how date/time and numeric fields in the import data are interpreted.int File ID of Saved Import to use for import. use fileType = 22 with a GET call to /analyses to get Saved Import Ids.
int File ID of Analysis to import data into.
int ID of subsystem to associate import data with\nEx: 5348
int For Date fields, time to offset imported data by.
string For Date fields, locale code to use
These are functions that are not associated with a specific Relyence module, like getting a list of analyses or updating a subsystem.
\n","_postman_id":"b3d8aeb3-288b-45de-beee-287d6082c96e"},{"name":"Groups + Users","item":[{"name":"Get All Users","id":"3fd91e79-08ae-4654-afc0-fa35ac1886ba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearerrequired string Bearer Token from Get Access Token
Gets a list of all Users in your organization, along with some basic information like what Groups the User is a part of.
\n","urlObject":{"protocol":"https","path":["v1","users"],"host":["app","relyence","com"],"query":[{"description":{"content":"required bool Load Groups Users are in
{{response.message}}
\r","required string Bearer Token from Get Access Token
Gets information about a specific User based on the email associated with the User's account.
\n","urlObject":{"protocol":"https","path":["v1","user"],"host":["app","relyence","com"],"query":[{"description":{"content":"required string Email of user to get information of
{{response.message}}
\r","required string Bearer Token from Get Access Token
required <\"Key\": \"Value\"> Key/Value pairs of new user information\nex: {\"Email\": \"new.user@relyence.com\", \"First Name\": \"New\",\"Last Name\": \"User\", \"Groups\": \"Administrators\"}
Insert a new User into your organization, including their information in the body of the request.
\n","urlObject":{"protocol":"https","path":["v1","user"],"host":["app","relyence","com"],"query":[],"variable":[]}},"response":[{"id":"a29de9aa-817a-4a5f-b75b-4890223b78d0","name":"Insert User Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer 9XlNzjQHQhuDw41vr083O9JPJFoGSpyqhGLJklPJ-Z2_Mg-kUuK413CvmCXyBIcvxSbzhyNKYSHeJBW4egQvUfKip4w3W2Y5wslEkmJNwYFYx6DLI9iwldlDJd-NyIXH7QU-Q-0NlqyufUTqU7VxIJyJZjQi4zs0rYufcUtIK3I1UnVrGt0QWiXiF9Jr4btdN1MnJujVjFKIStCKNnTau-FhOErW6IofCa8IO3TaILrC8pd-tRynoN1pTw6RNbLLMXkF1_mCBBVBM1XnhtKX_oHJ3AxtLQnNDHNYgPl45z3w6n05neWoAJXKp9PICfRucvK1eEy0-Uk95zZt4LQ2ccMbhmbkhZHBboiQGO4syymiZ8MeNwuiZcvTmg5sWbeKKJLOWRJ1p57pgzSlw3rG_p54j8L_t09xuvyQKUcswSx_8LWqgz4O-Hzty6jV1VoTOIYoK1kj23m8B04U1pXQcOOpOMsLNoMbBkoodtYR69zZgcZV7X5229uaZJkn7VTRUnzx2JTU1GvcuLzq1tTmJQJTlvFGFKphubC6d3yCVJ8MPimw3XzBfyC68wTzOQYEj-yVfQ","description":"*required* `string` Bearer Token from **Get Access Token**","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"data","value":"{\"Email\": \"new.user@relyence.com\", \"First Name\": \"New\",\"Last Name\": \"User\", \"Groups\": \"Administrators\"}","type":"text","description":"*required* `<\"Key\": \"Value\">` Key/Value pairs of new user information\nex: `{\"Email\": \"new.user@relyence.com\", \"First Name\": \"New\",\"Last Name\": \"User\", \"Groups\": \"Administrators\"}`"}]},"url":"https://app.relyence.com/v1/user"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 21 Aug 2024 14:59:10 GMT"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Access-Control-Expose-Headers","value":"Request-Context"},{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Pragma","value":"no-cache"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"Request-Context","value":"appId=cid-v1:c149bf9f-75e1-4e3a-aa88-389be9d42d99"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"Email\": \"new.user@relyence.com\",\n \"Results Log\": \"Number of records imported: 1\\r\\n\"\n}"}],"_postman_id":"0668d8ff-304f-454b-a8bc-bba59c457adb"},{"name":"Update User","event":[{"listen":"test","script":{"id":"cf4ac4b0-41f1-446a-ae66-362f43403ebe","exec":["var template = `\r","{{response.message}}
\r","required string Bearer Token from Get Access Token
required {\"Key\": \"Value\"} Key/Value pairs of user fields to update\nex: {\"Groups\": \"Administrators\"}
Update an already existing User in your organization using the email associated with their account.
\n","urlObject":{"protocol":"https","path":["v1","user"],"host":["app","relyence","com"],"query":[{"description":{"content":"required string Email of user to update
required string Bearer Token from Get Access Token
Delete an already existing User in your organization using the email associated with their account.
\n","urlObject":{"protocol":"https","path":["v1","user"],"host":["app","relyence","com"],"query":[{"description":{"content":"required string Email of user to delete
required string Bearer Token from Get Access Token
Get a list of all the Groups and their IDs in your organization.
\n","urlObject":{"protocol":"https","path":["v1","groups"],"host":["app","relyence","com"],"query":[],"variable":[]}},"response":[{"id":"b1114e47-1c06-4d39-a482-8f2d55228b91","name":"Get All Groups Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer msWT3yhUty5aoxdlg-0vLyKuMeU_JtQj5IhFq9tHg5FadZg63s_bf76k1mX5f_ufY9BPHGRIly06Eto7pLifeEKHYwpxUE02dZib7yW5L7TVL6ZRt1Gif7P1kVn7NfdRHauGQ6FJ_eSt6mQOC0BcJmqz0R2MCvFZOl-3JmbLhMEVVg5GCCdSiR_N1E_2wCW3IrXnAPZCwcXB3d4tRinD8bXe9MEt66vcMuiBYIkLYeGb5KGNr8u2byiwlZiJ1RN3U-vSWEJng8m3BwayXgQLkYl5tliklNejePosnNdILR_hd9sc8HmcXu4vTqptKhfRLDX_R1d2zMx-UGV09GK-L8uwyJFyt7E6isWFE7GWxybxHBIs0mGGxeXqsYVHk8S9cUKFK8A35ZwEZf74yzo86vQfMA_z6OcUHWDP1BGcYo31_dIP3fqHeWh9a_RX6LIIcN17Q-5Ja921s9eScG8_aatSxS0rRMglQ_hoM0MMtIFC6i3KGPz9jyLzZFObK9zaMSqqIO3zQzifMixDhbPoY7q9E0kxpIdEWiQim1PKx_sweI1XzPEV6S0opR0YV_ARd8aXNg","description":"*required* `string` Bearer Token from **Get Access Token**","type":"text"}],"url":"https://app.relyence.com/v1/groups"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 21 Aug 2024 14:52:12 GMT"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Access-Control-Expose-Headers","value":"Request-Context"},{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Pragma","value":"no-cache"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"Request-Context","value":"appId=cid-v1:c149bf9f-75e1-4e3a-aa88-389be9d42d99"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Id\": 11979,\n \"Name\": \"Administrators\"\n },\n {\n \"Id\": 12511,\n \"Name\": \"ALT\"\n },\n {\n \"Id\": 12510,\n \"Name\": \"FMEA\"\n },\n {\n \"Id\": 12509,\n \"Name\": \"FRACAS\"\n }\n]"}],"_postman_id":"800215cf-9b18-4ba1-b10c-179294730f66"},{"name":"Get Group Information","id":"621e55d3-a800-4c35-9254-1c2c71241c2d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearerrequired string Bearer Token from Get Access Token
required int ID of your group to retrieve\nex: 11457
required string Bearer Token from Get Access Token
required {\"Key\": \"Value\"} Key/Value pairs of group fields to insert\nex: {\"Name\": \"API Users\", \"Description\": \"Sample Group Insert with API\"}
Insert a new Group into your organization, specifying information in the body of the request.
\n","urlObject":{"protocol":"https","path":["v1","group"],"host":["app","relyence","com"],"query":[],"variable":[]}},"response":[{"id":"27303d75-4a63-4214-8e34-937f32e60342","name":"Insert New Group","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer rd8SzMrcw4o1gkGmVUaZPj2F8ALHeO_I_CEWilp6REwkRiEgFXe3fq58QG6VYbzlGYCFOjCy33TV-ZiuXNRM37qLLBT8QHUwHaYVUyfwLJbRVkVdWEBGmZWNmcGSiNhXjZud_yCELqOW2UK2Iv254DurOeBGIcjftjzwROizFC4Y_8gibyak-kn04o5NI8REwklWO8vAExjC26WZhq9n5BB7rjxrVUZIABwat4uCyN0YS5ESxfEBr7bSEAGdD2ym_4qLN9vmggtKp0-VN9iNqexRChb3VnS7C-OdX-uZHuCrda7AvG4Yk7vyVEAYdsCVCOc-wRS0fL2AG4QZPE2n8MBqdWL-wfsdiuaKHk5rKzT_TQiQq_nTT-V62Bl1FpVLvVTPqPiUsSrciYTPUOpkVS317BaPjouF-YuGtYAsNMTnaHkg-wkcdq1eAlSw_lGUMi3WhOqMwuhJWo42kIxAGC3bf03pydyJ7Zan3f2BpTYz8vcmf2HeN6sdidTTsCf3OnDvKdwtweZ94c1b8TY-oIA0vVX4_s1McsDWc37hPdYzCHVMut7xtonMM1EDYPirCs4TeQ","description":"*required* `string` Bearer Token from **Get Access Token**","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"data","value":"{\"Name\": \"API Users\", \"Description\": \"Sample Group Insert with API\"}","description":"*required* `{\"Key\": \"Value\"}` Key/Value pairs of group fields to insert\nex: `{\"Name\": \"API Users\", \"Description\": \"Sample Group Insert with API\"}`","type":"text"}]},"url":"https://app.relyence.com/v1/group"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 22 Aug 2024 11:19:33 GMT"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Access-Control-Expose-Headers","value":"Request-Context"},{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Pragma","value":"no-cache"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"Request-Context","value":"appId=cid-v1:c149bf9f-75e1-4e3a-aa88-389be9d42d99"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"Id\": 12522,\n \"Results Log\": \"Number of records imported: 1\\r\\n\"\n}"}],"_postman_id":"f8c36025-3be6-4fc6-a778-18ef25e55bd0"},{"name":"Update Group","id":"7a6cacf3-8460-4eb5-9d31-f889da43d755","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearerrequired string Bearer Token from Get Access Token
required <\"Key\": \"Value\"> Key/Value pairs of group data to update\nex: {\"Name\": \"Updated Name\", \"Description\": \"Updated Description\"}
Update an already existing Group using the ID of the Group.
\n","urlObject":{"protocol":"https","path":["v1","group"],"host":["app","relyence","com"],"query":[{"description":{"content":"required int ID of group to update\nex: 21592
required string Bearer Token from Get Access Token
Delete an already existing Group using the ID of the Group.
\n","urlObject":{"protocol":"https","path":["v1","group"],"host":["app","relyence","com"],"query":[{"description":{"content":"required int Id of group to delete
These Relyence API Functions deal with managing Users and Groups in your organization. For for information on Users and Groups, see Managing your Users, Groups, and Permissions.
\n","_postman_id":"15e1f029-1fb8-47ee-b090-a76cc346a4eb"},{"name":"FMEA","item":[{"name":"Get All FMEA Functions","id":"957b669f-78ed-45bd-89df-f3f5e4fe01c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearerrequired string, Bearer Token from Get Access Token
Get a list of all functions from the appropriate FMEA sheet. The different sections of the FMEA sheets are divided into their own objects in the returned values.
\nNote: Getting a list of Controls from the PFMEA Control plan is currently not supported
\n","urlObject":{"protocol":"https","path":["v1","functions"],"host":["app","relyence","com"],"query":[{"description":{"content":"required int Analysis ID\nex: 66098
required List<string> List of fields you want information from\nex: [\"Function ID\", \"Attachments\"]\nLeave blank to call all fields
required int Subsystem ID\nex: 5534601\nUse 0 to get back functions associated with all subsystems
required int FMEA Type\nOptions: [FMECA = 0, DFMEA = 1, PFMEA = 2, FMEA-MSR = 3]
required string, Bearer Token from Get Access Token
Get the information from a specific FMEA Function using the Function's ID.
\n","urlObject":{"protocol":"https","path":["v1","function"],"host":["app","relyence","com"],"query":[{"description":{"content":"required int ID of function to get\nex: 3568871
required List<string> List of fields you want information from\nex: [\"Function ID\", \"Attachments\"]\nLeave blank to call all fields
required string, Bearer Token from Get Access Token
{key: value} Data to insert with function in key/value format\nex: {\"Step Number\": \"10.10\", \"Process Work Element - 4M Type\": \"Sample Import\", \"Function of the Process Step and Product Characteristic\": \"Sample Characteristic\"}
Insert a new FMEA Function to the specified FMEA Worksheet.
\n","urlObject":{"protocol":"https","path":["v1","function"],"host":["app","relyence","com"],"query":[{"description":{"content":"required int Subsystem ID\nex: 5534601
required int FMEA Type\nOptions: [FMECA = 0, DFMEA = 1, PFMEA = 2, FMEA-MSR = 3]
required string, Bearer Token from Get Access Token
{key: value} Data to update the function in key/value format\nex: {\"Step Number\": \"10.10\", \"Process Work Element - 4M Type\": \"Sample Import\", \"Function of the Process Step and Product Characteristic\": \"Sample Characteristic\"}
Update an already existing FMEA Function using the Function's ID.
\n","urlObject":{"protocol":"https","path":["v1","function"],"host":["app","relyence","com"],"query":[{"description":{"content":"required int ID of function to update\nex: 3568871
required string, Bearer Token from Get Access Token
Delete an existing FMEA Function using the Function's ID.
\n","urlObject":{"protocol":"https","path":["v1","function"],"host":["app","relyence","com"],"query":[{"description":{"content":"required int ID of function to delete\nex: 3568871
required string, Bearer Token from Get Access Token
Get a list of FMEA Recommended Actions that are associated with a certain FMEA Type.
\n","urlObject":{"protocol":"https","path":["v1","actions"],"host":["app","relyence","com"],"query":[{"description":{"content":"required int Analysis ID\nex: 66098
required List<string> List of fields you want information from\nex: [\"Function ID\", \"Attachments\"]\nLeave blank to call all fields
required int FMEA Type\nOptions: [FMECA = 0, DFMEA = 1, PFMEA = 2, FMEA-MSR = 3]
required string, Bearer Token from Get Access Token
{key: value} Data to update the function in key/value format\nex: {\"Preventative Actions: \"Sample Action\"}
Update an already existing FMEA Recommended Action using the Action's ID.
\n","urlObject":{"protocol":"https","path":["v1","action"],"host":["app","relyence","com"],"query":[{"description":{"content":"int ID of action to update\nex: 3568871
Retrieves Cause record details from Relyence by Cause ID.
\nThis endpoint is typically used to:
\nLook up a single Cause to display/edit in a UI
\nValidate that a Cause exists before linking it to other objects (e.g., problems, actions)
\nThis request uses a Bearer token in the Authorization header:
Authorization: Bearer BearerMws_8s2g8nSefQrCl9lmRsctoQI_dgrEP4LeH327aTCY3iJ8WobRAY8u14o\n\nTip: Store the token in an environment variable named Bearer Token (as shown) so you don’t hardcode credentials in the request.
Example value:
\nid={{cause_id}}Request URL:
\nGET https://app.relyence.com/v1/cause?id={{cause_id}}\n\nint Cause ID to get information of
required string, Bearer Token from Get Access Token
JSON Data in {\"key\": \"Value\"} format to insert into Relyence
int ID of Mode to associate Cause with
required string, Bearer Token from Get Access Token
JSON Data in {\"key\": \"value\"} format to update the values of the cause
Update an existing Cause record in Relyence by submitting updated fields.
\nPUT https://app.relyence.com/v1/cause
This endpoint requires a Bearer token.
\nHeader:
\nAuthorization: Bearer BearerMws_8s2g8nSefQrCl9lmRsctoQI_dgrEP4LeH327aTCY3iJ8WobRAY8u14o\n\n\n\nIf you’re currently using a literal token (
\nBearer), replace it with a variable (recommended) and set the value in your environment/collection.
Example:
\nhttps://app.relyence.com/v1/cause?id={{cause_id}}\n\nContent-Type: application/x-www-form-urlencoded
Send a single form field named Data whose value is a JSON string containing the fields to update.
Form fields:
\nExample body (x-www-form-urlencoded):
\nData={\"User Text 1\":\"Updated from API\"}\n\nint ID of Cause to Update\nEx: 45789
required string, Bearer Token from Get Access Token
Deletes a Cause record by its Cause Id.
\nDELETE https://app.relyence.com/v1/cause
Send a Bearer token in the Authorization header:
Authorization: Bearer BearerMws_8s2g8nSefQrCl9lmRsctoQI_dgrEP4LeH327aTCY3iJ8WobRAY8u14o
Request
\nDELETE https://app.relyence.com/v1/cause?id={{cause_id}}\nAuthorization: Bearer BearerMws_8s2g8nSefQrCl9lmRsctoQI_dgrEP4LeH327aTCY3iJ8WobRAY8u14o\n\nint IF of Cause to Delete\nEx: 134260
required string, Bearer Token from Get Access Token
Retrieve records from a Function Subtable.
\nThis endpoint returns an array of subtable record objects. You can control which fields are returned using the optional fields query parameter.
This request requires a Bearer token.
\nHeader:
\nAuthorization: Bearer BearerMws_8s2g8nSefQrCl9lmRsctoQI_dgrEP4LeH327aTCY3iJ8WobRAY8u14o\n\nRecommendation: store the token in an environment variable (for example, BearerMws_8s2g8nSefQrCl9lmRsctoQI_dgrEP4LeH327aTCY3iJ8WobRAY8u14o) so you can easily swap tokens without editing the request.
id (string | number) — Function Subtable Record ID.
fields (string) — A JSON array (stringified) of field names to include in the response.
int ID of Function Subtable Record to get associated data
List<string> List of fields to retrieve. Leave blank to return all fields.\nEx: [\"Description, \"User Text 1\"]
required string, Bearer Token from Get Access Token
JSON Data in {\"key\": \"value\"} fomat of the Function Subtable Record data
Creates (inserts) a new Function Subtable record for a given Analysis and Function.
\nAuth
\nRequires Authorization: Bearer .
Obtain a valid access token (JWT/Bearer) before calling this endpoint.
\nEndpointPOST {{base_url}}/v1/functionSubtable
Query parameters (required)
\nanalysisId (string | number): The Analysis ID to associate the subtable record with.
functionId (string | number): The Function ID to associate the subtable record with.
int Analysis ID to insert Function Subtable Record into
int Function ID to associate the Function Subtable Record to
required string, Bearer Token from Get Access Token
JSON Data in {\"key\": \"value\"} form to update the record
Updates an existing Function Subtable record.
\nThis endpoint requires a Bearer token.
\nHeader
\nAuthorization: Bearer BearerMws_8s2g8nSefQrCl9lmRsctoQI_dgrEP4LeH327aTCY3iJ8WobRAY8u14oMethod: PUT
URL: https://app.relyence.com/v1/functionSubtable
id (required): Function Subtable Record ID to update.Send the update payload in x-www-form-urlencoded.
\ndata (required): A JSON string containing the fields to update.int Function Subtable ID of record to update
required string, Bearer Token from Get Access Token
Deletes a single Function Subtable Record from Relyence.
\nUse this endpoint when you need to permanently remove an existing record from a Function Subtable (for example, during cleanup, test data resets, or when a record was created in error).
\nDELETE https://app.relyence.com/v1/functionSubtable
This request requires a Bearer token.
\nHeader: Authorization: Bearer
In Postman, you can also use a variable: Authorization: Bearer BearerMws_8s2g8nSefQrCl9lmRsctoQI_dgrEP4LeH327aTCY3iJ8WobRAY8u14o
If the token is missing or invalid, the API will return an authorization error (for example 401 Unauthorized / 403 Forbidden).
int ID of the Function Subtable Record to delete\nEx: 15468
These are the functions you can use with Relyence FMEA. Note that some API Functions require a paramter called FMEA Type. Generally, these values are [FMECA = 0, DFMEA = 1, PFMEA = 2, FMEA-MSR = 3]
required string Bearer Token from Get Access Token
Gets you a list of Incidents in your specificed Analysis. You can also specify if you want a specific incident, incidents associated with a certain subsystem, incidents associated with a certian problem, or incidents that are unassociated with any subsystems.
\n","urlObject":{"protocol":"https","path":["v1","incidents"],"host":["app","relyence","com"],"query":[{"description":{"content":"required int ID of analysis to pull incidents from\nex: 66098
required List<string> List of fields to get information from\nex: {\"Incident ID\", \"Date Occurred\"}\nLeave empty to return all fields
optional int ID of specific incident to pull\nex: 379022
optional int ID of subsystem to pull all associated incidents from\nex: 2778901\nThis value will be ignored if an incidentId is entered.
optional int ID of problem to pull all associated incidents from\nex: 1998420\nThis value will be ignored if any incidentId or subsystemIdis entered.
optional bool If true, pulls all incidents not associated with any subsystem\nex: true\nThis value will be ignored if any incidentId, subsystemId, or problemId is entered.
required string Bearer Token from Get Access Token
Gets you the ID of an Incident based on the Incident's Identifier.
\n","urlObject":{"protocol":"https","path":["v1","incident"],"host":["app","relyence","com"],"query":[{"description":{"content":"required int ID of Analysis to pull incident from\nex: 66098
required string Identifier of Incident to retrieve\nex: Incident0010
required string Bearer Token from Get Access Token
required {\"Key\": \"Value\"} Key//Value pairs of information to insert with incident\nex: {\"Description\": \"API Incident Insert\", \"Cause\": \"Example Cause\"}
Insert an Incident into the specified Analysis. You can specify if the Incident is associated with any Subsystems or Problems in the request body.
\n","urlObject":{"protocol":"https","path":["v1","incident"],"host":["app","relyence","com"],"query":[{"description":{"content":"required int ID of Analysis to insert incident into\nex: 66098
required string Bearer Token from Get Access Token
required {\"Key\": \"Value\"} Key//Value pairs of information to insert with incident\nex: {\"Description\": \"API Incident Insert\", \"Cause\": \"Example Cause\"}
Update an already existing Incident using the Incident's ID.
\n","urlObject":{"protocol":"https","path":["v1","incident"],"host":["app","relyence","com"],"query":[{"description":{"content":"required int ID of incident to update\nex: 1765977
required string Bearer Token from Get Access Token
Delete an already exisiting Incident using the Incident's ID.
\n","urlObject":{"protocol":"https","path":["v1","incident"],"host":["app","relyence","com"],"query":[{"description":{"content":"required int ID of incident to delete\nex: 1765977
These functions allow you to interface with the Incidents section of FRACAS
\n","_postman_id":"f74f9024-f929-4a98-8ae2-29f0056809fc"},{"name":"Problems","item":[{"name":"Get All Problems","id":"0e8fe71a-ca30-4dc1-8c2e-50ecec596bd9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearerrequired string Bearer Token from Get Access Token
Gets you a list of Problems in your specified Analysis. You can specify if you want a certain Problem based on its ID, what Subsystem it is associated with, what Incident it is associated with, or if the Problem is not associated with any Subsystem.
\n","urlObject":{"protocol":"https","path":["v1","problems"],"host":["app","relyence","com"],"query":[{"description":{"content":"required int ID of analysis to retrieve Problems from\nex: 66098
required List<string> List of fields to get information from\nex: {\"Problem ID\", \"Date Occurred\"}\nLeave empty to return all fields
optional int ID of specific problem to pull\nex: 379022
optional int ID of subsystem to pull all associated Problems from\nex: 2778901\nThis value will be ignored if an problemId is entered.
optional int ID of incident to pull all associated problems from\nex: 1998420\nThis value will be ignored if any problemId or subsystemIdis entered.
optional bool If true, returns Problems not associated to any Subsystem\nex: true\nIgnored if problemId, subsystemId, or incidentId are set
required string Bearer Token from Get Access Token
Get the ID of a Problem based on the Identifier of the Problem.
\n","urlObject":{"protocol":"https","path":["v1","problem"],"host":["app","relyence","com"],"query":[{"description":{"content":"required int ID of Analysis to pull Problem from\nex: 66098
required string Identifier of Problem to retrieve\nex: Problem0010
required string Bearer Token from Get Access Token
required {\"Key\": \"Value\"} Key/Value pairs of Problem Information\nex: {\"Description\": \"API Problem Insert\", \"Permanent Solution\": \"Example Solution\"}
Insert a Problem into your Analysis. You can associate a Problem to an Incident or Subsystem in the body of the request.
\n","urlObject":{"protocol":"https","path":["v1","problem"],"host":["app","relyence","com"],"query":[{"description":{"content":"required int ID of Analysis to insert Problem into\nex: 66098
required string Bearer Token from Get Access Token
required {\"Key\": \"Value\"} Key/Value pairs of Problem Information to update\nex: {\"Description\": \"API Problem Insert\", \"Permanent Solution\": \"Example Solution\"}
Update an already existing Problem using the Problem's ID.
\n","urlObject":{"protocol":"https","path":["v1","problem"],"host":["app","relyence","com"],"query":[{"description":{"content":"required int ID of Problem to update\nex: 293588
required string Bearer Token from Get Access Token
Delete an already existing Problem using the Problem's ID.
\n","urlObject":{"protocol":"https","path":["v1","problem"],"host":["app","relyence","com"],"query":[{"description":{"content":"required int ID of Problem to delete\nex: 177530
These functions allow you to interface with the Problems section of FRACAS
\n","_postman_id":"b73f08c3-5830-40fe-977c-43cfa38248fc"},{"name":"Incident Subtables","item":[{"name":"Get All Incident Subtable Records","id":"41ce3ff3-1801-4978-8226-9aa75285da1b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearerrequired string Bearer Token from Get Access Token