Query Parameters

• analysisId: required(integer)

  The Id of the Analysis that you want to retrieve ALT Data Sets from.

Query Parameters

• fileType: (integer)

  Type of file that you want to retrieve.

Query Parameters

• id: required(integer)

  Id of the Analysis that you want to retrieve.

Query Parameters

• analysisName: required(string)

  Name of the Analysis to create.

Body

Media type: application/x-www-form-urlencoded

Type: object

• data: required(string)

  JSON string of Field/Value pairs of data to insert into the Analysis.

  Example:

  {
    "Description" : "This is the description of the record"
  }
  

Query Parameters

• id: required(integer)

  Id of the Gate / Event to update.

Body

Media type: application/x-www-form-urlencoded

Type: object

• data: required(string)

  JSON string of Field/Value pairs of data to update.

  Example:

  {
    "Description" : "This is the description of the record"
  }
  

Query Parameters

• analysisId: required(integer)

  The Id of the Analysis from which you want to retrieve Top Gate calculation results.

Query Parameters

• id: required(integer)

  Id of the requested Function.

• fields: required(string)

  JSON list of fields to retrieve for the Function. Leave empty to return all fields.

Query Parameters

• id: required(integer)

  Id of the Function to delete.

Query Parameters

• subsystemId: required(integer)

  Id of the Subsystem to associate the Function with.

• fmeaType: required(integer)

  The type of Fmea. FMECA = 0, Design Fmea = 1, Process Fmea = 2, or FMEA MSR = 3

Body

Media type: application/x-www-form-urlencoded

Type: object

• data: required(string)

  JSON string of Field/Value pairs of data to insert into the Function.

  Example:

  {
    "Description" : "This is the description of the record"
  }
  

Query Parameters

• id: required(integer)

  Id of the Function to update.

Body

Media type: application/x-www-form-urlencoded

Type: object

• data: required(string)

  JSON string of Field/Value pairs of data to update into the Function.

  Example:

  {
    "Description" : "This is the description of the record"
  }
  

Query Parameters

• analysisId: required(integer)

  The Id of the Analysis that you want to retrieve Functions from.

• fields: required(string)

  JSON list of fields to retrieve for each Function. Leave empty to return all fields.

• subsystemId: required(integer)

  Pass this parameter to retrieve only Functions associated to this Subsystem.

• fmeaType: required(integer)

  The type of Fmea. FMECA = 0, Design Fmea = 1, or Process Fmea = 2, or FMEA MSR = 3

Query Parameters

• id: required(integer)

  The Id of the Group that you want to retrieve.

Query Parameters

• Id: required(integer)

  The Id of the Group to delete.

Body

Media type: application/x-www-form-urlencoded

Type: object

• data: required(string)

  JSON string of Field/Value pairs of data to update for the Group.

  Example:

  {
    "Name" : "Group 1",
    "Description" : "Group allowed access to Fault Tree",
    "Fault Tree Module" : true
  }
  

Query Parameters

• id: required(integer)

  The Id of the Group that you want to update.

Body

Media type: application/x-www-form-urlencoded

Type: object

• data: required(string)

  JSON string of Field/Value pairs of data to update for the Group.

  Example:

  {
    "Description" : "Group allowed to access Fault Tree and FMEA",
    "FMEA Module" : true
  }
  

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "Id" : "1",
  "Name" : "Group 1"
}

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{
  "message" : "Groups not found"
}

Query Parameters

• analysisId: required(integer)

  Id of the Analysis that will contain the Incident.

• identifier: required(string)

  The identifier of the Incident that you want to retrieve.

Query Parameters

• id: required(integer)

  Id of the Incident to delete.

Query Parameters

• analysisId: required(integer)

  Id of the Analysis that will contain the Incident.

• subsystemId: (integer)

  Id of the Subsystem to associate the Incident with.

• problemId: (integer)

  Id of the Problem to associate the Incident with.

Body

Media type: application/x-www-form-urlencoded

Type: object

• data: required(string)

  JSON string of Field/Value pairs of data to insert into the Incident.

  Example:

  {
    "Description" : "This is the description of the record"
  }
  

Query Parameters

• id: required(integer)

  Id of the Incident to update.

Body

Media type: application/x-www-form-urlencoded

Type: object

• data: required(string)

  JSON string of Field/Value pairs of data to insert into the Incident.

  Example:

  {
    "Description" : "This is the description of the record"
  }
  

Query Parameters

• analysisId: required(integer)

  The Id of the Analysis from which you want to retrieve Incidents.

• fields: required(string)

  JSON list of fields to retrieve for each Incident. Leave empty to return all fields.

• incidentId: (integer)

  Pass this parameter to retrieve a specific Incident record.

• subsystemId: (integer)

  Pass this parameter to retrieve only Incidents associated to this Subsystem. Value will be ignored if an IncidentId is set.

• problemId: (integer)

  Pass this parameter to retrieve only Incidents associated to this Problem. Value will be ignored if an IncidentId or SubsystemId value is set.

• unassociated: (boolean)

  Pass this parameter to retrieve only Incidents not associated to any Subsystems. Value will be ignored if an IncidentId, SubsystemId, or ProblemId value is set.

Query Parameters

• id: required(integer)

  Id of the requested Incident Subtable record.

• fields: required(string)

  JSON list of fields to retrieve for the Incident Subtable record. Leave empty to return all fields.

Query Parameters

• id: required(integer)

  Id of the Incident Subtable record to delete.

Query Parameters

• analysisId: required(integer)

  Id of the Analysis that will contain the Incident Subtable record.

• subtableName: required(string)

  The name of the subtable to insert the new record into.

• incidentId: (integer)

  Id of the Incident to associate the Incident Subtable record with.

• incidentIdentifier: (string)

  Identifier of the Incident to associate the Incident Subtable record with. Value will be ignored if an IncidentId is set.

Body

Media type: application/x-www-form-urlencoded

Type: object

• data: required(string)

  JSON string of Field/Value pairs of data to insert into the Incident Subtable record.

  Example:

  {
    "Description" : "This is the description of the record"
  }
  

Query Parameters

• id: required(integer)

  Id of the Incident Subtable record to update.

Body

Media type: application/x-www-form-urlencoded

Type: object

• data: required(string)

  JSON string of Field/Value pairs of data to insert into the Incident Subtable record.

  Example:

  {
    "Description" : "This is the description of the record"
  }
  

Query Parameters

• analysisId: required(integer)

  The Id of the Analysis from which you want to retrieve Incident Subtable records.

• subtableName: required(string)

  The name of the subtable to retrieved records from.

• fields: required(string)

  JSON list of fields to retrieve for each Incident Subtable record. Leave empty to return all fields.

• incidentId: (integer)

  Pass this parameter to retrieve only Incident Subtable records associated to this Incident.

• incidentIdentifier: (string)

  Pass this parameter to retrieve only Incident Subtable records associated to this Incident. Value will be ignored if an IncidentId is set.

Query Parameters

• analysisId: required(integer)

  Id of the Analysis containing the List.

• listName: required(string)

  The name of the List to add choices to.

• createList: required(boolean)

  Create the List if it doesn't exist.

• clearList: (boolean)

  Set this to remove all choices from the List before adding the new choices.

Body

Media type: application/x-www-form-urlencoded

Type: object

• data: required(string)

  JSON string of choices to add to the List

  Example:

  {
    "Choice 1"
  }
  

Query Parameters

• analysisId: required(integer)

  Id of the Analysis that will contain the Parts.

• partnumber: required(string)

  The Part Number of the Parts that you want to retrieve their Id.

• subsystemId: required(integer)

  Pass this parameter to retrieve Parts associated to this Subsystem.

Query Parameters

• id: required(integer)

  Id of the Part to delete.

Query Parameters

• subsystemId: required(integer)

  Id of the Subsystem to associate the Part with.

Body

Media type: application/x-www-form-urlencoded

Type: object

• data: required(string)

  JSON string of Field/Value pairs of data to insert into the Part.

  Example:

  {
    "Description" : "This is the description of the record"
  }
  

Query Parameters

• id: required(integer)

  Id of the Part to update.

Body

Media type: application/x-www-form-urlencoded

Type: object

• data: required(string)

  JSON string of Field/Value pairs of data to update into the Part.

  Example:

  {
    "Description" : "This is the description of the record"
  }
  

Query Parameters

• analysisId: required(integer)

  The Id of the Analysis that you want to retrieve Parts from.

• fields: required(string)

  JSON list of fields to retrieve for each Part. Leave empty to return all fields.

• subsystemId: (integer)

  Pass this parameter to retrieve only Parts associated to this Subsystem.

Query Parameters

• analysisId: required(integer)

  Id of the Analysis that will contain the Problem.

• identifier: required(string)

  The identifier of the Problem that you want to retrieve.

Query Parameters

• id: required(integer)

  Id of the Problem to delete.

Query Parameters

• analysisId: required(integer)

  Id of the Analysis that will contain the Problem.

• subsystemId: (integer)

  Id of the Subsystem to associate the Problem with.

• incidentId: (integer)

  Id of the Incident to associate the Problem with.

Body

Media type: application/x-www-form-urlencoded

Type: object

• data: required(string)

  JSON string of Field/Value pairs of data to update into the Problem.

  Example:

  {
    "Description" : "This is the description of the record"
  }
  

Query Parameters

• id: required(integer)

  Id of the Problem to update.

Body

Media type: application/x-www-form-urlencoded

Type: object

• data: required(string)

  JSON string of Field/Value pairs of data to insert into the Problem.

  Example:

  {
    "Description" : "This is the description of the record"
  }
  

Query Parameters

• analysisId: required(integer)

  The Id of the Analysis from which you want to retrieve Problems.

• fields: required(string)

  JSON list of fields to retrieve for each Problem. Leave empty to return all fields.

• problemId: (integer)

  Pass this parameter to retrieve a specific Problem record.

• subsystemId: (integer)

  Pass this parameter to retrieve only Problems associated to this Subsystem. Value will be ignored if a ProblemId is set.

• incidentId: (integer)

  Pass this parameter to retrieve only Problems associated to this Incident. Value will be ignored if a ProblemId or SubsystemId value is set.

• unassociated: (boolean)

  Pass this parameter to retrieve only Problems not associated to any Subsystems. Value will be ignored if a ProblemId, SubsystemId, or IncidentId value is set.

Query Parameters

• id: required(integer)

  Id of the requested Problem Subtable record.

• fields: required(string)

  JSON list of fields to retrieve for the Problem Subtable record. Leave empty to return all fields.

Query Parameters

• id: required(integer)

  Id of the Problem Subtable record to delete.

Query Parameters

• analysisId: required(integer)

  Id of the Analysis that will contain the Problem Subtable record.

• subtableName: required(string)

  The name of the subtable to insert the new record into.

• problemId: (integer)

  Id of the Problem to associate the Problem Subtable record with.

• problemIdentifier: (string)

  Identifier of the Problem to associate the Problem Subtable record with. Value will be ignored if an ProblemId is set.

Body

Media type: application/x-www-form-urlencoded

Type: object

• data: required(string)

  JSON string of Field/Value pairs of data to insert into the Problem Subtable record.

  Example:

  {
    "Description" : "This is the description of the record"
  }
  

Query Parameters

• id: required(integer)

  Id of the Problem Subtable record to update.

Body

Media type: application/x-www-form-urlencoded

Type: object

• data: required(string)

  JSON string of Field/Value pairs of data to insert into the Problem Subtable record.

  Example:

  {
    "Description" : "This is the description of the record"
  }
  

Query Parameters

• analysisId: required(integer)

  The Id of the Analysis from which you want to retrieve Problem Subtable records.

• subtableName: required(string)

  The name of the subtable to retrieved records from.

• fields: required(string)

  JSON list of fields to retrieve for each Problem Subtable record. Leave empty to return all fields.

• problemId: (integer)

  Pass this parameter to retrieve only Problem Subtable records associated to this Problem.

• problemIdentifier: (string)

  Pass this parameter to retrieve only Problem Subtable records associated to this Problem. Value will be ignored if an ProblemId is set.

Query Parameters

• id: required(integer)

  Id of the RBD block to update.

Body

Media type: application/x-www-form-urlencoded

Type: object

• data: required(string)

  JSON string of Field/Value pairs of data to insert.

  Example:

  {
    "Description" : "This is the description of the record"
  }
  

Query Parameters

• analysisId: required(integer)

  The Id of the Analysis from which you want to retrieve top level diagram calculation results.

Query Parameters

• analysisId: required(integer)

  The Id of the Analysis from which you want to retrieve Subsystems.

• getPredictionResults: (boolean)

  Set this to also retrieve any previously calculated Reliability Prediction results.

• getFracasResults: (boolean)

  Set this to also retrieve any previously calculated FRACAS results.

• getParts: (boolean)

  Set this to also retrieve parts in the list of subsystems.

• fields: (string)

  JSON list of fields to retrieve for each Subsystem. Leave empty to return all fields.

Query Parameters

• analysisId: required(integer)

  Id of the Analysis that will contain the record.

• table: (string)

  The table of the record to open (if necessary). ('Functions', 'Modes', 'Actions', 'Causes', 'Characteristics', 'ControlMethods','Effects','Requirements','VerificationPlans','VerificationReports','Components','Problems','Incidents')

• recordId: (integer)

  Id of the record to open (if necessary).

• module: (integer)

  The Relyence module to open (if necesary). FMEA = 0, FRACAS = 1, Fault Tree = 2, Prediction = 3, RBD = 8, Weibull = 9, Maintainability = 10

• fmeaType: (integer)

  The type of Fmea of the record (if necessary). FMECA = 0, Design Fmea = 1, or Process Fmea = 2

• urlType: (integer)

  Get URL to what type of view (if necessary). Analysis = 0, Analysis Tree = 1, Table = 2, Form = 3, or Tree Properties = 4

Query Parameters

• email: required(string)

  The Email of the User that you want to retrieve.

Query Parameters

• email: required(string)

  The Email of the User to delete.

Body

Media type: application/x-www-form-urlencoded

Type: object

• data: required(string)

  JSON string of Field/Value pairs of data to update for the User.

  Example:

  {
    "FirstName" : "Support",
    "LastName" : "Relyence",
    "Email" : "support@relyence.com",
    "Company" : "Relyence",
    "Phone" : "724-832-1900",
    "Inactive" : false,
    "Groups" : "Group 1; Group 2"
  }
  

Query Parameters

• email: required(string)

  The Email of the User that you want to update.

Body

Media type: application/x-www-form-urlencoded

Type: object

• data: required(string)

  JSON string of Field/Value pairs of data to update for the User.

  Example:

  {
    "Groups" : "Group 3"
  }
  

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "FirstName" : "Support",
  "LastName" : "Relyence",
  "Email" : "support@relyence.com"
}

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{
  "message" : "Users not found"
}

Query Parameters

• analysisId: required(integer)

  The Id of the Analysis that you want to retrieve Weibull Data Sets from.