Causes and Effects API documentation version v1
Application_URL/services/api/v1
About Cause and Effect
Cause is the specific reason for the failure. An effect is the consequence of the failure on the system or end user .
Purpose
This API allows you to create, update, retrieve, delete effects and causes.
/failuremodes
This endpoint allows you to create effect.
This endpoint allows you to get the details of all effects.
post /failuremodes/meta/effects
This endpoint allows you to create effect.
REST API supports Basic Authentication
Body
Media type: application/json
Type: json
Content:
{
"type": "array",
"definitions": {},
"$schema": "http://json-schema.org/draft-06/schema#",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"title": "The Name Schema ",
"default": "",
"examples": [
"testing"
]
},
"description": {
"type": "string",
"title": "The Description Schema ",
"default": "",
"examples": [
"testing"
]
},
"impacts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"title": "The Code Schema ",
"default": "",
"examples": [
"BRD"
]
}
}
}
}
}
}
}Example:
[
{
"name": "testing",
"description": "testing",
"impacts": [
{
"code": "BRD"
}
]
}
]HTTP status code 200
Successfully created effect
Body
Media type: application/json
Type: json
Content:
{
"$id": "http://example.com/example.json",
"type": "object",
"definitions": {},
"$schema": "http://json-schema.org/draft-06/schema#",
"properties": {
"id": {
"$id": "/properties/id",
"type": "string",
"title": "ID of object created",
"examples": [
"12345678912345678912345678912345"
]
},
"status": {
"$id": "/properties/status",
"type": "boolean",
"title": "Status of object creation",
"examples": [
true
]
}
}
}Example:
{
"id": "12345678912345678912345678912345",
"status": true
}Secured by basic
get /failuremodes/meta/effects
This endpoint allows you to get the details of all effects.
REST API supports Basic Authentication
HTTP status code 200
Successfully displays all effects details
Body
Media type: application/json
Type: json
Content:
{
"type": "array",
"definitions": {},
"$schema": "http://json-schema.org/draft-06/schema#",
"items": {
"$id": "http://example.com/example.json/items",
"type": "object",
"properties": {
"id": {
"$id": "http://example.com/example.json/items/properties/id",
"type": "string",
"title": "Effect Id",
"examples": [
"12345678912345678912345678912345"
]
},
"name": {
"$id": "http://example.com/example.json/items/properties/name",
"type": "string",
"title": "Effect Name",
"examples": [
"fdvdff"
]
},
"description": {
"$id": "http://example.com/example.json/items/properties/description",
"type": "string",
"title": "Effect Description",
"examples": [
"dfsvcdsfv"
]
},
"impacts": {
"$id": "http://example.com/example.json/items/properties/impacts",
"type": "array",
"items": {
"$id": "http://example.com/example.json/items/properties/impacts/items",
"type": "object",
"properties": {
"code": {
"$id": "http://example.com/example.json/items/properties/impacts/items/properties/code",
"type": "string",
"title": "Impact Code",
"examples": [
"BRD"
]
},
"text": {
"$id": "http://example.com/example.json/items/properties/impacts/items/properties/text",
"type": "string",
"title": "Impact name",
"examples": [
"Brand"
]
}
}
}
}
}
}
}Example:
[{
"id": "12345678912345678912345678912345",
"name": "fdvdff",
"description": "dfsvcdsfv",
"impacts": [
{
"code": "BRD",
"text": "Brand"
}
]
}]Secured by basic
This endpoint allows you to get the details of effect.
This endpoint allows you to edit effect.
get /failuremodes/meta/effects/effectId
This endpoint allows you to get the details of effect.
REST API supports Basic Authentication
HTTP status code 200
Successfully displays effect details
Body
Media type: application/json
Type: json
Content:
{
"type": "array",
"definitions": {},
"$schema": "http://json-schema.org/draft-06/schema#",
"items": {
"$id": "http://example.com/example.json/items",
"type": "object",
"properties": {
"id": {
"$id": "http://example.com/example.json/items/properties/id",
"type": "string",
"title": "Effect ID",
"examples": [
"C45C74AA76004B69AFB076A94412E7FF"
]
},
"objectType": {
"$id": "http://example.com/example.json/items/properties/objectType",
"type": "string",
"title": "object type",
"examples": [
"EFFECT"
]
},
"displayId": {
"$id": "http://example.com/example.json/items/properties/displayId",
"type": "string",
"title": "Effect Display ID",
"examples": [
"EF.TEDX.17"
]
},
"name": {
"$id": "http://example.com/example.json/items/properties/name",
"type": "string",
"title": "Effect Name",
"examples": [
"AC_TestEffect_001"
]
},
"description": {
"$id": "http://example.com/example.json/items/properties/description",
"type": "string",
"title": "Effect Description",
"examples": [
"AC_TestEffect_001"
]
},
"assignedFailureModes": {
"$id": "http://example.com/example.json/items/properties/assignedFailureModes",
"type": "array",
"items": {
"$id": "http://example.com/example.json/items/properties/assignedFailureModes/items",
"type": "object",
"properties": {
"version": {
"$id": "http://example.com/example.json/items/properties/assignedFailureModes/items/properties/version",
"type": "integer",
"title": "Failuremode Version",
"examples": [
2
]
},
"status": {
"$id": "http://example.com/example.json/items/properties/assignedFailureModes/items/properties/status",
"type": "integer",
"title": "Failuremode Status",
"examples": [
3
]
},
"displayID": {
"$id": "http://example.com/example.json/items/properties/assignedFailureModes/items/properties/displayID",
"type": "string",
"title": "Failuremode Displayid",
"examples": [
"FM.TEDX.543"
]
},
"description": {
"$id": "http://example.com/example.json/items/properties/assignedFailureModes/items/properties/description",
"type": "object",
"properties": {
"short": {
"$id": "http://example.com/example.json/items/properties/assignedFailureModes/items/properties/description/properties/short",
"type": "string",
"title": "Failuremode Short description",
"examples": [
"testByKarnForShareInstance1"
]
},
"long": {
"$id": "http://example.com/example.json/items/properties/assignedFailureModes/items/properties/description/properties/long",
"type": "string",
"title": "Failuremode long description",
"examples": [
""
]
}
}
},
"subClass": {
"$id": "http://example.com/example.json/items/properties/assignedFailureModes/items/properties/subClass",
"type": "string",
"title": "Failuremode Subclass ID",
"examples": [
"1DAB095AAA73F247E10000000A78416B"
]
},
"publishDate": {
"$id": "http://example.com/example.json/items/properties/assignedFailureModes/items/properties/publishDate",
"type": "string",
"title": "Failuremode Published date",
"examples": [
"2017-11-13"
]
},
"lastUpdationTime": {
"$id": "http://example.com/example.json/items/properties/assignedFailureModes/items/properties/lastUpdationTime",
"type": "string",
"title": "Failuremode Last updation time",
"examples": [
"2017-11-14"
]
},
"lastUpdationBy": {
"$id": "http://example.com/example.json/items/properties/assignedFailureModes/items/properties/lastUpdationBy",
"type": "string",
"title": "Failuremode Last updation by",
"examples": [
"Singh, Karn"
]
},
"id": {
"$id": "http://example.com/example.json/items/properties/assignedFailureModes/items/properties/id",
"type": "string",
"title": "Failuremode Id ",
"examples": [
"5FF2638A138C46479F1CDC984B9A3C27"
]
},
"assignedObjects": {
"$id": "http://example.com/example.json/items/properties/assignedFailureModes/items/properties/assignedObjects",
"type": "object",
"properties": {
"MOD": {
"$id": "http://example.com/example.json/items/properties/assignedFailureModes/items/properties/assignedObjects/properties/MOD",
"type": "integer",
"title": "number of models assigned",
"examples": [
3
]
},
"PRT": {
"$id": "http://example.com/example.json/items/properties/assignedFailureModes/items/properties/assignedObjects/properties/PRT",
"type": "integer",
"title": "Number of spare parts assigned",
"examples": [
3
]
},
"GRP": {
"$id": "http://example.com/example.json/items/properties/assignedFailureModes/items/properties/assignedObjects/properties/GRP",
"type": "integer",
"title": "Number of groups assigned",
"examples": [
1
]
},
"FL": {
"$id": "http://example.com/example.json/items/properties/assignedFailureModes/items/properties/assignedObjects/properties/FL",
"type": "integer",
"title": "Number of functional locations assigned",
"examples": [
1
]
}
}
}
}
}
},
"impacts": {
"$id": "http://example.com/example.json/items/properties/impacts",
"type": "array",
"items": {
"$id": "http://example.com/example.json/items/properties/impacts/items",
"type": "object",
"properties": {
"code": {
"$id": "http://example.com/example.json/items/properties/impacts/items/properties/code",
"type": "string",
"title": "Impact code",
"examples": [
"BRD"
]
},
"text": {
"$id": "http://example.com/example.json/items/properties/impacts/items/properties/text",
"type": "string",
"title": "Impact name",
"examples": [
"Brand"
]
}
}
}
}
}
}
}Example:
[
{
"id": "12345678912345678912345678912345",
"name": "fdvdff",
"description": "dfsvcdsfv",
"impacts": [
{
"code": "BRD",
"text": "Brand"
}
]
}
]Secured by basic
put /failuremodes/meta/effects/effectId
This endpoint allows you to edit effect.
REST API supports Basic Authentication
Body
Media type: application/json
Type: json
Content:
{
"type": "array",
"definitions": {},
"$schema": "http://json-schema.org/draft-06/schema#",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"title": "The Name Schema ",
"default": "",
"examples": [
"testing"
]
},
"description": {
"type": "string",
"title": "The Description Schema ",
"default": "",
"examples": [
"testing"
]
},
"impacts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"title": "The Code Schema ",
"default": "",
"examples": [
"BRD"
]
}
}
}
}
}
}
}Example:
[
{
"name": "testing",
"description": "testing",
"impacts": [
{
"code": "BRD"
}
]
}
]HTTP status code 200
Successfully edited effect
Body
Media type: application/json
Type: json
Content:
{
"type": "object",
"definitions": {},
"$schema": "http://json-schema.org/draft-06/schema#",
"properties": {
"status": {
"$id": "/properties/status",
"type": "boolean",
"title": "The Status",
"examples": [
true
]
}
}
}Example:
{"status":true}Secured by basic
This endpoint allows you to delete effects.
put /failuremodes/meta/effects/delete
This endpoint allows you to delete effects.
REST API supports Basic Authentication
Body
Media type: application/json
Type: json
Content:
{
"type": "array",
"definitions": {},
"$schema": "http://json-schema.org/draft-06/schema#",
"items": {
"$id": "http://example.com/example.json/items",
"type": "string",
"title": "Id of object",
"examples": [
"12345678912345678912345678912345"
]
}
}Example:
["12345678912345678912345678912345"]HTTP status code 200
Successfully deletes effects
Body
Media type: application/json
Type: json
Content:
{
"type": "object",
"definitions": {},
"$schema": "http://json-schema.org/draft-06/schema#",
"properties": {
"status": {
"$id": "/properties/status",
"type": "boolean",
"title": "The Status",
"examples": [
true
]
}
}
}Example:
{"status":true}Secured by basic
This endpoint allows you to get the details of effect categories.
get /failuremodes/meta/effects/categories
This endpoint allows you to get the details of effect categories.
REST API supports Basic Authentication
HTTP status code 200
Successfully displays all effect categories
Body
Media type: application/json
Type: json
Content:
{
"type": "array",
"definitions": {},
"$schema": "http://json-schema.org/draft-06/schema#",
"items": {
"$id": "http://example.com/example.json/items",
"type": "object",
"properties": {
"code": {
"$id": "http://example.com/example.json/items/properties/code",
"type": "string",
"title": "Effect category code",
"examples": [
"ENV"
]
},
"text": {
"$id": "http://example.com/example.json/items/properties/text",
"type": "string",
"title": "Effect category name",
"examples": [
"Environment"
]
}
}
}
}Example:
[
{
"code": "ENV",
"text": "Environment"
}
]Secured by basic
This endpoint allows you to get the details of failuremode types.
get /failuremodes/meta/types
This endpoint allows you to get the details of failuremode types.
REST API supports Basic Authentication
HTTP status code 200
Successfully displays all types of failuremodes
Body
Media type: application/json
Type: json
Content:
{
"type": "array",
"definitions": {},
"$schema": "http://json-schema.org/draft-06/schema#",
"items": {
"$id": "http://example.com/example.json/items",
"type": "object",
"properties": {
"code": {
"$id": "http://example.com/example.json/items/properties/code",
"type": "string",
"title": "Failuremode type code",
"examples": [
"1"
]
},
"text": {
"$id": "http://example.com/example.json/items/properties/text",
"type": "string",
"title": "Failuremode type",
"examples": [
"Designed Functionis not obtained"
]
}
}
}
}Example:
[
{
"code": "1",
"text": "Designed Functionis not obtained"
}
]Secured by basic
This endpoint allows you to create cause.
This endpoint allows you to get the details of all causes.
post /failuremodes/meta/causes
This endpoint allows you to create cause.
REST API supports Basic Authentication
Body
Media type: application/json
Type: json
Content:
{
"$id": "http://example.com/example.json",
"type": "object",
"definitions": {},
"$schema": "http://json-schema.org/draft-06/schema#",
"properties": {
"name": {
"$id": "/properties/name",
"type": "string",
"title": "Cause name",
"examples": [
"testing"
]
},
"description": {
"$id": "/properties/description",
"type": "string",
"title": "Cause Description ",
"examples": [
"testing"
]
},"failureModeId": {
"$id": "/properties/failureModeId",
"type": "string",
"title": "Failuremode id assigned",
"examples": [
"18CD2FD626AC4888B6CE98636B7D247D"
]
}
}
}Example:
{
"name": "testing",
"description": "testing",
"failureModeId": "12345678912345678912345678912345"
}HTTP status code 200
Successfully created cause
Body
Media type: application/json
Type: json
Content:
{
"$id": "http://example.com/example.json",
"type": "object",
"definitions": {},
"$schema": "http://json-schema.org/draft-06/schema#",
"properties": {
"id": {
"$id": "/properties/id",
"type": "string",
"title": "ID of object created",
"examples": [
"12345678912345678912345678912345"
]
},
"status": {
"$id": "/properties/status",
"type": "boolean",
"title": "Status of object creation",
"examples": [
true
]
}
}
}Example:
{
"id": "12345678912345678912345678912345",
"status": true
}Secured by basic
get /failuremodes/meta/causes
This endpoint allows you to get the details of all causes.
REST API supports Basic Authentication
HTTP status code 200
Successfully displays all causes details
Body
Media type: application/json
Type: json
Content:
{
"type": "array",
"definitions": {},
"$schema": "http://json-schema.org/draft-06/schema#",
"items": {
"$id": "http://example.com/example.json/items",
"type": "object",
"properties": {
"id": {
"$id": "http://example.com/example.json/items/properties/id",
"type": "string",
"title": "Cause ID",
"default": "",
"examples": [
"12345678912345678912345678912345"
]
},
"displayId": {
"$id": "http://example.com/example.json/items/properties/displayId",
"type": "string",
"title": "Cause Dislay ID",
"default": "",
"examples": [
"CS.TEDX.484"
]
},
"name": {
"$id": "http://example.com/example.json/items/properties/name",
"type": "string",
"title": "Cause Name",
"default": "",
"examples": [
"testing"
]
},
"description": {
"$id": "http://example.com/example.json/items/properties/description",
"type": "string",
"title": "Cause Description",
"default": "",
"examples": [
"testing"
]
},
"failureModeId": {
"$id": "http://example.com/example.json/items/properties/failureModeId",
"type": "string",
"title": "Failuremode id",
"default": "",
"examples": [
"12345678912345678912345678912345"
]
},
"failureModeDisplayId": {
"$id": "http://example.com/example.json/items/properties/failureModeDisplayId",
"type": "string",
"title": "Failuremode display id",
"default": "",
"examples": [
"FM.TEDX.624"
]
},
"own": {
"$id": "http://example.com/example.json/items/properties/own",
"type": "boolean",
"title": "Is the cause created by the organization",
"default": false,
"examples": [
false
]
},
"isOwn": {
"$id": "http://example.com/example.json/items/properties/isOwn",
"type": "boolean",
"title": "Is the cause created by the organization",
"default": false,
"examples": [
false
]
}
}
}
}Example:
[
{
"id": "12345678912345678912345678912345",
"displayId": "CS.TEDX.484",
"name": "testing",
"description": "testing",
"failureModeId": "12345678912345678912345678912345",
"failureModeDisplayId": "FM.TEDX.624",
"own": false,
"isOwn": false
},
{
"id": "12345678912345678912345678912345",
"displayId": "CS.TEDX.483",
"name": "TestCause",
"description": "",
"failureModeId": "12345678912345678912345678912345",
"failureModeDisplayId": "FM.TEDX.476",
"own": false,
"isOwn": false
}]Secured by basic
This endpoint allows you to delete causes.
put /failuremodes/meta/causes/delete
This endpoint allows you to delete causes.
REST API supports Basic Authentication
Body
Media type: application/json
Type: json
Content:
{
"type": "array",
"definitions": {},
"$schema": "http://json-schema.org/draft-06/schema#",
"items": {
"$id": "http://example.com/example.json/items",
"type": "string",
"title": "Id of object",
"examples": [
"12345678912345678912345678912345"
]
}
}Example:
["12345678912345678912345678912345"]HTTP status code 200
Successfully deletes causes
Body
Media type: application/json
Type: json
Content:
{
"type": "object",
"definitions": {},
"$schema": "http://json-schema.org/draft-06/schema#",
"properties": {
"status": {
"$id": "/properties/status",
"type": "boolean",
"title": "The Status",
"examples": [
true
]
}
}
}Example:
{"status":true}Secured by basic
This endpoint allows you to get the details of cause.
This endpoint allows you to edit cause.
get /failuremodes/meta/causes/{causeId}
This endpoint allows you to get the details of cause.
REST API supports Basic Authentication
URI Parameters
- causeId: required (string)
HTTP status code 200
Successfully displays cause details
Body
Media type: application/json
Type: json
Content:
{
"type": "array",
"definitions": {},
"$schema": "http://json-schema.org/draft-06/schema#",
"items": {
"$id": "http://example.com/example.json/items",
"type": "object",
"properties": {
"id": {
"$id": "http://example.com/example.json/items/properties/id",
"type": "string",
"title": "Cause Id",
"default": "",
"examples": [
"12345678912345678912345678912345"
]
},
"displayId": {
"$id": "http://example.com/example.json/items/properties/displayId",
"type": "string",
"title": "The Display id of cause",
"default": "",
"examples": [
"CS.TEDX.484"
]
},
"name": {
"$id": "http://example.com/example.json/items/properties/name",
"type": "string",
"title": "Cause Name",
"default": "",
"examples": [
"testing"
]
},
"description": {
"$id": "http://example.com/example.json/items/properties/description",
"type": "string",
"title": "Cause Description",
"default": "",
"examples": [
"testing"
]
},
"failureModeId": {
"$id": "http://example.com/example.json/items/properties/failureModeId",
"type": "string",
"title": "The Failuremode id",
"default": "",
"examples": [
"12345678912345678912345678912345"
]
},
"failureModeDisplayId": {
"$id": "http://example.com/example.json/items/properties/failureModeDisplayId",
"type": "string",
"title": "The Failuremode display id",
"default": "",
"examples": [
"FM.TEDX.624"
]
},
"lowerLevelFailureMode": {
"$id": "http://example.com/example.json/items/properties/lowerLevelFailureMode",
"type": "object",
"properties": {
"version": {
"$id": "http://example.com/example.json/items/properties/lowerLevelFailureMode/properties/version",
"type": "integer",
"title": "Failuremode Version",
"default": 0,
"examples": [
2
]
},
"status": {
"$id": "http://example.com/example.json/items/properties/lowerLevelFailureMode/properties/status",
"type": "integer",
"title": "Failuremode status",
"default": 0,
"examples": [
3
]
},
"displayID": {
"$id": "http://example.com/example.json/items/properties/lowerLevelFailureMode/properties/displayID",
"type": "string",
"title": "Failuremode Display id",
"default": "",
"examples": [
"FM.TEDX.624"
]
},
"description": {
"$id": "http://example.com/example.json/items/properties/lowerLevelFailureMode/properties/description",
"type": "object",
"properties": {
"short": {
"$id": "http://example.com/example.json/items/properties/lowerLevelFailureMode/properties/description/properties/short",
"type": "string",
"title": "The Short description of failuremode",
"default": "",
"examples": [
"Morethan50_Alex"
]
},
"long": {
"$id": "http://example.com/example.json/items/properties/lowerLevelFailureMode/properties/description/properties/long",
"type": "string",
"title": "The Long description of failuremode",
"default": "",
"examples": [
"Morethan50_2"
]
}
}
},
"subClass": {
"$id": "http://example.com/example.json/items/properties/lowerLevelFailureMode/properties/subClass",
"type": "string",
"title": "The Subclass",
"default": "",
"examples": [
"12345678912345678912345678912345"
]
},
"subClassName": {
"$id": "http://example.com/example.json/items/properties/lowerLevelFailureMode/properties/subClassName",
"type": "string",
"title": "The Subclass name",
"default": "",
"examples": [
"Speed"
]
},
"publishDate": {
"$id": "http://example.com/example.json/items/properties/lowerLevelFailureMode/properties/publishDate",
"type": "string",
"title": "The Published date",
"default": "",
"examples": [
"2018-01-22"
]
},
"lastUpdationTime": {
"$id": "http://example.com/example.json/items/properties/lowerLevelFailureMode/properties/lastUpdationTime",
"type": "string",
"title": "The Last updation time",
"default": "",
"examples": [
"2018-01-22"
]
},
"lastUpdationBy": {
"$id": "http://example.com/example.json/items/properties/lowerLevelFailureMode/properties/lastUpdationBy",
"type": "string",
"title": "The Last updation by",
"default": "",
"examples": [
"XYZ"
]
},
"id": {
"$id": "http://example.com/example.json/items/properties/lowerLevelFailureMode/properties/id",
"type": "string",
"title": "The failurmode Id",
"default": "",
"examples": [
"12345678912345678912345678912345"
]
},
"assignedObjects": {
"$id": "http://example.com/example.json/items/properties/lowerLevelFailureMode/properties/assignedObjects",
"type": "object",
"properties": {
"EQU": {
"$id": "http://example.com/example.json/items/properties/lowerLevelFailureMode/properties/assignedObjects/properties/EQU",
"type": "integer",
"title": "Number of objects the cause is assigned to",
"default": 0,
"examples": [
3
]
}
}
}
}
},
"assignedFailureModes": {
"$id": "http://example.com/example.json/items/properties/assignedFailureModes",
"type": "array",
"items": {
"$id": "http://example.com/example.json/items/properties/assignedFailureModes/items",
"type": "object",
"properties": {
"version": {
"$id": "http://example.com/example.json/items/properties/assignedFailureModes/items/properties/version",
"type": "integer",
"title": "The Version of failuremode",
"default": 0,
"examples": [
7
]
},
"status": {
"$id": "http://example.com/example.json/items/properties/assignedFailureModes/items/properties/status",
"type": "integer",
"title": "The Status of failuremode",
"default": 0,
"examples": [
3
]
},
"displayID": {
"$id": "http://example.com/example.json/items/properties/assignedFailureModes/items/properties/displayID",
"type": "string",
"title": "The Display id of failuremode",
"default": "",
"examples": [
"FM.TEDX.625"
]
},
"description": {
"$id": "http://example.com/example.json/items/properties/assignedFailureModes/items/properties/description",
"type": "object",
"properties": {
"short": {
"$id": "http://example.com/example.json/items/properties/assignedFailureModes/items/properties/description/properties/short",
"type": "string",
"title": "The Short description of failuremode",
"default": "",
"examples": [
"testfm"
]
},
"long": {
"$id": "http://example.com/example.json/items/properties/assignedFailureModes/items/properties/description/properties/long",
"type": "string",
"title": "The Long description of failuremode",
"default": "",
"examples": [
"testfmtestfmtestfmtestfmtestfm"
]
}
}
},
"subClass": {
"$id": "http://example.com/example.json/items/properties/assignedFailureModes/items/properties/subClass",
"type": "string",
"title": "The Subclass ID",
"default": "",
"examples": [
"12345678912345678912345678912345"
]
},
"publishDate": {
"$id": "http://example.com/example.json/items/properties/assignedFailureModes/items/properties/publishDate",
"type": "string",
"title": "The Published date",
"default": "",
"examples": [
"2018-01-24"
]
},
"lastUpdationTime": {
"$id": "http://example.com/example.json/items/properties/assignedFailureModes/items/properties/lastUpdationTime",
"type": "string",
"title": "The Last updation time",
"default": "",
"examples": [
"2018-01-24"
]
},
"lastUpdationBy": {
"$id": "http://example.com/example.json/items/properties/assignedFailureModes/items/properties/lastUpdationBy",
"type": "string",
"title": "The Last updation by",
"default": "",
"examples": [
"XYZ"
]
},
"id": {
"$id": "http://example.com/example.json/items/properties/assignedFailureModes/items/properties/id",
"type": "string",
"title": "The Id of failuremode",
"default": "",
"examples": [
"12345678912345678912345678912345"
]
},
"assignedObjects": {
"$id": "http://example.com/example.json/items/properties/assignedFailureModes/items/properties/assignedObjects",
"type": "object"
}
}
}
}
}
}
}Example:
[
{
"id": "12345678912345678912345678912345",
"displayId": "CS.TEDX.484",
"name": "testing",
"description": "testing",
"failureModeId": "12345678912345678912345678912345",
"failureModeDisplayId": "FM.TEDX.624",
"lowerLevelFailureMode": {
"version": 2,
"status": 3,
"displayID": "FM.TEDX.624",
"description": {
"short": "Morethan50_Alex",
"long": "Morethan50_2"
},
"subClass": "12345678912345678912345678912345",
"subClassName": "Speed",
"publishDate": "2018-01-22",
"lastUpdationTime": "2018-01-22",
"lastUpdationBy": "Singh, Karn",
"id": "12345678912345678912345678912345",
"assignedObjects": {
"EQU": 3
}
},
"assignedFailureModes": [
{
"version": 7,
"status": 3,
"displayID": "FM.TEDX.625",
"description": {
"short": "testfm",
"long": "testfmtestfmtestfmtestfmtestfm"
},
"subClass": "12345678912345678912345678912345",
"publishDate": "2018-01-24",
"lastUpdationTime": "2018-01-24",
"lastUpdationBy": "Neti, Madhavi",
"id": "12345678912345678912345678912345",
"assignedObjects": {}
}
]
}
]Secured by basic
put /failuremodes/meta/causes/{causeId}
This endpoint allows you to edit cause.
REST API supports Basic Authentication
URI Parameters
- causeId: required (string)
Body
Media type: application/json
Type: json
Content:
{
"$id": "http://example.com/example.json",
"type": "object",
"definitions": {},
"$schema": "http://json-schema.org/draft-06/schema#",
"properties": {
"name": {
"$id": "/properties/name",
"type": "string",
"title": "Cause name",
"examples": [
"testing"
]
},
"description": {
"$id": "/properties/description",
"type": "string",
"title": "Cause Description ",
"examples": [
"testing"
]
},"failureModeId": {
"$id": "/properties/failureModeId",
"type": "string",
"title": "Failuremode id assigned",
"examples": [
"18CD2FD626AC4888B6CE98636B7D247D"
]
}
}
}Example:
{
"name": "testing",
"description": "testing",
"failureModeId": "12345678912345678912345678912345"
}HTTP status code 200
Successfully edited cause
Body
Media type: application/json
Type: json
Content:
{
"type": "object",
"definitions": {},
"$schema": "http://json-schema.org/draft-06/schema#",
"properties": {
"status": {
"$id": "/properties/status",
"type": "boolean",
"title": "The Status",
"examples": [
true
]
}
}
}Example:
{"status":true}Secured by basic
This endpoint allows you to assign failuremode to cause.
put /failuremodes/meta/causes/{causeId}/map
This endpoint allows you to assign failuremode to cause.
REST API supports Basic Authentication
URI Parameters
- causeId: required (string)
Query Parameters
- type: required (string - minLength: 3)
type of operation - assign/dissociate
Example:
assign
Body
Media type: application/json
Type: json
Content:
{
"type": "array",
"definitions": {},
"$schema": "http://json-schema.org/draft-06/schema#",
"items": {
"$id": "http://example.com/example.json/items",
"type": "string",
"title": "Id of object",
"examples": [
"12345678912345678912345678912345"
]
}
}Example:
["12345678912345678912345678912345"]HTTP status code 200
Successfully assigned failuremode to cause
Body
Media type: application/json
Type: json
Content:
{
"type": "object",
"definitions": {},
"$schema": "http://json-schema.org/draft-06/schema#",
"properties": {
"status": {
"$id": "/properties/status",
"type": "boolean",
"title": "The Status",
"examples": [
true
]
}
}
}Example:
{"status":true}Secured by basic
This endpoint allows you to get the details of patterns.
get /failuremodes/enum/patterns
This endpoint allows you to get the details of patterns.
REST API supports Basic Authentication
HTTP status code 200
Successfully displays patterns details
Body
Media type: application/json
Type: json
Content:
{
"type": "array",
"definitions": {},
"$schema": "http://json-schema.org/draft-06/schema#",
"items": {
"$id": "http://example.com/example.json/items",
"type": "object",
"properties": {
"code": {
"$id": "http://example.com/example.json/items/properties/code",
"type": "string",
"title": "Pattern Code",
"default": "",
"examples": [
"FC_1"
]
},
"name": {
"$id": "http://example.com/example.json/items/properties/name",
"type": "string",
"title": "Pattern Name",
"default": "",
"examples": [
"Failure Pattern A"
]
},
"image": {
"$id": "http://example.com/example.json/items/properties/image",
"type": "string",
"title": "Pattern Image",
"default": "",
"examples": [
"data:image/png;base64"
]
}
}
}
}Example:
[{
"code": "FC_1",
"name": "Failure Pattern A",
"image": "data:image/png;base64"
},
{
"code": "FC_2",
"name": "Failure Pattern B",
"image": "data:image/png;base64"
}]Secured by basic
This endpoint allows you to get the details of all effects.
get /failuremodes/enum/effects
This endpoint allows you to get the details of all effects.
REST API supports Basic Authentication
HTTP status code 200
Successfully displays all effects details
Body
Media type: application/json
Type: json
Content:
{
"type": "array",
"definitions": {},
"$schema": "http://json-schema.org/draft-06/schema#",
"items": {
"$id": "http://example.com/example.json/items",
"type": "object",
"properties": {
"id": {
"$id": "http://example.com/example.json/items/properties/id",
"type": "string",
"title": "Effect Id",
"examples": [
"12345678912345678912345678912345"
]
},
"name": {
"$id": "http://example.com/example.json/items/properties/name",
"type": "string",
"title": "Effect Name",
"examples": [
"fdvdff"
]
},
"description": {
"$id": "http://example.com/example.json/items/properties/description",
"type": "string",
"title": "Effect Description",
"examples": [
"dfsvcdsfv"
]
},
"impacts": {
"$id": "http://example.com/example.json/items/properties/impacts",
"type": "array",
"items": {
"$id": "http://example.com/example.json/items/properties/impacts/items",
"type": "object",
"properties": {
"code": {
"$id": "http://example.com/example.json/items/properties/impacts/items/properties/code",
"type": "string",
"title": "Impact Code",
"examples": [
"BRD"
]
},
"text": {
"$id": "http://example.com/example.json/items/properties/impacts/items/properties/text",
"type": "string",
"title": "Impact name",
"examples": [
"Brand"
]
}
}
}
}
}
}
}Example:
[{
"id": "12345678912345678912345678912345",
"name": "fdvdff",
"description": "dfsvcdsfv",
"impacts": [
{
"code": "BRD",
"text": "Brand"
}
]
}]Secured by basic
This endpoint allows you to get the details of options.
get /failuremodes/enum/options
This endpoint allows you to get the details of options.
REST API supports Basic Authentication
Query Parameters
- type: required (string - minLength: 4)
KPI code
Example:
MTTR
HTTP status code 200
Successfully displays options details
Body
Media type: application/json
Type: json
Content:
{
"type": "array",
"definitions": {},
"$schema": "http://json-schema.org/draft-06/schema#",
"items": {
"$id": "http://example.com/example.json/items",
"type": "object",
"properties": {
"code": {
"$id": "http://example.com/example.json/items/properties/code",
"type": "string",
"title": "Option code",
"default": "",
"examples": [
"FM_KP_1"
]
},
"text": {
"$id": "http://example.com/example.json/items/properties/text",
"type": "string",
"title": "Option text",
"default": "",
"examples": [
"years"
]
}
}
}
}Example:
[
{
"code": "FM_KP_1",
"text": "years"
},
{
"code": "FM_KP_2",
"text": "months"
}
]