ASPM Checklist Assessment API documentation version v1
Application_URL/services/api/v1/aspm
ASPM Checklist Assessment
About Checklist Assessment
Checklist Assessment feature is used for assessing bussiness objects like Equipment, Locations, Systems and Models on regular basis in short intervals.
Purpose
This API allows you to create, update, retrieve and delete Assessments for a Equipment, Locations, Systems and Models.
/checklists
This endpoint allows you to get the list of all checklist Assessments.
This endpoint allows you to create a checklist Assessment.
get /checklists
This endpoint allows you to get the list of all checklist 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('SFT', Type) 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",
"title": "The Root Schema",
"items": {
"$id": "#/items",
"type": "object",
"title": "The Items Schema",
"required": [
"ID",
"DisplayID",
"Type",
"TypeDescription",
"ShortDescription",
"LongDescription",
"CreatedOn",
"UpdatedOn",
"Client",
"Ownership",
"Source",
"Status",
"StatusText",
"ObjectCount",
"MatrixDisplayID"
],
"properties": {
"ID": {
"$id": "#/items/properties/ID",
"type": "string",
"title": "The Id Schema",
"examples": [
"326A2ADD2B50480D9609DA4528FF7E5E"
]
},
"DisplayID": {
"$id": "#/items/properties/DisplayID",
"type": "string",
"title": "The Displayid Schema",
"examples": [
"CL.TGSV.302"
]
},
"Type": {
"$id": "#/items/properties/Type",
"type": "string",
"title": "The Type Schema",
"examples": [
"ENV"
]
},
"TypeDescription": {
"$id": "#/items/properties/TypeDescription",
"type": "string",
"title": "The Typedescription Schema",
"examples": [
"Environment"
]
},
"ShortDescription": {
"$id": "#/items/properties/ShortDescription",
"type": "string",
"title": "The Shortdescription Schema",
"examples": [
"short desc"
]
},
"LongDescription": {
"$id": "#/items/properties/LongDescription",
"type": "string",
"title": "The Longdescription Schema",
"default": "",
"examples": [
""
]
},
"CreatedOn": {
"$id": "#/items/properties/CreatedOn",
"type": "integer",
"title": "The Createdon Schema",
"examples": [
1547683200000
]
},
"UpdatedOn": {
"$id": "#/items/properties/UpdatedOn",
"type": "integer",
"title": "The Updatedon Schema",
"examples": [
1547683200000
]
},
"Client": {
"$id": "#/items/properties/Client",
"type": "string",
"title": "The Client Schema",
"examples": [
"D6001ECF1B6B44D6896300EEA0FD3B29"
]
},
"Ownership": {
"$id": "#/items/properties/Ownership",
"type": "string",
"title": "The Ownership Schema",
"examples": [
"1"
]
},
"Source": {
"$id": "#/items/properties/Source",
"type": "string",
"title": "The Source Schema",
"examples": [
"ASPM Test"
]
},
"Status": {
"$id": "#/items/properties/Status",
"type": "integer",
"title": "The Status Schema",
"examples": [
0
]
},
"StatusText": {
"$id": "#/items/properties/StatusText",
"type": "string",
"title": "The Statustext Schema",
"examples": [
"Unpublished"
]
},
"ObjectCount": {
"$id": "#/items/properties/ObjectCount",
"type": "integer",
"title": "The Objectcount Schema",
"default": 0
},
"MatrixDisplayID": {
"$id": "#/items/properties/MatrixDisplayID",
"type": "string",
"title": "The Matrixdisplayid Schema",
"examples": [
"AT.TGSV.59"
]
}
}
}
}Example:
[
{
"ID": "326A2ADD2B50480D9609DA4528FF7E5E",
"DisplayID": "CL.TGSV.302",
"Type": "ENV",
"TypeDescription": "Environment",
"ShortDescription": "blah blah",
"LongDescription": "",
"CreatedOn": 1547683200000,
"UpdatedOn": 1547683200000,
"Client": "D6001ECF1B6B44D6896300EEA0FD3B29",
"Ownership": "1",
"Source": "ASPM Test",
"Status": 0,
"StatusText": "Unpublished",
"ObjectCount": 0,
"MatrixDisplayID": "AT.TGSV.59"
}
]HTTP status code 400
Not Found
Secured by basic
post /checklists
This endpoint allows you to create a checklist Assessment.
REST API supports Basic Authentication.
Body
Media type: application/json
Type:
{
"definitions": {},
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "http://example.com/root.json",
"type": "object",
"title": "The Root Schema",
"required": [
"description",
"type"
],
"properties": {
"description": {
"$id": "#/properties/description",
"type": "object",
"title": "The Description Schema",
"required": [
"short"
],
"properties": {
"short": {
"$id": "#/properties/description/properties/short",
"type": "string",
"title": "The Short Schema",
"examples": [
"test checklist"
]
},
"long": {
"$id": "#/properties/description/properties/long",
"type": "string",
"title": "The Long Schema",
"default": "",
"examples": [
"long description"
]
}
}
},
"type": {
"$id": "#/properties/type",
"type": "string",
"title": "The Type Schema",
"examples": [
"ENV"
]
},
"objects": {
"$id": "#/properties/objects",
"type": ["array","null"],
"title": "The Objects Schema",
"items": {
"$id": "#/properties/objects/items",
"type": "string",
"title": "The Items Schema",
"default": "",
"examples": [
"438DF11D35F94A22826E1367CF968F6C"
]
}
}
}
}Example:
{
"description": {
"short": "test checklist",
"long": ""
},
"type": "ENV",
"objects": [
"438DF11D35F94A22826E1367CF968F6C"
]
}HTTP status code 200
Successfully creates a checklist 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 update the header information of an unpublished Assessment.
This endpoint allows you to delete the specified unpublished assessment.
put /checklists/{checklistId}
This endpoint allows you to update the header information of an unpublished Assessment.
REST API supports Basic Authentication.
URI Parameters
- checklistId: required (string)
Checklist Assessment 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",
"title": "The Root Schema",
"required": [
"description",
"type"
],
"properties": {
"description": {
"$id": "#/properties/description",
"type": "object",
"title": "The Description Schema",
"required": [
"short"
],
"properties": {
"short": {
"$id": "#/properties/description/properties/short",
"type": "string",
"title": "The Short Schema",
"examples": [
"test checklist"
]
},
"long": {
"$id": "#/properties/description/properties/long",
"type": "string",
"title": "The Long Schema",
"default": "",
"examples": [
"long description"
]
}
}
},
"type": {
"$id": "#/properties/type",
"type": "string",
"title": "The Type Schema",
"examples": [
"ENV"
]
},
"objects": {
"$id": "#/properties/objects",
"type": ["array","null"],
"title": "The Objects Schema",
"items": {
"$id": "#/properties/objects/items",
"type": "string",
"title": "The Items Schema",
"default": "",
"examples": [
"438DF11D35F94A22826E1367CF968F6C"
]
}
}
}
}Example:
{
"description": {
"short": "test checklist",
"long": ""
},
"type": "ENV",
"objects": [
"438DF11D35F94A22826E1367CF968F6C"
]
}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
delete /checklists/{checklistId}
This endpoint allows you to delete the specified unpublished assessment.
REST API supports Basic Authentication.
URI Parameters
- checklistId: required (string)
Checklist 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 publish an unpublished Assessment.
put /checklists/{checklistId}/publish
This endpoint allows you to publish an unpublished Assessment.
REST API supports Basic Authentication.
URI Parameters
- checklistId: required (string)
Checklist 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 assign users to particular roles specified in assessment template of an unpublished Assessment.
This endpoint allows you to get users assigned to particular roles of Assessment.
put /checklists/{checklistId}/bproles
This endpoint allows you to assign users to particular roles specified in assessment template of an unpublished Assessment.
REST API supports Basic Authentication.
URI Parameters
- checklistId: required (string)
Checklist Assessment ID. Generated by server, used as read-only.
Body
Media type: application/json
Type:
{
"$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
get /checklists/{checklistId}/bproles
This endpoint allows you to get users assigned to particular roles of Assessment.
REST API supports Basic Authentication.
URI Parameters
- checklistId: required (string)
Checklist Assessment ID. Generated by server, used as read-only.
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",
"title": "The Root Schema",
"items": {
"$id": "#/items",
"type": "object",
"title": "The Items Schema",
"required": [
"code",
"role",
"mandatory",
"businessPartners"
],
"properties": {
"code": {
"$id": "#/items/properties/code",
"type": "string",
"title": "The Code Schema",
"examples": [
"2"
]
},
"role": {
"$id": "#/items/properties/role",
"type": "string",
"title": "The Role Schema",
"examples": [
"Moderator"
]
},
"mandatory": {
"$id": "#/items/properties/mandatory",
"type": "boolean",
"title": "The Mandatory Schema",
"default": false,
"examples": [
false
]
},
"businessPartners": {
"$id": "#/items/properties/businessPartners",
"type": "array",
"title": "The Businesspartners Schema",
"items": {
"$id": "#/items/properties/businessPartners/items",
"type": "object",
"title": "The Items Schema",
"required": [
"bpid",
"bpname"
],
"properties": {
"bpid": {
"$id": "#/items/properties/businessPartners/items/properties/bpid",
"type": "string",
"title": "The Bpid Schema",
"examples": [
"E203603EBDE84884866BB3B93AC3D09F"
]
},
"bpname": {
"$id": "#/items/properties/businessPartners/items/properties/bpname",
"type": "string",
"title": "The Bpname Schema",
"examples": [
"USER1"
]
}
}
}
}
}
}
}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
This endpoint allows you to get list of assigned objects of Assessment.
get /checklists/{checklistId}/businessobjects
This endpoint allows you to get list of assigned objects of Assessment.
REST API supports Basic Authentication.
URI Parameters
- checklistId: required (string)
Checklist Assessment ID. Generated by server, used as read-only.
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": "object",
"title": "The Root Schema",
"required": [
"EQU", "SYS", "FL", "MOD"
],
"properties": {
"EQU": {
"$id": "#/properties/EQU",
"type": "array",
"title": "The Equ Schema",
"items": {
"$id": "#/properties/EQU/items",
"type": "object",
"title": "The Items Schema",
"required": [
"id",
"objectType",
"assessmentId"
],
"properties": {
"id": {
"$id": "#/properties/EQU/items/properties/id",
"type": "string",
"title": "The Id Schema",
"default": "",
"examples": [
"6D361D5857A44AAA9CD3AD9A96910107"
]
},
"objectType": {
"$id": "#/properties/EQU/items/properties/objectType",
"type": "string",
"title": "The Objecttype Schema",
"default": "",
"examples": [
"EQU"
]
},
"assessmentId": {
"$id": "#/properties/EQU/items/properties/assessmentId",
"type": ["string","null"],
"title": "The Assessmentid Schema",
"default": "",
"examples": [
"055D1D1EE92A45FCAE75B9965E44015A"
]
}
}
}
}
}
}Example:
{
"MOD": [
{
"id": "90F10FE4AE9A411DA019E4891D74B543",
"objectType": "MOD",
"assessmentId": "E36225C8DC60489289265B089285E38D"
},
{
"id": "E841561A733342809FBC9F9216019476",
"objectType": "MOD",
"assessmentId": null
}
],
"FL": [
{
"id": "D9DBA36EF0034FC2B53E948468FFC2B6",
"objectType": "FL",
"assessmentId": "F7CCE39D7F9042CC9806A8746D784666"
},
{
"id": "553121502DE44D569B90BD7BD9C755BB",
"objectType": "FL",
"assessmentId": "F275F1310585471BB107789588CCFB65"
}
],
"EQU": [
{
"id": "6D361D5857A44AAA9CD3AD9A96910107",
"objectType": "EQU",
"assessmentId": "055D1D1EE92A45FCAE75B9965E44015A"
},
{
"id": "438DF11D35F94A22826E1367CF968F6C",
"objectType": "EQU",
"assessmentId": null
}
],
"SYS": [
{
"id": "6D37CF6BD4BA4BA88D8FB9FCCFE2892C",
"objectType": "SYS",
"assessmentId": "F016C378F41B4888935A9FDE010FE0DD"
},
{
"id": "9B6235A39F784E35B0DEDA39342CA947",
"objectType": "SYS",
"assessmentId": null
}
]
}HTTP status code 400
Not Found
Secured by basic
This endpoint allows you to assign objects to an unpublished Assessment.
put /checklists/{checklistId}/businessobjects/assign
This endpoint allows you to assign objects to an unpublished Assessment.
REST API supports Basic Authentication.
URI Parameters
- checklistId: required (string)
Checklist Assessment ID. Generated by server, used as read-only.
Query Parameters
- objectType: required (string)
Type of object
Body
Media type: application/json
Type:
{
"definitions": {},
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "http://example.com/root.json",
"type": "array",
"title": "The Root Schema",
"items": {
"$id": "#/items",
"type": "object",
"title": "The Items Schema",
"required": [
"id",
"checklistTemplateId"
],
"properties": {
"id": {
"$id": "#/items/properties/id",
"type": "string",
"title": "The Id Schema",
"examples": [
"438DF11D35F94A22826E1367CF968F6C"
]
},
"checklistTemplateId": {
"$id": "#/items/properties/checklistTemplateId",
"type": "string",
"title": "The Checklisttemplateid Schema",
"default": "",
"examples": [
"1B714A5E34D54AF1A1973506E2BEB23C"
]
}
}
}
}Example:
[
{
"id": "438DF11D35F94A22826E1367CF968F6C",
"checklistTemplateId": "1B714A5E34D54AF1A1973506E2BEB23C"
},
{
"id": "6D361D5857A44AAA9CD3AD9A96910107",
"checklistTemplateId": ""
}
]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 remove objects from an unpublished Assessment.
put /checklists/{checklistId}/businessobjects/unassign
This endpoint allows you to remove objects from an unpublished Assessment.
REST API supports Basic Authentication.
URI Parameters
- checklistId: required (string)
Checklist Assessment ID. Generated by server, used as read-only.
Body
Media type: application/json
Type:
{
"$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
/checklist/{checklistId}
Checklist value services
This endpoint fetches all the attribute values for a checklist assessment.
This endpoint updates the attribute values for a checklist assessment.
get /checklist/{checklistId}/assessment/{id}/values
This endpoint fetches all the attribute values for a checklist assessment.
REST API supports Basic Authentication.
URI Parameters
- checklistId: required (string)
Checklist Assessment ID. Generated by server, used as read-only.
- id: required (string)
HTTP status code 200
Body
Media type: application/json
Type: json
Content:
{
"definitions": {},
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "http://example.com/root.json",
"type": "object",
"title": "The Root Schema",
"required": [
"id",
"templates"
],
"properties": {
"id": {
"$id": "#/properties/id",
"type": "string",
"title": "The Id Schema",
"default": "",
"examples": [
"67AE044FA13E4686A785D1D20DD8B74C"
]
},
"templates": {
"$id": "#/properties/templates",
"type": "array",
"title": "The Templates Schema",
"items": {
"$id": "#/properties/templates/items",
"type": "object",
"title": "The Items Schema",
"required": [
"templateId",
"internalId",
"attributeGroups"
],
"properties": {
"templateId": {
"$id": "#/properties/templates/items/properties/templateId",
"type": "string",
"title": "The Templateid Schema",
"default": "",
"examples": [
"690400907FF9CC6E16005E02FACBCA49"
]
},
"internalId": {
"$id": "#/properties/templates/items/properties/internalId",
"type": "string",
"title": "The Internalid Schema",
"default": "",
"examples": [
"NM_ET_02"
]
},
"attributeGroups": {
"$id": "#/properties/templates/items/properties/attributeGroups",
"type": "array",
"title": "The Attributegroups Schema",
"items": {
"$id": "#/properties/templates/items/properties/attributeGroups/items",
"type": "object",
"title": "The Items Schema",
"required": [
"attributeGroupId",
"referenceId",
"internalId",
"attributes",
"attributeGroups"
],
"properties": {
"attributeGroupId": {
"$id": "#/properties/templates/items/properties/attributeGroups/items/properties/attributeGroupId",
"type": "string",
"title": "The Attributegroupid Schema",
"default": "",
"examples": [
"830D00B018D4F56516005E025BF350A4"
]
},
"referenceId": {
"$id": "#/properties/templates/items/properties/attributeGroups/items/properties/referenceId",
"type": "string",
"title": "The Referenceid Schema",
"default": "",
"examples": [
"AD28FE603A0D3AA381FF77ACA956294E"
]
},
"internalId": {
"$id": "#/properties/templates/items/properties/attributeGroups/items/properties/internalId",
"type": "string",
"title": "The Internalid Schema",
"default": "",
"examples": [
"Attributes-for-CL"
]
},
"attributes": {
"$id": "#/properties/templates/items/properties/attributeGroups/items/properties/attributes",
"type": "array",
"title": "The Attributes Schema",
"items": {
"$id": "#/properties/templates/items/properties/attributeGroups/items/properties/attributes/items",
"type": "object",
"title": "The Items Schema",
"required": [
"attributeId",
"value1",
"name",
"internalId",
"dataType"
],
"properties": {
"attributeId": {
"$id": "#/properties/templates/items/properties/attributeGroups/items/properties/attributes/items/properties/attributeId",
"type": "string",
"title": "The Attributeid Schema",
"default": "",
"examples": [
"894B03EC273A43398BC298D4FE982868"
]
},
"value1": {
"$id": "#/properties/templates/items/properties/attributeGroups/items/properties/attributes/items/properties/value1",
"type": "string",
"title": "The Value1 Schema",
"default": "",
"examples": [
"999"
]
},
"name": {
"$id": "#/properties/templates/items/properties/attributeGroups/items/properties/attributes/items/properties/name",
"type": "string",
"title": "The Name Schema",
"default": "",
"examples": [
"attribute"
]
},
"internalId": {
"$id": "#/properties/templates/items/properties/attributeGroups/items/properties/attributes/items/properties/internalId",
"type": "string",
"title": "The Internalid Schema",
"default": "",
"examples": [
"attribute"
]
},
"dataType": {
"$id": "#/properties/templates/items/properties/attributeGroups/items/properties/attributes/items/properties/dataType",
"type": "string",
"title": "The Datatype Schema",
"default": "",
"examples": [
"NUMERICFLEXIBLE"
]
}
}
}
},
"attributeGroups": {
"$id": "#/properties/templates/items/properties/attributeGroups/items/properties/attributeGroups",
"type": "array",
"title": "The Attributegroups Schema"
}
}
}
}
}
}
}
}
}Example:
{
"id": "67AE044FA13E4686A785D1D20DD8B74C",
"templates": [{
"templateId": "690400907FF9CC6E16005E02FACBCA49",
"internalId": "NM_ET_02",
"attributeGroups": [{
"attributeGroupId": "830D00B018D4F56516005E025BF350A4",
"referenceId": "AD28FE603A0D3AA381FF77ACA956294E",
"internalId": "Attributes-for-CL",
"attributes": [{
"attributeId": "894B03EC273A43398BC298D4FE982868",
"value1": "999",
"name": "attribute",
"internalId": "attribute",
"dataType": "NUMERICFLEXIBLE"
}, {
"attributeId": "B8B16E2F0C3B4D2A8D26973ACEE1ED4B",
"value1": "False",
"name": "Att-Bool",
"internalId": "Att-Bool",
"dataType": "BOOLEAN"
}, {
"attributeId": "EC1DC673FED64BF2BFE3FB696646AD69",
"value1": "777",
"uom1": "944",
"name": "Att-Currency",
"internalId": "Att-Currency",
"dataType": "CURRENCY"
}],
"attributeGroups": []
}, {
"attributeGroupId": "5D0800907FF9CC6E16005E02FACBCA49",
"referenceId": "AD28FE603A0D3AA381FF77ACA956294E",
"internalId": "ST_CL_01",
"attributes": [{
"attributeId": "4007A3EE9FC5470FB1665485E23519C0",
"value1": "True",
"name": "ST_CL_01",
"internalId": "ST_CL_01",
"dataType": "BOOLEAN"
}],
"attributeGroups": []
}]
}, {
"templateId": "240B00B018D4F56516005E025BF350A4",
"internalId": "NM_ET_01",
"attributeGroups": [{
"attributeGroupId": "650200907FF9CC6E16005E02FACBCA49",
"referenceId": "D7E38150213832EBA3434ECE85AF002A",
"internalId": "MDU_test_AG",
"attributes": [{
"attributeId": "B8B16E2F0C3B4D2A8D26973ACEE1ED4B",
"value1": "False",
"name": "Att-Bool",
"internalId": "Att-Bool",
"dataType": "BOOLEAN"
}, {
"attributeId": "EC1DC673FED64BF2BFE3FB696646AD69",
"value1": "787",
"uom1": "051",
"name": "Att-Currency",
"internalId": "Att-Currency",
"dataType": "CURRENCY"
}],
"attributeGroups": []
}]
}]
}HTTP status code 400
Not Found
Secured by basic
put /checklist/{checklistId}/assessment/{id}/values
This endpoint updates the attribute values for a checklist assessment.
REST API supports Basic Authentication.
URI Parameters
- checklistId: required (string)
Checklist Assessment ID. Generated by server, used as read-only.
- id: required (string)
Body
Media type: application/json
Type: json
Content:
{
"definitions": {},
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "http://example.com/root.json",
"type": "object",
"title": "The Root Schema",
"required": [
"templates"
],
"properties": {
"templates": {
"$id": "#/properties/templates",
"type": "array",
"title": "The Templates Schema",
"items": {
"$id": "#/properties/templates/items",
"type": "object",
"title": "The Items Schema",
"required": [
"templateId",
"attributeGroups"
],
"properties": {
"templateId": {
"$id": "#/properties/templates/items/properties/templateId",
"type": "string",
"title": "The Templateid Schema",
"default": "",
"examples": [
"240B00B018D4F56516005E025BF350A4"
]
},
"attributeGroups": {
"$id": "#/properties/templates/items/properties/attributeGroups",
"type": "array",
"title": "The Attributegroups Schema",
"items": {
"$id": "#/properties/templates/items/properties/attributeGroups/items",
"type": "object",
"title": "The Items Schema",
"required": [
"attributeGroupId",
"attributes"
],
"properties": {
"attributeGroupId": {
"$id": "#/properties/templates/items/properties/attributeGroups/items/properties/attributeGroupId",
"type": "string",
"title": "The Attributegroupid Schema",
"default": "",
"examples": [
"650200907FF9CC6E16005E02FACBCA49"
]
},
"attributes": {
"$id": "#/properties/templates/items/properties/attributeGroups/items/properties/attributes",
"type": "array",
"title": "The Attributes Schema",
"items": {
"$id": "#/properties/templates/items/properties/attributeGroups/items/properties/attributes/items",
"type": "object",
"title": "The Items Schema",
"required": [
"attributeId",
"value1"
],
"properties": {
"attributeId": {
"$id": "#/properties/templates/items/properties/attributeGroups/items/properties/attributes/items/properties/attributeId",
"type": "string",
"title": "The Attributeid Schema",
"default": "",
"examples": [
"6A0F7DAC7E5C49D7AD12222033448AB0"
]
},
"value1": {
"$id": "#/properties/templates/items/properties/attributeGroups/items/properties/attributes/items/properties/value1",
"type": "string",
"title": "The Value1 Schema",
"default": "",
"examples": [
"attribute1"
]
}
}
}
}
}
}
}
}
}
}
}
}Example:
{
"templates": [{
"templateId": "240B00B018D4F56516005E025BF350A4",
"attributeGroups": [{
"attributeGroupId": "650200907FF9CC6E16005E02FACBCA49",
"attributes": [{
"attributeId": "6A0F7DAC7E5C49D7AD12222033448AB0",
"value1": "attribute1"
}, {
"attributeId": "B8B16E2F0C3B4D2A8D26973ACEE1ED4B",
"value1": "true"
}, {
"attributeId": "EC1DC673FED64BF2BFE3FB696646AD69",
"value1": "567",
"uom1": "840",
"value2": "567"
}, {
"attributeId": "E0B785A2AB1D4FC8BB1F2B35E6839037",
"value1": "2019-01-15"
}]
}]
}]
}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 fetches all the indicator values for a checklist assessment.
This endpoint adds the indicator values for a checklist assessment.
get /checklist/{checklistId}/indicator/{assessmentId}/values
This endpoint fetches all the indicator values for a checklist assessment.
REST API supports Basic Authentication.
URI Parameters
- checklistId: required (string)
Checklist Assessment ID. Generated by server, used as read-only.
- assessmentId: required (string)
HTTP status code 200
Body
Media type: application/json
Type: json
Content:
{
"definitions": {},
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "http://example.com/root.json",
"type": "array",
"title": "The Root Schema",
"items": {
"$id": "#/items",
"type": "object",
"title": "The Items Schema",
"required": [
"categoryID",
"pstID",
"propertyId",
"objectId",
"originAppDesc",
"assessmentId",
"timestamp",
"convertedValue",
"uom",
"convertedUOM",
"valueID",
"baseValue",
"uomDesc",
"convertedUomDesc"
],
"properties": {
"categoryID": {
"$id": "#/items/properties/categoryID",
"type": "string",
"title": "The Categoryid Schema",
"default": "",
"examples": [
"690400907FF9CC6E16005E02FACBCA49"
]
},
"pstID": {
"$id": "#/items/properties/pstID",
"type": "string",
"title": "The Pstid Schema",
"default": "",
"examples": [
"1E0B00B018D4F56516005E025BF350A4"
]
},
"propertyId": {
"$id": "#/items/properties/propertyId",
"type": "string",
"title": "The Propertyid Schema",
"default": "",
"examples": [
"419C0967BF494748A0FFABD61FFD7085"
]
},
"objectId": {
"$id": "#/items/properties/objectId",
"type": "string",
"title": "The Objectid Schema",
"default": "",
"examples": [
"1FC1D282A05F4F4A80E926BBECB35D26"
]
},
"originAppDesc": {
"$id": "#/items/properties/originAppDesc",
"type": "string",
"title": "The Originappdesc Schema",
"default": "",
"examples": [
"Assessment"
]
},
"assessmentId": {
"$id": "#/items/properties/assessmentId",
"type": "string",
"title": "The Assessmentid Schema",
"default": "",
"examples": [
"67AE044FA13E4686A785D1D20DD8B74C"
]
},
"timestamp": {
"$id": "#/items/properties/timestamp",
"type": "string",
"title": "The Timestamp Schema",
"default": "",
"examples": [
"2018-11-29"
]
},
"convertedValue": {
"$id": "#/items/properties/convertedValue",
"type": "string",
"title": "The Convertedvalue Schema",
"default": "",
"examples": [
"43.99999978"
]
},
"uom": {
"$id": "#/items/properties/uom",
"type": "string",
"title": "The Uom Schema",
"default": "",
"examples": [
"FA"
]
},
"convertedUOM": {
"$id": "#/items/properties/convertedUOM",
"type": "string",
"title": "The Converteduom Schema",
"default": "",
"examples": [
"GC"
]
},
"valueID": {
"$id": "#/items/properties/valueID",
"type": "string",
"title": "The Valueid Schema",
"default": "",
"examples": [
"3372894FE11541BAA70A3588F2845C77"
]
},
"baseValue": {
"$id": "#/items/properties/baseValue",
"type": "string",
"title": "The Basevalue Schema",
"default": "",
"examples": [
"111.2"
]
},
"uomDesc": {
"$id": "#/items/properties/uomDesc",
"type": "string",
"title": "The Uomdesc Schema",
"default": "",
"examples": [
"°F"
]
},
"convertedUomDesc": {
"$id": "#/items/properties/convertedUomDesc",
"type": "string",
"title": "The Converteduomdesc Schema",
"default": "",
"examples": [
"°C"
]
}
}
}
}Example:
[
{
"categoryID": "690400907FF9CC6E16005E02FACBCA49",
"pstID": "1E0B00B018D4F56516005E025BF350A4",
"propertyId": "419C0967BF494748A0FFABD61FFD7085",
"objectId": "1FC1D282A05F4F4A80E926BBECB35D26",
"originAppDesc": "Assessment",
"assessmentId": "67AE044FA13E4686A785D1D20DD8B74C",
"timestamp": "2018-11-29",
"convertedValue": "43.99999978",
"uom": "FA",
"convertedUOM": "GC",
"valueID": "3372894FE11541BAA70A3588F2845C77",
"baseValue": "111.2",
"uomDesc": "°F",
"convertedUomDesc": "°C"
}, {
"categoryID": "240B00B018D4F56516005E025BF350A4",
"pstID": "1E0B00B018D4F56516005E025BF350A4",
"propertyId": "419C0967BF494748A0FFABD61FFD7085",
"objectId": "1FC1D282A05F4F4A80E926BBECB35D26",
"originAppDesc": "Assessment",
"assessmentId": "67AE044FA13E4686A785D1D20DD8B74C",
"timestamp": "2018-12-06",
"convertedValue": "43.99999978",
"uom": "FA",
"convertedUOM": "GC",
"valueID": "9EB3CFE1971948ABBA15309AC91DC04F",
"baseValue": "111.2",
"uomDesc": "°F",
"convertedUomDesc": "°C"
}
]HTTP status code 400
Not Found
Secured by basic
post /checklist/{checklistId}/indicator/{assessmentId}/values
This endpoint adds the indicator values for a checklist assessment.
REST API supports Basic Authentication.
URI Parameters
- checklistId: required (string)
Checklist Assessment ID. Generated by server, used as read-only.
- assessmentId: required (string)
Body
Media type: application/json
Type: json
Content:
{
"definitions": {},
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "http://example.com/root.json",
"type": "object",
"title": "The Root Schema",
"required": [
"originURL",
"originApplication",
"originApplicationDesc",
"method",
"values"
],
"properties": {
"originURL": {
"$id": "#/properties/originURL",
"type": "string",
"title": "The Originurl Schema",
"default": "",
"examples": [
""
]
},
"originApplication": {
"$id": "#/properties/originApplication",
"type": "string",
"title": "The Originapplication Schema",
"default": "",
"examples": [
"AT.TGSV.72"
]
},
"originApplicationDesc": {
"$id": "#/properties/originApplicationDesc",
"type": "string",
"title": "The Originapplicationdesc Schema",
"default": "",
"examples": [
"Assessment"
]
},
"method": {
"$id": "#/properties/method",
"type": "string",
"title": "The Method Schema",
"default": "",
"examples": [
"API"
]
},
"values": {
"$id": "#/properties/values",
"type": "array",
"title": "The Values Schema",
"items": {
"$id": "#/properties/values/items",
"type": "object",
"title": "The Items Schema",
"required": [
"indicatorId",
"value",
"objectId",
"indicatorGroupId",
"categoryId",
"updatedTimestamp",
"associatedObjectId"
],
"properties": {
"indicatorId": {
"$id": "#/properties/values/items/properties/indicatorId",
"type": "string",
"title": "The Indicatorid Schema",
"default": "",
"examples": [
"F0EF11E79EFF49E4AC29BC050BEED399"
]
},
"value": {
"$id": "#/properties/values/items/properties/value",
"type": "string",
"title": "The Value Schema",
"default": "",
"examples": [
"555"
]
},
"objectId": {
"$id": "#/properties/values/items/properties/objectId",
"type": "string",
"title": "The Objectid Schema",
"default": "",
"examples": [
"C9056E13E1E547488496CE9E037AC04A"
]
},
"indicatorGroupId": {
"$id": "#/properties/values/items/properties/indicatorGroupId",
"type": "string",
"title": "The Indicatorgroupid Schema",
"default": "",
"examples": [
"1E0B00B018D4F56516005E025BF350A4"
]
},
"categoryId": {
"$id": "#/properties/values/items/properties/categoryId",
"type": "string",
"title": "The Categoryid Schema",
"default": "",
"examples": [
"240B00B018D4F56516005E025BF350A4"
]
},
"updatedTimestamp": {
"$id": "#/properties/values/items/properties/updatedTimestamp",
"type": "string",
"title": "The Updatedtimestamp Schema",
"default": "",
"examples": [
"2019-02-04 04:00:49.596"
]
},
"associatedObjectId": {
"$id": "#/properties/values/items/properties/associatedObjectId",
"type": "string",
"title": "The Associatedobjectid Schema",
"default": "",
"examples": [
"55AEB6EF3C0F4EC7BA16AF32B6EF6CF4"
]
}
}
}
}
}
}Example:
{
"originURL": "",
"originApplication": "AT.TGSV.72",
"originApplicationDesc": "Assessment",
"method": "API",
"values": [
{
"indicatorId": "F0EF11E79EFF49E4AC29BC050BEED399",
"value": "555",
"objectId": "C9056E13E1E547488496CE9E037AC04A",
"indicatorGroupId": "1E0B00B018D4F56516005E025BF350A4",
"categoryId": "240B00B018D4F56516005E025BF350A4",
"updatedTimestamp": "2019-02-04 04:00:49.596",
"associatedObjectId": "55AEB6EF3C0F4EC7BA16AF32B6EF6CF4"
},
{
"indicatorId": "3665273B93324C66A36E96483D0A731F",
"value": "777",
"objectId": "C9056E13E1E547488496CE9E037AC04A",
"indicatorGroupId": "1E0B00B018D4F56516005E025BF350A4",
"categoryId": "240B00B018D4F56516005E025BF350A4",
"updatedTimestamp": "2019-02-04 04:00:49.596",
"associatedObjectId": "55AEB6EF3C0F4EC7BA16AF32B6EF6CF4"
}
]
}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 updates the individual indicator value for a checklist assessment.
put /checklist/{checklistId}/indicator/{valueId}/values
This endpoint updates the individual indicator value for a checklist assessment.
REST API supports Basic Authentication.
URI Parameters
- checklistId: required (string)
Checklist Assessment ID. Generated by server, used as read-only.
- valueId: required (string)
Query Parameters
- uomSystem: required (string)
Unit of Measure system in which the indicator value is to be updated, for example metric or imperial
Body
Media type: application/json
Type: json
Content:
{
"definitions": {},
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "http://example.com/root.json",
"type": "object",
"title": "The Root Schema",
"required": [
"xcvbiui",
"value",
"updatedTimestamp",
"originApplicationDesc"
],
"properties": {
"xcvbiui": {
"$id": "#/properties/xcvbiui",
"type": "string",
"title": "The Xcvbiui Schema",
"default": "",
"examples": [
"CC2A0BFD05724FB0B7E0C70D95F6E8F4"
]
},
"value": {
"$id": "#/properties/value",
"type": "string",
"title": "The Value Schema",
"default": "",
"examples": [
"30"
]
},
"updatedTimestamp": {
"$id": "#/properties/updatedTimestamp",
"type": "string",
"title": "The Updatedtimestamp Schema",
"default": "",
"examples": [
"2018-10-15 10:00:00.000"
]
},
"originApplicationDesc": {
"$id": "#/properties/originApplicationDesc",
"type": "string",
"title": "The Originapplicationdesc Schema",
"default": "",
"examples": [
"CL.ASPM.10"
]
}
}
}Example:
{
"xcvbiui": "CC2A0BFD05724FB0B7E0C70D95F6E8F4",
"value": "30",
"updatedTimestamp": "2018-10-15 10:00:00.000",
"originApplicationDesc": "CL.ASPM.10"
}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