Skip to content

tools.ozone.moderation.cancelScheduledActions

Lexicon Version: 1

Type: procedure

Cancel all pending scheduled moderation actions for specified subjects

Parameters: (None defined)

Input:

  • Encoding: application/json
  • Schema:

Schema Type: object

NameTypeReq’dDescriptionConstraints
subjectsArray of stringArray of DID subjects to cancel scheduled actions forMax Items: 100
commentstringOptional comment describing the reason for cancellation
Output:
  • Encoding: application/json
  • Schema:

Schema Type: #cancellationResults


Type: object

Properties:

NameTypeReq’dDescriptionConstraints
succeededArray of stringDIDs for which all pending scheduled actions were successfully cancelled
failedArray of #failedCancellationDIDs for which cancellation failed with error details

Type: object

Properties:

NameTypeReq’dDescriptionConstraints
didstringFormat: did
errorstring
errorCodestring

{
"lexicon": 1,
"id": "tools.ozone.moderation.cancelScheduledActions",
"defs": {
"main": {
"type": "procedure",
"description": "Cancel all pending scheduled moderation actions for specified subjects",
"input": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": [
"subjects"
],
"properties": {
"subjects": {
"type": "array",
"maxLength": 100,
"items": {
"type": "string",
"format": "did"
},
"description": "Array of DID subjects to cancel scheduled actions for"
},
"comment": {
"type": "string",
"description": "Optional comment describing the reason for cancellation"
}
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "ref",
"ref": "#cancellationResults"
}
}
},
"cancellationResults": {
"type": "object",
"required": [
"succeeded",
"failed"
],
"properties": {
"succeeded": {
"type": "array",
"items": {
"type": "string",
"format": "did"
},
"description": "DIDs for which all pending scheduled actions were successfully cancelled"
},
"failed": {
"type": "array",
"items": {
"type": "ref",
"ref": "#failedCancellation"
},
"description": "DIDs for which cancellation failed with error details"
}
}
},
"failedCancellation": {
"type": "object",
"required": [
"did",
"error"
],
"properties": {
"did": {
"type": "string",
"format": "did"
},
"error": {
"type": "string"
},
"errorCode": {
"type": "string"
}
}
}
}
}