Skip to main content

CustomIoaService

platform.v1.CustomIoaService

CustomIoaService is Custom IOA rule-group and rule query/get/create/patch/delete.

RPCs​

QueryRuleGroups​

  • Request: QueryRuleGroupsRequest
  • Response: MsaStringResponse
  • REST mapping: GET /ioarules/queries/rule-groups/v1

GetRuleGroups​

  • Request: IdsQueryRequest
  • Response: MsaIoaRuleGroupResponse
  • REST mapping: GET /ioarules/entities/rule-groups/v1

CreateRuleGroups​

  • Request: CreateRuleGroupsRequest
  • Response: MsaIoaRuleGroupResponse
  • REST mapping: POST /ioarules/entities/rule-groups/v1

UpdateRuleGroups​

  • Request: UpdateRuleGroupsRequest
  • Response: MsaIoaRuleGroupResponse
  • REST mapping: PATCH /ioarules/entities/rule-groups/v1

DeleteRuleGroups​

  • Request: IdsQueryRequest
  • Response: MsaStringResponse
  • REST mapping: DELETE /ioarules/entities/rule-groups/v1

QueryRules​

  • Request: QueryRulesRequest
  • Response: MsaStringResponse
  • REST mapping: GET /ioarules/queries/rules/v1

GetRules​

  • Request: IdsQueryRequest
  • Response: MsaIoaRuleResponse
  • REST mapping: GET /ioarules/entities/rules/v1

CreateRules​

  • Request: CreateRulesRequest
  • Response: MsaIoaRuleResponse
  • REST mapping: POST /ioarules/entities/rules/v1

UpdateRules​

  • Request: UpdateRulesRequest
  • Response: MsaIoaRuleResponse
  • REST mapping: PATCH /ioarules/entities/rules/v1

DeleteRules​

  • Request: IdsQueryRequest
  • Response: MsaStringResponse
  • REST mapping: DELETE /ioarules/entities/rules/v1

Messages​

CreateRuleGroupsRequest​

FieldType#Notes
namestring1
descriptionstring2
platformstring3

CreateRulesRequest​

FieldType#Notes
namestring1
descriptionstring2
rulegroup_idstring3
pattern_severitystring4

IdsQueryRequest​

FieldType#Notes
idsstring1

MsaIoaRuleGroupResponse​

FieldType#Notes
metaMsaMeta1
errorsMsaError2
resourcesIoaRuleGroup3

MsaIoaRuleResponse​

FieldType#Notes
metaMsaMeta1
errorsMsaError2
resourcesIoaRule3

MsaStringResponse​

FieldType#Notes
metaMsaMeta1
errorsMsaError2
resourcesstring3

QueryRuleGroupsRequest​

FieldType#Notes
filterstring1
limitint322
offsetint323
sortstring4

QueryRulesRequest​

FieldType#Notes
filterstring1
limitint322
offsetint323
sortstring4

UpdateRuleGroupsRequest​

FieldType#Notes
idstring1
namestring2
descriptionstring3
enabledbool4HasEnabled distinguishes omit vs false so PATCH can disable a group.

UpdateRulesRequest​

FieldType#Notes
idstring1
namestring2
descriptionstring3
pattern_severitystring4
enabledbool5