{ "opencollection": "1.0.0", "info": { "name": "Data Labeling Management API", "version": "20211001" }, "items": [ { "info": { "name": "dataLabelingManagement", "type": "folder" }, "items": [ { "info": { "name": "Gets a list of all annotation formats available to the data labeling service.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20211001/annotationFormats", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." } ] }, "docs": "These are a static list in a given region." }, { "info": { "name": "Gets a list of all Datasets in a compartment", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20211001/datasets", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "id", "value": "", "type": "query", "description": "Unique Dataset OCID" }, { "name": "annotationFormat", "value": "", "type": "query", "description": "A filter to return only resources that match the entire annotation format given." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources whose lifecycleState matches this query param." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.\n" } ] }, "docs": "Returns a list of Datasets.\n" }, { "info": { "name": "Creates a new Dataset", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20211001/datasets", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Dataset.\n" }, { "info": { "name": "Get Dataset", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20211001/datasets/:datasetId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "datasetId", "value": "", "type": "path", "description": "Unique Dataset OCID" } ] }, "docs": "Gets a Dataset by identifier" }, { "info": { "name": "Update the Dataset identified by the id", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20211001/datasets/:datasetId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "datasetId", "value": "", "type": "path", "description": "Unique Dataset OCID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the Dataset" }, { "info": { "name": "Delete a provisioned Dataset", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20211001/datasets/:datasetId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "datasetId", "value": "", "type": "path", "description": "Unique Dataset OCID" } ] }, "docs": "Deletes a Dataset resource by identifier" }, { "info": { "name": "Add Labels to the Dataset LabelSet", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20211001/datasets/:datasetId/actions/addLabels", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "datasetId", "value": "", "type": "path", "description": "Unique Dataset OCID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add Labels to the Dataset LabelSet until the maximum number of Labels has been reached.\n" }, { "info": { "name": "Moves a resource into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20211001/datasets/:datasetId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "datasetId", "value": "", "type": "path", "description": "Unique Dataset OCID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a Dataset resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource." }, { "info": { "name": "Crawl data source and generate dataset records", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20211001/datasets/:datasetId/actions/generateDatasetRecords", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "datasetId", "value": "", "type": "path", "description": "Unique Dataset OCID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Generates Record resources from the Dataset's data source" }, { "info": { "name": "Remove Labels from the Dataset LabelSet", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20211001/datasets/:datasetId/actions/removeLabels", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "datasetId", "value": "", "type": "path", "description": "Unique Dataset OCID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removes the labels from the Dataset Labelset. Labels can only be removed if there are no Annotations associated with the Dataset that reference the Label names.\n" }, { "info": { "name": "Rename Labels in the Dataset LabelSet", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20211001/datasets/:datasetId/actions/renameLabels", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "datasetId", "value": "", "type": "path", "description": "Unique Dataset OCID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Renames the labels from the Dataset Labelset. Labels that are renamed will be reflected in Annotations associated with the Dataset that reference the Label names.\n" }, { "info": { "name": "Snapshot dataset to object storage.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20211001/datasets/:datasetId/actions/snapshot", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "datasetId", "value": "", "type": "path", "description": "Unique Dataset OCID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Writes the dataset records and annotations in a consolidated format out to an object storage reference for consumption.\nWhile the snapshot takes place, there may be a time while records and annotations cannot be created to ensure the snapshot is a point in time.\n" }, { "info": { "name": "List Work Requests", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20211001/workRequests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "workRequestId", "value": "", "type": "query", "description": "The ID of the asynchronous work request." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." } ] }, "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/20211001/workRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." } ] }, "docs": "Gets the status of the work request with the given ID." }, { "info": { "name": "Lists work request errors", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20211001/workRequests/:workRequestId/errors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." } ] }, "docs": "Return a (paginated) list of errors for a given work request.\n" }, { "info": { "name": "Lists work request logs", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20211001/workRequests/:workRequestId/logs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." } ] }, "docs": "Return a (paginated) list of logs for a given work request.\n" } ] } ], "bundled": true }