Skip to content

tools.ozone.moderation.listScheduledActions

Lexicon Version: 1

Type: procedure

List scheduled moderation actions with optional filtering

Parameters: (None defined)

Input:

  • Encoding: application/json
  • Schema:

Schema Type: object

NameTypeReq’dDescriptionConstraints
startsAfterstringFilter actions scheduled to execute after this timeFormat: datetime
endsBeforestringFilter actions scheduled to execute before this timeFormat: datetime
subjectsArray of stringFilter actions for specific DID subjectsMax Items: 100
statusesArray of stringFilter actions by statusMin Items: 1
limitintegerMaximum number of results to returnMin: 1
Max: 100
Default: 50
cursorstringCursor for pagination
Output:
  • Encoding: application/json
  • Schema:

Schema Type: object

NameTypeReq’dDescriptionConstraints
actionsArray of tools.ozone.moderation.defs#scheduledActionView
cursorstringCursor for next page of results

{
"lexicon": 1,
"id": "tools.ozone.moderation.listScheduledActions",
"defs": {
"main": {
"type": "procedure",
"description": "List scheduled moderation actions with optional filtering",
"input": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": [
"statuses"
],
"properties": {
"startsAfter": {
"type": "string",
"format": "datetime",
"description": "Filter actions scheduled to execute after this time"
},
"endsBefore": {
"type": "string",
"format": "datetime",
"description": "Filter actions scheduled to execute before this time"
},
"subjects": {
"type": "array",
"maxLength": 100,
"items": {
"type": "string",
"format": "did"
},
"description": "Filter actions for specific DID subjects"
},
"statuses": {
"type": "array",
"minLength": 1,
"items": {
"type": "string",
"knownValues": [
"pending",
"executed",
"cancelled",
"failed"
]
},
"description": "Filter actions by status"
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50,
"description": "Maximum number of results to return"
},
"cursor": {
"type": "string",
"description": "Cursor for pagination"
}
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": [
"actions"
],
"properties": {
"actions": {
"type": "array",
"items": {
"type": "ref",
"ref": "tools.ozone.moderation.defs#scheduledActionView"
}
},
"cursor": {
"type": "string",
"description": "Cursor for next page of results"
}
}
}
}
}
}
}