Functional Failure API documentation version v1
Application_URL/services/api/v1/aspm
About Functional Failure
Functional failures is used to save information about the different failures occuring in a function.
Purpose
The APIs allow you to create, update, retrieve, delete and link functional failures to functions and failure modes of a business object like Equipment, Model, Location and System.
/functionalfailure
This endpoint allows you to get the list of all functional failures.
This endpoint allows you to create a functional failure.
get /functionalfailure
This endpoint allows you to get the list of all functional failures.
REST API is secured by OAuth 2.0 authentication
Query Parameters
- $filter: required(string)
Retrieves functional failures based on the value provided. This parameter follows ODATA URL convention. For eg $filter=(substringof('FF', displayId) eq true)
HTTP status code 200
Body
Media type: application/json
Type:
{
"definitions": {},
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "http://example.com/root.json",
"type": "array",
"items": {
"$id": "#/items",
"type": "object",
"properties": {
"id": {
"$id": "#/items/properties/id",
"type": "string",
"title": "The Id Schema",
"default": "",
"examples": [
"BD7B80C99A114BE88815DABFCB576658"
]
},
"displayId": {
"$id": "#/items/properties/displayId",
"type": "string",
"title": "The Displayid Schema",
"default": "",
"examples": [
"FF.PDMS_T.84"
]
},
"shortDescription": {
"$id": "#/items/properties/shortDescription",
"type": "string",
"title": "The Shortdescription Schema",
"default": "",
"examples": [
"Functional Failure 1"
]
},
"longDescription": {
"$id": "#/items/properties/longDescription",
"type": "string",
"title": "The Longdescription Schema",
"default": "",
"examples": [
""
]
},
"updatedTime": {
"$id": "#/items/properties/updatedTime",
"type": "integer",
"title": "The Updatedtime Schema",
"default": 0,
"examples": [
1578441600000
]
},
"eventCode": {
"$id": "#/items/properties/eventCode",
"type": "string",
"title": "The Eventcode Schema",
"default": "",
"examples": [
"NT"
]
},
"eventDescription": {
"$id": "#/items/properties/eventDescription",
"type": "string",
"title": "The Eventdescription Schema",
"default": "",
"examples": [
"Notification"
]
}
}
}
}Example:
[{
"id": "BD7B80C99A114BE88815DABFCB576658",
"displayId": "FF.PDMS_T.84",
"shortDescription": "Functional Failure 1",
"longDescription": "",
"updatedTime": 1578441600000,
"eventCode": "NT",
"eventDescription": "Notification"
}, {
"id": "0031A5A9314C493AA8E7ED9AA9854E9B",
"displayId": "FF.PDMS_T.83",
"shortDescription": "Functional Failure 2",
"longDescription": "Functional Failure 2",
"updatedTime": 1578355200000,
"eventCode": "ALR",
"eventDescription": "Alert"
}]HTTP status code 400
Not Found
Secured by OAuth 2.0
post /functionalfailure
This endpoint allows you to create a functional failure.
REST API is secured by OAuth 2.0 authentication
Body
Media type: application/json
Type:
{
"definitions": {},
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "http://example.com/root.json",
"type": "object",
"properties": {
"description": {
"$id": "#/properties/description",
"type": "object",
"title": "The Description Schema",
"properties": {
"short": {
"$id": "#/properties/description/properties/short",
"type": "string",
"title": "The Short Schema",
"default": "",
"examples": [
"NM Functional failure 03"
]
},
"long": {
"$id": "#/properties/description/properties/long",
"type": "string",
"title": "The Long Schema",
"default": "",
"examples": [
""
]
}
}
},
"failureEventCodes": {
"$id": "#/properties/failureEventCodes",
"type": "array",
"title": "The Failureeventcodes Schema",
"items": {
"$id": "#/properties/failureEventCodes/items",
"type": "string",
"title": "The Items Schema",
"default": "",
"examples": [
"NT"
]
}
}
}
}Example:
{
"description": {
"short": "NM Functional failure 03",
"long": ""
},
"failureEventCodes": ["NT"]
}HTTP status code 201
Successfully creates a Functional Failure.
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 OAuth 2.0
This endpoint allows you to update an unpublished Functional failure.
This endpoint allows you to delete the specified unpublished functional failure.
put /functionalfailure/{id}
This endpoint allows you to update an unpublished Functional failure.
REST API is secured by OAuth 2.0 authentication
URI Parameters
- id: required(string)
Functional failure ID. Generated by server, used as read-only.
Body
Media type: application/json
Type:
{
"definitions": {},
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "http://example.com/root.json",
"type": "object",
"properties": {
"description": {
"$id": "#/properties/description",
"type": "object",
"title": "The Description Schema",
"properties": {
"short": {
"$id": "#/properties/description/properties/short",
"type": "string",
"title": "The Short Schema",
"default": "",
"examples": [
"NM Functional failure 03"
]
},
"long": {
"$id": "#/properties/description/properties/long",
"type": "string",
"title": "The Long Schema",
"default": "",
"examples": [
""
]
}
}
},
"failureEventCodes": {
"$id": "#/properties/failureEventCodes",
"type": "array",
"title": "The Failureeventcodes Schema",
"items": {
"$id": "#/properties/failureEventCodes/items",
"type": "string",
"title": "The Items Schema",
"default": "",
"examples": [
"NT"
]
}
}
}
}Example:
{
"description": {
"short": "NM Functional failure 03",
"long": ""
},
"failureEventCodes": ["NT"]
}HTTP status code 200
Successfully updates a Functional failure.
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 OAuth 2.0
delete /functionalfailure/{id}
This endpoint allows you to delete the specified unpublished functional failure.
REST API is secured by OAuth 2.0 authentication
URI Parameters
- id: required(string)
Functional failure 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 OAuth 2.0
This endpoint allows you to fetch all the event types that can be used for a functional failure.
get /functionalfailure/failureevents
This endpoint allows you to fetch all the event types that can be used for a functional failure.
REST API is secured by OAuth 2.0 authentication
HTTP status code 200
Body
Media type: application/json
Type:
{
"definitions": {},
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "http://example.com/root.json",
"type": "array",
"items": {
"$id": "#/items",
"type": "object",
"properties": {
"code": {
"$id": "#/items/properties/code",
"type": "string",
"title": "The Code Schema",
"default": "",
"examples": [
"ALR"
]
},
"name": {
"$id": "#/items/properties/name",
"type": "string",
"title": "The Name Schema",
"default": "",
"examples": [
"Alert"
]
}
}
}
}Example:
[{
"code": "ALR",
"name": "Alert"
}, {
"code": "NT",
"name": "Notification"
}, {
"code": "ST",
"name": "Service Ticket"
}]HTTP status code 400
Not Found