{ "opencollection": "1.0.0", "info": { "name": "Control Plane AI Data Platform API", "version": "20240831" }, "items": [ { "info": { "name": "AiDataPlatform", "type": "folder" }, "items": [ { "info": { "name": "List work requests", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20240831/workRequests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources." }, { "name": "workRequestId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request." }, { "name": "status", "value": "", "type": "query", "description": "A filter to return only the resources that match the given lifecycle state." }, { "name": "resourceId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource affected by the work request." }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for `timeAccepted` is descending.\n" } ] }, "docs": "Lists the work requests in a compartment.\n" }, { "info": { "name": "Get work request status", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20240831/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 asynchronous work request." } ] }, "docs": "Gets the details of a work request." }, { "info": { "name": "Cancel work request", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20240831/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 asynchronous work request." } ] }, "docs": "Cancels a work request." }, { "info": { "name": "List work request errors", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20240831/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 asynchronous work request." }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for `timestamp` is descending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." } ] }, "docs": "Lists the errors for a work request.\n" }, { "info": { "name": "List work request logs", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20240831/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 asynchronous work request." }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for `timestamp` is descending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." } ] }, "docs": "Lists the logs for a work request.\n" }, { "info": { "name": "Gets a list of AiDataPlatforms.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20240831/aiDataPlatforms", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state. The\nstate value is case-insensitive.\n" }, { "name": "excludeLifecycleState", "value": "", "type": "query", "description": "A filter to exclude resources that match the given lifecycle state. The\nstate value is case-insensitive.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly." }, { "name": "id", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the AiDataPlatform." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide only one sort order. Default order for `timeCreated`\nis descending. Default order for `displayName` is ascending.\n" }, { "name": "includeLegacy", "value": "", "type": "query", "description": "This flag will determine if legacy instances will be returned." } ] }, "docs": "Gets a list of AiDataPlatforms.\n" }, { "info": { "name": "Creates a AiDataPlatform.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20240831/aiDataPlatforms", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a AiDataPlatform.\n" }, { "info": { "name": "Get AiDataPlatform", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20240831/aiDataPlatforms/:aiDataPlatformId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "aiDataPlatformId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the AiDataPlatform." } ] }, "docs": "Gets information about a AiDataPlatform." }, { "info": { "name": "Updates a AiDataPlatform.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20240831/aiDataPlatforms/:aiDataPlatformId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "aiDataPlatformId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the AiDataPlatform." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a AiDataPlatform." }, { "info": { "name": "Deletes a AiDataPlatform.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20240831/aiDataPlatforms/:aiDataPlatformId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "aiDataPlatformId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the AiDataPlatform." }, { "name": "isForceDelete", "value": "", "type": "query", "description": "A flag to enable force deletion of the AiDataPlatform." } ] }, "docs": "Deletes a AiDataPlatform." }, { "info": { "name": "Moves a AiDataPlatform into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20240831/aiDataPlatforms/:aiDataPlatformId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "aiDataPlatformId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the AiDataPlatform." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a AiDataPlatform into a different compartment within the same tenancy. For information about moving resources between\ncompartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" } ] } ], "bundled": true }