Checklist Assessment Values API documentation version v1
Application_URL/services/api/v1/aspm
Purpose
This API allows you to update and retrieve the attribute or indicator values corresponding to the checklist assessment.
/checklists/objects/assessmenttemplates/map/{id}
This endpoint allows you to update the list of all attribute values corresponding to the checklist, object and assessment template combination.
This endpoint allows you to get the list of all attribute values corresponding to the checklist, object and assessment template combination.
put /checklists/objects/assessmenttemplates/map/{id}/attribute/values
This endpoint allows you to update the list of all attribute values corresponding to the checklist, object and assessment template combination.
REST API is secured by OAuth 2.0 authentication
URI Parameters
- id: required (string)
Map ID corresponding to the checklist, object and assessment template combination. 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": [
"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
Successfully updates 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 checklist 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
get /checklists/objects/assessmenttemplates/map/{id}/attribute/values
This endpoint allows you to get the list of all attribute values corresponding to the checklist, object and assessment template combination.
REST API is secured by OAuth 2.0 authentication
URI Parameters
- id: required (string)
Map ID corresponding to the checklist, object and assessment template combination. 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": [
"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": []
}]
}]
}Secured by OAuth 2.0
This endpoint allows you to update the list of all indicator values corresponding to the checklist, object and assessment template combination.
This endpoint allows you to get the list of all indicator values corresponding to the checklist, object and assessment template combination.
put /checklists/objects/assessmenttemplates/map/{id}/indicator/values
This endpoint allows you to update the list of all indicator values corresponding to the checklist, object and assessment template combination.
REST API is secured by OAuth 2.0 authentication
URI Parameters
- id: required (string)
Map ID corresponding to the checklist, object and assessment template combination. 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": [
"contextURL",
"contextName",
"method",
"values"
],
"properties": {
"contextURL": {
"$id": "#/properties/originURL",
"type": "string",
"title": "The Originurl Schema",
"default": "",
"examples": [
""
]
},
"contextName": {
"$id": "#/properties/originApplication",
"type": "string",
"title": "The contextname Schema",
"default": "",
"examples": [
"AT.TGSV.72"
]
},
"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:
{
"contextURL": "",
"contextName": "CL.PDMSDP.9 - CL PERF 20 Obj ASPM1911",
"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
Successfully updates 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 checklist 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
get /checklists/objects/assessmenttemplates/map/{id}/indicator/values
This endpoint allows you to get the list of all indicator values corresponding to the checklist, object and assessment template combination.
REST API is secured by OAuth 2.0 authentication
URI Parameters
- id: required (string)
Map ID corresponding to the checklist, object and assessment template combination. 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": [
"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"
}
]