List operations

GET 
/backend/api/operations

Host: https://core.ocplanet.cloud

List operations

Request

Query Parameters

page_size string
ordering string
filtering string
page string
active_client string

Responses

200

application/json

Schema

Schema

count integerrequired
next nullstringrequired
previous nullstringrequired
objects object[]required
Array [
id stringrequired
operation_type stringrequired
primary_object_id nullstringrequired
status stringrequired
completed booleanrequired
created_at stringrequired
progress objectrequired
total_steps integerrequired
completed_steps integerrequired
steps_details object[]required
Array [
name stringrequired
display stringrequired
status stringrequired
timeout_minutes integerrequired
timeout_error_message stringrequired
start_time stringrequired
error_message nullrequired
]
initiating_user objectrequired
id integerrequired
email stringrequired
full_name stringrequired
display stringrequired
seen booleanrequired
can_retry booleanrequired
]
totalCount integerrequired
pageNo stringrequired
filter_options objectrequired
operation_type object[]required
Array [
display stringrequired
value stringrequired
]
status object[]required
Array [
display stringrequired
value stringrequired
]

Example (from schema)

{
  "count": 0,
  "objects": [
    {
      "id": "string",
      "operation_type": "string",
      "status": "string",
      "completed": true,
      "created_at": "string",
      "progress": {
        "total_steps": 0,
        "completed_steps": 0,
        "steps_details": [
          {
            "name": "string",
            "display": "string",
            "status": "string",
            "timeout_minutes": 0,
            "timeout_error_message": "string",
            "start_time": "string"
          }
        ]
      },
      "initiating_user": {
        "id": 0,
        "email": "string",
        "full_name": "string",
        "display": "string"
      },
      "seen": true,
      "can_retry": true
    }
  ],
  "totalCount": 0,
  "pageNo": "string",
  "filter_options": {
    "operation_type": [
      {
        "display": "string",
        "value": "string"
      }
    ],
    "status": [
      {
        "display": "string",
        "value": "string"
      }
    ]
  }
}

Loading...