ASPM Assessment API documentation version v1
Application_URL/services/api/v1/aspm
ASPM Assessment
About ASPM Assessment
Assessment feature is used for assessing and viewing the calculated scores. This can be of the following three types: • Risk and criticality assessment • Questionnaire • FMEA
Purpose
This API allows you to create, update, retrieve and delete Assessments for Equipment, Locations, Systems and Groups. The first block of APIs are common for all 3 types of assessments, where as the next block of APIs which have the key 'fmea' in the API URL are only for the FMEA assessment in conjunction with the first block.
/riskassessments
This endpoint allows you to get the list of Assessments.
This endpoint allows you to create an Assessment.
get /riskassessments
This endpoint allows you to get the list of Assessments.
REST API supports Basic Authentication.
Query Parameters
- $filter: required (string)
Retrieves Assessments based on the value provided. This parameter follows ODATA URL covention. For eg $filter=(substringof('UNMIT', RiskTypeCode) eq true)
HTTP status code 200
Body
Media type: application/json
Example:
[
{
"ID": "5B4B29D96D66438188FAD3F038668964",
"BusinessObjectType": "GRP",
"DisplayID": "AS.TEDX.119",
"ShortDescription": "testing_system_asmt",
"LongDescription": "",
"MatrixID": "3DADEB42F4334DC0858764D5C1BE082D",
"MatrixVersion": 1.0,
"Status": 1,
"RiskValue": 21.0,
"NormalizedRiskValue": 43.48,
"IntentCode": "QUEST",
"CriticalityCode": "C",
"CriticalityText": "Low",
"RiskThresholdColor": "#2A6D3C",
"RiskTypeCode": "CUR",
"RiskType": "Current Risk",
"MatrixDisplayID": "AT.TEDX.52",
"MatrixName": "",
"CreatedBy": "Vatsalya, Thunuguntla",
"CreatedOn": "2017-10-17",
"UpdatedBy": "Vatsalya, Thunuguntla",
"UpdatedOn": "2017-10-23",
"ObjectCount": 2,
"Action": null,
"QuestionsCount": 2,
"AnsweredQuestionsCount": 2
},
{
"ID": "D6AFDB119C05483FA93AAAF926AD6300",
"BusinessObjectType": "GRP",
"DisplayID": "AS.TEDX.122",
"ShortDescription": "testing_assessemnt",
"LongDescription": "",
"MatrixID": "4A543624E58F411684A38150A7A07C17",
"MatrixVersion": 1.0,
"Status": 1,
"RiskValue": 57.0,
"NormalizedRiskValue": 33.33,
"IntentCode": "QUEST",
"CriticalityCode": "C",
"CriticalityText": "Low",
"RiskThresholdColor": "#4CBA6B",
"RiskTypeCode": "UNMIT",
"RiskType": "Unmitigated Risk",
"MatrixDisplayID": "AT.TEDX.29",
"MatrixName": null,
"CreatedBy": "Vatsalya, Thunuguntla",
"CreatedOn": "2017-10-19",
"UpdatedBy": "Vatsalya, Thunuguntla",
"UpdatedOn": "2017-10-23",
"ObjectCount": 1,
"Action": null,
"QuestionsCount": 2,
"AnsweredQuestionsCount": 2
}
]HTTP status code 400
Not Found
Secured by basic
post /riskassessments
This endpoint allows you to create an Assessment.
REST API supports Basic Authentication.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"id": "http://example.com/example.json",
"properties": {
"description":{
"type":[
"object",
"null"
],
"properties":{
"short":{
"type":"string"
},
"long":{
"type":"string"
}
},
"required":[
"short"
]
},
"descriptions":{
"type":[
"array",
"null"
],
"description":"The list of all descriptions in different languages in which description needs to be maintained. The API will perform a complete refresh of the list descriptions",
"items":{
"type":"object",
"properties":{
"language":{
"type":"string",
"maxLength":2,
"description":"Language in which description is present."
},
"short":{
"type":"string",
"maxLength":255,
"description":"Short description"
},
"long":{
"type":"string",
"maxLength":5000,
"description":"Long description"
}
}
}
},
"assessmentTemplateId": {
"description": "ID of Assessment Template with which assessment has to be associated. ",
"id": "/properties/assessmentTemplateId",
"maxLength": 32,
"minLength": 32,
"type": "string"
},
"riskTypeCode": {
"default": "",
"description": "CUR - Current Risk, MIT - Mitigated Risk, UNMIT - Unmitigated Risk",
"id": "/properties/riskTypeCode",
"type": "string"
},
"estimatedCostUOM" : {
"default": "",
"description": "Estimated Cost",
"id": "/properties/estimatedCostUOM",
"type": "string"
},
"estimatedFrequencyUOM" : {
"default": "",
"description": "Estimated Frequency",
"id": "/properties/estimatedFrequencyUOM",
"type": "string"
},
"riskReductionUOM" : {
"default": "",
"description": "Risk reduction value",
"id": "/properties/riskReductionUOM",
"type": "string"
}
},
"type": "object",
"required":[
"assessmentTemplateId",
"riskTypeCode"
],
"anyOf":[
{
"required":[
"description"
]
},
{
"required":[
"descriptions"
]
}
]
}Example:
{
"assessmentTemplateId":"206D8DD401884310BB71F72E541CC9A9",
"description":{
"short":"test assessment 1 short description.",
"long":"test assessment 1 short description. test assessment 1 short description. test assessment 1 short description."
},
"riskTypeCode":"MIT",
"estimatedCostUOM":"",
"estimatedFrequencyUOM":"",
"riskReductionUOM":""
}HTTP status code 200
Successfully creates an Assessment.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"id": "http://example.com/example.json",
"properties": {
"id": {
"description": "A system generated 32 bit ID which is unique for the created risk assessment.",
"id": "/properties/id",
"maxLength": 32,
"minLength": 32,
"type": "string"
},
"status": {
"id": "/properties/status",
"type": "boolean"
}
},
"type": "object"
}Example:
{
"id": "3A1606CE91DF41639CE9979554D0469E",
"status": true
}HTTP status code 400
Not Found
Secured by basic
This endpoint allows you to get the list of Assessments performed on a given Object. Objects supported are Systems, Equipments, Fucntional Location
get /riskassessments/businessobjects/{objectid}/assessmentlist
This endpoint allows you to get the list of Assessments performed on a given Object. Objects supported are Systems, Equipments, Fucntional Location
REST API supports Basic Authentication.
URI Parameters
- objectid: required (string)
Query Parameters
- objectType: required (string)
Type of object
- $filter: required (string)
Retrieves Assessments based on the value provided. This parameter follows ODATA URL covention. For eg $filter=(substringof('UNMIT', RiskTypeCode) eq true)
HTTP status code 200
Body
Media type: application/json
Example:
[
{
"AssessmentID": "79DFE44FE55C420BADA997EEADFD33BD",
"AssessmentDisplayID": "AS.TEDX.43",
"AssessmentShortDescription": "testBO",
"BusinessObjectVersion": 0.0,
"RiskValue": 90.0,
"NormalizedRiskValue": 57.14,
"CriticalityCode": "A",
"CriticalityText": "High",
"RiskColorCode": "#A9245B",
"RiskTypeCode": "MIT",
"RiskType": "Mitigated Risk",
"MatrixID": "8CE5B977C0054C35A1CCC7B21EB5874E",
"MatrixVersion": 1.0,
"MatrixDisplayID": "AT.TEDX.20",
"IntentCode": "CA",
"MatrixName": null,
"PublishedBy": "Vatsalya, Thunuguntla",
"PublishedDate": "2017-09-22",
"MyAssessment": 1,
"Status": 1,
"GroupID": null,
"GroupDisplayID": null
},
{
"AssessmentID": "7EE8980B3A4542B19FC38B4F36302878",
"AssessmentDisplayID": "AS.TEDX.100",
"AssessmentShortDescription": "rrrrr",
"BusinessObjectVersion": 0.0,
"RiskValue": 3822.5,
"NormalizedRiskValue": 15.68,
"CriticalityCode": "A",
"CriticalityText": "High",
"RiskColorCode": "#ED7E17",
"RiskTypeCode": "UNMIT",
"RiskType": "Unmitigated Risk",
"MatrixID": "745F9DF42A234719A98FED3B0260DB90",
"MatrixVersion": 1.0,
"MatrixDisplayID": "MX.TEDX.67",
"IntentCode": "CA",
"MatrixName": "",
"PublishedBy": "Patnaikuni, Rahul Bhargav",
"PublishedDate": "2017-09-05",
"MyAssessment": 1,
"Status": 1,
"GroupID": 222D18011D6C4D81A73D140F22A6B591,
"GroupDisplayID": AS.GRPX.100
}
]HTTP status code 400
Not Found
Secured by basic
This endpoint allows you to get the list of Risk Types. For example, Initial Risk, Mitigated Risk, Unmitigated Risk.
get /riskassessments/risktypes
This endpoint allows you to get the list of Risk Types. For example, Initial Risk, Mitigated Risk, Unmitigated Risk.
REST API supports Basic Authentication.
HTTP status code 200
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"id": "http://example.com/example.json",
"items": {
"id": "/items",
"minProperties": 1,
"properties": {
"code": {
"enum": [
"CUR",
"MIT",
"UNMIT"
],
"id": "/items/properties/code",
"type": "string"
},
"name": {
"enum": [
"Current Risk",
"Mitigated Risk",
"Unmitigated Risk"
],
"id": "/items/properties/name",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}Example:
[
{
"code": "CUR",
"name": "Current Risk"
},
{
"code": "MIT",
"name": "Mitigated Risk"
},
{
"code": "UNMIT",
"name": "Unmitigated Risk"
}
]HTTP status code 400
Not Found
Secured by basic
This endpoint allows you to update the header information of an unpublished Assessment.
put /riskassessments/header
This endpoint allows you to update the header information of an unpublished Assessment.
REST API supports Basic Authentication.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"id": "http://example.com/example.json",
"properties": {
"id" : {
"description": "Unique 32 bit ID of Risk Assessment",
"id": "/properties/id",
"type": "string",
"maxLength": 32,
"minLength": 32
},
"description":{
"type":[
"object",
"null"
],
"properties":{
"short":{
"type":"string"
},
"long":{
"type":"string"
}
},
"required":[
"short"
]
},
"descriptions":{
"type":[
"array",
"null"
],
"description":"The list of all descriptions in different languages in which description needs to be maintained. The API will perform a complete refresh of the list descriptions",
"items":{
"type":"object",
"properties":{
"language":{
"type":"string",
"maxLength":2,
"description":"Language in which description is present."
},
"short":{
"type":"string",
"maxLength":255,
"description":"Short description"
},
"long":{
"type":"string",
"maxLength":5000,
"description":"Long description"
}
}
}
},
"riskTypeCode": {
"default": "",
"description": "CUR - Current Risk, MIT - Mitigated Risk, UNMIT - Unmitigated Risk",
"id": "/properties/riskTypeCode",
"type": "string"
},
"estimatedCostUOM" : {
"default": "",
"description": "Estimated Cost",
"id": "/properties/estimatedCostUOM",
"type": "string"
},
"estimatedFrequencyUOM" : {
"default": "",
"description": "Estimated Frequency",
"id": "/properties/estimatedFrequencyUOM",
"type": "string"
},
"riskReductionUOM" : {
"default": "",
"description": "Risk reduction value",
"id": "/properties/riskReductionUOM",
"type": "string"
}
},
"type": "object",
"required":[
"id",
"riskTypeCode"
],
"anyOf":[
{
"required":[
"description"
]
},
{
"required":[
"descriptions"
]
}
]
}Example:
{
"id":"3A1606CE91DF41639CE9979554D0469E",
"description":{
"short":"test assessment 1 short description.",
"long":"test assessment 1 short description. test assessment 1 short description. test assessment 1 short description."
},
"riskTypeCode":"MIT",
"estimatedCostUOM":"",
"estimatedFrequencyUOM":"",
"riskReductionUOM":""
}HTTP status code 200
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"id": "http://example.com/example.json",
"properties": {
"id": {
"description": "A system generated 32 bit ID which is unique for the created risk assessment.",
"id": "/properties/id",
"maxLength": 32,
"minLength": 32,
"type": "string"
},
"status": {
"id": "/properties/status",
"type": "boolean"
}
},
"type": "object"
}Example:
{
"id": "3A1606CE91DF41639CE9979554D0469E",
"status": true
}HTTP status code 400
Not Found
Secured by basic
This endpoint allows you to delete the specified unpublished assessment.
delete /riskassessments/{id}
This endpoint allows you to delete the specified unpublished assessment.
REST API supports Basic Authentication.
URI Parameters
- id: required (string)
Risk Assessment ID. Generated by server, used as read-only.
HTTP status code 200
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"id": "http://example.com/example.json",
"properties": {
"id": {
"description": "A system generated 32 bit ID which is unique for the created risk assessment.",
"id": "/properties/id",
"maxLength": 32,
"minLength": 32,
"type": "string"
},
"status": {
"id": "/properties/status",
"type": "boolean"
}
},
"type": "object"
}Example:
{
"id": "3A1606CE91DF41639CE9979554D0469E",
"status": true
}Secured by basic
This endpoint allows you to get assigned objects (Groups, Systems, Equipment, Locations) of an assessment.
get /riskassessments/{id}/businessobjects
This endpoint allows you to get assigned objects (Groups, Systems, Equipment, Locations) of an assessment.
REST API supports Basic Authentication.
URI Parameters
- id: required (string)
Risk Assessment ID. Generated by server, used as read-only.
HTTP status code 200
Body
Media type: application/json
Type: json
Content:
{
"definitions": {},
"$schema": "http://json-schema.org/draft-06/schema#",
"type": "object",
"$id": "http://example.com/example.json",
"properties": {
"GRP": {
"type": "array",
"$id": "/properties/GRP",
"items": {
"type": "object",
"$id": "/properties/GRP/items",
"properties": {
"id": {
"type": "string",
"$id": "/properties/GRP/items/properties/id",
"title": "The Id Schema.",
"description": "An explanation about the purpose of this instance.",
"default": "",
"examples": [
"B0C2B1B86256433A875DFD750DA34E49"
]
},
"version": {
"type": "integer",
"$id": "/properties/GRP/items/properties/version",
"title": "The Version Schema.",
"description": "An explanation about the purpose of this instance.",
"default": 0,
"examples": [
1
]
},
"objectType": {
"type": "string",
"$id": "/properties/GRP/items/properties/objectType",
"title": "The Objecttype Schema.",
"description": "An explanation about the purpose of this instance.",
"default": "",
"examples": [
"GRP"
]
},
"description": {
"type": "object",
"$id": "/properties/GRP/items/properties/description",
"properties": {
"short": {
"type": "string",
"$id": "/properties/GRP/items/properties/description/properties/_short",
"title": "The _short Schema.",
"description": "An explanation about the purpose of this instance.",
"default": "",
"examples": [
"11"
]
},
"long": {
"type": "string",
"$id": "/properties/GRP/items/properties/description/properties/_long",
"title": "The _long Schema.",
"description": "An explanation about the purpose of this instance.",
"default": "",
"examples": [
""
]
}
}
},
"status": {
"type": "integer",
"$id": "/properties/GRP/items/properties/status",
"title": "The Status Schema.",
"description": "An explanation about the purpose of this instance.",
"default": 0,
"examples": [
0
]
}
}
}
},
"EQU": {
"type": "array",
"$id": "/properties/EQU",
"items": {
"type": "object",
"$id": "/properties/EQU/items",
"properties": {
"id": {
"type": "string",
"$id": "/properties/EQU/items/properties/id",
"title": "The Id Schema.",
"description": "An explanation about the purpose of this instance.",
"default": "",
"examples": [
"B0C2B1B86256433A875DFD750DA34E49"
]
},
"version": {
"type": "integer",
"$id": "/properties/EQU/items/properties/version",
"title": "The Version Schema.",
"description": "An explanation about the purpose of this instance.",
"default": 0,
"examples": [
1
]
},
"objectType": {
"type": "string",
"$id": "/properties/EQU/items/properties/objectType",
"title": "The Objecttype Schema.",
"description": "An explanation about the purpose of this instance.",
"default": "",
"examples": [
"EQU"
]
},
"description": {
"type": "object",
"$id": "/properties/EQU/items/properties/description",
"properties": {
"short": {
"type": "string",
"$id": "/properties/EQU/items/properties/description/properties/_short",
"title": "The _short Schema.",
"description": "An explanation about the purpose of this instance.",
"default": "",
"examples": [
"11"
]
},
"long": {
"type": "string",
"$id": "/properties/EQU/items/properties/description/properties/_long",
"title": "The _long Schema.",
"description": "An explanation about the purpose of this instance.",
"default": "",
"examples": [
""
]
}
}
},
"status": {
"type": "integer",
"$id": "/properties/EQU/items/properties/status",
"title": "The Status Schema.",
"description": "An explanation about the purpose of this instance.",
"default": 0,
"examples": [
0
]
}
}
}
}
}
}Example:
{
"GRP": [
{
"id": "B0C2B1B86256433A875DFD750DA34E49",
"version": 1.0,
"objectType": "GRP",
"description": {
"short": "11",
"long": ""
},
"status": 0
}
],
"EQU": [
{
"id": "222D18011D6C4D81A73D140F22A6B591",
"version": 0.0,
"objectType": "EQU",
"description": {
"short": "Model 145 A-Equipment",
"long": ""
},
"status": 0
},
{
"id": "B884340A14AB4C30952C11AA6B807EDD",
"version": 0.0,
"objectType": "EQU",
"description": {
"short": "New equipment for sync September 5 2017",
"long" : ""
},
"status": 0
},
{
"id": "F562A7426CF04358873DB90A48B88F22",
"version": 0.0,
"objectType": "EQU",
"description": {
"short": "example description",
"long": ""
},
"status": 0
}
]
}HTTP status code 400
Not Found
Secured by basic
This endpoint allows you to assign objects (Groups, Systems, Equipment, Locations) to an assessment.
put /riskassessments/{id}/businessobjects/assign
This endpoint allows you to assign objects (Groups, Systems, Equipment, Locations) to an assessment.
REST API supports Basic Authentication.
URI Parameters
- id: required (string)
Risk Assessment ID. Generated by server, used as read-only.
Query Parameters
- objectType: required (string)
Type of object
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"id": "http://example.com/example.json",
"properties": {
"boList": {
"id": "/properties/boList",
"items": {
"id": "/properties/boList/items",
"type": "string",
"maxLength": 32,
"minLength": 32
},
"type": "array"
}
},
"type": "object"
}Example:
{
"boList": [
"7428F313F8CA4E9D8AA57E1E6F090B72",
"18BE01926AD143009A5369033FF5D9CF"
]
}HTTP status code 200
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"id": "http://example.com/example.json",
"properties": {
"id": {
"description": "A system generated 32 bit ID which is unique for the created risk assessment.",
"id": "/properties/id",
"maxLength": 32,
"minLength": 32,
"type": "string"
},
"status": {
"id": "/properties/status",
"type": "boolean"
}
},
"type": "object"
}Example:
{
"id": "3A1606CE91DF41639CE9979554D0469E",
"status": true
}HTTP status code 400
Not Found
Secured by basic
This endpoint allows you to unassign objects (Groups, Systems, Equipment, Locations) from an assessment.
put /riskassessments/{id}/businessobjects/unassign
This endpoint allows you to unassign objects (Groups, Systems, Equipment, Locations) from an assessment.
REST API supports Basic Authentication.
URI Parameters
- id: required (string)
Risk Assessment ID. Generated by server, used as read-only.
Query Parameters
- objectType: required (string)
Type of object
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"id": "http://example.com/example.json",
"properties": {
"boList": {
"id": "/properties/boList",
"items": {
"id": "/properties/boList/items",
"type": "string",
"maxLength": 32,
"minLength": 32
},
"type": "array"
}
},
"type": "object"
}Example:
{
"boList": [
"7428F313F8CA4E9D8AA57E1E6F090B72",
"18BE01926AD143009A5369033FF5D9CF"
]
}HTTP status code 200
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"id": "http://example.com/example.json",
"properties": {
"id": {
"description": "A system generated 32 bit ID which is unique for the created risk assessment.",
"id": "/properties/id",
"maxLength": 32,
"minLength": 32,
"type": "string"
},
"status": {
"id": "/properties/status",
"type": "boolean"
}
},
"type": "object"
}Example:
{
"id": "3A1606CE91DF41639CE9979554D0469E",
"status": true
}HTTP status code 400
Not Found
Secured by basic
This endpoint allows you to get questions and answer information of an assessment.
This endpoint allows you to update question and answer information of an impact in an assessment.
get /riskassessments/{id}/questionnaire
This endpoint allows you to get questions and answer information of an assessment.
REST API supports Basic Authentication.
URI Parameters
- id: required (string)
Risk Assessment ID. Generated by server, used as read-only.
HTTP status code 200
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"id": "http://example.com/example.json",
"items": {
"id": "/items",
"properties": {
"answerCount": {
"id": "/items/properties/answerCount",
"type": "integer"
},
"dimensions": {
"id": "/items/properties/dimensions",
"items": {
"id": "/items/properties/dimensions/items",
"properties": {
"dimensionDisplayId": {
"id": "/items/properties/dimensions/items/properties/dimensionDisplayId",
"type": "string"
},
"dimensionId": {
"id": "/items/properties/dimensions/items/properties/dimensionId",
"type": "string"
},
"dimensionWeightage": {
"id": "/items/properties/dimensions/items/properties/dimensionWeightage",
"type": "integer"
},
"questionDescription": {
"id": "/items/properties/dimensions/items/properties/questionDescription",
"type": "string"
},
"questionText": {
"id": "/items/properties/dimensions/items/properties/questionText",
"type": "string"
},
"scaleDisplayId": {
"id": "/items/properties/dimensions/items/properties/scaleDisplayId",
"type": "string"
},
"scaleId": {
"id": "/items/properties/dimensions/items/properties/scaleId",
"type": "string"
},
"scaleOptions": {
"id": "/items/properties/dimensions/items/properties/scaleOptions",
"items": {
"id": "/items/properties/dimensions/items/properties/scaleOptions/items",
"properties": {
"comments": {
"id": "/items/properties/dimensions/items/properties/scaleOptions/items/properties/comments",
"type": "null"
},
"displayOrder": {
"id": "/items/properties/dimensions/items/properties/scaleOptions/items/properties/displayOrder",
"type": "integer"
},
"isSelected": {
"id": "/items/properties/dimensions/items/properties/scaleOptions/items/properties/isSelected",
"type": "integer"
},
"scaleOptionDescription": {
"id": "/items/properties/dimensions/items/properties/scaleOptions/items/properties/scaleOptionDescription",
"type": "string"
},
"scaleOptionId": {
"id": "/items/properties/dimensions/items/properties/scaleOptions/items/properties/scaleOptionId",
"type": "string"
},
"scaleOptionLongDescription": {
"id": "/items/properties/dimensions/items/properties/scaleOptions/items/properties/scaleOptionLongDescription",
"type": "string"
},
"scaleOptionWeightage": {
"id": "/items/properties/dimensions/items/properties/scaleOptions/items/properties/scaleOptionWeightage",
"type": "integer"
},
"value1": {
"id": "/items/properties/dimensions/items/properties/scaleOptions/items/properties/value1",
"type": "string"
},
"value2": {
"id": "/items/properties/dimensions/items/properties/scaleOptions/items/properties/value2",
"type": "null"
}
},
"type": "object"
},
"type": "array"
},
"scaleType": {
"id": "/items/properties/dimensions/items/properties/scaleType",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"impactDisplayId": {
"id": "/items/properties/impactDisplayId",
"type": "string"
},
"impactId": {
"id": "/items/properties/impactId",
"type": "string"
},
"impactWeightage": {
"id": "/items/properties/impactWeightage",
"type": "integer"
},
"impactImageURL": {
"id": "/items/properties/impactImageURL",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}Example:
[
{
"description":{
"short":"risk_safety",
"long":""
},
"answerCount":2,
"dimensions":[
{
"description":{
"short":"test_dimension",
"long":""
},
"scaleId":"14EFC3172E0E498A9E873B4A848460B1",
"scaleDisplayId":"SC.TEDX.160",
"scaleShortDescription":"test_scale",
"scaleType":1,
"questionText":"test_dim_question_14EFC3172E0E498A9E873B4A848460B1",
"questionDescription":"test_dim_question",
"comments":null,
"scaleOptions":[
{
"description":{
"short":"op_1",
"long":"op_1_long"
},
"value1":"scale_op_1",
"value2":null,
"isSelected":1,
"scaleOptionWeightage":10.0,
"id":"7ABC921576B544D8A40AB38D8283DAC8",
"weightage":10.0,
"displayOrder":1
},
{
"description":{
"short":"op_2",
"long":"op_2_long"
},
"value1":"scale_op_2",
"value2":null,
"isSelected":0,
"scaleOptionWeightage":20.0,
"id":"2618551A72D34B8CA6402BFE0FA0EA3A",
"weightage":20.0,
"displayOrder":2
},
{
"description":{
"short":"op_3",
"long":"op_3_long"
},
"value1":"scale_op_3",
"value2":null,
"isSelected":0,
"scaleOptionWeightage":30.0,
"id":"910E93866FE04609ABE93BF040B79CF4",
"weightage":30.0,
"displayOrder":3
}
],
"id":"9E20161AD29445D19712C9D81E052F14",
"displayId":"DM.TEDX.97",
"weightage":0.0
},
{
"description":{
"_short":"test_dimension",
"_long":""
},
"scaleId":"096F1C3DD3F440A3966593F491A3F493",
"scaleDisplayId":"SC.TEDX.159",
"scaleShortDescription":"test_scale",
"scaleType":1,
"questionText":"test_dim_question_096F1C3DD3F440A3966593F491A3F493",
"questionDescription":"test_dim_question",
"comments":null,
"scaleOptions":[
{
"description":{
"short":"op_1",
"long":"op_1_long"
},
"value1":"scale_op_1",
"value2":null,
"isSelected":0,
"scaleOptionWeightage":10.0,
"id":"48B1F11C4B804900894804E9616F381E",
"weightage":10.0,
"displayOrder":1
},
{
"description":{
"short":"op_2",
"long":"op_2_long"
},
"value1":"scale_op_2",
"value2":null,
"isSelected":0,
"scaleOptionWeightage":20.0,
"id":"B994E41AF401467797A8FCB4D2C24E0E",
"weightage":20.0,
"displayOrder":2
},
{
"description":{
"short":"op_3",
"long":"op_3_long"
},
"value1":"scale_op_3",
"value2":null,
"isSelected":1,
"scaleOptionWeightage":30.0,
"id":"3A0E12E50D9B4FA0A9186A0D3E64477E",
"weightage":30.0,
"displayOrder":3
}
],
"id":"1A6D69BB5F674F5B99708C3A4B3E51AB",
"displayId":"DM.TEDX.96",
"weightage":0.0
}
],
"impactId":"56278F636AC84B61A07ED1220C9A7F70",
"impactDisplayId":"risk_safety",
"impactImageURL":"SFT",
"impactWeightage":100.0,
"impactRisk":300.0
}
]HTTP status code 400
Not Found
Secured by basic
put /riskassessments/{id}/questionnaire
This endpoint allows you to update question and answer information of an impact in an assessment.
REST API supports Basic Authentication.
URI Parameters
- id: required (string)
Risk Assessment ID. Generated by server, used as read-only.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"id": "http://example.com/example.json",
"properties": {
"dimensions": {
"id": "/properties/dimensions",
"items": {
"id": "/properties/dimensions/items",
"properties": {
"comments": {
"id": "/properties/dimensions/items/properties/comments",
"type": "string"
},
"dimensionId": {
"id": "/properties/dimensions/items/properties/dimensionId",
"type": "string"
},
"selectedScaleOptionId": {
"id": "/properties/dimensions/items/properties/selectedScaleOptionId",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"impactId": {
"id": "/properties/impactId",
"type": "string"
}
},
"type": "object"
}Example:
{
"impactId" : "98B2F15C12364F7ABC2514F76B04E333",
"dimensions" : [
{
"dimensionId": "4B17B90ECA984D20A4ABEEEA4C338FA2",
"selectedScaleOptionId": "376DB1A920FF477DA35B9516DE2852C3",
"comments": "something something"
},
{
"dimensionId": "AAC127583761441395AAF7B0643D0174",
"selectedScaleOptionId": "6B1DDE90046A47778C03D666EB7A2621",
"comments": "something123 something123"
}
]
}
HTTP status code 200
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"id": "http://example.com/example.json",
"properties": {
"id": {
"description": "A system generated 32 bit ID which is unique for the created risk assessment.",
"id": "/properties/id",
"maxLength": 32,
"minLength": 32,
"type": "string"
},
"status": {
"id": "/properties/status",
"type": "boolean"
}
},
"type": "object"
}Example:
{
"id": "3A1606CE91DF41639CE9979554D0469E",
"status": true
}HTTP status code 400
Not Found
Secured by basic
This endpoint allows you to publish an Assessment
put /riskassessments/{id}/publish
This endpoint allows you to publish an Assessment
REST API supports Basic Authentication.
URI Parameters
- id: required (string)
Risk Assessment ID. Generated by server, used as read-only.
HTTP status code 200
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"id": "http://example.com/example.json",
"properties": {
"id": {
"description": "A system generated 32 bit ID which is unique for the created risk assessment.",
"id": "/properties/id",
"maxLength": 32,
"minLength": 32,
"type": "string"
},
"status": {
"id": "/properties/status",
"type": "boolean"
}
},
"type": "object"
}Example:
{
"id": "3A1606CE91DF41639CE9979554D0469E",
"status": true
}HTTP status code 400
Not Found
Secured by basic
This endpoint allows you to get users assigned to roles
This endpoint allows you to assign users to roles
get /riskassessments/{id}/bproles
This endpoint allows you to get users assigned to roles
REST API supports Basic Authentication.
URI Parameters
- id: required (string)
Risk Assessment ID. Generated by server, used as read-only.
HTTP status code 200
Body
Media type: application/json
Type: Can not resolve schemas/riskassessment/getBPRoles.json
Example:
[
{
"code": "1",
"role": "Requestor",
"mandatory": true,
"businessPartners": []
},
{
"code": "2",
"role": "Moderator",
"mandatory": false,
"businessPartners": [
{
"bpid": "E203603EBDE84884866BB3B93AC3D09F",
"bpname": "USER1"
}
]
},
{
"code": "3",
"role": "Approver",
"mandatory": true,
"businessPartners": [
{
"bpid": "E203603EBDE84884866BB3B93AC3D09F",
"bpname": "USER2"
}
]
},
{
"code": "4",
"role": "Maintenance Engineer",
"mandatory": false,
"businessPartners": []
},
{
"code": "5",
"role": "Maintenance Planner",
"mandatory": false,
"businessPartners": []
},
{
"code": "6",
"role": "Reliability Engineer",
"mandatory": false,
"businessPartners": []
},
{
"code": "7",
"role": "Subject-Matter Expert",
"mandatory": false,
"businessPartners": []
},
{
"code": "8",
"role": "Operator",
"mandatory": false,
"businessPartners": []
}
]
HTTP status code 400
Not Found
Secured by basic
put /riskassessments/{id}/bproles
This endpoint allows you to assign users to roles
REST API supports Basic Authentication.
URI Parameters
- id: required (string)
Risk Assessment ID. Generated by server, used as read-only.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"properties": {
"items": {
"$id": "/properties/items",
"type": "object",
"properties": {
"code": {
"$id": "/properties/items/properties/code",
"type": "string",
"title": "Role Code",
"description": "Code corresponding to the type of role defined"
},
"businessPartners" : {
"$id": "/properties/items/properties/businessPartners",
"type": "array",
"title": "List of Business Partner IDs",
"description": "List of Business Partner IDs",
"items": {
"id": "/properties/boList/items",
"type": "string",
"maxLength": 32,
"minLength": 32
}
}
}
}
},
"type": "array"
}Example:
[
{
"code": "1",
"businessPartners": [
"E203603EBDE84884866BB3B93AC3D09F"
]
},
{
"code": "3",
"businessPartners": [
"E203603EBDE84884866BB3B93AC3D09F"
]
},
{
"code": "7",
"businessPartners": [
"E203603EBDE84884866BB3B93AC3D09F"
]
}
]HTTP status code 200
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"id": "http://example.com/example.json",
"properties": {
"id": {
"description": "A system generated 32 bit ID which is unique for the created risk assessment.",
"id": "/properties/id",
"maxLength": 32,
"minLength": 32,
"type": "string"
},
"status": {
"id": "/properties/status",
"type": "boolean"
}
},
"type": "object"
}Example:
{
"id": "3A1606CE91DF41639CE9979554D0469E",
"status": true
}HTTP status code 400
Not Found
Secured by basic
This endpoint allows user to get various types of descriptions like scope
This endpoint allows user to update various types of descriptions like scope
get /riskassessments/{id}/information
This endpoint allows user to get various types of descriptions like scope
REST API supports Basic Authentication.
URI Parameters
- id: required (string)
Risk Assessment ID. Generated by server, used as read-only.
HTTP status code 200
Body
Media type: application/json
Type: json
Content:
{
"$id": "http://example.com/example.json",
"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": "The Code Schema",
"description": "Type of decription.",
"examples": [
"SCOPE"
]
},
"description": {
"$id": "http://example.com/example.json/items/properties/description",
"type": "string",
"title": "The Description Schema",
"description": "Description text.",
"default": "",
"examples": [
"test scope description1"
]
}
}
}
}Example:
[
{
"code": "SCOPE",
"description": "test scope description1"
}
]
HTTP status code 400
Not Found
Secured by basic
put /riskassessments/{id}/information
This endpoint allows user to update various types of descriptions like scope
REST API supports Basic Authentication.
URI Parameters
- id: required (string)
Risk Assessment ID. Generated by server, used as read-only.
Body
Media type: application/json
Type: json
Content:
{
"$id": "http://example.com/example.json",
"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": "The Code Schema",
"description": "Type of decription.",
"examples": [
"SCOPE"
]
},
"description": {
"$id": "http://example.com/example.json/items/properties/description",
"type": "string",
"title": "The Description Schema",
"description": "Description text.",
"default": "",
"examples": [
"test scope description1"
]
}
}
}
}Example:
[
{
"code": "SCOPE",
"description": "test scope description1"
}
]
HTTP status code 200
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"id": "http://example.com/example.json",
"properties": {
"id": {
"description": "A system generated 32 bit ID which is unique for the created risk assessment.",
"id": "/properties/id",
"maxLength": 32,
"minLength": 32,
"type": "string"
},
"status": {
"id": "/properties/status",
"type": "boolean"
}
},
"type": "object"
}Example:
{
"id": "3A1606CE91DF41639CE9979554D0469E",
"status": true
}HTTP status code 400
Not Found
Secured by basic
/assessments/fmea
This endpoint Gives the list of failuremodes, causes and effects for a particular object in an assessment
get /assessments/fmea/{assessmentId}/objects/{objectId}
This endpoint Gives the list of failuremodes, causes and effects for a particular object in an assessment
REST API supports Basic Authentication.
URI Parameters
- assessmentId: required (string)
- objectId: required (string)
HTTP status code 200
Body
Media type: application/json
Type: Can not resolve schemas/riskassessment/getObjectDetails.json
Example:
[{
"objectId": "5074811101864DFFA22AE1ED337D889A",
"objectVersion": "1.0",
"objectType": "MOD",
"failureModes": [{
"fmId": "B9017663B8A14A429375A0A3F30CE93A",
"fmeaMapId": "9B98725ABDB93031E10000000A78416B",
"fmDisplayID": "FM.ASPM.27",
"fmImage": null,
"fmVersion": "1.0",
"shortDescription": "RR_War_Test",
"longDescription": "RR_War_Test",
"causes": [{
"rpn": "196000.0",
"id": "566A095E24A242358150EE13A925DE22",
"objectType": "CS",
"displayId": "CS.ASPM.18",
"name": "gfdtgds",
"description": "fgdgfd"
}, {
"rpn": "7000.0",
"id": "7CCBC7CC58F34670A0ED6C420B5A0783",
"objectType": "CS",
"displayId": "CS.ASPM.19",
"name": "cause effect db",
"description": ""
}, {
"rpn": "245000.0",
"id": "7E6A579782604729B7A1E31733CA5302",
"objectType": "CS",
"displayId": "CS.ASPM.20",
"name": "cause effect db",
"description": ""
}],
"effects": [{
"id": "EFED6794C4CF4866827560966BA52A18",
"objectType": "EF",
"displayId": "EF.ASPM.4",
"name": "RRR",
"description": "RRR"
}, {
"id": "73A230CE1DAE4E5FBF3AB03AF5856234",
"objectType": "EF",
"displayId": "EF.ASPM.7",
"name": "RR_war",
"description": "RR_war"
}]
}, {
"fmId": "962B25F3930C432E85AD0E95BFE346E6",
"fmeaMapId": "9C98725ABDB93031E10000000A78416B",
"fmDisplayID": "FM.ASPM.24",
"fmImage": null,
"fmVersion": "1.0",
"shortDescription": "RR_COPIED",
"longDescription": "RR_COPIED",
"causes": [{
"rpn": "1000.0",
"id": "3734457B363A4A9D91D2DF4A9703093E",
"objectType": "CS",
"displayId": "CS.ASPM.21",
"name": "rrr",
"description": "rrr"
}, {
"rpn": "5000.0",
"id": "7812AD4A59714135B4FAD859BBE36EAE",
"objectType": "CS",
"displayId": "CS.ASPM.22",
"name": "cause effect db",
"description": ""
}, {
"rpn": "3000.0",
"id": "6A454DB9FB204AA3898178D32B8A90F8",
"objectType": "CS",
"displayId": "CS.ASPM.23",
"name": "cause effect db",
"description": ""
}],
"effects": [{
"id": "285651ED02B447DBA118422332B7F5B2",
"objectType": "EF",
"displayId": "EF.ASPM.8",
"name": "rrr",
"description": "rrr"
}, {
"id": "73A230CE1DAE4E5FBF3AB03AF5856234",
"objectType": "EF",
"displayId": "EF.ASPM.7",
"name": "RR_war",
"description": "RR_war"
}, {
"id": "3B259DB6E69D4000924EBF2F012F3A4D",
"objectType": "EF",
"displayId": "EF.ASPM.6",
"name": "test",
"description": "testjadshfkja"
}]
}]
}]HTTP status code 400
Not Found.
Secured by basic
This endpoint Gives the dimensions and scale options for Effects [EF].
get /assessments/fmea/map/{fmeaMapId}/effects/dimensions
This endpoint Gives the dimensions and scale options for Effects [EF].
REST API supports Basic Authentication.
URI Parameters
- fmeaMapId: required (string)
HTTP status code 200
Body
Media type: application/json
Type:
{
"$id": "http://example.com/example.json",
"type": "array",
"definitions": {},
"$schema": "http://json-schema.org/draft-07/schema#",
"items": {
"$id": "http://example.com/example.json/items",
"type": "object",
"properties": {
"effectId": {
"$id": "http://example.com/example.json/items/properties/effectId",
"type": "string",
"title": "The Effectid Schema ",
"default": "",
"examples": [
"086B047A0D244C7FA04997AD5983B8EC"
]
},
"dimensionId": {
"$id": "http://example.com/example.json/items/properties/dimensionId",
"type": "string",
"title": "The Dimensionid Schema ",
"default": "",
"examples": [
"299D6B33129E4371A2B56D2DE33C8339"
]
},
"scaleId": {
"$id": "http://example.com/example.json/items/properties/scaleId",
"type": "string",
"title": "The Scaleid Schema ",
"default": "",
"examples": [
"CCC51A712F1B43BABB6F0F18677294E8"
]
},
"selectedScaleOptionId": {
"$id": "http://example.com/example.json/items/properties/selectedScaleOptionId",
"type": "string",
"title": "The Selectedscaleoptionid Schema ",
"default": "",
"examples": [
"B8E872FF7C344F0F88E47E56DEDA8C51"
]
},
"dimensionType": {
"$id": "http://example.com/example.json/items/properties/dimensionType",
"type": "string",
"title": "The Dimensiontype Schema ",
"default": "",
"examples": [
"SEV"
]
},
"displayId": {
"$id": "http://example.com/example.json/items/properties/displayId",
"type": "string",
"title": "The Displayid Schema ",
"default": "",
"examples": [
"EF.TEDX.124"
]
},
"shortDesc": {
"$id": "http://example.com/example.json/items/properties/shortDesc",
"type": "string",
"title": "The Shortdesc Schema ",
"default": "",
"examples": [
"createeffect"
]
},
"isOwn": {
"$id": "http://example.com/example.json/items/properties/isOwn",
"type": "string",
"title": "The Isown Schema ",
"default": "",
"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": "The Code Schema ",
"default": ""
},
"test": {
"$id": "http://example.com/example.json/items/properties/impacts/items/properties/test",
"type": "string",
"title": "The Test Schema ",
"default": ""
}
}
}
}
}
}
}Example:
[
{
"effectId":"086B047A0D244C7FA04997AD5983B8EC",
"dimensionId":"299D6B33129E4371A2B56D2DE33C8339",
"scaleId":"CCC51A712F1B43BABB6F0F18677294E8",
"selectedScaleOptionId":"B8E872FF7C344F0F88E47E56DEDA8C51",
"selectedEffectId":null,
"dimensionType":"SEV",
"activityCount":0,
"rpn":0.0,
"displayId":"EF.TEDX.124",
"shortDesc":"createeffect",
"isOwn":"1",
"impacts":[
{
"code":"ENV",
"test":"Environment"
}
]
}
]HTTP status code 400
Not Found.
Secured by basic
This endpoint Gives the dimensions and scale options for Causes [CS].
get /assessments/fmea/map/{fmeaMapId}/causes/dimensions
This endpoint Gives the dimensions and scale options for Causes [CS].
REST API supports Basic Authentication.
URI Parameters
- fmeaMapId: required (string)
HTTP status code 200
Body
Media type: application/json
Type:
{
"$id": "http://example.com/example.json",
"type": "array",
"definitions": {},
"$schema": "http://json-schema.org/draft-07/schema#",
"items": {
"$id": "http://example.com/example.json/items",
"type": "object",
"properties": {
"causeId": {
"$id": "http://example.com/example.json/items/properties/causeId",
"type": "string",
"title": "The Causeid Schema ",
"default": "",
"examples": [
"509F93C32F1C4854933F2890BE17E120"
]
},
"selectedEffectId": {
"$id": "http://example.com/example.json/items/properties/selectedEffectId",
"type": "string",
"title": "The Selectedeffectid Schema ",
"default": "",
"examples": [
"086B047A0D244C7FA04997AD5983B8EC"
]
},
"activityCount": {
"$id": "http://example.com/example.json/items/properties/activityCount",
"type": "integer",
"title": "The Activitycount Schema ",
"default": 0,
"examples": [
0
]
},
"rpn": {
"$id": "http://example.com/example.json/items/properties/rpn",
"type": "number",
"title": "The Rpn Schema ",
"default": 0,
"examples": [
60000
]
},
"displayId": {
"$id": "http://example.com/example.json/items/properties/displayId",
"type": "string",
"title": "The Displayid Schema ",
"default": "",
"examples": [
"CS.TEDX.794"
]
},
"shortDesc": {
"$id": "http://example.com/example.json/items/properties/shortDesc",
"type": "string",
"title": "The Shortdesc Schema ",
"default": "",
"examples": [
"Micro switch faulty "
]
},
"isOwn": {
"$id": "http://example.com/example.json/items/properties/isOwn",
"type": "string",
"title": "The Isown Schema ",
"default": "",
"examples": [
"1"
]
},
"dimensions": {
"$id": "http://example.com/example.json/items/properties/dimensions",
"type": "array",
"items": {
"$id": "http://example.com/example.json/items/properties/dimensions/items",
"type": "object",
"properties": {
"dimensionId": {
"$id": "http://example.com/example.json/items/properties/dimensions/items/properties/dimensionId",
"type": "string",
"title": "The Dimensionid Schema ",
"default": "",
"examples": [
"488F367D1AA94D5E86B6F794D5F4CCC9"
]
},
"scaleId": {
"$id": "http://example.com/example.json/items/properties/dimensions/items/properties/scaleId",
"type": "string",
"title": "The Scaleid Schema ",
"default": "",
"examples": [
"63C77CAEB5FB4687BF5455EE2A72DD24"
]
},
"selectedScaleOptionId": {
"$id": "http://example.com/example.json/items/properties/dimensions/items/properties/selectedScaleOptionId",
"type": "string",
"title": "The Selectedscaleoptionid Schema ",
"default": "",
"examples": [
"9330D4C4F0594522983FA48019DEDF14"
]
},
"dimensionType": {
"$id": "http://example.com/example.json/items/properties/dimensions/items/properties/dimensionType",
"type": "string",
"title": "The Dimensiontype Schema ",
"default": "",
"examples": [
"OCR"
]
}
}
}
}
}
}
}Example:
[
{
"causeId":"509F93C32F1C4854933F2890BE17E120",
"selectedEffectId":"086B047A0D244C7FA04997AD5983B8EC",
"activityCount":0,
"rpn":60000.0,
"displayId":"CS.TEDX.794",
"shortDesc":"Micro switch faulty ",
"isOwn":"1",
"dimensions":[
{
"dimensionId":"488F367D1AA94D5E86B6F794D5F4CCC9",
"scaleId":"63C77CAEB5FB4687BF5455EE2A72DD24",
"selectedScaleOptionId":"9330D4C4F0594522983FA48019DEDF14",
"dimensionType":"OCR"
},
{
"dimensionId":"4BE40396A9784C09A0739A9B1D9A028D",
"scaleId":"3952BBF436924E07B0381F195A2AE94F",
"selectedScaleOptionId":"C95F223DEB8448599E94CB8DA5CB499B",
"dimensionType":"DET"
}
]
}
]HTTP status code 400
Not Found.
Secured by basic
This endpoint allows user to update causes for a FMEA assessment.
put /assessments/fmea/causes
This endpoint allows user to update causes for a FMEA assessment.
REST API supports Basic Authentication.
Body
Media type: application/json
Type:
{
"$id": "http://example.com/example.json",
"type": "object",
"definitions": {},
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"assessmentId": {
"$id": "/properties/assessmentId",
"type": "string",
"title": "The Assessmentid Schema ",
"default": "",
"examples": [
"0BAE580F9ADA4182B526069AEE915995"
]
},
"businessObjectId": {
"$id": "/properties/businessObjectId",
"type": "string",
"title": "The Businessobjectid Schema ",
"default": "",
"examples": [
"0D79808A7A2640879769DCE0EF0B4720"
]
},
"failureModeId": {
"$id": "/properties/failureModeId",
"type": "string",
"title": "The Failuremodeid Schema ",
"default": "",
"examples": [
"4E08A88BD1ED4D28A44F255C8E550AC8"
]
},
"causes": {
"$id": "/properties/causes",
"type": "array",
"items": {
"$id": "/properties/causes/items",
"type": "object",
"properties": {
"causeId": {
"$id": "/properties/causes/items/properties/causeId",
"type": "string",
"title": "The Causeid Schema ",
"default": "",
"examples": [
"ECF1E7C346B34BB2A95A02C580C1DB1F"
]
},
"relatedEffectId": {
"$id": "/properties/causes/items/properties/relatedEffectId",
"type": "string",
"title": "The Relatedeffectid Schema ",
"default": "",
"examples": [
"086B047A0D244C7FA04997AD5983B8EC"
]
},
"dimensions": {
"$id": "/properties/causes/items/properties/dimensions",
"type": "array",
"items": {
"$id": "/properties/causes/items/properties/dimensions/items",
"type": "object",
"properties": {
"dimensionId": {
"$id": "/properties/causes/items/properties/dimensions/items/properties/dimensionId",
"type": "string",
"title": "The Dimensionid Schema ",
"default": "",
"examples": [
"4BE40396A9784C09A0739A9B1D9A028D"
]
},
"selectedScaleOptionId": {
"$id": "/properties/causes/items/properties/dimensions/items/properties/selectedScaleOptionId",
"type": "string",
"title": "The Selectedscaleoptionid Schema ",
"default": "",
"examples": [
"7E0728E2427C4F46B3BC21E851569B76"
]
}
}
}
}
}
}
}
}
}Example:
{
"assessmentId":"0BAE580F9ADA4182B526069AEE915995",
"businessObjectId":"0D79808A7A2640879769DCE0EF0B4720",
"failureModeId":"4E08A88BD1ED4D28A44F255C8E550AC8",
"causes":[
{
"causeId":"ECF1E7C346B34BB2A95A02C580C1DB1F",
"relatedEffectId":"086B047A0D244C7FA04997AD5983B8EC",
"dimensions":[
{
"dimensionId":"4BE40396A9784C09A0739A9B1D9A028D",
"selectedScaleOptionId":"7E0728E2427C4F46B3BC21E851569B76"
},
{
"dimensionId":"488F367D1AA94D5E86B6F794D5F4CCC9",
"selectedScaleOptionId":"86CB9EF9CC12414E9E31AE922EB6C391"
}
]
},
{
"causeId":"B168E095BBA741F7AF5423381D07CE7B",
"relatedEffectId":"086B047A0D244C7FA04997AD5983B8EC",
"dimensions":[
{
"dimensionId":"4BE40396A9784C09A0739A9B1D9A028D",
"selectedScaleOptionId":"C717033CB6D146B18A05C4043CADB7A8"
},
{
"dimensionId":"488F367D1AA94D5E86B6F794D5F4CCC9",
"selectedScaleOptionId":"55E5D23F433F4201A0F463D035071C13"
}
]
}
]
}HTTP status code 200
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"id": "http://example.com/example.json",
"properties": {
"id": {
"description": "A system generated 32 bit ID which is unique for the created risk assessment.",
"id": "/properties/id",
"maxLength": 32,
"minLength": 32,
"type": "string"
},
"status": {
"id": "/properties/status",
"type": "boolean"
}
},
"type": "object"
}Example:
{
"id": "3A1606CE91DF41639CE9979554D0469E",
"status": true
}HTTP status code 400
Bad request.
Secured by basic
This endpoint allows user to update effect's scale options for a FMEA assessment.
put /assessments/fmea/effects
This endpoint allows user to update effect's scale options for a FMEA assessment.
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": {
"assessmentId": {
"$id": "/properties/assessmentId",
"type": "string",
"title": "The Assessmentid Schema",
"description": "A system generated 32 bit ID which is unique for the assessment.",
"maxLength": 32,
"minLength": 32,
"examples": [
"F42159526C354B8791E040A573C88434"
]
},
"businessObjectId": {
"$id": "/properties/businessObjectId",
"type": "string",
"title": "The Businessobjectid Schema",
"description": "A system generated 32 bit ID which is unique for the business object.",
"maxLength": 32,
"minLength": 32,
"examples": [
"B5AEC4AFAD8548229A24D00B2DA9E769"
]
},
"failureModeId": {
"$id": "/properties/failureModeId",
"type": "string",
"title": "The Failuremodeid Schema",
"description": "A system generated 32 bit ID which is unique for the failure mode.",
"maxLength": 32,
"minLength": 32,
"examples": [
"BE402C6F83F54A34BA5FC9FBE425DD11"
]
},
"effects": {
"$id": "/properties/effects",
"type": "array",
"items": {
"$id": "/properties/effects/items",
"type": "object",
"properties": {
"effectId": {
"$id": "/properties/effects/items/properties/effectId",
"type": "string",
"title": "The Effectid Schema",
"description": "A system generated 32 bit ID which is unique for the effect.",
"maxLength": 32,
"minLength": 32,
"examples": [
"E26A3C202AB24E61B049FBEB4343F115"
]
},
"dimensions": {
"$id": "/properties/dimensions",
"type": "array",
"items": {
"$id": "/properties/dimensions/items",
"type": "object",
"properties": {
"dimensionId": {
"$id": "/properties/dimensions/items/properties/dimensionId",
"type": "string",
"title": "The Dimensionid Schema",
"description": "A system generated 32 bit ID which is unique for the dimension.",
"maxLength": 32,
"minLength": 32,
"examples": [
"FC56E7B5D8C641D2AE35E7A048FF6B0D"
]
},
"selectedScaleOptionId": {
"$id": "/properties/dimensions/items/properties/selectedScaleOptionId",
"type": "string",
"title": "The Selectedscaleoptionid Schema",
"description": "A system generated 32 bit ID which is unique for the scale option.",
"maxLength": 32,
"minLength": 32,
"examples": [
"6FA9FCD5CB0D4D7F9482BCC281F2F961"
]
}
}
}
}
}
}
}
}
}Example:
{
"assessmentId": "8DD3B6D753AD4F5389D14B0314E68823",
"businessObjectId": "5074811101864DFFA22AE1ED337D889A",
"failureModeId": "B9017663B8A14A429375A0A3F30CE93A",
"effects": [{
"effectId": "EFED6794C4CF4866827560966BA52A18",
"dimension": {
"dimensionId": "7D567CA5F07A40EDB75537200563983E",
"selectedScaleOptionId": "2B7B5767076A415CA3144E1244CC6D32"
}
}, {
"effectId": "73A230CE1DAE4E5FBF3AB03AF5856234",
"dimension": {
"dimensionId": "7D567CA5F07A40EDB75537200563983E",
"selectedScaleOptionId": "BEA7CE05D8124D36BA092519D57E3CDF"
}
}]
}HTTP status code 200
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"id": "http://example.com/example.json",
"properties": {
"id": {
"description": "A system generated 32 bit ID which is unique for the created risk assessment.",
"id": "/properties/id",
"maxLength": 32,
"minLength": 32,
"type": "string"
},
"status": {
"id": "/properties/status",
"type": "boolean"
}
},
"type": "object"
}Example:
{
"id": "3A1606CE91DF41639CE9979554D0469E",
"status": true
}HTTP status code 400
Bad request.