Articles in this section

Remediation Plan Object Fields

Field

Type

Description

activationTime

string

Timestamp

applicableComputersCnt

Number

Number of applicable endpoints

applicableUpdatesCnt

Number

Number of applicable updates

archived

Boolean

Should it be in archive or not

autoRPRuleName

string

name of Automatic Remediation Plan rule if it was initiate the creation

cancelledBy

string

name of the canceling user
createdBy string name of the created user
createdTime string A timestamp of the remediation plan creation
creationType string Represent if this was created automatically or by user decision
description string Remediation Plan description
devicesCompliance    
errMsg string  
hasApprovedPatches Boolean  
hasUnapprovedPatches Boolean  
id Number Remediation Plan ID
isCritical Boolean If Rememdation Plan is critical or not
isEmergencyPlan Boolean If Rememdation Plan is an emergency plan or not
kanbanStatus string  
modifiedBy string name of the modified user
modifiedTime string A timestamp of the remediation plan modification
name string Remediation Plan Name

patchingStatus

string

 

remediationCycle

object list

List of remediation cycles steps. For example:

"cycleSteps":[
{
"computerGroupId":5016,
"workflowId":501,
"order":0,
"maintenanceScheduleId":null
},
{
"computerGroupId":5016,
"workflowId":1001,
"order":1,
"maintenanceScheduleId":null
},
{
"computerGroupId":5016,
"workflowId":503,
"order":2,
"maintenanceScheduleId":null
}
]
}

rpStatus

string

Status (string in the UI)

NEW ("Pending activation"),
PENDING ("Pending approval"),
SENT_FOR_ITSM_APPROVAL("Sent for approval"),
ITSM_APPROVED("Approved"),
WSUS_SYNC("Updating WSUS"),
WSUS_SYNC_SUCCEEDED("WSUS updated"),
WSUS_SYNC_FAILED("Failed to update WSUS"),
WSUS_SYNC_SKIPPED("Waiting to start"),
IN_PROGRESS("Executing"),
COMPLETED("Done"),
CANCELLED("Cancelled by user"),
REJECTED("Rejected by user"),
PENDING_CANCEL("Pending cancellation"),
PENDING_CANCEL_ARCHIVE("Pending cancellation"),
// for UI only
WAITING_FOR_EXECUTION("Waiting for execution");

sparseHidden

Boolean

 
Example Object - 
 
{
"archived":false,
"activationTime":1600088698322,
"sparseHidden":false,
"hasUnapprovedPatches":false,
"hasApprovedPatches":false,
"id":4017,
"name":"Test",
"description":null,
"isEmergencyPlan":false,
"isCritical":false,
"createdBy":"admin",
"createdTime":1600088582712,
"modifiedBy":"admin",
"modifiedTime":1600088698322,
"remediationCycle":{
"cycleSteps":[
{
"computerGroupId":5016,
"workflowId":501,
"order":0,
"maintenanceScheduleId":null
},
{
"computerGroupId":5016,
"workflowId":1001,
"order":1,
"maintenanceScheduleId":null
},
{
"computerGroupId":5016,
"workflowId":503,
"order":2,
"maintenanceScheduleId":null
}
]
}

Available REST Calls

Description Type URL Notes
Get all Remediation Plans in a list GET experimental/patch-governance/remediation-plans  
Get specific Remediation Plans GET experimental/patch-governance/remediation-plans/{id} {id} - the requested remedition plan
Duplicate Remeidation Plan POST experimental/patch-governance/remediation-plans/duplicate/{id} {id} - the requested remedition plan
Change all patch actions to install operation PATCH experimental/patch-governance/remediation-plans/{id}/updates

{id} - the requested remedition plan

Change Remediation Plan properties

Activate Remediation Plan

 PUT experimental/patch-governance/remediation-plans/{id} {id} - the requested remedition plan

 

 

Related articles

Comments

0 comments

Please sign in to leave a comment.