{
  "opencollection": "1.0.0",
  "info": {
    "name": "OS Management Hub Scheduled Job API",
    "version": "20220901"
  },
  "items": [
    {
      "info": {
        "name": "scheduledJob",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Gets a list of all scheduled jobs in a compartment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20220901/scheduledJobs",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "compartmentId",
                "value": "",
                "type": "query",
                "description": "The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment."
              },
              {
                "name": "displayName",
                "value": "",
                "type": "query",
                "description": "A filter to return resources that match the given user-friendly name."
              },
              {
                "name": "displayNameContains",
                "value": "",
                "type": "query",
                "description": "A filter to return resources that may partially match the given display name."
              },
              {
                "name": "lifecycleState",
                "value": "",
                "type": "query",
                "description": "A filter to return only scheduled jobs currently in the given state."
              },
              {
                "name": "managedInstanceId",
                "value": "",
                "type": "query",
                "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance. This filter returns resources associated with this managed instance."
              },
              {
                "name": "managedInstanceGroupId",
                "value": "",
                "type": "query",
                "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance group. This filter returns resources associated with this group."
              },
              {
                "name": "managedCompartmentId",
                "value": "",
                "type": "query",
                "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed compartment. This filter returns resources associated with this compartment."
              },
              {
                "name": "lifecycleStageId",
                "value": "",
                "type": "query",
                "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the lifecycle stage. This resource returns resources associated with this lifecycle stage."
              },
              {
                "name": "operationType",
                "value": "",
                "type": "query",
                "description": "A filter to return only scheduled jobs with the given operation type."
              },
              {
                "name": "scheduleType",
                "value": "",
                "type": "query",
                "description": "A filter to return only scheduled jobs of the given scheduling type (one-time or recurring)."
              },
              {
                "name": "timeStart",
                "value": "",
                "type": "query",
                "description": "A filter to return only resources with a date on or after the given value, in ISO 8601 format.\n\nExample: 2017-07-14T02:40:00.000Z\n"
              },
              {
                "name": "timeEnd",
                "value": "",
                "type": "query",
                "description": "A filter to return only resources with a date on or before the given value, in ISO 8601 format.\n\nExample: 2017-07-14T02:40:00.000Z\n"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `3`\n"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "The sort order to use, either 'ASC' or 'DESC'."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.\n"
              },
              {
                "name": "isRestricted",
                "value": "",
                "type": "query",
                "description": "A filter to return only restricted scheduled jobs."
              },
              {
                "name": "id",
                "value": "",
                "type": "query",
                "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the scheduled job. A filter to return the specified job."
              },
              {
                "name": "compartmentIdInSubtree",
                "value": "",
                "type": "query",
                "description": "Indicates whether to include subcompartments in the returned results. Default is false."
              },
              {
                "name": "location",
                "value": "",
                "type": "query",
                "description": "A filter to return only resources whose location matches the given value."
              },
              {
                "name": "locationNotEqualTo",
                "value": "",
                "type": "query",
                "description": "A filter to return only resources whose location does not match the given value."
              },
              {
                "name": "isManagedByAutonomousLinux",
                "value": "",
                "type": "query",
                "description": "Indicates whether to list only resources managed by the Autonomous Linux service.\n"
              },
              {
                "name": "dynamicSetId",
                "value": "",
                "type": "query",
                "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the dynamic set. This filter returns resources associated with this dynamic set."
              }
            ]
          },
          "docs": "Lists scheduled jobs that match the specified compartment or scheduled job [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n"
        },
        {
          "info": {
            "name": "Creates a new scheduled job.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://127.0.0.1/20220901/scheduledJobs",
            "headers": [
              {
                "name": "opc-retry-token",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new scheduled job.\n"
        },
        {
          "info": {
            "name": "Gets a scheduled job",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20220901/scheduledJobs/:scheduledJobId",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "scheduledJobId",
                "value": "",
                "type": "path",
                "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the scheduled job."
              }
            ]
          },
          "docs": "Gets information about the specified scheduled job.\n"
        },
        {
          "info": {
            "name": "Update the specified scheduled job.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "http://127.0.0.1/20220901/scheduledJobs/:scheduledJobId",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "scheduledJobId",
                "value": "",
                "type": "path",
                "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the scheduled job."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the specified scheduled job's name, description, and other details, such as next execution and recurrence.\n"
        },
        {
          "info": {
            "name": "Cancel (delete) a scheduled job.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "http://127.0.0.1/20220901/scheduledJobs/:scheduledJobId",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "scheduledJobId",
                "value": "",
                "type": "path",
                "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the scheduled job."
              }
            ]
          },
          "docs": "Deletes the specified scheduled job.\n"
        },
        {
          "info": {
            "name": "Moves a resource into a different compartment.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://127.0.0.1/20220901/scheduledJobs/:scheduledJobId/actions/changeCompartment",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              },
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-retry-token",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "scheduledJobId",
                "value": "",
                "type": "path",
                "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the scheduled job."
              }
            ]
          },
          "docs": "Moves a scheduled job to another compartment."
        },
        {
          "info": {
            "name": "Triggers a scheduled job to execute immediately",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://127.0.0.1/20220901/scheduledJobs/:scheduledJobId/actions/runNow",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              },
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-retry-token",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "scheduledJobId",
                "value": "",
                "type": "path",
                "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the scheduled job."
              }
            ]
          },
          "docs": "Triggers an already created recurring scheduled job to run immediately instead of waiting for its next regularly\nscheduled time. This operation only applies to recurring jobs, not one-time scheduled jobs.\n"
        }
      ]
    }
  ],
  "bundled": true
}