{
  "opencollection": "1.0.0",
  "info": {
    "name": "Resource Scheduler Schedule API",
    "version": "20240430"
  },
  "items": [
    {
      "info": {
        "name": "schedule",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Gets a list of schedules",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20240430/schedules",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "compartmentId",
                "value": "",
                "type": "query",
                "description": "This is the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources."
              },
              {
                "name": "lifecycleState",
                "value": "",
                "type": "query",
                "description": "This is a filter to return only resources that match the given lifecycle state. The\nstate value is case-insensitive.\n"
              },
              {
                "name": "displayName",
                "value": "",
                "type": "query",
                "description": "This is a filter to return only resources that match the given display name exactly."
              },
              {
                "name": "scheduleId",
                "value": "",
                "type": "query",
                "description": "This is the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the schedule."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "This used for list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "This is the field to sort by. You can provide only one sort order. The default order for `timeCreated`\nis descending. The default order for `displayName` is ascending.\n"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "This is the sort order to use, either ascending (`ASC`) or descending (`DESC`)."
              },
              {
                "name": "resourceId",
                "value": "",
                "type": "query",
                "description": "This is the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource affected by the work request."
              }
            ]
          },
          "docs": "This API gets a list of schedules. You must provide either a compartmentId or a scheduleId or both. You can list resources in this compartment [OCID](/iaas/Content/General/Concepts/identifiers.htm). This is required unless a specific schedule ID is passed.\n"
        },
        {
          "info": {
            "name": "This API creates a schedule",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://127.0.0.1/20240430/schedules",
            "headers": [
              {
                "name": "opc-retry-token",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API creates a schedule. You must provide either resources or resourceFilters.\n"
        },
        {
          "info": {
            "name": "Gets a list of schedule resource types.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20240430/schedules/resourceTypes",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "compartmentId",
                "value": "",
                "type": "query",
                "description": "This is the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "This used for list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
              }
            ]
          },
          "docs": "This API gets a list of schedule resource types.\n"
        },
        {
          "info": {
            "name": "Get Schedule",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20240430/schedules/:scheduleId",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "scheduleId",
                "value": "",
                "type": "path",
                "description": "This is the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the schedule."
              }
            ]
          },
          "docs": "This API gets information about a schedule."
        },
        {
          "info": {
            "name": "Updates a schedule",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "http://127.0.0.1/20240430/schedules/:scheduleId",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "scheduleId",
                "value": "",
                "type": "path",
                "description": "This is the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the schedule."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "The API updates a schedule"
        },
        {
          "info": {
            "name": "Deletes a schedule",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "http://127.0.0.1/20240430/schedules/:scheduleId",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "scheduleId",
                "value": "",
                "type": "path",
                "description": "This is the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the schedule."
              }
            ]
          },
          "docs": "This API deletes a schedule."
        },
        {
          "info": {
            "name": "Activates a schedule",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://127.0.0.1/20240430/schedules/:scheduleId/actions/activateSchedule",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              },
              {
                "name": "opc-retry-token",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "scheduleId",
                "value": "",
                "type": "path",
                "description": "This is the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the schedule."
              }
            ]
          },
          "docs": "This API activates a schedule."
        },
        {
          "info": {
            "name": "Moves a schedule into a different compartment.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://127.0.0.1/20240430/schedules/:scheduleId/actions/changeCompartment",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              },
              {
                "name": "opc-retry-token",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "scheduleId",
                "value": "",
                "type": "path",
                "description": "This is the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the schedule."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API moves a schedule into a different compartment within the same tenancy. For information about moving resources between\ncompartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n"
        },
        {
          "info": {
            "name": "Deactivates a schedule",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://127.0.0.1/20240430/schedules/:scheduleId/actions/deactivateSchedule",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              },
              {
                "name": "opc-retry-token",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "scheduleId",
                "value": "",
                "type": "path",
                "description": "This is the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the schedule."
              }
            ]
          },
          "docs": "This API deactivates a schedule."
        },
        {
          "info": {
            "name": "List Work Requests",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20240430/workRequests",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "compartmentId",
                "value": "",
                "type": "query",
                "description": "This is the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources."
              },
              {
                "name": "workRequestId",
                "value": "",
                "type": "query",
                "description": "This is the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request."
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "This is a filter to return only the resources that match the given lifecycle state."
              },
              {
                "name": "resourceId",
                "value": "",
                "type": "query",
                "description": "This is the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource affected by the work request."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "This used for list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "This is the sort order to use, either ascending (`ASC`) or descending (`DESC`)."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "This is the field to sort by. Only one sort order may be provided. Default order for `timeAccepted` is descending.\n"
              },
              {
                "name": "scheduleId",
                "value": "",
                "type": "query",
                "description": "This is the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the schedule."
              }
            ]
          },
          "docs": "This API gets a list of work requests. You must provide either a compartmentId or a workRequestId or both. You can list work requests in this compartment [OCID](/iaas/Content/General/Concepts/identifiers.htm). This is required unless a specific workRequestId is passed."
        },
        {
          "info": {
            "name": "Get work request status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20240430/workRequests/:workRequestId",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "workRequestId",
                "value": "",
                "type": "path",
                "description": "This is the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request."
              }
            ]
          },
          "docs": "This API gets the details of a work request."
        },
        {
          "info": {
            "name": "Cancel work request",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "http://127.0.0.1/20240430/workRequests/:workRequestId",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "workRequestId",
                "value": "",
                "type": "path",
                "description": "This is the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request."
              }
            ]
          },
          "docs": "This API cancels a work request."
        },
        {
          "info": {
            "name": "List work request errors",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20240430/workRequests/:workRequestId/errors",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "workRequestId",
                "value": "",
                "type": "path",
                "description": "This is the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "This used for list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "This is the field to sort by. Only one sort order may be provided. Default order for `timestamp` is descending.\n"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "This is the sort order to use, either ascending (`ASC`) or descending (`DESC`)."
              }
            ]
          },
          "docs": "This API lists the errors for a work request.\n"
        },
        {
          "info": {
            "name": "List work request logs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20240430/workRequests/:workRequestId/logs",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "workRequestId",
                "value": "",
                "type": "path",
                "description": "This is the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "This used for list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "This is the field to sort by. Only one sort order may be provided. Default order for `timestamp` is descending.\n"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "This is the sort order to use, either ascending (`ASC`) or descending (`DESC`)."
              }
            ]
          },
          "docs": "Lists the logs for a work request.\n"
        }
      ]
    }
  ],
  "bundled": true
}