{
"opencollection": "1.0.0",
"info": {
"name": "Data Science API",
"version": "20190101"
},
"items": [
{
"info": {
"name": "dataScience",
"type": "folder"
},
"items": [
{
"info": {
"name": "Lists the valid compute target shapes.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/computeTargetShapes",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "compartmentId",
"value": "",
"type": "query",
"description": "Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 100 is the maximum.\nSee [List Pagination](/iaas/Content/General/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\nheader from the previous \"List\" call.\n\nSee [List Pagination](/iaas/Content/General/Concepts/usingapi.htm#nine).\n"
}
]
},
"docs": "Lists the valid compute target shapes."
},
{
"info": {
"name": "List compute targets in the specified compartment.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/computeTargets",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "compartmentId",
"value": "",
"type": "query",
"description": "Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
},
{
"name": "id",
"value": "",
"type": "query",
"description": "Filter results by [OCID](/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type.\n"
},
{
"name": "displayName",
"value": "",
"type": "query",
"description": "Filter results by its user-friendly name."
},
{
"name": "lifecycleState",
"value": "",
"type": "query",
"description": "Filter results by the specified lifecycle state. Must be a valid\n state for the resource type.\n"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 100 is the maximum.\nSee [List Pagination](/iaas/Content/General/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\nheader from the previous \"List\" call.\n\nSee [List Pagination](/iaas/Content/General/Concepts/usingapi.htm#nine).\n"
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).\n"
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field.\nBy default, when you sort by `timeCreated`, the results are shown\nin descending order. When you sort by `displayName`, the results are\nshown in ascending order. Sort order for the `displayName` field is case sensitive.\n"
}
]
},
"docs": "List all compute targets in the specified compartment. Supports queries on various other parameters in the query alongside compartmentId (must be included).\n"
},
{
"info": {
"name": "Creates a new compute target resource.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/computeTargets",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a new compute target resource."
},
{
"info": {
"name": "Gets the compute target.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/computeTargets/:computeTargetId",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "computeTargetId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute target."
}
]
},
"docs": "Retrieves the compute target for the specified `computeTargetId`."
},
{
"info": {
"name": "Updates the compute target.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://$SWAGGER_HOST_URL/20190101/computeTargets/:computeTargetId",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "if-match",
"value": ""
}
],
"params": [
{
"name": "computeTargetId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute target."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates the compute target."
},
{
"info": {
"name": "Deletes the compute target.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://$SWAGGER_HOST_URL/20190101/computeTargets/:computeTargetId",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "computeTargetId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute target."
}
]
},
"docs": "Deletes the specified compute target."
},
{
"info": {
"name": "Moves a compute target into a different compartment.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/computeTargets/:computeTargetId/actions/changeCompartment",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"params": [
{
"name": "computeTargetId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute target."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Moves a compute target into a different compartment. When provided, If-Match is checked against ETag values of the resource."
},
{
"info": {
"name": "List the datascience private endpoints.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/dataSciencePrivateEndpoints",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "compartmentId",
"value": "",
"type": "query",
"description": "Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 100 is the maximum.\nSee [List Pagination](/iaas/Content/General/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\nheader from the previous \"List\" call.\n\nSee [List Pagination](/iaas/Content/General/Concepts/usingapi.htm#nine).\n"
},
{
"name": "lifecycleState",
"value": "",
"type": "query",
"description": "The lifecycle state of the private endpoint.\n"
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "The field used to sort the results. Multiple fields aren't supported.\n"
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).\n"
},
{
"name": "displayName",
"value": "",
"type": "query",
"description": "Filter results by its user-friendly name."
},
{
"name": "createdBy",
"value": "",
"type": "query",
"description": "Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the user who created the resource."
},
{
"name": "dataScienceResourceType",
"value": "",
"type": "query",
"description": "Resource types in the Data Science service such as notebooks.\n"
}
]
},
"docs": "Lists all Data Science private endpoints in the specified compartment. The query must include compartmentId. The query can also include one other parameter. If the query doesn't include compartmentId, or includes compartmentId with two or more other parameters, then an error is returned.\n"
},
{
"info": {
"name": "Create a Data Science private endpoint to be used by a Data Science resource.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/dataSciencePrivateEndpoints",
"headers": [
{
"name": "opc-retry-token",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a Data Science private endpoint to be used by a Data Science resource.\n"
},
{
"info": {
"name": "Get a private endpoint.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/dataSciencePrivateEndpoints/:dataSciencePrivateEndpointId",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "dataSciencePrivateEndpointId",
"value": "",
"type": "path",
"description": "The unique ID for a Data Science private endpoint.\n"
}
]
},
"docs": "Retrieves an private endpoint using a `privateEndpointId`.\n"
},
{
"info": {
"name": "Update a private endpoint.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://$SWAGGER_HOST_URL/20190101/dataSciencePrivateEndpoints/:dataSciencePrivateEndpointId",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "if-match",
"value": ""
}
],
"params": [
{
"name": "dataSciencePrivateEndpointId",
"value": "",
"type": "path",
"description": "The unique ID for a Data Science private endpoint.\n"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates a private endpoint using a `privateEndpointId`. If changes to a private endpoint match\na previously defined private endpoint, then a 409 status code is returned. This indicates\nthat a conflict has been detected.\n"
},
{
"info": {
"name": "Delete a private endpoint.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://$SWAGGER_HOST_URL/20190101/dataSciencePrivateEndpoints/:dataSciencePrivateEndpointId",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "if-match",
"value": ""
}
],
"params": [
{
"name": "dataSciencePrivateEndpointId",
"value": "",
"type": "path",
"description": "The unique ID for a Data Science private endpoint.\n"
}
]
},
"docs": "Deletes a private endpoint using `privateEndpointId`.\n"
},
{
"info": {
"name": "Moves a private endpoint into a different compartment.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/dataSciencePrivateEndpoints/:dataSciencePrivateEndpointId/actions/changeCompartment",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "if-match",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"params": [
{
"name": "dataSciencePrivateEndpointId",
"value": "",
"type": "path",
"description": "The unique ID for a Data Science private endpoint.\n"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Moves a private endpoint into a different compartment. When provided, If-Match is checked against ETag values of the resource.\n"
},
{
"info": {
"name": "FastLaunchJobConfigs",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/fastLaunchJobConfigs",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "compartmentId",
"value": "",
"type": "query",
"description": "Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 100 is the maximum.\nSee [List Pagination](/iaas/Content/General/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\nheader from the previous \"List\" call.\n\nSee [List Pagination](/iaas/Content/General/Concepts/usingapi.htm#nine).\n"
}
]
},
"docs": "List fast launch capable job configs in the specified compartment."
},
{
"info": {
"name": "ListJobRuns",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/jobRuns",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "query",
"description": "Filter results by [OCID](/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type.\n"
},
{
"name": "jobId",
"value": "",
"type": "query",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the job."
},
{
"name": "compartmentId",
"value": "",
"type": "query",
"description": "Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
},
{
"name": "createdBy",
"value": "",
"type": "query",
"description": "Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the user who created the resource."
},
{
"name": "displayName",
"value": "",
"type": "query",
"description": "Filter results by its user-friendly name."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 100 is the maximum.\nSee [List Pagination](/iaas/Content/General/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\nheader from the previous \"List\" call.\n\nSee [List Pagination](/iaas/Content/General/Concepts/usingapi.htm#nine).\n"
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).\n"
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field.\nBy default, when you sort by `timeCreated`, the results are shown\nin descending order. When you sort by `displayName`, the results are\nshown in ascending order. Sort order for the `displayName` field is case sensitive.\n"
},
{
"name": "lifecycleState",
"value": "",
"type": "query",
"description": "Filter results by the specified lifecycle state. Must be a valid\nstate for the resource type.\n"
}
]
},
"docs": "List out job runs."
},
{
"info": {
"name": "CreateJobRun",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/jobRuns",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a job run."
},
{
"info": {
"name": "GetJobRun",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/jobRuns/:jobRunId",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "jobRunId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the job run."
}
]
},
"docs": "Gets a job run."
},
{
"info": {
"name": "UpdateJobRun",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://$SWAGGER_HOST_URL/20190101/jobRuns/:jobRunId",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "if-match",
"value": ""
}
],
"params": [
{
"name": "jobRunId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the job run."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates a job run."
},
{
"info": {
"name": "DeleteJobRun",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://$SWAGGER_HOST_URL/20190101/jobRuns/:jobRunId",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "jobRunId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the job run."
}
]
},
"docs": "Deletes a job run."
},
{
"info": {
"name": "CancelJobRun",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/jobRuns/:jobRunId/actions/cancelJobRun",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "if-match",
"value": ""
}
],
"params": [
{
"name": "jobRunId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the job run."
}
]
},
"docs": "Cancels an IN_PROGRESS job run."
},
{
"info": {
"name": "ChangeJobRunCompartment",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/jobRuns/:jobRunId/actions/changeCompartment",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "jobRunId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the job run."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Changes a job run's compartment"
},
{
"info": {
"name": "ListJobShapes",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/jobShapes",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "compartmentId",
"value": "",
"type": "query",
"description": "Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 100 is the maximum.\nSee [List Pagination](/iaas/Content/General/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\nheader from the previous \"List\" call.\n\nSee [List Pagination](/iaas/Content/General/Concepts/usingapi.htm#nine).\n"
}
]
},
"docs": "List job shapes available in the specified compartment."
},
{
"info": {
"name": "ListJobs",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/jobs",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "compartmentId",
"value": "",
"type": "query",
"description": "Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
},
{
"name": "projectId",
"value": "",
"type": "query",
"description": "Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project."
},
{
"name": "id",
"value": "",
"type": "query",
"description": "Filter results by [OCID](/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type.\n"
},
{
"name": "displayName",
"value": "",
"type": "query",
"description": "Filter results by its user-friendly name."
},
{
"name": "lifecycleState",
"value": "",
"type": "query",
"description": "Filter results by the specified lifecycle state. Must be a valid\n state for the resource type.\n"
},
{
"name": "createdBy",
"value": "",
"type": "query",
"description": "Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the user who created the resource."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 100 is the maximum.\nSee [List Pagination](/iaas/Content/General/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\nheader from the previous \"List\" call.\n\nSee [List Pagination](/iaas/Content/General/Concepts/usingapi.htm#nine).\n"
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).\n"
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field.\nBy default, when you sort by `timeCreated`, the results are shown\nin descending order. When you sort by `displayName`, the results are\nshown in ascending order. Sort order for the `displayName` field is case sensitive.\n"
}
]
},
"docs": "List jobs in the specified compartment."
},
{
"info": {
"name": "CreateJob",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/jobs",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a job."
},
{
"info": {
"name": "GetJob",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/jobs/:jobId",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "jobId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the job."
}
]
},
"docs": "Gets a job."
},
{
"info": {
"name": "UpdateJob",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://$SWAGGER_HOST_URL/20190101/jobs/:jobId",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "if-match",
"value": ""
}
],
"params": [
{
"name": "jobId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the job."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates a job."
},
{
"info": {
"name": "DeleteJob",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://$SWAGGER_HOST_URL/20190101/jobs/:jobId",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "jobId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the job."
},
{
"name": "deleteRelatedJobRuns",
"value": "",
"type": "query",
"description": "Delete all JobRuns associated with this job."
}
]
},
"docs": "Deletes a job."
},
{
"info": {
"name": "ChangeJobCompartment",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/jobs/:jobId/actions/changeCompartment",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "jobId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the job."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Changes a job's compartment"
},
{
"info": {
"name": "CreateJobArtifact",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/jobs/:jobId/artifact",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
},
{
"name": "content-length",
"value": ""
},
{
"name": "content-disposition",
"value": ""
}
],
"params": [
{
"name": "jobId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the job."
}
]
},
"docs": "Uploads a job artifact."
},
{
"info": {
"name": "GetJobArtifactContent",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/jobs/:jobId/artifact/content",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "range",
"value": ""
}
],
"params": [
{
"name": "jobId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the job."
}
]
},
"docs": "Downloads job artifact content for specified job."
},
{
"info": {
"name": "HeadJobArtifact",
"type": "http"
},
"http": {
"method": "HEAD",
"url": "https://$SWAGGER_HOST_URL/20190101/jobs/:jobId/artifact/content",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "jobId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the job."
}
]
},
"docs": "Gets job artifact metadata."
},
{
"info": {
"name": "Gets a list of all MlApplicationImplementationVersions in a compartment",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/mlApplicationImplementationVersions",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "mlApplicationImplementationId",
"value": "",
"type": "query",
"description": "unique MlApplicationImplementation identifier"
},
{
"name": "lifecycleState",
"value": "",
"type": "query",
"description": "A filter to return only resources matching the given lifecycleState."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 100 is the maximum.\nSee [List Pagination](/iaas/Content/General/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\nheader from the previous \"List\" call.\n\nSee [List Pagination](/iaas/Content/General/Concepts/usingapi.htm#nine).\n"
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).\n"
},
{
"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 name is ascending.\n"
}
]
},
"docs": "Returns a list of MlApplicationImplementationVersions.\n"
},
{
"info": {
"name": "Get MlApplicationImplementationVersion",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/mlApplicationImplementationVersions/:mlApplicationImplementationVersionId",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "mlApplicationImplementationVersionId",
"value": "",
"type": "path",
"description": "unique MlApplicationImplementationVersion identifier"
}
]
},
"docs": "Gets a MlApplicationImplementationVersion by identifier"
},
{
"info": {
"name": "Update the MlApplicationImplementationVersion identified by the id",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://$SWAGGER_HOST_URL/20190101/mlApplicationImplementationVersions/:mlApplicationImplementationVersionId",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "mlApplicationImplementationVersionId",
"value": "",
"type": "path",
"description": "unique MlApplicationImplementationVersion identifier"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates the MlApplicationImplementationVersion"
},
{
"info": {
"name": "Get GetMlApplicationHistoricalPackageContent",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/mlApplicationImplementationVersions/:mlApplicationImplementationVersionId/mlApplicationHistoricalPackage/content",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "mlApplicationImplementationVersionId",
"value": "",
"type": "path",
"description": "unique MlApplicationImplementationVersion identifier"
}
]
},
"docs": "Retrieves ML Application package for MlApplicationImplementationVersion with given id."
},
{
"info": {
"name": "Gets a list of all MlApplicationImplementations in a compartment",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/mlApplicationImplementations",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "mlApplicationImplementationId",
"value": "",
"type": "query",
"description": "unique MlApplicationImplementation identifier"
},
{
"name": "name",
"value": "",
"type": "query",
"description": "A filter to return only resources that match the entire name given."
},
{
"name": "mlApplicationId",
"value": "",
"type": "query",
"description": "unique MlApplication identifier"
},
{
"name": "compartmentId",
"value": "",
"type": "query",
"description": "Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
},
{
"name": "compartmentIdInSubtree",
"value": "",
"type": "query",
"description": "If it is true search must include all results from descendant compartments. Value true is allowed only if compartmentId refers to root compartment."
},
{
"name": "lifecycleState",
"value": "",
"type": "query",
"description": "A filter to return only resources with lifecycleState matching the given lifecycleState."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 100 is the maximum.\nSee [List Pagination](/iaas/Content/General/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\nheader from the previous \"List\" call.\n\nSee [List Pagination](/iaas/Content/General/Concepts/usingapi.htm#nine).\n"
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).\n"
},
{
"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 name is ascending.\n"
}
]
},
"docs": "Returns a list of MlApplicationImplementations.\n"
},
{
"info": {
"name": "Creates a new MlApplicationImplementation",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/mlApplicationImplementations",
"headers": [
{
"name": "opc-retry-token",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a new MlApplicationImplementation.\n"
},
{
"info": {
"name": "Get MlApplicationImplementation",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/mlApplicationImplementations/:mlApplicationImplementationId",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "mlApplicationImplementationId",
"value": "",
"type": "path",
"description": "unique MlApplicationImplementation identifier"
}
]
},
"docs": "Gets a MlApplicationImplementation by identifier"
},
{
"info": {
"name": "Update the MlApplicationImplementation identified by the id",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://$SWAGGER_HOST_URL/20190101/mlApplicationImplementations/:mlApplicationImplementationId",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "mlApplicationImplementationId",
"value": "",
"type": "path",
"description": "unique MlApplicationImplementation identifier"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates the MlApplicationImplementation"
},
{
"info": {
"name": "Delete a provisioned MlApplicationImplementation",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://$SWAGGER_HOST_URL/20190101/mlApplicationImplementations/:mlApplicationImplementationId",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "mlApplicationImplementationId",
"value": "",
"type": "path",
"description": "unique MlApplicationImplementation identifier"
}
]
},
"docs": "Deletes a MlApplicationImplementation resource by identifier"
},
{
"info": {
"name": "Moves a resource into a different compartment.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/mlApplicationImplementations/:mlApplicationImplementationId/actions/changeCompartment",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"params": [
{
"name": "mlApplicationImplementationId",
"value": "",
"type": "path",
"description": "unique MlApplicationImplementation identifier"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Moves a MlApplicationImplementation resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource."
},
{
"info": {
"name": "Upload ML Application Package",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://$SWAGGER_HOST_URL/20190101/mlApplicationImplementations/:mlApplicationImplementationId/mlApplicationPackage",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
},
{
"name": "content-length",
"value": ""
},
{
"name": "content-disposition",
"value": ""
},
{
"name": "opc-ml-app-package-args",
"value": ""
}
],
"params": [
{
"name": "mlApplicationImplementationId",
"value": "",
"type": "path",
"description": "unique MlApplicationImplementation identifier"
}
]
},
"docs": "Upload ML Application Package"
},
{
"info": {
"name": "Get ML Application package content",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/mlApplicationImplementations/:mlApplicationImplementationId/mlApplicationPackage/content",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "mlApplicationImplementationId",
"value": "",
"type": "path",
"description": "unique MlApplicationImplementation identifier"
}
]
},
"docs": "Retrieves last ML Application package uploaded for given ML Application Implementation"
},
{
"info": {
"name": "Gets a list of all MlApplicationInstanceViews in a compartment",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/mlApplicationInstanceViews",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "compartmentId",
"value": "",
"type": "query",
"description": "Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
},
{
"name": "displayName",
"value": "",
"type": "query",
"description": "Filter results by its user-friendly name."
},
{
"name": "mlApplicationId",
"value": "",
"type": "query",
"description": "unique MlApplication identifier"
},
{
"name": "mlApplicationImplementationId",
"value": "",
"type": "query",
"description": "unique MlApplicationImplementation identifier"
},
{
"name": "mlApplicationInstanceId",
"value": "",
"type": "query",
"description": "unique MlApplicationInstance identifier"
},
{
"name": "lifecycleState",
"value": "",
"type": "query",
"description": "A filter to return only resources matching the given lifecycleState."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 100 is the maximum.\nSee [List Pagination](/iaas/Content/General/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\nheader from the previous \"List\" call.\n\nSee [List Pagination](/iaas/Content/General/Concepts/usingapi.htm#nine).\n"
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).\n"
},
{
"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 name is ascending.\n"
}
]
},
"docs": "Returns a list of MlApplicationInstanceViews.\n"
},
{
"info": {
"name": "Get MlApplicationInstanceView",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/mlApplicationInstanceViews/:mlApplicationInstanceViewId",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "mlApplicationInstanceViewId",
"value": "",
"type": "path",
"description": "unique MlApplicationInstanceView identifier"
}
]
},
"docs": "Gets a MlApplicationInstanceView by identifier"
},
{
"info": {
"name": "Update the MlApplicationInstanceView identified by the id",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://$SWAGGER_HOST_URL/20190101/mlApplicationInstanceViews/:mlApplicationInstanceViewId",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "mlApplicationInstanceViewId",
"value": "",
"type": "path",
"description": "unique MlApplicationInstanceView identifier"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates the MlApplicationInstanceView"
},
{
"info": {
"name": "Moves a resource into a different compartment.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/mlApplicationInstanceViews/:mlApplicationInstanceViewId/actions/changeCompartment",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"params": [
{
"name": "mlApplicationInstanceViewId",
"value": "",
"type": "path",
"description": "unique MlApplicationInstanceView identifier"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Moves a MlApplicationInstanceView resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource."
},
{
"info": {
"name": "Disable trigger",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/mlApplicationInstanceViews/:mlApplicationInstanceViewId/actions/disableTrigger",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"params": [
{
"name": "mlApplicationInstanceViewId",
"value": "",
"type": "path",
"description": "unique MlApplicationInstanceView identifier"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Disable trigger of given name for given ML Application Instance View flow"
},
{
"info": {
"name": "Enable trigger",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/mlApplicationInstanceViews/:mlApplicationInstanceViewId/actions/enableTrigger",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"params": [
{
"name": "mlApplicationInstanceViewId",
"value": "",
"type": "path",
"description": "unique MlApplicationInstanceView identifier"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Enable trigger of given name for given ML Application Instance View flow"
},
{
"info": {
"name": "Recovers MlApplicationInstanceView from failures by retrying failed operation.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/mlApplicationInstanceViews/:mlApplicationInstanceViewId/actions/recover",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"params": [
{
"name": "mlApplicationInstanceViewId",
"value": "",
"type": "path",
"description": "unique MlApplicationInstanceView identifier"
}
]
},
"docs": "Provider can initiate recovery of the resource only if MlApplicationInstanceView is in one of the recoverable sub-states (RECOVERABLE_PROVIDER_ISSUE, RECOVERABLE_SERVICE_ISSUE).\nProvider should investigate (using MlApplicationInstanceView lifecycleDetails, relevant logs and metrics) and fix the issue before the recovery is initiated.\n"
},
{
"info": {
"name": "Trigger request",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/mlApplicationInstanceViews/:mlApplicationInstanceViewId/actions/trigger",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"params": [
{
"name": "mlApplicationInstanceViewId",
"value": "",
"type": "path",
"description": "unique MlApplicationInstanceView identifier"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Trigger ML Application Instance View flow if possible"
},
{
"info": {
"name": "Gets a list of all MlApplicationInstances in a compartment",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/mlApplicationInstances",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "compartmentId",
"value": "",
"type": "query",
"description": "Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
},
{
"name": "displayName",
"value": "",
"type": "query",
"description": "Filter results by its user-friendly name."
},
{
"name": "mlApplicationId",
"value": "",
"type": "query",
"description": "unique MlApplication identifier"
},
{
"name": "lifecycleState",
"value": "",
"type": "query",
"description": "A filter to return only resources matching the given lifecycleState."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 100 is the maximum.\nSee [List Pagination](/iaas/Content/General/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\nheader from the previous \"List\" call.\n\nSee [List Pagination](/iaas/Content/General/Concepts/usingapi.htm#nine).\n"
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).\n"
},
{
"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 name is ascending.\n"
}
]
},
"docs": "Returns a list of MlApplicationsInstances.\n"
},
{
"info": {
"name": "Creates a new MlApplicationInstance",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/mlApplicationInstances",
"headers": [
{
"name": "opc-retry-token",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a new MlApplicationInstance.\n"
},
{
"info": {
"name": "Get MlApplicationInstance",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/mlApplicationInstances/:mlApplicationInstanceId",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "mlApplicationInstanceId",
"value": "",
"type": "path",
"description": "unique MlApplicationInstance identifier"
}
]
},
"docs": "Gets a MlApplicationInstance by identifier"
},
{
"info": {
"name": "Update the MlApplicationInstance identified by the id",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://$SWAGGER_HOST_URL/20190101/mlApplicationInstances/:mlApplicationInstanceId",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "mlApplicationInstanceId",
"value": "",
"type": "path",
"description": "unique MlApplicationInstance identifier"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates the MlApplicationInstance"
},
{
"info": {
"name": "Delete a provisioned MlApplicationInstance",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://$SWAGGER_HOST_URL/20190101/mlApplicationInstances/:mlApplicationInstanceId",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "mlApplicationInstanceId",
"value": "",
"type": "path",
"description": "unique MlApplicationInstance identifier"
}
]
},
"docs": "Deletes a MlApplicationInstance resource by identifier"
},
{
"info": {
"name": "Moves a resource into a different compartment.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/mlApplicationInstances/:mlApplicationInstanceId/actions/changeCompartment",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"params": [
{
"name": "mlApplicationInstanceId",
"value": "",
"type": "path",
"description": "unique MlApplicationInstance identifier"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Moves a MlApplicationInstance resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource."
},
{
"info": {
"name": "Trigger request",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/mlApplicationInstances/:mlApplicationInstanceId/actions/trigger",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"params": [
{
"name": "mlApplicationInstanceId",
"value": "",
"type": "path",
"description": "unique MlApplicationInstance identifier"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Trigger ML Application Instance flow if possible"
},
{
"info": {
"name": "Gets a list of all MlApplications in a compartment",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/mlApplications",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "mlApplicationId",
"value": "",
"type": "query",
"description": "unique MlApplication identifier"
},
{
"name": "compartmentId",
"value": "",
"type": "query",
"description": "Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
},
{
"name": "compartmentIdInSubtree",
"value": "",
"type": "query",
"description": "If it is true search must include all results from descendant compartments. Value true is allowed only if compartmentId refers to root compartment."
},
{
"name": "name",
"value": "",
"type": "query",
"description": "A filter to return only resources that match the entire name given."
},
{
"name": "lifecycleState",
"value": "",
"type": "query",
"description": "A filter to return only resources with lifecycleState matching the given lifecycleState."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 100 is the maximum.\nSee [List Pagination](/iaas/Content/General/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\nheader from the previous \"List\" call.\n\nSee [List Pagination](/iaas/Content/General/Concepts/usingapi.htm#nine).\n"
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).\n"
},
{
"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 name is ascending.\n"
}
]
},
"docs": "Returns a list of MlApplications.\n"
},
{
"info": {
"name": "Creates a new MlApplication",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/mlApplications",
"headers": [
{
"name": "opc-retry-token",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a new MlApplication.\n"
},
{
"info": {
"name": "Get MlApplication",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/mlApplications/:mlApplicationId",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "mlApplicationId",
"value": "",
"type": "path",
"description": "unique MlApplication identifier"
}
]
},
"docs": "Gets a MlApplication by identifier"
},
{
"info": {
"name": "Update the MlApplication identified by the id",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://$SWAGGER_HOST_URL/20190101/mlApplications/:mlApplicationId",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "mlApplicationId",
"value": "",
"type": "path",
"description": "unique MlApplication identifier"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates the MlApplication"
},
{
"info": {
"name": "Delete a MlApplication",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://$SWAGGER_HOST_URL/20190101/mlApplications/:mlApplicationId",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "mlApplicationId",
"value": "",
"type": "path",
"description": "unique MlApplication identifier"
}
]
},
"docs": "Deletes a MlApplication resource by identifier"
},
{
"info": {
"name": "Moves a resource into a different compartment.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/mlApplications/:mlApplicationId/actions/changeCompartment",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"params": [
{
"name": "mlApplicationId",
"value": "",
"type": "path",
"description": "unique MlApplication identifier"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Moves a MlApplication resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource."
},
{
"info": {
"name": "Lists the valid model deployment shapes.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/modelDeploymentShapes",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "compartmentId",
"value": "",
"type": "query",
"description": "Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 100 is the maximum.\nSee [List Pagination](/iaas/Content/General/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\nheader from the previous \"List\" call.\n\nSee [List Pagination](/iaas/Content/General/Concepts/usingapi.htm#nine).\n"
}
]
},
"docs": "Lists the valid model deployment shapes."
},
{
"info": {
"name": "Lists the model deployments.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/modelDeployments",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "compartmentId",
"value": "",
"type": "query",
"description": "Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
},
{
"name": "id",
"value": "",
"type": "query",
"description": "Filter results by [OCID](/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type.\n"
},
{
"name": "projectId",
"value": "",
"type": "query",
"description": "Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project."
},
{
"name": "displayName",
"value": "",
"type": "query",
"description": "Filter results by its user-friendly name."
},
{
"name": "lifecycleState",
"value": "",
"type": "query",
"description": "Filter results by the specified lifecycle state. Must be a valid\nstate for the resource type.\n"
},
{
"name": "createdBy",
"value": "",
"type": "query",
"description": "Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the user who created the resource."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 100 is the maximum.\nSee [List Pagination](/iaas/Content/General/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\nheader from the previous \"List\" call.\n\nSee [List Pagination](/iaas/Content/General/Concepts/usingapi.htm#nine).\n"
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).\n"
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field.\nBy default, when you sort by `timeCreated`, results are shown\nin descending order. When you sort by `displayName`, results are\nshown in ascending order. Sort order for the `displayName` field is case sensitive.\n"
}
]
},
"docs": "Lists all model deployments in the specified compartment. Only one parameter other than compartmentId may also be included in a query. The query must include compartmentId. If the query does not include compartmentId, or includes compartmentId but two or more other parameters an error is returned.\n"
},
{
"info": {
"name": "Creates a new model deployment.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/modelDeployments",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a new model deployment."
},
{
"info": {
"name": "Gets the model deployment.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/modelDeployments/:modelDeploymentId",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "modelDeploymentId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model deployment."
}
]
},
"docs": "Retrieves the model deployment for the specified `modelDeploymentId`."
},
{
"info": {
"name": "Updates the model deployment.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://$SWAGGER_HOST_URL/20190101/modelDeployments/:modelDeploymentId",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "modelDeploymentId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model deployment."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates the properties of a model deployment. Some of the properties of `modelDeploymentConfigurationDetails` or `CategoryLogDetails` can also be updated with zero down time\nwhen the model deployment's lifecycle state is ACTIVE or NEEDS_ATTENTION i.e `instanceShapeName`, `instanceCount` and `modelId`, separately `loadBalancerShape` or `CategoryLogDetails`\ncan also be updated independently. All of the fields can be updated when the deployment is in the INACTIVE lifecycle state. Changes will take "
},
{
"info": {
"name": "Deletes the model deployment.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://$SWAGGER_HOST_URL/20190101/modelDeployments/:modelDeploymentId",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "modelDeploymentId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model deployment."
}
]
},
"docs": "Deletes the specified model deployment. Any unsaved work in this model deployment is lost."
},
{
"info": {
"name": "Activates the model deployment.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/modelDeployments/:modelDeploymentId/actions/activate",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "modelDeploymentId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model deployment."
}
]
},
"docs": "Activates the model deployment."
},
{
"info": {
"name": "Moves a model deployment into a different compartment.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/modelDeployments/:modelDeploymentId/actions/changeCompartment",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"params": [
{
"name": "modelDeploymentId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model deployment."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Moves a model deployment into a different compartment. When provided, If-Match is checked against ETag values of the resource."
},
{
"info": {
"name": "Deactivates the model deployment.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/modelDeployments/:modelDeploymentId/actions/deactivate",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "modelDeploymentId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model deployment."
}
]
},
"docs": "Deactivates the model deployment."
},
{
"info": {
"name": "Lists the status of models in a model group deployment.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/modelDeployments/:modelDeploymentId/models/modelState",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"params": [
{
"name": "modelDeploymentId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model deployment."
},
{
"name": "compartmentId",
"value": "",
"type": "query",
"description": "Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
},
{
"name": "projectId",
"value": "",
"type": "query",
"description": "Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project."
},
{
"name": "displayName",
"value": "",
"type": "query",
"description": "Filter results by its user-friendly name."
},
{
"name": "inferenceKey",
"value": "",
"type": "query",
"description": "Filter results by the inference key."
},
{
"name": "modelId",
"value": "",
"type": "query",
"description": "Filter results by the model ocid."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 100 is the maximum.\nSee [List Pagination](/iaas/Content/General/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\nheader from the previous \"List\" call.\n\nSee [List Pagination](/iaas/Content/General/Concepts/usingapi.htm#nine).\n"
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).\n"
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field.\nBy default, when you sort by `timeCreated`, results are shown\nin descending order. When you sort by `displayName`, results are\nshown in ascending order. Sort order for the `displayName` field is case sensitive.\n"
}
]
},
"docs": "Lists the status of models in a model group deployment."
},
{
"info": {
"name": "List all modelGroupVersionHistories in the specified compartment.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/modelGroupVersionHistory",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "compartmentId",
"value": "",
"type": "query",
"description": "Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
},
{
"name": "projectId",
"value": "",
"type": "query",
"description": "Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project."
},
{
"name": "id",
"value": "",
"type": "query",
"description": "Filter results by [OCID](/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type.\n"
},
{
"name": "displayName",
"value": "",
"type": "query",
"description": "Filter results by its user-friendly name."
},
{
"name": "lifecycleState",
"value": "",
"type": "query",
"description": "A filter to return resources matching the given lifecycleState."
},
{
"name": "createdBy",
"value": "",
"type": "query",
"description": "Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the user who created the resource."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 100 is the maximum.\nSee [List Pagination](/iaas/Content/General/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\nheader from the previous \"List\" call.\n\nSee [List Pagination](/iaas/Content/General/Concepts/usingapi.htm#nine).\n"
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).\n"
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field.\nBy default, when you sort by `timeCreated`, the results are shown\nin descending order. All other fields default to ascending order. Sort order for the `displayName` field is case sensitive.\n"
}
]
},
"docs": "List all modelGroupVersionHistories in the specified compartment. The query must include compartmentId."
},
{
"info": {
"name": "Creates a new modelGroupVersionHistory.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/modelGroupVersionHistory",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a new modelGroupVersionHistory."
},
{
"info": {
"name": "Gets information of the specified ModelGroupVersionHistory.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/modelGroupVersionHistory/:modelGroupVersionHistoryId",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "modelGroupVersionHistoryId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the modelGroupVersionHistory."
}
]
},
"docs": "Gets the specified modelGroupVersionHistory's information."
},
{
"info": {
"name": "Updates the properties of a modelGroupVersionHistory.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://$SWAGGER_HOST_URL/20190101/modelGroupVersionHistory/:modelGroupVersionHistoryId",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "if-match",
"value": ""
}
],
"params": [
{
"name": "modelGroupVersionHistoryId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the modelGroupVersionHistory."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates the properties of a modelGroupVersionHistory."
},
{
"info": {
"name": "Deletes the specified modelGroupVersionHistory.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://$SWAGGER_HOST_URL/20190101/modelGroupVersionHistory/:modelGroupVersionHistoryId",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "if-match",
"value": ""
}
],
"params": [
{
"name": "modelGroupVersionHistoryId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the modelGroupVersionHistory."
}
]
},
"docs": "Deletes the specified modelGroupVersionHistory."
},
{
"info": {
"name": "Change compartment of the modelGroupVersionHistory.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/modelGroupVersionHistory/:modelGroupVersionHistoryId/actions/changeCompartment",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"params": [
{
"name": "modelGroupVersionHistoryId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the modelGroupVersionHistory."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Moves a model Group Version History resource into a different compartment."
},
{
"info": {
"name": "List all model groups in the specified compartment.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/modelGroups",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "compartmentId",
"value": "",
"type": "query",
"description": "Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
},
{
"name": "projectId",
"value": "",
"type": "query",
"description": "Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project."
},
{
"name": "id",
"value": "",
"type": "query",
"description": "Filter results by [OCID](/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type.\n"
},
{
"name": "displayName",
"value": "",
"type": "query",
"description": "Filter results by its user-friendly name."
},
{
"name": "lifecycleState",
"value": "",
"type": "query",
"description": "A filter to return resources matching the given lifecycleState."
},
{
"name": "createdBy",
"value": "",
"type": "query",
"description": "Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the user who created the resource."
},
{
"name": "modelGroupVersionHistoryId",
"value": "",
"type": "query",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the modelGroupVersionHistory."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 100 is the maximum.\nSee [List Pagination](/iaas/Content/General/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\nheader from the previous \"List\" call.\n\nSee [List Pagination](/iaas/Content/General/Concepts/usingapi.htm#nine).\n"
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).\n"
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field.\nBy default, when you sort by `timeCreated`, the results are shown\nin descending order. All other fields default to ascending order. Sort order for the `displayName` field is case sensitive.\n"
}
]
},
"docs": "Lists all the modelGroups in the specified compartment. The query must include compartmentId."
},
{
"info": {
"name": "Create a new Model Group resource.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/modelGroups",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new Model Group resource."
},
{
"info": {
"name": "Gets information of the specified Model Group.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/modelGroups/:modelGroupId",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "modelGroupId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the modelGroup."
}
]
},
"docs": "Retrieves the Model Group resource based on the specified modelGroup id."
},
{
"info": {
"name": "Update the properties of the Model Group.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://$SWAGGER_HOST_URL/20190101/modelGroups/:modelGroupId",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "if-match",
"value": ""
}
],
"params": [
{
"name": "modelGroupId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the modelGroup."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates the properties of the Model Group."
},
{
"info": {
"name": "Deletes the specified Model Group.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://$SWAGGER_HOST_URL/20190101/modelGroups/:modelGroupId",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "if-match",
"value": ""
}
],
"params": [
{
"name": "modelGroupId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the modelGroup."
}
]
},
"docs": "Deletes the specified Model Group."
},
{
"info": {
"name": "Activates the model group.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/modelGroups/:modelGroupId/actions/activate",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "modelGroupId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the modelGroup."
}
]
},
"docs": "Activates the model group."
},
{
"info": {
"name": "Change compartment of the Model Group.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/modelGroups/:modelGroupId/actions/changeCompartment",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"params": [
{
"name": "modelGroupId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the modelGroup."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Moves a model group resource into a different compartment."
},
{
"info": {
"name": "Deactivates the model group.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/modelGroups/:modelGroupId/actions/deactivate",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "modelGroupId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the modelGroup."
}
]
},
"docs": "Deactivates the model group."
},
{
"info": {
"name": "Creates artifact for the Model Group.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/modelGroups/:modelGroupId/artifact",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
},
{
"name": "content-length",
"value": ""
},
{
"name": "content-disposition",
"value": ""
},
{
"name": "if-match",
"value": ""
}
],
"params": [
{
"name": "modelGroupId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the modelGroup."
}
]
},
"docs": "Creates artifact for the Model Group."
},
{
"info": {
"name": "Downloads the model group artifact.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/modelGroups/:modelGroupId/artifact/content",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "range",
"value": ""
}
],
"params": [
{
"name": "modelGroupId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the modelGroup."
}
]
},
"docs": "Downloads the model artifact for the specified model group."
},
{
"info": {
"name": "Gets model group artifact metadata.",
"type": "http"
},
"http": {
"method": "HEAD",
"url": "https://$SWAGGER_HOST_URL/20190101/modelGroups/:modelGroupId/artifact/content",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "modelGroupId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the modelGroup."
}
]
},
"docs": "Gets model group artifact metadata for a specified model group."
},
{
"info": {
"name": "List models associated with the Model Group.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/modelGroups/:modelGroupId/models",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "modelGroupId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the modelGroup."
},
{
"name": "compartmentId",
"value": "",
"type": "query",
"description": "Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
},
{
"name": "id",
"value": "",
"type": "query",
"description": "Filter results by [OCID](/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type.\n"
},
{
"name": "displayName",
"value": "",
"type": "query",
"description": "Filter results by its user-friendly name."
},
{
"name": "lifecycleState",
"value": "",
"type": "query",
"description": "Filter results by the specified lifecycle state. Must be a valid\nstate for the resource type.\n"
},
{
"name": "createdBy",
"value": "",
"type": "query",
"description": "Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the user who created the resource."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 100 is the maximum.\nSee [List Pagination](/iaas/Content/General/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\nheader from the previous \"List\" call.\n\nSee [List Pagination](/iaas/Content/General/Concepts/usingapi.htm#nine).\n"
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).\n"
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field.\nBy default, when you sort by `timeCreated`, the results are shown\nin descending order. All other fields default to ascending order. Sort order for the `displayName` field is case sensitive.\n"
}
]
},
"docs": "Lists all models associated with the modelGroup in the specified compartment."
},
{
"info": {
"name": "ListModelVersionSets",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/modelVersionSets",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "compartmentId",
"value": "",
"type": "query",
"description": "Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
},
{
"name": "id",
"value": "",
"type": "query",
"description": "Filter results by [OCID](/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type.\n"
},
{
"name": "projectId",
"value": "",
"type": "query",
"description": "Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project."
},
{
"name": "name",
"value": "",
"type": "query",
"description": "A filter to return only resources that match the entire name given."
},
{
"name": "lifecycleState",
"value": "",
"type": "query",
"description": "Filter results by the specified lifecycle state. Must be a valid\nstate for the resource type.\n"
},
{
"name": "createdBy",
"value": "",
"type": "query",
"description": "Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the user who created the resource."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 100 is the maximum.\nSee [List Pagination](/iaas/Content/General/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\nheader from the previous \"List\" call.\n\nSee [List Pagination](/iaas/Content/General/Concepts/usingapi.htm#nine).\n"
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).\n"
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field.\nBy default, when you sort by `timeCreated`, the results are shown in descending order.\n"
}
]
},
"docs": "Lists model version sets in the specified compartment."
},
{
"info": {
"name": "CreateModelVersionSet",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/modelVersionSets",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a new modelVersionSet."
},
{
"info": {
"name": "GetModelVersionSet",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/modelVersionSets/:modelVersionSetId",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "modelVersionSetId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model version set."
}
]
},
"docs": "Gets the specified model version set information."
},
{
"info": {
"name": "UpdateModelVersionSet",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://$SWAGGER_HOST_URL/20190101/modelVersionSets/:modelVersionSetId",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "modelVersionSetId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model version set."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates the properties of a model version set. User can update the `description` property."
},
{
"info": {
"name": "DeleteModelVersionSet",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://$SWAGGER_HOST_URL/20190101/modelVersionSets/:modelVersionSetId",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "modelVersionSetId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model version set."
},
{
"name": "isDeleteRelatedModels",
"value": "",
"type": "query",
"description": "By default, this parameter is false. A model version set can only be deleted if all the models associate with it are already in the DELETED state.\nYou can optionally specify the deleteRelatedModels boolean query parameters to true, which deletes all associated models for you.\n"
}
]
},
"docs": "Deletes the specified modelVersionSet."
},
{
"info": {
"name": "ChangeModelVersionSetCompartment",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/modelVersionSets/:modelVersionSetId/actions/changeCompartment",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"params": [
{
"name": "modelVersionSetId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model version set."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Moves a modelVersionSet resource into a different compartment."
},
{
"info": {
"name": "ListModels",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/models",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "compartmentId",
"value": "",
"type": "query",
"description": "Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
},
{
"name": "modelVersionSetName",
"value": "",
"type": "query",
"description": "Filter results by the name of the model version set."
},
{
"name": "versionLabel",
"value": "",
"type": "query",
"description": "Filter results by version label."
},
{
"name": "id",
"value": "",
"type": "query",
"description": "Filter results by [OCID](/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type.\n"
},
{
"name": "projectId",
"value": "",
"type": "query",
"description": "Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project."
},
{
"name": "displayName",
"value": "",
"type": "query",
"description": "Filter results by its user-friendly name."
},
{
"name": "lifecycleState",
"value": "",
"type": "query",
"description": "Filter results by the specified lifecycle state. Must be a valid\nstate for the resource type.\n"
},
{
"name": "createdBy",
"value": "",
"type": "query",
"description": "Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the user who created the resource."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 100 is the maximum.\nSee [List Pagination](/iaas/Content/General/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\nheader from the previous \"List\" call.\n\nSee [List Pagination](/iaas/Content/General/Concepts/usingapi.htm#nine).\n"
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).\n"
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field.\nBy default, when you sort by `timeCreated`, the results are shown\nin descending order. All other fields default to ascending order. Sort order for the `displayName` field is case sensitive.\n"
}
]
},
"docs": "Lists models in the specified compartment."
},
{
"info": {
"name": "CreateModel",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/models",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a new model."
},
{
"info": {
"name": "GetModel",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/models/:modelId",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "modelId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model."
}
]
},
"docs": "Gets the specified model's information."
},
{
"info": {
"name": "UpdateModel",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://$SWAGGER_HOST_URL/20190101/models/:modelId",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "modelId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates the properties of a model. You can update the `displayName`, `description`, `freeformTags`, and `definedTags` properties."
},
{
"info": {
"name": "DeleteModel",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://$SWAGGER_HOST_URL/20190101/models/:modelId",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "modelId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model."
}
]
},
"docs": "Deletes the specified model."
},
{
"info": {
"name": "ActivateModel",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/models/:modelId/actions/activate",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "modelId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model."
}
]
},
"docs": "Activates the model."
},
{
"info": {
"name": "ChangeModelCompartment",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/models/:modelId/actions/changeCompartment",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"params": [
{
"name": "modelId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Moves a model resource into a different compartment."
},
{
"info": {
"name": "DeactivateModel",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/models/:modelId/actions/deactivate",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "modelId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model."
}
]
},
"docs": "Deactivates the model."
},
{
"info": {
"name": "ExportModelArtifact",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/models/:modelId/actions/exportArtifact",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
},
{
"name": "if-match",
"value": ""
}
],
"params": [
{
"name": "modelId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Export model artifact from source to the service bucket"
},
{
"info": {
"name": "ImportModelArtifact",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/models/:modelId/actions/importArtifact",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "if-match",
"value": ""
}
],
"params": [
{
"name": "modelId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Import model artifact from service bucket"
},
{
"info": {
"name": "RestoreArchivedModelArtifact",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/models/:modelId/actions/restore",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
},
{
"name": "if-match",
"value": ""
}
],
"params": [
{
"name": "modelId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model."
},
{
"name": "restoreModelForHoursSpecified",
"value": "",
"type": "query",
"description": "Duration in hours for which the archived model is available for access."
}
]
},
"docs": "Restore archived model artifact"
},
{
"info": {
"name": "CreateModelArtifact",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/models/:modelId/artifact",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
},
{
"name": "content-length",
"value": ""
},
{
"name": "content-disposition",
"value": ""
},
{
"name": "if-match",
"value": ""
}
],
"params": [
{
"name": "modelId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model."
}
]
},
"docs": "Creates model artifact for specified model."
},
{
"info": {
"name": "GetModelArtifactContent",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/models/:modelId/artifact/content",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "range",
"value": ""
}
],
"params": [
{
"name": "modelId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model."
}
]
},
"docs": "Downloads model artifact content for specified model."
},
{
"info": {
"name": "HeadModelArtifact",
"type": "http"
},
"http": {
"method": "HEAD",
"url": "https://$SWAGGER_HOST_URL/20190101/models/:modelId/artifact/content",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "modelId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model."
}
]
},
"docs": "Gets model artifact metadata for specified model."
},
{
"info": {
"name": "GetModelProvenance",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/models/:modelId/provenance",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "modelId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model."
}
]
},
"docs": "Gets provenance information for specified model."
},
{
"info": {
"name": "CreateModelProvenance",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/models/:modelId/provenance",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"params": [
{
"name": "modelId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates provenance information for the specified model."
},
{
"info": {
"name": "UpdateModelProvenance",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://$SWAGGER_HOST_URL/20190101/models/:modelId/provenance",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "if-match",
"value": ""
}
],
"params": [
{
"name": "modelId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the model."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates the provenance information for the specified model."
},
{
"info": {
"name": "ListNotebookSessionShapes",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/notebookSessionShapes",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "compartmentId",
"value": "",
"type": "query",
"description": "Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 100 is the maximum.\nSee [List Pagination](/iaas/Content/General/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\nheader from the previous \"List\" call.\n\nSee [List Pagination](/iaas/Content/General/Concepts/usingapi.htm#nine).\n"
}
]
},
"docs": "Lists the valid notebook session shapes."
},
{
"info": {
"name": "ListNotebookSessions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/notebookSessions",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "compartmentId",
"value": "",
"type": "query",
"description": "Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
},
{
"name": "id",
"value": "",
"type": "query",
"description": "Filter results by [OCID](/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type.\n"
},
{
"name": "projectId",
"value": "",
"type": "query",
"description": "Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project."
},
{
"name": "displayName",
"value": "",
"type": "query",
"description": "Filter results by its user-friendly name."
},
{
"name": "lifecycleState",
"value": "",
"type": "query",
"description": "Filter results by the specified lifecycle state. Must be a valid\nstate for the resource type.\n"
},
{
"name": "createdBy",
"value": "",
"type": "query",
"description": "Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the user who created the resource."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 100 is the maximum.\nSee [List Pagination](/iaas/Content/General/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\nheader from the previous \"List\" call.\n\nSee [List Pagination](/iaas/Content/General/Concepts/usingapi.htm#nine).\n"
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).\n"
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field.\nBy default, when you sort by `timeCreated`, the results are shown\nin descending order. When you sort by `displayName`, results are\nshown in ascending order. Sort order for the `displayName` field is case sensitive.\n"
}
]
},
"docs": "Lists the notebook sessions in the specified compartment."
},
{
"info": {
"name": "CreateNotebookSession",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/notebookSessions",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a new notebook session."
},
{
"info": {
"name": "GetNotebookSession",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/notebookSessions/:notebookSessionId",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "notebookSessionId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the notebook session."
}
]
},
"docs": "Gets the specified notebook session's information."
},
{
"info": {
"name": "UpdateNotebookSession",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://$SWAGGER_HOST_URL/20190101/notebookSessions/:notebookSessionId",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "notebookSessionId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the notebook session."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates the properties of a notebook session. You can update the `displayName`, `freeformTags`, and `definedTags` properties.\nWhen the notebook session is in the INACTIVE lifecycle state, you can update `notebookSessionConfigurationDetails` and change `shape`, `subnetId`, and `blockStorageSizeInGBs`.\nChanges to the `notebookSessionConfigurationDetails` take effect the next time the `ActivateNotebookSession` action is invoked on the notebook session resource.\n"
},
{
"info": {
"name": "DeleteNotebookSession",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://$SWAGGER_HOST_URL/20190101/notebookSessions/:notebookSessionId",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "notebookSessionId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the notebook session."
}
]
},
"docs": "Deletes the specified notebook session. Any unsaved work in this notebook session are lost."
},
{
"info": {
"name": "ActivateNotebookSession",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/notebookSessions/:notebookSessionId/actions/activate",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "notebookSessionId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the notebook session."
}
]
},
"docs": "Activates the notebook session."
},
{
"info": {
"name": "ChangeNotebookSessionCompartment",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/notebookSessions/:notebookSessionId/actions/changeCompartment",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"params": [
{
"name": "notebookSessionId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the notebook session."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Moves a notebook session resource into a different compartment."
},
{
"info": {
"name": "DeactivateNotebookSession",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/notebookSessions/:notebookSessionId/actions/deactivate",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "notebookSessionId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the notebook session."
}
]
},
"docs": "Deactivates the notebook session."
},
{
"info": {
"name": "Gets a list of all PipelineRuns in a compartment",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/pipelineRuns",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "query",
"description": "Filter results by [OCID](/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type.\n"
},
{
"name": "pipelineId",
"value": "",
"type": "query",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the pipeline."
},
{
"name": "compartmentId",
"value": "",
"type": "query",
"description": "Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
},
{
"name": "displayName",
"value": "",
"type": "query",
"description": "Filter results by its user-friendly name."
},
{
"name": "lifecycleState",
"value": "",
"type": "query",
"description": "The current state of the PipelineRun."
},
{
"name": "createdBy",
"value": "",
"type": "query",
"description": "Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the user who created the resource."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 100 is the maximum.\nSee [List Pagination](/iaas/Content/General/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\nheader from the previous \"List\" call.\n\nSee [List Pagination](/iaas/Content/General/Concepts/usingapi.htm#nine).\n"
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).\n"
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field.\nBy default, when you sort by `timeAccepted`, the results are shown\nin descending order. When you sort by `displayName`, the results are\nshown in ascending order. Sort order for the `displayName` field is case sensitive.\n"
}
]
},
"docs": "Returns a list of PipelineRuns."
},
{
"info": {
"name": "Creates a new PipelineRun",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/pipelineRuns",
"headers": [
{
"name": "opc-retry-token",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a new PipelineRun.\n"
},
{
"info": {
"name": "Get PipelineRun",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/pipelineRuns/:pipelineRunId",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "pipelineRunId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the pipeline run."
}
]
},
"docs": "Gets a PipelineRun by identifier."
},
{
"info": {
"name": "Update the PipelineRun identified by the id",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://$SWAGGER_HOST_URL/20190101/pipelineRuns/:pipelineRunId",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "pipelineRunId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the pipeline run."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates the PipelineRun."
},
{
"info": {
"name": "Delete a provisioned PipelineRun",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://$SWAGGER_HOST_URL/20190101/pipelineRuns/:pipelineRunId",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "pipelineRunId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the pipeline run."
},
{
"name": "deleteRelatedJobRuns",
"value": "",
"type": "query",
"description": "A boolean value to specify whether to delete related jobRuns or not."
}
]
},
"docs": "Deletes a PipelineRun resource by identifier."
},
{
"info": {
"name": "Cancel a PipelineRun",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/pipelineRuns/:pipelineRunId/actions/cancelPipelineRun",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
},
{
"name": "if-match",
"value": ""
}
],
"params": [
{
"name": "pipelineRunId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the pipeline run."
},
{
"name": "terminateGracefully",
"value": "",
"type": "query",
"description": "A boolean value to specify whether to terminate pipeline run gracefully."
}
]
},
"docs": "Cancel a PipelineRun."
},
{
"info": {
"name": "Moves a resource into a different compartment.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/pipelineRuns/:pipelineRunId/actions/changeCompartment",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "if-match",
"value": ""
}
],
"params": [
{
"name": "pipelineRunId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the pipeline run."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource."
},
{
"info": {
"name": "Gets a list of all Pipelines in a compartment",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/pipelines",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "compartmentId",
"value": "",
"type": "query",
"description": "Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
},
{
"name": "projectId",
"value": "",
"type": "query",
"description": "Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project."
},
{
"name": "id",
"value": "",
"type": "query",
"description": "Filter results by [OCID](/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type.\n"
},
{
"name": "displayName",
"value": "",
"type": "query",
"description": "Filter results by its user-friendly name."
},
{
"name": "lifecycleState",
"value": "",
"type": "query",
"description": "The current state of the Pipeline."
},
{
"name": "createdBy",
"value": "",
"type": "query",
"description": "Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the user who created the resource."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 100 is the maximum.\nSee [List Pagination](/iaas/Content/General/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\nheader from the previous \"List\" call.\n\nSee [List Pagination](/iaas/Content/General/Concepts/usingapi.htm#nine).\n"
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).\n"
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field.\nBy default, when you sort by `timeCreated`, the results are shown\nin descending order. When you sort by `displayName`, the results are\nshown in ascending order. Sort order for the `displayName` field is case sensitive.\n"
}
]
},
"docs": "Returns a list of Pipelines."
},
{
"info": {
"name": "Creates a new Pipeline",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/pipelines",
"headers": [
{
"name": "opc-retry-token",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a new Pipeline.\n"
},
{
"info": {
"name": "Get Pipeline",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/pipelines/:pipelineId",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "pipelineId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the pipeline."
}
]
},
"docs": "Gets a Pipeline by identifier."
},
{
"info": {
"name": "Update the Pipeline identified by the id",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://$SWAGGER_HOST_URL/20190101/pipelines/:pipelineId",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "pipelineId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the pipeline."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates the Pipeline."
},
{
"info": {
"name": "Delete a provisioned Pipeline",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://$SWAGGER_HOST_URL/20190101/pipelines/:pipelineId",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "pipelineId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the pipeline."
},
{
"name": "deleteRelatedPipelineRuns",
"value": "",
"type": "query",
"description": "A boolean value to specify whether to delete related PipelineRuns or not."
},
{
"name": "deleteRelatedJobRuns",
"value": "",
"type": "query",
"description": "A boolean value to specify whether to delete related jobRuns or not."
}
]
},
"docs": "Deletes a Pipeline resource by identifier."
},
{
"info": {
"name": "Moves a resource into a different compartment.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/pipelines/:pipelineId/actions/changeCompartment",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "if-match",
"value": ""
}
],
"params": [
{
"name": "pipelineId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the pipeline."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource."
},
{
"info": {
"name": "Upload Artifact",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/pipelines/:pipelineId/steps/:stepName/artifact",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
},
{
"name": "content-length",
"value": ""
},
{
"name": "content-disposition",
"value": ""
}
],
"params": [
{
"name": "pipelineId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the pipeline."
},
{
"name": "stepName",
"value": "",
"type": "path",
"description": "Unique Step identifier in a pipeline."
}
]
},
"docs": "Upload the artifact for a step in the pipeline."
},
{
"info": {
"name": "Download Artifact",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/pipelines/:pipelineId/steps/:stepName/artifact/content",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "range",
"value": ""
}
],
"params": [
{
"name": "pipelineId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the pipeline."
},
{
"name": "stepName",
"value": "",
"type": "path",
"description": "Unique Step identifier in a pipeline."
}
]
},
"docs": "Download the artifact for a step in the pipeline."
},
{
"info": {
"name": "HeadStepArtifact",
"type": "http"
},
"http": {
"method": "HEAD",
"url": "https://$SWAGGER_HOST_URL/20190101/pipelines/:pipelineId/steps/:stepName/artifact/content",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "pipelineId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the pipeline."
},
{
"name": "stepName",
"value": "",
"type": "path",
"description": "Unique Step identifier in a pipeline."
}
]
},
"docs": "Get the artifact metadata for a step in the pipeline."
},
{
"info": {
"name": "ListProjects",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/projects",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "compartmentId",
"value": "",
"type": "query",
"description": "Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
},
{
"name": "id",
"value": "",
"type": "query",
"description": "Filter results by [OCID](/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type.\n"
},
{
"name": "displayName",
"value": "",
"type": "query",
"description": "Filter results by its user-friendly name."
},
{
"name": "lifecycleState",
"value": "",
"type": "query",
"description": "Filter results by the specified lifecycle state. Must be a valid\nstate for the resource type.\n"
},
{
"name": "createdBy",
"value": "",
"type": "query",
"description": "Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the user who created the resource."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 100 is the maximum.\nSee [List Pagination](/iaas/Content/General/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\nheader from the previous \"List\" call.\n\nSee [List Pagination](/iaas/Content/General/Concepts/usingapi.htm#nine).\n"
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).\n"
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field.\nBy default, when you sort by `timeCreated`, the results are shown\nin descending order. When you sort by `displayName`, the results are\nshown in ascending order. Sort order for the `displayName` field is case sensitive.\n"
}
]
},
"docs": "Lists projects in the specified compartment."
},
{
"info": {
"name": "CreateProject",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/projects",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a new project."
},
{
"info": {
"name": "GetProject",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/projects/:projectId",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project."
}
]
},
"docs": "Gets the specified project's information."
},
{
"info": {
"name": "UpdateProject",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://$SWAGGER_HOST_URL/20190101/projects/:projectId",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates the properties of a project. You can update the `displayName`, `description`, `freeformTags`, and `definedTags` properties."
},
{
"info": {
"name": "DeleteProject",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://$SWAGGER_HOST_URL/20190101/projects/:projectId",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project."
}
]
},
"docs": "Deletes the specified project. This operation fails unless all associated resources (notebook sessions or models) are in a DELETED state. You must delete all associated resources before deleting a project."
},
{
"info": {
"name": "ChangeProjectCompartment",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/projects/:projectId/actions/changeCompartment",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"params": [
{
"name": "projectId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Moves a project resource into a different compartment."
},
{
"info": {
"name": "Gets a list of all Schedules in a compartment",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/schedules",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "compartmentId",
"value": "",
"type": "query",
"description": "Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
},
{
"name": "projectId",
"value": "",
"type": "query",
"description": "Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the project."
},
{
"name": "lifecycleState",
"value": "",
"type": "query",
"description": "A filter to return only resources their lifecycleState matches the given lifecycleState."
},
{
"name": "displayName",
"value": "",
"type": "query",
"description": "Filter results by its user-friendly name."
},
{
"name": "id",
"value": "",
"type": "query",
"description": "unique Schedule identifier"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 100 is the maximum.\nSee [List Pagination](/iaas/Content/General/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\nheader from the previous \"List\" call.\n\nSee [List Pagination](/iaas/Content/General/Concepts/usingapi.htm#nine).\n"
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).\n"
},
{
"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"
}
]
},
"docs": "Returns a list of Schedules.\n"
},
{
"info": {
"name": "Creates a new Schedule",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/schedules",
"headers": [
{
"name": "opc-retry-token",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a new Schedule.\n"
},
{
"info": {
"name": "Get Schedule",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/schedules/:scheduleId",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "scheduleId",
"value": "",
"type": "path",
"description": "unique Schedule identifier"
}
]
},
"docs": "Gets a Schedule by identifier"
},
{
"info": {
"name": "Update the Schedule identified by the id",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://$SWAGGER_HOST_URL/20190101/schedules/:scheduleId",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "scheduleId",
"value": "",
"type": "path",
"description": "unique Schedule identifier"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates the Schedule"
},
{
"info": {
"name": "Delete a provisioned Schedule",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://$SWAGGER_HOST_URL/20190101/schedules/:scheduleId",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "scheduleId",
"value": "",
"type": "path",
"description": "unique Schedule identifier"
}
]
},
"docs": "Deletes a Schedule resource by identifier"
},
{
"info": {
"name": "Activate schedule",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/schedules/:scheduleId/actions/activate",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "if-match",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"params": [
{
"name": "scheduleId",
"value": "",
"type": "path",
"description": "unique Schedule identifier"
}
]
},
"docs": "Activate schedule."
},
{
"info": {
"name": "Moves a resource into a different compartment.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/schedules/:scheduleId/actions/changeCompartment",
"headers": [
{
"name": "opc-retry-token",
"value": ""
},
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "scheduleId",
"value": "",
"type": "path",
"description": "unique Schedule identifier"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Moves a Schedule resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource."
},
{
"info": {
"name": "Deactivate schedule",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://$SWAGGER_HOST_URL/20190101/schedules/:scheduleId/actions/deactivate",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "if-match",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"params": [
{
"name": "scheduleId",
"value": "",
"type": "path",
"description": "unique Schedule identifier"
}
]
},
"docs": "Deactivate schedule."
},
{
"info": {
"name": "ListWorkRequests",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/workRequests",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "compartmentId",
"value": "",
"type": "query",
"description": "Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
},
{
"name": "id",
"value": "",
"type": "query",
"description": "Filter results by [OCID](/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type.\n"
},
{
"name": "resourceId",
"value": "",
"type": "query",
"description": "Filter results by the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource associated with the work request."
},
{
"name": "operationType",
"value": "",
"type": "query",
"description": "Filter results by the type of the operation associated with the work request."
},
{
"name": "status",
"value": "",
"type": "query",
"description": "Filter results by work request status."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 100 is the maximum.\nSee [List Pagination](/iaas/Content/General/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\nheader from the previous \"List\" call.\n\nSee [List Pagination](/iaas/Content/General/Concepts/usingapi.htm#nine).\n"
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).\n"
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, the results are shown in descending order. All other fields default to ascending order.\n"
}
]
},
"docs": "Lists work requests in the specified compartment."
},
{
"info": {
"name": "GetWorkRequest",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/workRequests/:workRequestId",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workRequestId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request."
}
]
},
"docs": "Gets the specified work request's information."
},
{
"info": {
"name": "CancelWorkRequest",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://$SWAGGER_HOST_URL/20190101/workRequests/:workRequestId",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workRequestId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request."
}
]
},
"docs": "Cancels a work request that has not started."
},
{
"info": {
"name": "ListWorkRequestErrors",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/workRequests/:workRequestId/errors",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workRequestId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 100 is the maximum.\nSee [List Pagination](/iaas/Content/General/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\nheader from the previous \"List\" call.\n\nSee [List Pagination](/iaas/Content/General/Concepts/usingapi.htm#nine).\n"
}
]
},
"docs": "Lists work request errors for the specified work request."
},
{
"info": {
"name": "ListWorkRequestLogs",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://$SWAGGER_HOST_URL/20190101/workRequests/:workRequestId/logs",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workRequestId",
"value": "",
"type": "path",
"description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 100 is the maximum.\nSee [List Pagination](/iaas/Content/General/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\nheader from the previous \"List\" call.\n\nSee [List Pagination](/iaas/Content/General/Concepts/usingapi.htm#nine).\n"
}
]
},
"docs": "Lists work request logs for the specified work request."
}
]
}
],
"bundled": true
}