Risk and Criticality Assessment API Reference
The document guides you in using APIs provided by SAP Asset Performance Management.
You can access the following information:
Queries
apmEnumerations
Description
Get the enumerations
Response
Returns
[Enumerations]
Arguments
| Name | Description |
|---|---|
filter -
EnumerationsFilterInput
|
Return the entries matching filter criteria. |
Example
Query
query apmEnumerations($filter: EnumerationsFilterInput) {
apmEnumerations(filter: $filter) {
list {
code
languageCode
text
}
type
}
}
Variables
{"filter": EnumerationsFilterInput}
Response
{
"data": {
"apmEnumerations": [
{
"list": [EnumerationsData],
"type": "CATEGORY_CODE"
}
]
}
}
assessment
Description
Get Assessment by ID
Response
Returns an
Assessment
Arguments
| Name | Description |
|---|---|
id -
String
|
Example
Query
query assessment($id: String) {
assessment(id: $id) {
assignedObject {
action
alphanumericRiskScore
assessmentTemplateDescriptions {
language
long
short
}
assessmentTemplateDisplayValue
assessmentTemplateId
assessmentTemplateVersion
color
completedImpacts
criticality {
code
language
shortText
ssid
text
}
documentsCount
questionnaireImpact {
alphanumericImpactScore
financialRisk
id
impactScore
isComplete
isRelevant
questionnaireDimensions {
dimensionId
notes {
language
long
short
}
questionnaireId
selectedScaleId
selectedScaleValue
}
}
riskScore
technicalObjectCategory
technicalObjectDescription
technicalObjectLabelName
technicalObjectManufacturer
technicalObjectNumber
technicalObjectSsid
technicalObjectType
totalImpacts
updatedOn
}
assignedRoles {
roleType
users {
application
email
familyName
givenName
id
userName
}
}
createdOn
currency {
code
language
shortText
ssid
text
}
description {
language
long
short
}
descriptions {
language
long
short
}
displayValue
id
referenceLanguage
riskType
scopeDescriptions {
language
long
short
}
status
updatedOn
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"assessment": {
"assignedObject": [AssignedObject],
"assignedRoles": [Role],
"createdOn": SqlTimestamp,
"currency": Enumeration,
"description": Description,
"descriptions": [Description],
"displayValue": "abc123",
"id": "abc123",
"referenceLanguage": "xyz789",
"riskType": "CURRENT",
"scopeDescriptions": [Description],
"status": "CREATED",
"updatedOn": SqlTimestamp
}
}
}
assessmentDetailsForTechnicalObject
Description
Get a list of assessments assigned to a technical object
Response
Returns
[AssessmentForTechnicalObject]
Arguments
| Name | Description |
|---|---|
technicalObject -
TechnicalObjectInput
|
Example
Query
query assessmentDetailsForTechnicalObject($technicalObject: TechnicalObjectInput) {
assessmentDetailsForTechnicalObject(technicalObject: $technicalObject) {
action
alphanumericRiskScore
assessmentId
assessmentTemplateId
color
criticality {
code
language
shortText
ssid
text
}
description {
language
long
short
}
displayValue
riskScore
updatedBy
updatedOn
}
}
Variables
{"technicalObject": TechnicalObjectInput}
Response
{
"data": {
"assessmentDetailsForTechnicalObject": [
{
"action": "xyz789",
"alphanumericRiskScore": "xyz789",
"assessmentId": "abc123",
"assessmentTemplateId": "xyz789",
"color": "abc123",
"criticality": Enumeration,
"description": Description,
"displayValue": "xyz789",
"riskScore": 987.65,
"updatedBy": "xyz789",
"updatedOn": "xyz789"
}
]
}
}
assessmentTechnicalObject
Description
Gives a Technical object for an assessment
Response
Returns an
AssignedObject
Example
Query
query assessmentTechnicalObject(
$technicalObjectType: String,
$technicalObjectSsid: String,
$assessmentTemplateId: String,
$technicalObjectNumber: String,
$assessmentId: String
) {
assessmentTechnicalObject(
technicalObjectType: $technicalObjectType,
technicalObjectSsid: $technicalObjectSsid,
assessmentTemplateId: $assessmentTemplateId,
technicalObjectNumber: $technicalObjectNumber,
assessmentId: $assessmentId
) {
action
alphanumericRiskScore
assessmentTemplateDescriptions {
language
long
short
}
assessmentTemplateDisplayValue
assessmentTemplateId
assessmentTemplateVersion
color
completedImpacts
criticality {
code
language
shortText
ssid
text
}
documentsCount
questionnaireImpact {
alphanumericImpactScore
financialRisk
id
impactScore
isComplete
isRelevant
questionnaireDimensions {
dimensionId
notes {
language
long
short
}
questionnaireId
selectedScaleId
selectedScaleValue
}
}
riskScore
technicalObjectCategory
technicalObjectDescription
technicalObjectLabelName
technicalObjectManufacturer
technicalObjectNumber
technicalObjectSsid
technicalObjectType
totalImpacts
updatedOn
}
}
Variables
{
"technicalObjectType": "xyz789",
"technicalObjectSsid": "xyz789",
"assessmentTemplateId": "abc123",
"technicalObjectNumber": "xyz789",
"assessmentId": "xyz789"
}
Response
{
"data": {
"assessmentTechnicalObject": {
"action": "xyz789",
"alphanumericRiskScore": "abc123",
"assessmentTemplateDescriptions": [Description],
"assessmentTemplateDisplayValue": "xyz789",
"assessmentTemplateId": "abc123",
"assessmentTemplateVersion": 123.45,
"color": "abc123",
"completedImpacts": 987,
"criticality": Enumeration,
"documentsCount": 987,
"questionnaireImpact": [QuestionnaireImpact],
"riskScore": 123.45,
"technicalObjectCategory": "xyz789",
"technicalObjectDescription": "abc123",
"technicalObjectLabelName": "xyz789",
"technicalObjectManufacturer": "abc123",
"technicalObjectNumber": "abc123",
"technicalObjectSsid": "xyz789",
"technicalObjectType": "xyz789",
"totalImpacts": 123,
"updatedOn": SqlTimestamp
}
}
}
assessmentTechnicalObjects
Description
Get a technical object assigned to an assessment
Response
Returns an
AssignedObjectConnection
Arguments
| Name | Description |
|---|---|
filter -
AssignmentsFilterInput
|
Return the entries matching filter criteria. |
search -
String
|
Return the entries matching the search string. All fields supported in the Filter are also supported in Search. |
offset -
Int
|
Default = 0 |
orderBy -
AssignmentsSortInput
|
Return the entries sorted by the specified columns. |
id -
String
|
|
first -
Int
|
Default = 20 |
Example
Query
query assessmentTechnicalObjects(
$filter: AssignmentsFilterInput,
$search: String,
$offset: Int,
$orderBy: AssignmentsSortInput,
$id: String,
$first: Int
) {
assessmentTechnicalObjects(
filter: $filter,
search: $search,
offset: $offset,
orderBy: $orderBy,
id: $id,
first: $first
) {
edges {
node {
action
alphanumericRiskScore
assessmentTemplateDescriptions {
language
long
short
}
assessmentTemplateDisplayValue
assessmentTemplateId
assessmentTemplateVersion
color
completedImpacts
criticality {
code
language
shortText
ssid
text
}
documentsCount
questionnaireImpact {
alphanumericImpactScore
financialRisk
id
impactScore
isComplete
isRelevant
questionnaireDimensions {
dimensionId
notes {
...DescriptionFragment
}
questionnaireId
selectedScaleId
selectedScaleValue
}
}
riskScore
technicalObjectCategory
technicalObjectDescription
technicalObjectLabelName
technicalObjectManufacturer
technicalObjectNumber
technicalObjectSsid
technicalObjectType
totalImpacts
updatedOn
}
cursor
}
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
}
totalCount
}
}
Variables
{
"filter": AssignmentsFilterInput,
"search": "abc123",
"offset": 0,
"orderBy": AssignmentsSortInput,
"id": "abc123",
"first": 20
}
Response
{
"data": {
"assessmentTechnicalObjects": {
"edges": [AssignedObjectEdge],
"pageInfo": PageInfo,
"totalCount": {}
}
}
}
assessmentTemplate
Description
Get the details of a single assessment template
Response
Returns an
AssessmentTemplate
Example
Query
query assessmentTemplate(
$id: String,
$version: Float
) {
assessmentTemplate(
id: $id,
version: $version
) {
alphaNumeric
alphanumericThresholds {
action {
code
language
shortText
ssid
text
}
color
criticality {
code
language
shortText
ssid
text
}
descriptions {
language
long
short
}
displayOrder
xAxisValue
yAxisValue
}
assessmentCount
assessmentDetails {
descriptions {
language
long
short
}
displayValue
id
status
}
calculationMethod {
methodAtDimension
methodAtImpact
weightingAtDimension
weightingAtImpact
}
description {
language
long
short
}
descriptions {
language
long
short
}
displayValue
id
impactThresholdEnabled
impacts {
description {
language
long
short
}
descriptions {
language
long
short
}
dimensions {
description {
language
long
short
}
descriptions {
language
long
short
}
displayOrder
id
indicatorId
scales {
alphaNumericValue
description {
language
long
short
}
descriptions {
language
long
short
}
displayOrder
id
scaleValue
updatedOn
}
updatedOn
weighting
}
displayOrder
id
thresholds {
action {
code
language
shortText
ssid
text
}
color
criticality {
code
language
shortText
ssid
text
}
descriptions {
language
long
short
}
displayOrder
rangeFrom
rangeTo
}
type
updatedOn
weighting
}
referenceLanguage
status
thresholds {
action {
code
language
shortText
ssid
text
}
color
criticality {
code
language
shortText
ssid
text
}
descriptions {
language
long
short
}
displayOrder
rangeFrom
rangeTo
}
timelineEntries {
changeType
id
objectId
}
updatedOn
version
}
}
Variables
{"id": "abc123", "version": -1}
Response
{
"data": {
"assessmentTemplate": {
"alphaNumeric": false,
"alphanumericThresholds": [AlphanumericThreshold],
"assessmentCount": 987,
"assessmentDetails": [AssessmentDetails],
"calculationMethod": CalculationMethod,
"description": Description,
"descriptions": [Description],
"displayValue": "xyz789",
"id": "abc123",
"impactThresholdEnabled": false,
"impacts": [Impact],
"referenceLanguage": "xyz789",
"status": "CREATED",
"thresholds": [Threshold],
"timelineEntries": [TimelineEntry],
"updatedOn": SqlTimestamp,
"version": 123.45
}
}
}
assessmentTemplates
Description
Get the list of assessment templates
Response
Returns an
AssessmentTemplateConnection
Arguments
| Name | Description |
|---|---|
filter -
AssessmentTemplateFilterInput
|
Return the entries matching filter criteria. |
search -
String
|
Return the entries matching the search string. All fields supported in the Filter are also supported in Search. |
offset -
Int
|
The number of entries to be skipped before returning the result. Default = 0 |
orderBy -
AssessmentTemplateSortInput
|
Return the entries sorted by the specified columns. |
first -
Int
|
Number of entries to be returned. Default = 20 |
Example
Query
query assessmentTemplates(
$filter: AssessmentTemplateFilterInput,
$search: String,
$offset: Int,
$orderBy: AssessmentTemplateSortInput,
$first: Int
) {
assessmentTemplates(
filter: $filter,
search: $search,
offset: $offset,
orderBy: $orderBy,
first: $first
) {
edges {
node {
alphaNumeric
alphanumericThresholds {
action {
code
language
shortText
ssid
text
}
color
criticality {
code
language
shortText
ssid
text
}
descriptions {
language
long
short
}
displayOrder
xAxisValue
yAxisValue
}
assessmentCount
assessmentDetails {
descriptions {
language
long
short
}
displayValue
id
status
}
calculationMethod {
methodAtDimension
methodAtImpact
weightingAtDimension
weightingAtImpact
}
description {
language
long
short
}
descriptions {
language
long
short
}
displayValue
id
impactThresholdEnabled
impacts {
description {
language
long
short
}
descriptions {
language
long
short
}
dimensions {
description {
...DescriptionFragment
}
descriptions {
...DescriptionFragment
}
displayOrder
id
indicatorId
scales {
...ScaleFragment
}
updatedOn
weighting
}
displayOrder
id
thresholds {
action {
...EnumerationFragment
}
color
criticality {
...EnumerationFragment
}
descriptions {
...DescriptionFragment
}
displayOrder
rangeFrom
rangeTo
}
type
updatedOn
weighting
}
referenceLanguage
status
thresholds {
action {
code
language
shortText
ssid
text
}
color
criticality {
code
language
shortText
ssid
text
}
descriptions {
language
long
short
}
displayOrder
rangeFrom
rangeTo
}
timelineEntries {
changeType
id
objectId
}
updatedOn
version
}
cursor
}
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
}
totalCount
}
}
Variables
{
"filter": AssessmentTemplateFilterInput,
"search": "xyz789",
"offset": 0,
"orderBy": AssessmentTemplateSortInput,
"first": 20
}
Response
{
"data": {
"assessmentTemplates": {
"edges": [AssessmentTemplateEdge],
"pageInfo": PageInfo,
"totalCount": {}
}
}
}
assessmentTemplatesCount
Response
Returns an
Int!
Example
Query
query assessmentTemplatesCount {
assessmentTemplatesCount
}
Response
{"data": {"assessmentTemplatesCount": 123}}
assessments
Description
Get the list of assessments
Response
Returns an
AssessmentConnection
Arguments
| Name | Description |
|---|---|
filter -
AssessmentFilterInput
|
Return the entries matching filter criteria. |
search -
String
|
Return the entries matching the search string. All fields supported in the Filter are also supported in Search. |
offset -
Int
|
Default = 0 |
orderBy -
AssessmentSortInput
|
Return the entries sorted by the specified columns. |
first -
Int
|
Default = 20 |
Example
Query
query assessments(
$filter: AssessmentFilterInput,
$search: String,
$offset: Int,
$orderBy: AssessmentSortInput,
$first: Int
) {
assessments(
filter: $filter,
search: $search,
offset: $offset,
orderBy: $orderBy,
first: $first
) {
edges {
node {
assignedObject {
action
alphanumericRiskScore
assessmentTemplateDescriptions {
language
long
short
}
assessmentTemplateDisplayValue
assessmentTemplateId
assessmentTemplateVersion
color
completedImpacts
criticality {
code
language
shortText
ssid
text
}
documentsCount
questionnaireImpact {
alphanumericImpactScore
financialRisk
id
impactScore
isComplete
isRelevant
questionnaireDimensions {
...QuestionnaireDimensionFragment
}
}
riskScore
technicalObjectCategory
technicalObjectDescription
technicalObjectLabelName
technicalObjectManufacturer
technicalObjectNumber
technicalObjectSsid
technicalObjectType
totalImpacts
updatedOn
}
assignedRoles {
roleType
users {
application
email
familyName
givenName
id
userName
}
}
createdOn
currency {
code
language
shortText
ssid
text
}
description {
language
long
short
}
descriptions {
language
long
short
}
displayValue
id
referenceLanguage
riskType
scopeDescriptions {
language
long
short
}
status
updatedOn
}
cursor
}
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
}
totalCount
}
}
Variables
{
"filter": AssessmentFilterInput,
"search": "xyz789",
"offset": 0,
"orderBy": AssessmentSortInput,
"first": 20
}
Response
{
"data": {
"assessments": {
"edges": [AssessmentEdge],
"pageInfo": PageInfo,
"totalCount": {}
}
}
}
assessmentsCount
Description
Gives the assessments count
Response
Returns an
Int!
Example
Query
query assessmentsCount {
assessmentsCount
}
Response
{"data": {"assessmentsCount": 987}}
getAlphanumericThresholds
Description
Get all the alphanumeric thresholds
Response
Returns
[AlphanumericThreshold]
Example
Query
query getAlphanumericThresholds(
$assessmentTemplateId: String,
$assessmentTemplateVersion: Float
) {
getAlphanumericThresholds(
assessmentTemplateId: $assessmentTemplateId,
assessmentTemplateVersion: $assessmentTemplateVersion
) {
action {
code
language
shortText
ssid
text
}
color
criticality {
code
language
shortText
ssid
text
}
descriptions {
language
long
short
}
displayOrder
xAxisValue
yAxisValue
}
}
Variables
{
"assessmentTemplateId": "xyz789",
"assessmentTemplateVersion": -1
}
Response
{
"data": {
"getAlphanumericThresholds": [
{
"action": Enumeration,
"color": "abc123",
"criticality": Enumeration,
"descriptions": [Description],
"displayOrder": 987,
"xAxisValue": "xyz789",
"yAxisValue": "xyz789"
}
]
}
}
suggestImpactThresholds
Description
Get all the suggested thresholds for impacts
Response
Returns
[Impact]
Example
Query
query suggestImpactThresholds(
$thresholdCount: Int,
$impactIds: [String],
$id: String,
$version: Float
) {
suggestImpactThresholds(
thresholdCount: $thresholdCount,
impactIds: $impactIds,
id: $id,
version: $version
) {
description {
language
long
short
}
descriptions {
language
long
short
}
dimensions {
description {
language
long
short
}
descriptions {
language
long
short
}
displayOrder
id
indicatorId
scales {
alphaNumericValue
description {
language
long
short
}
descriptions {
language
long
short
}
displayOrder
id
scaleValue
updatedOn
}
updatedOn
weighting
}
displayOrder
id
thresholds {
action {
code
language
shortText
ssid
text
}
color
criticality {
code
language
shortText
ssid
text
}
descriptions {
language
long
short
}
displayOrder
rangeFrom
rangeTo
}
type
updatedOn
weighting
}
}
Variables
{
"thresholdCount": 2,
"impactIds": ["xyz789"],
"id": "abc123",
"version": -1
}
Response
{
"data": {
"suggestImpactThresholds": [
{
"description": Description,
"descriptions": [Description],
"dimensions": [Dimension],
"displayOrder": 123,
"id": "xyz789",
"thresholds": [Threshold],
"type": "xyz789",
"updatedOn": SqlTimestamp,
"weighting": 987.65
}
]
}
}
suggestOverallThresholds
Description
Get all the overall suggested thresholds
Response
Returns
[Threshold]
Example
Query
query suggestOverallThresholds(
$thresholdCount: Int,
$id: String,
$version: Float
) {
suggestOverallThresholds(
thresholdCount: $thresholdCount,
id: $id,
version: $version
) {
action {
code
language
shortText
ssid
text
}
color
criticality {
code
language
shortText
ssid
text
}
descriptions {
language
long
short
}
displayOrder
rangeFrom
rangeTo
}
}
Variables
{
"thresholdCount": 2,
"id": "abc123",
"version": -1
}
Response
{
"data": {
"suggestOverallThresholds": [
{
"action": Enumeration,
"color": "abc123",
"criticality": Enumeration,
"descriptions": [Description],
"displayOrder": 987,
"rangeFrom": 987.65,
"rangeTo": 987.65
}
]
}
}
Mutations
addDimensions
Description
Add a new dimension to the assessment template and impact
Response
Returns
[Dimension]
Arguments
| Name | Description |
|---|---|
assessmentTemplateId -
String
|
|
impactId -
String
|
|
dimensions -
[DimensionCreateInput]
|
Example
Query
mutation addDimensions(
$assessmentTemplateId: String,
$impactId: String,
$dimensions: [DimensionCreateInput]
) {
addDimensions(
assessmentTemplateId: $assessmentTemplateId,
impactId: $impactId,
dimensions: $dimensions
) {
description {
language
long
short
}
descriptions {
language
long
short
}
displayOrder
id
indicatorId
scales {
alphaNumericValue
description {
language
long
short
}
descriptions {
language
long
short
}
displayOrder
id
scaleValue
updatedOn
}
updatedOn
weighting
}
}
Variables
{
"assessmentTemplateId": "abc123",
"impactId": "abc123",
"dimensions": [DimensionCreateInput]
}
Response
{
"data": {
"addDimensions": [
{
"description": Description,
"descriptions": [Description],
"displayOrder": 987,
"id": "abc123",
"indicatorId": "xyz789",
"scales": [Scale],
"updatedOn": SqlTimestamp,
"weighting": 987.65
}
]
}
}
addImpacts
Description
Add a new impact to the assessment template
Response
Returns
[Impact]
Arguments
| Name | Description |
|---|---|
assessmentTemplateId -
String
|
|
impacts -
[ImpactCreateInput]
|
Example
Query
mutation addImpacts(
$assessmentTemplateId: String,
$impacts: [ImpactCreateInput]
) {
addImpacts(
assessmentTemplateId: $assessmentTemplateId,
impacts: $impacts
) {
description {
language
long
short
}
descriptions {
language
long
short
}
dimensions {
description {
language
long
short
}
descriptions {
language
long
short
}
displayOrder
id
indicatorId
scales {
alphaNumericValue
description {
language
long
short
}
descriptions {
language
long
short
}
displayOrder
id
scaleValue
updatedOn
}
updatedOn
weighting
}
displayOrder
id
thresholds {
action {
code
language
shortText
ssid
text
}
color
criticality {
code
language
shortText
ssid
text
}
descriptions {
language
long
short
}
displayOrder
rangeFrom
rangeTo
}
type
updatedOn
weighting
}
}
Variables
{
"assessmentTemplateId": "xyz789",
"impacts": [ImpactCreateInput]
}
Response
{
"data": {
"addImpacts": [
{
"description": Description,
"descriptions": [Description],
"dimensions": [Dimension],
"displayOrder": 987,
"id": "abc123",
"thresholds": [Threshold],
"type": "abc123",
"updatedOn": SqlTimestamp,
"weighting": 987.65
}
]
}
}
addScales
Description
Add new scale to the assessment template, impact, and dimension
Response
Returns
[Scale]
Arguments
| Name | Description |
|---|---|
dimensionId -
String
|
|
assessmentTemplateId -
String
|
|
impactId -
String
|
|
scales -
[ScaleCreateInput]
|
Example
Query
mutation addScales(
$dimensionId: String,
$assessmentTemplateId: String,
$impactId: String,
$scales: [ScaleCreateInput]
) {
addScales(
dimensionId: $dimensionId,
assessmentTemplateId: $assessmentTemplateId,
impactId: $impactId,
scales: $scales
) {
alphaNumericValue
description {
language
long
short
}
descriptions {
language
long
short
}
displayOrder
id
scaleValue
updatedOn
}
}
Variables
{
"dimensionId": "xyz789",
"assessmentTemplateId": "xyz789",
"impactId": "abc123",
"scales": [ScaleCreateInput]
}
Response
{
"data": {
"addScales": [
{
"alphaNumericValue": "xyz789",
"description": Description,
"descriptions": [Description],
"displayOrder": 987,
"id": "abc123",
"scaleValue": 987.65,
"updatedOn": SqlTimestamp
}
]
}
}
assessTechnicalObjects
Description
Multiple Technical Object Assessment
Response
Returns
[AssignedObject]
Arguments
| Name | Description |
|---|---|
assessmentTemplateId -
String
|
|
assessmentTemplateVersion -
Float
|
|
technicalObjects -
[TechnicalObjectInput]
|
|
assessmentId -
String
|
|
questionnaireImpacts -
[QuestionnaireImpactCreateInput]
|
Example
Query
mutation assessTechnicalObjects(
$assessmentTemplateId: String,
$assessmentTemplateVersion: Float,
$technicalObjects: [TechnicalObjectInput],
$assessmentId: String,
$questionnaireImpacts: [QuestionnaireImpactCreateInput]
) {
assessTechnicalObjects(
assessmentTemplateId: $assessmentTemplateId,
assessmentTemplateVersion: $assessmentTemplateVersion,
technicalObjects: $technicalObjects,
assessmentId: $assessmentId,
questionnaireImpacts: $questionnaireImpacts
) {
action
alphanumericRiskScore
assessmentTemplateDescriptions {
language
long
short
}
assessmentTemplateDisplayValue
assessmentTemplateId
assessmentTemplateVersion
color
completedImpacts
criticality {
code
language
shortText
ssid
text
}
documentsCount
questionnaireImpact {
alphanumericImpactScore
financialRisk
id
impactScore
isComplete
isRelevant
questionnaireDimensions {
dimensionId
notes {
language
long
short
}
questionnaireId
selectedScaleId
selectedScaleValue
}
}
riskScore
technicalObjectCategory
technicalObjectDescription
technicalObjectLabelName
technicalObjectManufacturer
technicalObjectNumber
technicalObjectSsid
technicalObjectType
totalImpacts
updatedOn
}
}
Variables
{
"assessmentTemplateId": "xyz789",
"assessmentTemplateVersion": 123.45,
"technicalObjects": [TechnicalObjectInput],
"assessmentId": "abc123",
"questionnaireImpacts": [QuestionnaireImpactCreateInput]
}
Response
{
"data": {
"assessTechnicalObjects": [
{
"action": "abc123",
"alphanumericRiskScore": "abc123",
"assessmentTemplateDescriptions": [Description],
"assessmentTemplateDisplayValue": "xyz789",
"assessmentTemplateId": "xyz789",
"assessmentTemplateVersion": 123.45,
"color": "abc123",
"completedImpacts": 987,
"criticality": Enumeration,
"documentsCount": 123,
"questionnaireImpact": [QuestionnaireImpact],
"riskScore": 123.45,
"technicalObjectCategory": "xyz789",
"technicalObjectDescription": "xyz789",
"technicalObjectLabelName": "xyz789",
"technicalObjectManufacturer": "xyz789",
"technicalObjectNumber": "xyz789",
"technicalObjectSsid": "xyz789",
"technicalObjectType": "abc123",
"totalImpacts": 987,
"updatedOn": SqlTimestamp
}
]
}
}
assignAssessmentTemplate
Description
Assign assessment template to technical objects
Response
Returns
[AssignedTechnicalObject]
Arguments
| Name | Description |
|---|---|
assessmentTemplateId -
String
|
|
technicalObjects -
[TechnicalObjectInput]
|
|
assessmentId -
String
|
Example
Query
mutation assignAssessmentTemplate(
$assessmentTemplateId: String,
$technicalObjects: [TechnicalObjectInput],
$assessmentId: String
) {
assignAssessmentTemplate(
assessmentTemplateId: $assessmentTemplateId,
technicalObjects: $technicalObjects,
assessmentId: $assessmentId
) {
assessmentTemplateId
assessmentTemplateVersion
number
order
ssid
type
}
}
Variables
{
"assessmentTemplateId": "abc123",
"technicalObjects": [TechnicalObjectInput],
"assessmentId": "abc123"
}
Response
{
"data": {
"assignAssessmentTemplate": [
{
"assessmentTemplateId": "abc123",
"assessmentTemplateVersion": 987.65,
"number": "abc123",
"order": 987,
"ssid": "xyz789",
"type": "xyz789"
}
]
}
}
assignTechnicalObjects
Description
Assign technical objects to an assessment
Response
Returns
[AssignedTechnicalObject]
Arguments
| Name | Description |
|---|---|
technicalObjects -
[TechnicalObjectInput]
|
|
assessmentId -
String
|
Example
Query
mutation assignTechnicalObjects(
$technicalObjects: [TechnicalObjectInput],
$assessmentId: String
) {
assignTechnicalObjects(
technicalObjects: $technicalObjects,
assessmentId: $assessmentId
) {
assessmentTemplateId
assessmentTemplateVersion
number
order
ssid
type
}
}
Variables
{
"technicalObjects": [TechnicalObjectInput],
"assessmentId": "abc123"
}
Response
{
"data": {
"assignTechnicalObjects": [
{
"assessmentTemplateId": "abc123",
"assessmentTemplateVersion": 123.45,
"number": "xyz789",
"order": 987,
"ssid": "abc123",
"type": "xyz789"
}
]
}
}
copyAssessmentTemplate
Description
Copy Assessment Template
Response
Returns an
AssessmentTemplate
Arguments
| Name | Description |
|---|---|
assessmentTemplateId -
String
|
|
assessmentTemplateDisplayName -
String
|
|
selectedOption -
CopyTemplateOptions
|
Example
Query
mutation copyAssessmentTemplate(
$assessmentTemplateId: String,
$assessmentTemplateDisplayName: String,
$selectedOption: CopyTemplateOptions
) {
copyAssessmentTemplate(
assessmentTemplateId: $assessmentTemplateId,
assessmentTemplateDisplayName: $assessmentTemplateDisplayName,
selectedOption: $selectedOption
) {
alphaNumeric
alphanumericThresholds {
action {
code
language
shortText
ssid
text
}
color
criticality {
code
language
shortText
ssid
text
}
descriptions {
language
long
short
}
displayOrder
xAxisValue
yAxisValue
}
assessmentCount
assessmentDetails {
descriptions {
language
long
short
}
displayValue
id
status
}
calculationMethod {
methodAtDimension
methodAtImpact
weightingAtDimension
weightingAtImpact
}
description {
language
long
short
}
descriptions {
language
long
short
}
displayValue
id
impactThresholdEnabled
impacts {
description {
language
long
short
}
descriptions {
language
long
short
}
dimensions {
description {
language
long
short
}
descriptions {
language
long
short
}
displayOrder
id
indicatorId
scales {
alphaNumericValue
description {
language
long
short
}
descriptions {
language
long
short
}
displayOrder
id
scaleValue
updatedOn
}
updatedOn
weighting
}
displayOrder
id
thresholds {
action {
code
language
shortText
ssid
text
}
color
criticality {
code
language
shortText
ssid
text
}
descriptions {
language
long
short
}
displayOrder
rangeFrom
rangeTo
}
type
updatedOn
weighting
}
referenceLanguage
status
thresholds {
action {
code
language
shortText
ssid
text
}
color
criticality {
code
language
shortText
ssid
text
}
descriptions {
language
long
short
}
displayOrder
rangeFrom
rangeTo
}
timelineEntries {
changeType
id
objectId
}
updatedOn
version
}
}
Variables
{
"assessmentTemplateId": "abc123",
"assessmentTemplateDisplayName": "xyz789",
"selectedOption": "COPY_IMPACT_DIMENSION_SCALE"
}
Response
{
"data": {
"copyAssessmentTemplate": {
"alphaNumeric": true,
"alphanumericThresholds": [AlphanumericThreshold],
"assessmentCount": 123,
"assessmentDetails": [AssessmentDetails],
"calculationMethod": CalculationMethod,
"description": Description,
"descriptions": [Description],
"displayValue": "xyz789",
"id": "abc123",
"impactThresholdEnabled": false,
"impacts": [Impact],
"referenceLanguage": "xyz789",
"status": "CREATED",
"thresholds": [Threshold],
"timelineEntries": [TimelineEntry],
"updatedOn": SqlTimestamp,
"version": 987.65
}
}
}
createAssessment
Description
Create a new Assessment
Response
Returns an
Assessment
Arguments
| Name | Description |
|---|---|
assessment -
AssessmentCreateInput
|
Example
Query
mutation createAssessment($assessment: AssessmentCreateInput) {
createAssessment(assessment: $assessment) {
assignedObject {
action
alphanumericRiskScore
assessmentTemplateDescriptions {
language
long
short
}
assessmentTemplateDisplayValue
assessmentTemplateId
assessmentTemplateVersion
color
completedImpacts
criticality {
code
language
shortText
ssid
text
}
documentsCount
questionnaireImpact {
alphanumericImpactScore
financialRisk
id
impactScore
isComplete
isRelevant
questionnaireDimensions {
dimensionId
notes {
language
long
short
}
questionnaireId
selectedScaleId
selectedScaleValue
}
}
riskScore
technicalObjectCategory
technicalObjectDescription
technicalObjectLabelName
technicalObjectManufacturer
technicalObjectNumber
technicalObjectSsid
technicalObjectType
totalImpacts
updatedOn
}
assignedRoles {
roleType
users {
application
email
familyName
givenName
id
userName
}
}
createdOn
currency {
code
language
shortText
ssid
text
}
description {
language
long
short
}
descriptions {
language
long
short
}
displayValue
id
referenceLanguage
riskType
scopeDescriptions {
language
long
short
}
status
updatedOn
}
}
Variables
{"assessment": AssessmentCreateInput}
Response
{
"data": {
"createAssessment": {
"assignedObject": [AssignedObject],
"assignedRoles": [Role],
"createdOn": SqlTimestamp,
"currency": Enumeration,
"description": Description,
"descriptions": [Description],
"displayValue": "xyz789",
"id": "xyz789",
"referenceLanguage": "xyz789",
"riskType": "CURRENT",
"scopeDescriptions": [Description],
"status": "CREATED",
"updatedOn": SqlTimestamp
}
}
}
createAssessmentTemplate
Description
Create a new Assessment Template
Response
Returns an
AssessmentTemplate
Arguments
| Name | Description |
|---|---|
assessmentTemplate -
AssessmentTemplateInputInput
|
Example
Query
mutation createAssessmentTemplate($assessmentTemplate: AssessmentTemplateInputInput) {
createAssessmentTemplate(assessmentTemplate: $assessmentTemplate) {
alphaNumeric
alphanumericThresholds {
action {
code
language
shortText
ssid
text
}
color
criticality {
code
language
shortText
ssid
text
}
descriptions {
language
long
short
}
displayOrder
xAxisValue
yAxisValue
}
assessmentCount
assessmentDetails {
descriptions {
language
long
short
}
displayValue
id
status
}
calculationMethod {
methodAtDimension
methodAtImpact
weightingAtDimension
weightingAtImpact
}
description {
language
long
short
}
descriptions {
language
long
short
}
displayValue
id
impactThresholdEnabled
impacts {
description {
language
long
short
}
descriptions {
language
long
short
}
dimensions {
description {
language
long
short
}
descriptions {
language
long
short
}
displayOrder
id
indicatorId
scales {
alphaNumericValue
description {
language
long
short
}
descriptions {
language
long
short
}
displayOrder
id
scaleValue
updatedOn
}
updatedOn
weighting
}
displayOrder
id
thresholds {
action {
code
language
shortText
ssid
text
}
color
criticality {
code
language
shortText
ssid
text
}
descriptions {
language
long
short
}
displayOrder
rangeFrom
rangeTo
}
type
updatedOn
weighting
}
referenceLanguage
status
thresholds {
action {
code
language
shortText
ssid
text
}
color
criticality {
code
language
shortText
ssid
text
}
descriptions {
language
long
short
}
displayOrder
rangeFrom
rangeTo
}
timelineEntries {
changeType
id
objectId
}
updatedOn
version
}
}
Variables
{"assessmentTemplate": AssessmentTemplateInputInput}
Response
{
"data": {
"createAssessmentTemplate": {
"alphaNumeric": false,
"alphanumericThresholds": [AlphanumericThreshold],
"assessmentCount": 987,
"assessmentDetails": [AssessmentDetails],
"calculationMethod": CalculationMethod,
"description": Description,
"descriptions": [Description],
"displayValue": "abc123",
"id": "abc123",
"impactThresholdEnabled": false,
"impacts": [Impact],
"referenceLanguage": "xyz789",
"status": "CREATED",
"thresholds": [Threshold],
"timelineEntries": [TimelineEntry],
"updatedOn": SqlTimestamp,
"version": 987.65
}
}
}
deleteAssessment
Description
Delete an assessment
deleteAssessmentTemplate
Description
Delete an assessment Template
deleteDescriptions
Description
Delete descriptions of an object
Response
Returns
[Description]
Arguments
| Name | Description |
|---|---|
descriptions -
[DescriptionInput]
|
|
objectId -
String
|
|
objectType -
ObjectType
|
Example
Query
mutation deleteDescriptions(
$descriptions: [DescriptionInput],
$objectId: String,
$objectType: ObjectType
) {
deleteDescriptions(
descriptions: $descriptions,
objectId: $objectId,
objectType: $objectType
) {
language
long
short
}
}
Variables
{
"descriptions": [DescriptionInput],
"objectId": "abc123",
"objectType": "ASSESSMENT"
}
Response
{
"data": {
"deleteDescriptions": [
{
"language": "abc123",
"long": "xyz789",
"short": "xyz789"
}
]
}
}
deleteObjectDescriptions
Description
Delete descriptions for multiple objects with same objectType
Response
Returns
[ObjectDescriptions]
Arguments
| Name | Description |
|---|---|
Objectdescriptions -
[ObjectDescriptionsDeleteInput]
|
|
objectType -
ObjectType
|
Example
Query
mutation deleteObjectDescriptions(
$Objectdescriptions: [ObjectDescriptionsDeleteInput],
$objectType: ObjectType
) {
deleteObjectDescriptions(
Objectdescriptions: $Objectdescriptions,
objectType: $objectType
) {
descriptions {
language
long
short
}
objectId
}
}
Variables
{
"Objectdescriptions": [ObjectDescriptionsDeleteInput],
"objectType": "ASSESSMENT"
}
Response
{
"data": {
"deleteObjectDescriptions": [
{
"descriptions": [Description],
"objectId": "xyz789"
}
]
}
}
releaseAssessmentTemplate
Description
Release an assessment template
Response
Returns an
AssessmentTemplate
Arguments
| Name | Description |
|---|---|
assessmentTemplateId -
String
|
Example
Query
mutation releaseAssessmentTemplate($assessmentTemplateId: String) {
releaseAssessmentTemplate(assessmentTemplateId: $assessmentTemplateId) {
alphaNumeric
alphanumericThresholds {
action {
code
language
shortText
ssid
text
}
color
criticality {
code
language
shortText
ssid
text
}
descriptions {
language
long
short
}
displayOrder
xAxisValue
yAxisValue
}
assessmentCount
assessmentDetails {
descriptions {
language
long
short
}
displayValue
id
status
}
calculationMethod {
methodAtDimension
methodAtImpact
weightingAtDimension
weightingAtImpact
}
description {
language
long
short
}
descriptions {
language
long
short
}
displayValue
id
impactThresholdEnabled
impacts {
description {
language
long
short
}
descriptions {
language
long
short
}
dimensions {
description {
language
long
short
}
descriptions {
language
long
short
}
displayOrder
id
indicatorId
scales {
alphaNumericValue
description {
language
long
short
}
descriptions {
language
long
short
}
displayOrder
id
scaleValue
updatedOn
}
updatedOn
weighting
}
displayOrder
id
thresholds {
action {
code
language
shortText
ssid
text
}
color
criticality {
code
language
shortText
ssid
text
}
descriptions {
language
long
short
}
displayOrder
rangeFrom
rangeTo
}
type
updatedOn
weighting
}
referenceLanguage
status
thresholds {
action {
code
language
shortText
ssid
text
}
color
criticality {
code
language
shortText
ssid
text
}
descriptions {
language
long
short
}
displayOrder
rangeFrom
rangeTo
}
timelineEntries {
changeType
id
objectId
}
updatedOn
version
}
}
Variables
{"assessmentTemplateId": "abc123"}
Response
{
"data": {
"releaseAssessmentTemplate": {
"alphaNumeric": false,
"alphanumericThresholds": [AlphanumericThreshold],
"assessmentCount": 123,
"assessmentDetails": [AssessmentDetails],
"calculationMethod": CalculationMethod,
"description": Description,
"descriptions": [Description],
"displayValue": "abc123",
"id": "xyz789",
"impactThresholdEnabled": true,
"impacts": [Impact],
"referenceLanguage": "abc123",
"status": "CREATED",
"thresholds": [Threshold],
"timelineEntries": [TimelineEntry],
"updatedOn": SqlTimestamp,
"version": 123.45
}
}
}
removeAssignedTechnicalObjects
Description
Remove technical objects from the assessment
Response
Returns
[AssignedTechnicalObject]
Arguments
| Name | Description |
|---|---|
technicalObjects -
[TechnicalObjectInput]
|
|
assessmentId -
String
|
Example
Query
mutation removeAssignedTechnicalObjects(
$technicalObjects: [TechnicalObjectInput],
$assessmentId: String
) {
removeAssignedTechnicalObjects(
technicalObjects: $technicalObjects,
assessmentId: $assessmentId
) {
assessmentTemplateId
assessmentTemplateVersion
number
order
ssid
type
}
}
Variables
{
"technicalObjects": [TechnicalObjectInput],
"assessmentId": "xyz789"
}
Response
{
"data": {
"removeAssignedTechnicalObjects": [
{
"assessmentTemplateId": "xyz789",
"assessmentTemplateVersion": 987.65,
"number": "abc123",
"order": 123,
"ssid": "abc123",
"type": "xyz789"
}
]
}
}
removeAssignedTemplate
Description
Delete assigned assessment templates from the Technical Object
Response
Returns
[AssignedTechnicalObject]
Arguments
| Name | Description |
|---|---|
technicalObjects -
[TechnicalObjectInput]
|
|
assessmentId -
String
|
Example
Query
mutation removeAssignedTemplate(
$technicalObjects: [TechnicalObjectInput],
$assessmentId: String
) {
removeAssignedTemplate(
technicalObjects: $technicalObjects,
assessmentId: $assessmentId
) {
assessmentTemplateId
assessmentTemplateVersion
number
order
ssid
type
}
}
Variables
{
"technicalObjects": [TechnicalObjectInput],
"assessmentId": "xyz789"
}
Response
{
"data": {
"removeAssignedTemplate": [
{
"assessmentTemplateId": "xyz789",
"assessmentTemplateVersion": 987.65,
"number": "xyz789",
"order": 987,
"ssid": "abc123",
"type": "xyz789"
}
]
}
}
removeDimensions
Description
Remove dimensions from the impact in the assessment template
Response
Returns
[Dimension]
Example
Query
mutation removeDimensions(
$dimensionIds: [String],
$assessmentTemplateId: String,
$impactId: String
) {
removeDimensions(
dimensionIds: $dimensionIds,
assessmentTemplateId: $assessmentTemplateId,
impactId: $impactId
) {
description {
language
long
short
}
descriptions {
language
long
short
}
displayOrder
id
indicatorId
scales {
alphaNumericValue
description {
language
long
short
}
descriptions {
language
long
short
}
displayOrder
id
scaleValue
updatedOn
}
updatedOn
weighting
}
}
Variables
{
"dimensionIds": ["xyz789"],
"assessmentTemplateId": "abc123",
"impactId": "xyz789"
}
Response
{
"data": {
"removeDimensions": [
{
"description": Description,
"descriptions": [Description],
"displayOrder": 987,
"id": "abc123",
"indicatorId": "abc123",
"scales": [Scale],
"updatedOn": SqlTimestamp,
"weighting": 123.45
}
]
}
}
removeImpacts
Description
Remove impacts from the assessment template
Response
Returns
[Impact]
Example
Query
mutation removeImpacts(
$assessmentTemplateId: String,
$impactIds: [String]
) {
removeImpacts(
assessmentTemplateId: $assessmentTemplateId,
impactIds: $impactIds
) {
description {
language
long
short
}
descriptions {
language
long
short
}
dimensions {
description {
language
long
short
}
descriptions {
language
long
short
}
displayOrder
id
indicatorId
scales {
alphaNumericValue
description {
language
long
short
}
descriptions {
language
long
short
}
displayOrder
id
scaleValue
updatedOn
}
updatedOn
weighting
}
displayOrder
id
thresholds {
action {
code
language
shortText
ssid
text
}
color
criticality {
code
language
shortText
ssid
text
}
descriptions {
language
long
short
}
displayOrder
rangeFrom
rangeTo
}
type
updatedOn
weighting
}
}
Variables
{
"assessmentTemplateId": "xyz789",
"impactIds": ["abc123"]
}
Response
{
"data": {
"removeImpacts": [
{
"description": Description,
"descriptions": [Description],
"dimensions": [Dimension],
"displayOrder": 987,
"id": "xyz789",
"thresholds": [Threshold],
"type": "abc123",
"updatedOn": SqlTimestamp,
"weighting": 987.65
}
]
}
}
removeScales
Description
Remove scales in dimension from the impact in the assessment template
Response
Returns
[Dimension]
Example
Query
mutation removeScales(
$assessmentTemplateId: String,
$impactId: String,
$scaleIds: [String]
) {
removeScales(
assessmentTemplateId: $assessmentTemplateId,
impactId: $impactId,
scaleIds: $scaleIds
) {
description {
language
long
short
}
descriptions {
language
long
short
}
displayOrder
id
indicatorId
scales {
alphaNumericValue
description {
language
long
short
}
descriptions {
language
long
short
}
displayOrder
id
scaleValue
updatedOn
}
updatedOn
weighting
}
}
Variables
{
"assessmentTemplateId": "xyz789",
"impactId": "xyz789",
"scaleIds": ["xyz789"]
}
Response
{
"data": {
"removeScales": [
{
"description": Description,
"descriptions": [Description],
"displayOrder": 123,
"id": "xyz789",
"indicatorId": "abc123",
"scales": [Scale],
"updatedOn": SqlTimestamp,
"weighting": 987.65
}
]
}
}
removeTechnicalObjectsFromAssessment
Description
remove technical objects from assessment
Response
Returns a
Boolean
Arguments
| Name | Description |
|---|---|
technicalObjects -
[TechnicalObjectInput]
|
Example
Query
mutation removeTechnicalObjectsFromAssessment($technicalObjects: [TechnicalObjectInput]) {
removeTechnicalObjectsFromAssessment(technicalObjects: $technicalObjects)
}
Variables
{"technicalObjects": [TechnicalObjectInput]}
Response
{"data": {"removeTechnicalObjectsFromAssessment": false}}
setImpactNumericThresholds
Description
Set the impact numeric thresholds
Response
Returns
[ImpactThreshold]
Arguments
| Name | Description |
|---|---|
thresholds -
[ImpactThresholdUpdateInput]
|
|
assessmentTemplateId -
String
|
|
impactId -
String
|
Example
Query
mutation setImpactNumericThresholds(
$thresholds: [ImpactThresholdUpdateInput],
$assessmentTemplateId: String,
$impactId: String
) {
setImpactNumericThresholds(
thresholds: $thresholds,
assessmentTemplateId: $assessmentTemplateId,
impactId: $impactId
) {
action {
code
language
shortText
ssid
text
}
color
criticality {
code
language
shortText
ssid
text
}
descriptions {
language
long
short
}
displayOrder
impactId
rangeFrom
rangeTo
}
}
Variables
{
"thresholds": [ImpactThresholdUpdateInput],
"assessmentTemplateId": "xyz789",
"impactId": "abc123"
}
Response
{
"data": {
"setImpactNumericThresholds": [
{
"action": Enumeration,
"color": "xyz789",
"criticality": Enumeration,
"descriptions": [Description],
"displayOrder": 123,
"impactId": "xyz789",
"rangeFrom": 987.65,
"rangeTo": 987.65
}
]
}
}
setOverallAlphanumericThresholds
Description
Set the overall alphanumeric thresholds
Response
Returns
[AlphanumericThreshold]
Arguments
| Name | Description |
|---|---|
thresholds -
[AlphanumericThresholdUpdateInput]
|
|
assessmentTemplateId -
String
|
Example
Query
mutation setOverallAlphanumericThresholds(
$thresholds: [AlphanumericThresholdUpdateInput],
$assessmentTemplateId: String
) {
setOverallAlphanumericThresholds(
thresholds: $thresholds,
assessmentTemplateId: $assessmentTemplateId
) {
action {
code
language
shortText
ssid
text
}
color
criticality {
code
language
shortText
ssid
text
}
descriptions {
language
long
short
}
displayOrder
xAxisValue
yAxisValue
}
}
Variables
{
"thresholds": [AlphanumericThresholdUpdateInput],
"assessmentTemplateId": "abc123"
}
Response
{
"data": {
"setOverallAlphanumericThresholds": [
{
"action": Enumeration,
"color": "abc123",
"criticality": Enumeration,
"descriptions": [Description],
"displayOrder": 123,
"xAxisValue": "xyz789",
"yAxisValue": "xyz789"
}
]
}
}
setOverallNumericThresholds
Description
Set the overall numeric thresholds
Response
Returns
[Threshold]
Arguments
| Name | Description |
|---|---|
thresholds -
[ThresholdUpdateInput]
|
|
assessmentTemplateId -
String
|
Example
Query
mutation setOverallNumericThresholds(
$thresholds: [ThresholdUpdateInput],
$assessmentTemplateId: String
) {
setOverallNumericThresholds(
thresholds: $thresholds,
assessmentTemplateId: $assessmentTemplateId
) {
action {
code
language
shortText
ssid
text
}
color
criticality {
code
language
shortText
ssid
text
}
descriptions {
language
long
short
}
displayOrder
rangeFrom
rangeTo
}
}
Variables
{
"thresholds": [ThresholdUpdateInput],
"assessmentTemplateId": "xyz789"
}
Response
{
"data": {
"setOverallNumericThresholds": [
{
"action": Enumeration,
"color": "abc123",
"criticality": Enumeration,
"descriptions": [Description],
"displayOrder": 987,
"rangeFrom": 987.65,
"rangeTo": 123.45
}
]
}
}
technicalObjectAssessment
Description
Technical Object Assessment
Response
Returns an
AssignedObject
Arguments
| Name | Description |
|---|---|
technicalObjectType -
String
|
|
technicalObjectSsid -
String
|
|
technicalObjectNumber -
String
|
|
assessmentId -
String
|
|
questionnaireImpacts -
[QuestionnaireImpactCreateInput]
|
Example
Query
mutation technicalObjectAssessment(
$technicalObjectType: String,
$technicalObjectSsid: String,
$technicalObjectNumber: String,
$assessmentId: String,
$questionnaireImpacts: [QuestionnaireImpactCreateInput]
) {
technicalObjectAssessment(
technicalObjectType: $technicalObjectType,
technicalObjectSsid: $technicalObjectSsid,
technicalObjectNumber: $technicalObjectNumber,
assessmentId: $assessmentId,
questionnaireImpacts: $questionnaireImpacts
) {
action
alphanumericRiskScore
assessmentTemplateDescriptions {
language
long
short
}
assessmentTemplateDisplayValue
assessmentTemplateId
assessmentTemplateVersion
color
completedImpacts
criticality {
code
language
shortText
ssid
text
}
documentsCount
questionnaireImpact {
alphanumericImpactScore
financialRisk
id
impactScore
isComplete
isRelevant
questionnaireDimensions {
dimensionId
notes {
language
long
short
}
questionnaireId
selectedScaleId
selectedScaleValue
}
}
riskScore
technicalObjectCategory
technicalObjectDescription
technicalObjectLabelName
technicalObjectManufacturer
technicalObjectNumber
technicalObjectSsid
technicalObjectType
totalImpacts
updatedOn
}
}
Variables
{
"technicalObjectType": "abc123",
"technicalObjectSsid": "xyz789",
"technicalObjectNumber": "abc123",
"assessmentId": "abc123",
"questionnaireImpacts": [QuestionnaireImpactCreateInput]
}
Response
{
"data": {
"technicalObjectAssessment": {
"action": "abc123",
"alphanumericRiskScore": "xyz789",
"assessmentTemplateDescriptions": [Description],
"assessmentTemplateDisplayValue": "abc123",
"assessmentTemplateId": "abc123",
"assessmentTemplateVersion": 987.65,
"color": "abc123",
"completedImpacts": 123,
"criticality": Enumeration,
"documentsCount": 123,
"questionnaireImpact": [QuestionnaireImpact],
"riskScore": 987.65,
"technicalObjectCategory": "xyz789",
"technicalObjectDescription": "abc123",
"technicalObjectLabelName": "xyz789",
"technicalObjectManufacturer": "abc123",
"technicalObjectNumber": "xyz789",
"technicalObjectSsid": "abc123",
"technicalObjectType": "xyz789",
"totalImpacts": 987,
"updatedOn": SqlTimestamp
}
}
}
updateAssessmentHeader
Description
Update Assessment
Response
Returns an
Assessment
Arguments
| Name | Description |
|---|---|
assessment -
AssessmentHeaderUpdateInput
|
Example
Query
mutation updateAssessmentHeader($assessment: AssessmentHeaderUpdateInput) {
updateAssessmentHeader(assessment: $assessment) {
assignedObject {
action
alphanumericRiskScore
assessmentTemplateDescriptions {
language
long
short
}
assessmentTemplateDisplayValue
assessmentTemplateId
assessmentTemplateVersion
color
completedImpacts
criticality {
code
language
shortText
ssid
text
}
documentsCount
questionnaireImpact {
alphanumericImpactScore
financialRisk
id
impactScore
isComplete
isRelevant
questionnaireDimensions {
dimensionId
notes {
language
long
short
}
questionnaireId
selectedScaleId
selectedScaleValue
}
}
riskScore
technicalObjectCategory
technicalObjectDescription
technicalObjectLabelName
technicalObjectManufacturer
technicalObjectNumber
technicalObjectSsid
technicalObjectType
totalImpacts
updatedOn
}
assignedRoles {
roleType
users {
application
email
familyName
givenName
id
userName
}
}
createdOn
currency {
code
language
shortText
ssid
text
}
description {
language
long
short
}
descriptions {
language
long
short
}
displayValue
id
referenceLanguage
riskType
scopeDescriptions {
language
long
short
}
status
updatedOn
}
}
Variables
{"assessment": AssessmentHeaderUpdateInput}
Response
{
"data": {
"updateAssessmentHeader": {
"assignedObject": [AssignedObject],
"assignedRoles": [Role],
"createdOn": SqlTimestamp,
"currency": Enumeration,
"description": Description,
"descriptions": [Description],
"displayValue": "abc123",
"id": "abc123",
"referenceLanguage": "abc123",
"riskType": "CURRENT",
"scopeDescriptions": [Description],
"status": "CREATED",
"updatedOn": SqlTimestamp
}
}
}
updateAssessmentTemplateHeader
Description
Edit Assessment Template
Response
Returns an
AssessmentTemplate
Arguments
| Name | Description |
|---|---|
assessmentTemplate -
AssessmentTemplateHeaderUpdateInput
|
Example
Query
mutation updateAssessmentTemplateHeader($assessmentTemplate: AssessmentTemplateHeaderUpdateInput) {
updateAssessmentTemplateHeader(assessmentTemplate: $assessmentTemplate) {
alphaNumeric
alphanumericThresholds {
action {
code
language
shortText
ssid
text
}
color
criticality {
code
language
shortText
ssid
text
}
descriptions {
language
long
short
}
displayOrder
xAxisValue
yAxisValue
}
assessmentCount
assessmentDetails {
descriptions {
language
long
short
}
displayValue
id
status
}
calculationMethod {
methodAtDimension
methodAtImpact
weightingAtDimension
weightingAtImpact
}
description {
language
long
short
}
descriptions {
language
long
short
}
displayValue
id
impactThresholdEnabled
impacts {
description {
language
long
short
}
descriptions {
language
long
short
}
dimensions {
description {
language
long
short
}
descriptions {
language
long
short
}
displayOrder
id
indicatorId
scales {
alphaNumericValue
description {
language
long
short
}
descriptions {
language
long
short
}
displayOrder
id
scaleValue
updatedOn
}
updatedOn
weighting
}
displayOrder
id
thresholds {
action {
code
language
shortText
ssid
text
}
color
criticality {
code
language
shortText
ssid
text
}
descriptions {
language
long
short
}
displayOrder
rangeFrom
rangeTo
}
type
updatedOn
weighting
}
referenceLanguage
status
thresholds {
action {
code
language
shortText
ssid
text
}
color
criticality {
code
language
shortText
ssid
text
}
descriptions {
language
long
short
}
displayOrder
rangeFrom
rangeTo
}
timelineEntries {
changeType
id
objectId
}
updatedOn
version
}
}
Variables
{
"assessmentTemplate": AssessmentTemplateHeaderUpdateInput
}
Response
{
"data": {
"updateAssessmentTemplateHeader": {
"alphaNumeric": true,
"alphanumericThresholds": [AlphanumericThreshold],
"assessmentCount": 987,
"assessmentDetails": [AssessmentDetails],
"calculationMethod": CalculationMethod,
"description": Description,
"descriptions": [Description],
"displayValue": "abc123",
"id": "xyz789",
"impactThresholdEnabled": true,
"impacts": [Impact],
"referenceLanguage": "abc123",
"status": "CREATED",
"thresholds": [Threshold],
"timelineEntries": [TimelineEntry],
"updatedOn": SqlTimestamp,
"version": 987.65
}
}
}
updateDimensions
Description
Update dimensions to the assessment template and impacts
Response
Returns
[Dimension]
Arguments
| Name | Description |
|---|---|
assessmentTemplateId -
String
|
|
impactId -
String
|
|
dimensions -
[DimensionUpdateInput]
|
Example
Query
mutation updateDimensions(
$assessmentTemplateId: String,
$impactId: String,
$dimensions: [DimensionUpdateInput]
) {
updateDimensions(
assessmentTemplateId: $assessmentTemplateId,
impactId: $impactId,
dimensions: $dimensions
) {
description {
language
long
short
}
descriptions {
language
long
short
}
displayOrder
id
indicatorId
scales {
alphaNumericValue
description {
language
long
short
}
descriptions {
language
long
short
}
displayOrder
id
scaleValue
updatedOn
}
updatedOn
weighting
}
}
Variables
{
"assessmentTemplateId": "abc123",
"impactId": "xyz789",
"dimensions": [DimensionUpdateInput]
}
Response
{
"data": {
"updateDimensions": [
{
"description": Description,
"descriptions": [Description],
"displayOrder": 123,
"id": "xyz789",
"indicatorId": "xyz789",
"scales": [Scale],
"updatedOn": SqlTimestamp,
"weighting": 987.65
}
]
}
}
updateImpacts
Description
Update impacts in the assessment template
Response
Returns
[Impact]
Arguments
| Name | Description |
|---|---|
assessmentTemplateId -
String
|
|
impacts -
[ImpactUpdateInput]
|
Example
Query
mutation updateImpacts(
$assessmentTemplateId: String,
$impacts: [ImpactUpdateInput]
) {
updateImpacts(
assessmentTemplateId: $assessmentTemplateId,
impacts: $impacts
) {
description {
language
long
short
}
descriptions {
language
long
short
}
dimensions {
description {
language
long
short
}
descriptions {
language
long
short
}
displayOrder
id
indicatorId
scales {
alphaNumericValue
description {
language
long
short
}
descriptions {
language
long
short
}
displayOrder
id
scaleValue
updatedOn
}
updatedOn
weighting
}
displayOrder
id
thresholds {
action {
code
language
shortText
ssid
text
}
color
criticality {
code
language
shortText
ssid
text
}
descriptions {
language
long
short
}
displayOrder
rangeFrom
rangeTo
}
type
updatedOn
weighting
}
}
Variables
{
"assessmentTemplateId": "xyz789",
"impacts": [ImpactUpdateInput]
}
Response
{
"data": {
"updateImpacts": [
{
"description": Description,
"descriptions": [Description],
"dimensions": [Dimension],
"displayOrder": 123,
"id": "xyz789",
"thresholds": [Threshold],
"type": "xyz789",
"updatedOn": SqlTimestamp,
"weighting": 987.65
}
]
}
}
updateScales
Description
Update scales in the assessment template, impact, and dimension
Response
Returns
[Scale]
Arguments
| Name | Description |
|---|---|
dimensionId -
String
|
|
assessmentTemplateId -
String
|
|
impactId -
String
|
|
scales -
[ScaleUpdateInput]
|
Example
Query
mutation updateScales(
$dimensionId: String,
$assessmentTemplateId: String,
$impactId: String,
$scales: [ScaleUpdateInput]
) {
updateScales(
dimensionId: $dimensionId,
assessmentTemplateId: $assessmentTemplateId,
impactId: $impactId,
scales: $scales
) {
alphaNumericValue
description {
language
long
short
}
descriptions {
language
long
short
}
displayOrder
id
scaleValue
updatedOn
}
}
Variables
{
"dimensionId": "abc123",
"assessmentTemplateId": "xyz789",
"impactId": "abc123",
"scales": [ScaleUpdateInput]
}
Response
{
"data": {
"updateScales": [
{
"alphaNumericValue": "xyz789",
"description": Description,
"descriptions": [Description],
"displayOrder": 123,
"id": "xyz789",
"scaleValue": 987.65,
"updatedOn": SqlTimestamp
}
]
}
}
Types
AlphanumericThreshold
Fields
| Field Name | Description |
|---|---|
action -
Enumeration
|
|
color -
String
|
|
criticality -
Enumeration
|
|
descriptions -
[Description]
|
|
displayOrder -
Int!
|
|
xAxisValue -
String
|
|
yAxisValue -
String
|
Example
{
"action": Enumeration,
"color": "xyz789",
"criticality": Enumeration,
"descriptions": [Description],
"displayOrder": 123,
"xAxisValue": "abc123",
"yAxisValue": "abc123"
}
AlphanumericThresholdUpdateInput
Fields
| Input Field | Description |
|---|---|
actionCode -
String
|
|
color -
String
|
|
criticality -
CriticalityInput
|
|
criticalityCode -
CriticalityInput
|
|
descriptions -
[DescriptionInput]
|
|
displayOrder -
Int!
|
|
xAxisValue -
String!
|
|
yAxisValue -
String!
|
Example
{
"actionCode": "abc123",
"color": "xyz789",
"criticality": CriticalityInput,
"criticalityCode": CriticalityInput,
"descriptions": [DescriptionInput],
"displayOrder": 987,
"xAxisValue": "xyz789",
"yAxisValue": "xyz789"
}
Assessment
Fields
| Field Name | Description |
|---|---|
assignedObject -
[AssignedObject]
|
|
assignedRoles -
[Role]
|
|
createdOn -
SqlTimestamp
|
|
currency -
Enumeration
|
|
description -
Description
|
|
descriptions -
[Description]
|
|
displayValue -
String
|
|
id -
String
|
|
referenceLanguage -
String
|
|
riskType -
RiskType
|
|
scopeDescriptions -
[Description]
|
|
status -
Status
|
|
updatedOn -
SqlTimestamp
|
Example
{
"assignedObject": [AssignedObject],
"assignedRoles": [Role],
"createdOn": SqlTimestamp,
"currency": Enumeration,
"description": Description,
"descriptions": [Description],
"displayValue": "abc123",
"id": "xyz789",
"referenceLanguage": "xyz789",
"riskType": "CURRENT",
"scopeDescriptions": [Description],
"status": "CREATED",
"updatedOn": SqlTimestamp
}
AssessmentConnection
Description
A connection is a way to get all of the nodes that are connected to another node in a specific way.
Fields
| Field Name | Description |
|---|---|
edges -
[AssessmentEdge]
|
A list of edges |
pageInfo -
PageInfo!
|
Details about this specific page |
totalCount -
Long!
|
Example
{
"edges": [AssessmentEdge],
"pageInfo": PageInfo,
"totalCount": {}
}
AssessmentCreateInput
Fields
| Input Field | Description |
|---|---|
currency -
CurrencyUpdateInput!
|
|
descriptions -
[DescriptionInput]!
|
|
displayValue -
String!
|
|
riskTypeCode -
String!
|
Example
{
"currency": CurrencyUpdateInput,
"descriptions": [DescriptionInput],
"displayValue": "abc123",
"riskTypeCode": "abc123"
}
AssessmentDetails
Fields
| Field Name | Description |
|---|---|
descriptions -
[Description]
|
|
displayValue -
String
|
|
id -
String
|
|
status -
Status
|
Example
{
"descriptions": [Description],
"displayValue": "abc123",
"id": "abc123",
"status": "CREATED"
}
AssessmentEdge
Description
An edge is one of the links between the nodes that's used across the connection
Fields
| Field Name | Description |
|---|---|
node -
Assessment
|
The item at the end of the edge |
cursor -
String!
|
Cursor marks a unique position or index into the connection |
Example
{
"node": Assessment,
"cursor": "xyz789"
}
AssessmentFilterInput
Fields
| Input Field | Description |
|---|---|
allOf -
[AssessmentFilterInput]
|
|
anyOf -
[AssessmentFilterInput]
|
|
createdOn -
TimestampFilterInput
|
|
currency -
StringFilterInput
|
|
displayValue -
StringFilterInput
|
|
id -
StringFilterInput
|
|
joinCondition -
FilterJoinCondition
|
|
longDescription -
StringFilterInput
|
|
riskType -
EnumFilter_RiskTypeInput
|
|
shortDescription -
StringFilterInput
|
|
status -
EnumFilter_StatusInput
|
|
updatedOn -
TimestampFilterInput
|
Example
{
"allOf": [AssessmentFilterInput],
"anyOf": [AssessmentFilterInput],
"createdOn": TimestampFilterInput,
"currency": StringFilterInput,
"displayValue": StringFilterInput,
"id": StringFilterInput,
"joinCondition": "AND",
"longDescription": StringFilterInput,
"riskType": EnumFilter_RiskTypeInput,
"shortDescription": StringFilterInput,
"status": EnumFilter_StatusInput,
"updatedOn": TimestampFilterInput
}
AssessmentForTechnicalObject
Example
{
"action": "abc123",
"alphanumericRiskScore": "xyz789",
"assessmentId": "xyz789",
"assessmentTemplateId": "abc123",
"color": "xyz789",
"criticality": Enumeration,
"description": Description,
"displayValue": "abc123",
"riskScore": 987.65,
"updatedBy": "xyz789",
"updatedOn": "xyz789"
}
AssessmentHeaderUpdateInput
Fields
| Input Field | Description |
|---|---|
currency -
CurrencyUpdateInput
|
|
descriptions -
[DescriptionInput]
|
|
id -
String!
|
|
riskType -
RiskType
|
|
roles -
[RoleInputInput]
|
|
scopeDescriptions -
[DescriptionInput]
|
|
status -
Status
|
Example
{
"currency": CurrencyUpdateInput,
"descriptions": [DescriptionInput],
"id": "abc123",
"riskType": "CURRENT",
"roles": [RoleInputInput],
"scopeDescriptions": [DescriptionInput],
"status": "CREATED"
}
AssessmentSortInput
Fields
| Input Field | Description |
|---|---|
createdOn -
SortDirection
|
|
displayValue -
SortDirection
|
|
id -
SortDirection
|
|
longDescription -
SortDirection
|
|
riskType -
SortDirection
|
|
shortDescription -
SortDirection
|
|
status -
SortDirection
|
|
updatedOn -
SortDirection
|
Example
{
"createdOn": "ASC",
"displayValue": "ASC",
"id": "ASC",
"longDescription": "ASC",
"riskType": "ASC",
"shortDescription": "ASC",
"status": "ASC",
"updatedOn": "ASC"
}
AssessmentTemplate
Fields
| Field Name | Description |
|---|---|
alphaNumeric -
Boolean!
|
|
alphanumericThresholds -
[AlphanumericThreshold]
|
|
assessmentCount -
Int
|
|
assessmentDetails -
[AssessmentDetails]
|
|
calculationMethod -
CalculationMethod
|
|
description -
Description
|
|
descriptions -
[Description]
|
|
displayValue -
String
|
|
id -
String
|
|
impactThresholdEnabled -
Boolean
|
|
impacts -
[Impact]
|
|
referenceLanguage -
String
|
|
status -
Status
|
|
thresholds -
[Threshold]
|
|
timelineEntries -
[TimelineEntry]
|
|
updatedOn -
SqlTimestamp
|
|
version -
Float!
|
Example
{
"alphaNumeric": true,
"alphanumericThresholds": [AlphanumericThreshold],
"assessmentCount": 123,
"assessmentDetails": [AssessmentDetails],
"calculationMethod": CalculationMethod,
"description": Description,
"descriptions": [Description],
"displayValue": "xyz789",
"id": "abc123",
"impactThresholdEnabled": true,
"impacts": [Impact],
"referenceLanguage": "abc123",
"status": "CREATED",
"thresholds": [Threshold],
"timelineEntries": [TimelineEntry],
"updatedOn": SqlTimestamp,
"version": 123.45
}
AssessmentTemplateConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges -
[AssessmentTemplateEdge]
|
A list of edges |
pageInfo -
PageInfo!
|
Details about this specific page |
totalCount -
Long!
|
Example
{
"edges": [AssessmentTemplateEdge],
"pageInfo": PageInfo,
"totalCount": {}
}
AssessmentTemplateEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
node -
AssessmentTemplate
|
The item at the end of the edge |
cursor -
String!
|
Cursor marks a unique position or index into the connection |
Example
{
"node": AssessmentTemplate,
"cursor": "xyz789"
}
AssessmentTemplateFilterInput
Fields
| Input Field | Description |
|---|---|
allOf -
[AssessmentTemplateFilterInput]
|
|
anyOf -
[AssessmentTemplateFilterInput]
|
|
calculationMethodAtDimension -
EnumFilter_DimensionCalculationInput
|
|
calculationMethodAtImpact -
EnumFilter_ImpactCalculationInput
|
|
createdOn -
TimestampFilterInput
|
|
displayValue -
StringFilterInput
|
|
id -
StringFilterInput
|
|
isAlphaNumeric -
BooleanFilterInput
|
|
joinCondition -
FilterJoinCondition
|
|
longDescription -
StringFilterInput
|
|
shortDescription -
StringFilterInput
|
|
status -
EnumFilter_StatusInput
|
|
updatedOn -
TimestampFilterInput
|
|
version -
IntegerFilterInput
|
|
weightingEnabledAtDimension -
BooleanFilterInput
|
|
weightingEnabledAtImpact -
BooleanFilterInput
|
Example
{
"allOf": [AssessmentTemplateFilterInput],
"anyOf": [AssessmentTemplateFilterInput],
"calculationMethodAtDimension": EnumFilter_DimensionCalculationInput,
"calculationMethodAtImpact": EnumFilter_ImpactCalculationInput,
"createdOn": TimestampFilterInput,
"displayValue": StringFilterInput,
"id": StringFilterInput,
"isAlphaNumeric": BooleanFilterInput,
"joinCondition": "AND",
"longDescription": StringFilterInput,
"shortDescription": StringFilterInput,
"status": EnumFilter_StatusInput,
"updatedOn": TimestampFilterInput,
"version": IntegerFilterInput,
"weightingEnabledAtDimension": BooleanFilterInput,
"weightingEnabledAtImpact": BooleanFilterInput
}
AssessmentTemplateHeaderUpdateInput
Fields
| Input Field | Description |
|---|---|
calculation -
CalculationMethodInput
|
|
descriptions -
[DescriptionInput]
|
|
id -
String!
|
|
impactThresholdEnabled -
Boolean
|
Example
{
"calculation": CalculationMethodInput,
"descriptions": [DescriptionInput],
"id": "abc123",
"impactThresholdEnabled": true
}
AssessmentTemplateInputInput
Fields
| Input Field | Description |
|---|---|
alphaNumeric -
Boolean!
|
|
calculationMethod -
CalculationMethodInput
|
|
descriptions -
[DescriptionInput]!
|
|
displayValue -
String!
|
|
impactThresholdEnabled -
Boolean
|
|
impacts -
[ImpactCreateInput]
|
|
thresholds -
[ThresholdUpdateInput]
|
Example
{
"alphaNumeric": false,
"calculationMethod": CalculationMethodInput,
"descriptions": [DescriptionInput],
"displayValue": "xyz789",
"impactThresholdEnabled": false,
"impacts": [ImpactCreateInput],
"thresholds": [ThresholdUpdateInput]
}
AssessmentTemplateSortInput
Fields
| Input Field | Description |
|---|---|
calculationMethodAtDimension -
SortDirection
|
|
calculationMethodAtImpact -
SortDirection
|
|
createdOn -
SortDirection
|
|
displayValue -
SortDirection
|
|
id -
SortDirection
|
|
isAlphaNumeric -
SortDirection
|
|
longDescription -
SortDirection
|
|
shortDescription -
SortDirection
|
|
status -
SortDirection
|
|
updatedOn -
SortDirection
|
|
version -
SortDirection
|
|
weightingEnabledAtDimension -
SortDirection
|
|
weightingEnabledAtImpact -
SortDirection
|
Example
{
"calculationMethodAtDimension": "ASC",
"calculationMethodAtImpact": "ASC",
"createdOn": "ASC",
"displayValue": "ASC",
"id": "ASC",
"isAlphaNumeric": "ASC",
"longDescription": "ASC",
"shortDescription": "ASC",
"status": "ASC",
"updatedOn": "ASC",
"version": "ASC",
"weightingEnabledAtDimension": "ASC",
"weightingEnabledAtImpact": "ASC"
}
AssignedObject
Fields
| Field Name | Description |
|---|---|
action -
String
|
|
alphanumericRiskScore -
String
|
|
assessmentTemplateDescriptions -
[Description]
|
|
assessmentTemplateDisplayValue -
String
|
|
assessmentTemplateId -
String
|
|
assessmentTemplateVersion -
Float
|
|
color -
String
|
|
completedImpacts -
Int
|
|
criticality -
Enumeration
|
|
documentsCount -
Int
|
|
questionnaireImpact -
[QuestionnaireImpact]
|
|
riskScore -
Float
|
|
technicalObjectCategory -
String
|
|
technicalObjectDescription -
String
|
|
technicalObjectLabelName -
String
|
|
technicalObjectManufacturer -
String
|
|
technicalObjectNumber -
String
|
|
technicalObjectSsid -
String
|
|
technicalObjectType -
String
|
|
totalImpacts -
Int
|
|
updatedOn -
SqlTimestamp
|
Example
{
"action": "abc123",
"alphanumericRiskScore": "abc123",
"assessmentTemplateDescriptions": [Description],
"assessmentTemplateDisplayValue": "xyz789",
"assessmentTemplateId": "abc123",
"assessmentTemplateVersion": 987.65,
"color": "abc123",
"completedImpacts": 987,
"criticality": Enumeration,
"documentsCount": 123,
"questionnaireImpact": [QuestionnaireImpact],
"riskScore": 987.65,
"technicalObjectCategory": "abc123",
"technicalObjectDescription": "abc123",
"technicalObjectLabelName": "xyz789",
"technicalObjectManufacturer": "xyz789",
"technicalObjectNumber": "abc123",
"technicalObjectSsid": "abc123",
"technicalObjectType": "abc123",
"totalImpacts": 123,
"updatedOn": SqlTimestamp
}
AssignedObjectConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
edges -
[AssignedObjectEdge]
|
A list of edges |
pageInfo -
PageInfo!
|
Details about this specific page |
totalCount -
Long!
|
Example
{
"edges": [AssignedObjectEdge],
"pageInfo": PageInfo,
"totalCount": {}
}
AssignedObjectEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
node -
AssignedObject
|
The item at the end of the edge |
cursor -
String!
|
Cursor marks a unique position or index into the connection |
Example
{
"node": AssignedObject,
"cursor": "xyz789"
}
AssignedTechnicalObject
Example
{
"assessmentTemplateId": "abc123",
"assessmentTemplateVersion": 987.65,
"number": "xyz789",
"order": 987,
"ssid": "xyz789",
"type": "xyz789"
}
AssignmentsFilterInput
Fields
| Input Field | Description |
|---|---|
action -
StringFilterInput
|
|
assessmentTemplate -
StringFilterInput
|
|
criticalityCode -
StringFilterInput
|
|
impact -
StringFilterInput
|
|
riskScore -
StringFilterInput
|
|
technicalObject -
StringFilterInput
|
Example
{
"action": StringFilterInput,
"assessmentTemplate": StringFilterInput,
"criticalityCode": StringFilterInput,
"impact": StringFilterInput,
"riskScore": StringFilterInput,
"technicalObject": StringFilterInput
}
AssignmentsSortInput
Fields
| Input Field | Description |
|---|---|
assessmentTemplate -
SortDirection
|
|
technicalObject -
SortDirection
|
Example
{"assessmentTemplate": "ASC", "technicalObject": "ASC"}
Boolean
Description
Built-in Boolean
Example
true
BooleanFilterInput
CalculationMethod
Fields
| Field Name | Description |
|---|---|
methodAtDimension -
DimensionCalculation
|
|
methodAtImpact -
ImpactCalculation
|
|
weightingAtDimension -
Boolean
|
|
weightingAtImpact -
Boolean
|
Example
{
"methodAtDimension": "ADDITION",
"methodAtImpact": "ADDITION",
"weightingAtDimension": false,
"weightingAtImpact": false
}
CalculationMethodInput
Fields
| Input Field | Description |
|---|---|
methodAtDimension -
DimensionCalculation
|
|
methodAtImpact -
ImpactCalculation
|
|
weightingAtDimension -
Boolean
|
|
weightingAtImpact -
Boolean
|
Example
{
"methodAtDimension": "ADDITION",
"methodAtImpact": "ADDITION",
"weightingAtDimension": true,
"weightingAtImpact": false
}
ChangeType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CREATED"
CopyTemplateOptions
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"COPY_IMPACT_DIMENSION_SCALE"
CriticalityInput
CurrencyUpdateInput
Description
DescriptionInput
Dimension
Fields
| Field Name | Description |
|---|---|
description -
Description
|
|
descriptions -
[Description]
|
|
displayOrder -
Int
|
|
id -
String
|
|
indicatorId -
String
|
|
scales -
[Scale]
|
|
updatedOn -
SqlTimestamp
|
|
weighting -
Float
|
Example
{
"description": Description,
"descriptions": [Description],
"displayOrder": 123,
"id": "xyz789",
"indicatorId": "abc123",
"scales": [Scale],
"updatedOn": SqlTimestamp,
"weighting": 123.45
}
DimensionCalculation
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ADDITION"
DimensionCreateInput
Fields
| Input Field | Description |
|---|---|
descriptions -
[DescriptionInput]!
|
|
displayOrder -
Int
|
|
indicatorId -
String
|
|
scales -
[ScaleCreateInput]
|
|
weighting -
Float
|
Example
{
"descriptions": [DescriptionInput],
"displayOrder": 987,
"indicatorId": "abc123",
"scales": [ScaleCreateInput],
"weighting": 987.65
}
DimensionUpdateInput
Fields
| Input Field | Description |
|---|---|
descriptions -
[DescriptionInput]
|
|
displayOrder -
Int
|
|
id -
String!
|
|
indicatorId -
String
|
|
scales -
[ScaleUpdateInput]
|
|
weighting -
Float
|
Example
{
"descriptions": [DescriptionInput],
"displayOrder": 987,
"id": "abc123",
"indicatorId": "abc123",
"scales": [ScaleUpdateInput],
"weighting": 987.65
}
EnumFilter_DimensionCalculationInput
Fields
| Input Field | Description |
|---|---|
contains -
String
|
|
eq -
DimensionCalculation
|
|
in -
[DimensionCalculation]
|
|
isNotNull -
Boolean
|
|
isNull -
Boolean
|
|
ne -
DimensionCalculation
|
|
nin -
[DimensionCalculation]
|
Example
{
"contains": "abc123",
"eq": "ADDITION",
"in": ["ADDITION"],
"isNotNull": false,
"isNull": true,
"ne": "ADDITION",
"nin": ["ADDITION"]
}
EnumFilter_EnumTypeInput
Fields
| Input Field | Description |
|---|---|
contains -
String
|
|
eq -
EnumType
|
|
in -
[EnumType]
|
|
isNotNull -
Boolean
|
|
isNull -
Boolean
|
|
ne -
EnumType
|
|
nin -
[EnumType]
|
Example
{
"contains": "abc123",
"eq": "CATEGORY_CODE",
"in": ["CATEGORY_CODE"],
"isNotNull": true,
"isNull": true,
"ne": "CATEGORY_CODE",
"nin": ["CATEGORY_CODE"]
}
EnumFilter_ImpactCalculationInput
Fields
| Input Field | Description |
|---|---|
contains -
String
|
|
eq -
ImpactCalculation
|
|
in -
[ImpactCalculation]
|
|
isNotNull -
Boolean
|
|
isNull -
Boolean
|
|
ne -
ImpactCalculation
|
|
nin -
[ImpactCalculation]
|
Example
{
"contains": "abc123",
"eq": "ADDITION",
"in": ["ADDITION"],
"isNotNull": false,
"isNull": false,
"ne": "ADDITION",
"nin": ["ADDITION"]
}
EnumFilter_LanguageCodeInput
Fields
| Input Field | Description |
|---|---|
contains -
String
|
|
eq -
LanguageCode
|
|
in -
[LanguageCode]
|
|
isNotNull -
Boolean
|
|
isNull -
Boolean
|
|
ne -
LanguageCode
|
|
nin -
[LanguageCode]
|
Example
{
"contains": "abc123",
"eq": "DE",
"in": ["DE"],
"isNotNull": true,
"isNull": false,
"ne": "DE",
"nin": ["DE"]
}
EnumFilter_RiskTypeInput
Fields
| Input Field | Description |
|---|---|
contains -
String
|
|
eq -
RiskType
|
|
in -
[RiskType]
|
|
isNotNull -
Boolean
|
|
isNull -
Boolean
|
|
ne -
RiskType
|
|
nin -
[RiskType]
|
Example
{
"contains": "xyz789",
"eq": "CURRENT",
"in": ["CURRENT"],
"isNotNull": true,
"isNull": false,
"ne": "CURRENT",
"nin": ["CURRENT"]
}
EnumFilter_StatusInput
EnumType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"CATEGORY_CODE"
Enumeration
EnumerationInput
Enumerations
Fields
| Field Name | Description |
|---|---|
list -
[EnumerationsData]
|
|
type -
EnumType
|
Example
{"list": [EnumerationsData], "type": "CATEGORY_CODE"}
EnumerationsData
Fields
| Field Name | Description |
|---|---|
code -
String
|
|
languageCode -
LanguageCode
|
|
text -
String
|
Example
{
"code": "xyz789",
"languageCode": "DE",
"text": "xyz789"
}
EnumerationsFilterInput
Fields
| Input Field | Description |
|---|---|
code -
StringFilterInput
|
|
languageCode -
EnumFilter_LanguageCodeInput
|
|
type -
EnumFilter_EnumTypeInput
|
Example
{
"code": StringFilterInput,
"languageCode": EnumFilter_LanguageCodeInput,
"type": EnumFilter_EnumTypeInput
}
FilterJoinCondition
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"AND"
Float
Description
Built-in Float
Example
123.45
Impact
Fields
| Field Name | Description |
|---|---|
description -
Description
|
|
descriptions -
[Description]
|
|
dimensions -
[Dimension]
|
|
displayOrder -
Int
|
|
id -
String
|
|
thresholds -
[Threshold]
|
|
type -
String
|
|
updatedOn -
SqlTimestamp
|
|
weighting -
Float
|
Example
{
"description": Description,
"descriptions": [Description],
"dimensions": [Dimension],
"displayOrder": 987,
"id": "abc123",
"thresholds": [Threshold],
"type": "xyz789",
"updatedOn": SqlTimestamp,
"weighting": 123.45
}
ImpactCalculation
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ADDITION"
ImpactCreateInput
Fields
| Input Field | Description |
|---|---|
descriptions -
[DescriptionInput]!
|
|
dimensions -
[DimensionCreateInput]
|
|
displayOrder -
Int
|
|
thresholds -
[ThresholdInput]
|
|
type -
String
|
|
weighting -
Float
|
Example
{
"descriptions": [DescriptionInput],
"dimensions": [DimensionCreateInput],
"displayOrder": 987,
"thresholds": [ThresholdInput],
"type": "abc123",
"weighting": 987.65
}
ImpactThreshold
Fields
| Field Name | Description |
|---|---|
action -
Enumeration
|
|
color -
String
|
|
criticality -
Enumeration
|
|
descriptions -
[Description]
|
|
displayOrder -
Int!
|
|
impactId -
String
|
|
rangeFrom -
Float!
|
|
rangeTo -
Float!
|
Example
{
"action": Enumeration,
"color": "xyz789",
"criticality": Enumeration,
"descriptions": [Description],
"displayOrder": 987,
"impactId": "xyz789",
"rangeFrom": 987.65,
"rangeTo": 987.65
}
ImpactThresholdUpdateInput
Fields
| Input Field | Description |
|---|---|
color -
String!
|
|
descriptions -
[DescriptionInput]
|
|
displayOrder -
Int!
|
|
rangeFrom -
Float!
|
|
rangeTo -
Float!
|
Example
{
"color": "abc123",
"descriptions": [DescriptionInput],
"displayOrder": 123,
"rangeFrom": 987.65,
"rangeTo": 123.45
}
ImpactUpdateInput
Fields
| Input Field | Description |
|---|---|
descriptions -
[DescriptionInput]
|
|
dimensions -
[DimensionUpdateInput]
|
|
displayOrder -
Int
|
|
id -
String!
|
|
thresholds -
[ThresholdInput]
|
|
type -
String
|
|
weighting -
Float
|
Example
{
"descriptions": [DescriptionInput],
"dimensions": [DimensionUpdateInput],
"displayOrder": 123,
"id": "xyz789",
"thresholds": [ThresholdInput],
"type": "abc123",
"weighting": 987.65
}
Int
Description
Built-in Int
Example
123
IntegerFilterInput
Example
{
"contains": "abc123",
"eq": 987,
"gt": 987,
"gte": 123,
"in": [987],
"isNotNull": false,
"isNull": true,
"lt": 123,
"lte": 987,
"ne": 987,
"nin": [123]
}
LanguageCode
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"DE"
Long
Description
Long type
Example
{}
ObjectDescriptions
Fields
| Field Name | Description |
|---|---|
descriptions -
[Description]
|
|
objectId -
String
|
Example
{
"descriptions": [Description],
"objectId": "xyz789"
}
ObjectDescriptionsDeleteInput
Fields
| Input Field | Description |
|---|---|
descriptions -
[DescriptionInput]!
|
|
objectId -
String!
|
Example
{
"descriptions": [DescriptionInput],
"objectId": "abc123"
}
ObjectType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ASSESSMENT"
PageInfo
Description
Information about pagination in a connection.
Fields
| Field Name | Description |
|---|---|
hasNextPage -
Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage -
Boolean!
|
When paginating backwards, are there more items? |
startCursor -
String
|
When paginating backwards, the cursor to continue. |
endCursor -
String
|
When paginating forwards, the cursor to continue. |
Example
{
"hasNextPage": false,
"hasPreviousPage": false,
"startCursor": "xyz789",
"endCursor": "xyz789"
}
QuestionnaireDimension
Fields
| Field Name | Description |
|---|---|
dimensionId -
String
|
|
notes -
[Description]
|
|
questionnaireId -
String
|
|
selectedScaleId -
String
|
|
selectedScaleValue -
Float
|
Example
{
"dimensionId": "abc123",
"notes": [Description],
"questionnaireId": "abc123",
"selectedScaleId": "abc123",
"selectedScaleValue": 123.45
}
QuestionnaireDimensionsCreateInput
Fields
| Input Field | Description |
|---|---|
dimensionId -
String!
|
|
notes -
[DescriptionInput]
|
|
selectedScaleId -
String
|
|
selectedScaleValue -
Float
|
Example
{
"dimensionId": "abc123",
"notes": [DescriptionInput],
"selectedScaleId": "abc123",
"selectedScaleValue": 987.65
}
QuestionnaireImpact
Example
{
"alphanumericImpactScore": "xyz789",
"financialRisk": 987.65,
"id": "xyz789",
"impactScore": 987.65,
"isComplete": false,
"isRelevant": false,
"questionnaireDimensions": [QuestionnaireDimension]
}
QuestionnaireImpactCreateInput
Fields
| Input Field | Description |
|---|---|
financialRisk -
Float
|
|
impactId -
String!
|
|
isRelevant -
Boolean
|
|
questionnaireDimensions -
[QuestionnaireDimensionsCreateInput]!
|
Example
{
"financialRisk": 123.45,
"impactId": "xyz789",
"isRelevant": true,
"questionnaireDimensions": [
QuestionnaireDimensionsCreateInput
]
}
RiskType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"CURRENT"
Role
RoleInputInput
RoleType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"APPROVER"
Scale
Fields
| Field Name | Description |
|---|---|
alphaNumericValue -
String
|
|
description -
Description
|
|
descriptions -
[Description]
|
|
displayOrder -
Int
|
|
id -
String
|
|
scaleValue -
Float
|
|
updatedOn -
SqlTimestamp
|
Example
{
"alphaNumericValue": "abc123",
"description": Description,
"descriptions": [Description],
"displayOrder": 123,
"id": "xyz789",
"scaleValue": 987.65,
"updatedOn": SqlTimestamp
}
ScaleCreateInput
Fields
| Input Field | Description |
|---|---|
alphaNumericValue -
String
|
|
descriptions -
[DescriptionInput]
|
|
displayOrder -
Int
|
|
scaleValue -
Float
|
Example
{
"alphaNumericValue": "abc123",
"descriptions": [DescriptionInput],
"displayOrder": 987,
"scaleValue": 987.65
}
ScaleUpdateInput
Example
{
"alphaNumericValue": "abc123",
"description": "abc123",
"descriptions": [DescriptionInput],
"displayOrder": 987,
"id": "xyz789",
"scaleValue": 123.45
}
SortDirection
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ASC"
SqlTimestamp
Description
Built-in scalar representing a SQL compliant local date-time
Example
SqlTimestamp
Status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CREATED"
String
Description
Built-in String
Example
"abc123"
StringFilterInput
TechnicalObjectInput
Threshold
Fields
| Field Name | Description |
|---|---|
action -
Enumeration
|
|
color -
String
|
|
criticality -
Enumeration
|
|
descriptions -
[Description]
|
|
displayOrder -
Int!
|
|
rangeFrom -
Float!
|
|
rangeTo -
Float!
|
Example
{
"action": Enumeration,
"color": "abc123",
"criticality": Enumeration,
"descriptions": [Description],
"displayOrder": 123,
"rangeFrom": 123.45,
"rangeTo": 987.65
}
ThresholdInput
Fields
| Input Field | Description |
|---|---|
action -
EnumerationInput
|
|
color -
String
|
|
criticality -
EnumerationInput
|
|
descriptions -
[DescriptionInput]
|
|
displayOrder -
Int!
|
|
rangeFrom -
Float!
|
|
rangeTo -
Float!
|
Example
{
"action": EnumerationInput,
"color": "xyz789",
"criticality": EnumerationInput,
"descriptions": [DescriptionInput],
"displayOrder": 987,
"rangeFrom": 123.45,
"rangeTo": 987.65
}
ThresholdUpdateInput
Fields
| Input Field | Description |
|---|---|
actionCode -
String!
|
|
color -
String!
|
|
criticality -
CriticalityInput
|
|
descriptions -
[DescriptionInput]
|
|
displayOrder -
Int!
|
|
rangeFrom -
Float!
|
|
rangeTo -
Float!
|
Example
{
"actionCode": "xyz789",
"color": "xyz789",
"criticality": CriticalityInput,
"descriptions": [DescriptionInput],
"displayOrder": 987,
"rangeFrom": 123.45,
"rangeTo": 123.45
}
TimelineEntry
Fields
| Field Name | Description |
|---|---|
changeType -
ChangeType
|
|
id -
String
|
|
objectId -
String
|
Example
{
"changeType": "CREATED",
"id": "xyz789",
"objectId": "abc123"
}
TimestampFilterInput
Fields
| Input Field | Description |
|---|---|
after -
SqlTimestamp
|
|
before -
SqlTimestamp
|
|
eq -
SqlTimestamp
|
|
isNotNull -
Boolean
|
|
isNull -
Boolean
|
|
ne -
SqlTimestamp
|
Example
{
"after": SqlTimestamp,
"before": SqlTimestamp,
"eq": SqlTimestamp,
"isNotNull": true,
"isNull": true,
"ne": SqlTimestamp
}