Update Action Plan Status or Assignee
PATCH/apm/api/v1/action-plan/:action-plan-id/status-assignee
Update an action plan. Partial updates are supported. You must have ActionPlanOverview_UPDATE permission to access this endpoint. Rate limit 5/sec.
Request
Path Parameters
action-plan-id stringrequired
action plan id
Example: action plan id
Header Parameters
x-redlock-auth stringrequired
Authorize using Authentication token
Example: jwt token
- application/json; charset=UTF-8
Body
status string
Possible values: [new
, in-progress
, done
]
assignee string
Responses
- 200
- 400
- 401
- 403
- 404
- 405
- 429
OK
- application/json; charset=UTF-8
- Schema
- Example (from schema)
Schema
- Array [
- ]
- Array [
- ]
name string
id string
status string
alertCount int64
assetCount int64
findingTypes string[]
impactfulAssetId string
impactfulAssetType int64
criticality string
primaryAssetStatus string
summary string
assignee string
thumbsUpDown string
Possible values: [down
, up
, none
]
thumbsDownReasons ThumbsDownReason (string)[]
thumbsDownDescription string
countByPolicyType object[]
policyType string
count int64
countByPolicyCategory object[]
policyCategory string
count int64
createdAtTs int64
feedbackLastUpdatedTs int64
lastUpdatedTs int64
lastUpdatedBy string
{
"name": "string",
"id": "string",
"status": "string",
"alertCount": 0,
"assetCount": 0,
"findingTypes": [
"string"
],
"impactfulAssetId": "string",
"impactfulAssetType": 0,
"criticality": "string",
"primaryAssetStatus": "string",
"summary": "string",
"assignee": "string",
"thumbsUpDown": "down",
"thumbsDownReasons": [
"Wrong priority for me"
],
"thumbsDownDescription": "string",
"countByPolicyType": [
{
"policyType": "string",
"count": 0
}
],
"countByPolicyCategory": [
{
"policyCategory": "string",
"count": 0
}
],
"createdAtTs": 0,
"feedbackLastUpdatedTs": 0,
"lastUpdatedTs": 0,
"lastUpdatedBy": "string"
}
Bad Request
- application/json; charset=UTF-8
- Schema
- Example (from schema)
Schema
error object
code string
message string
target string
{
"error": {
"code": "string",
"message": "string",
"target": "string"
}
}
Unauthorized
Forbidden
Action-Plan ID not found
Method Not Allowed
Too Many Requests
Loading...