{ "opencollection": "1.0.0", "info": { "name": "Data Labeling API", "version": "20211001" }, "items": [ { "info": { "name": "dataLabeling", "type": "folder" }, "items": [ { "info": { "name": "Summarize annotations created for a given dataset.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20211001/annotationAnalytics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "datasetId", "value": "", "type": "query", "description": "Filter the results by the OCID of the dataset." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources whose lifecycleState matches the given lifecycleState." }, { "name": "label", "value": "", "type": "query", "description": "It summarizes annotations with the specified label." }, { "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. The default order is descending. If no value is specified, updatedBy is used by default." }, { "name": "annotationGroupBy", "value": "", "type": "query", "description": "The field to group by. If no value is specified, updatedBy is used by default." } ] }, "docs": "Summarize the annotations created for a given dataset.\n" }, { "info": { "name": "List annotations in the specified compartment. These query parameters may not be combined.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20211001/annotations", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources whose lifecycleState matches the given lifecycleState." }, { "name": "id", "value": "", "type": "query", "description": "The unique OCID identifier." }, { "name": "datasetId", "value": "", "type": "query", "description": "Filter the results by the OCID of the dataset." }, { "name": "updatedBy", "value": "", "type": "query", "description": "The OCID of the principal which updated the annotation." }, { "name": "recordId", "value": "", "type": "query", "description": "The OCID of the record annotated." }, { "name": "timeCreatedGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The date and time the resource was created, in the timestamp format defined by RFC3339.\n" }, { "name": "timeCreatedLessThanOrEqualTo", "value": "", "type": "query", "description": "The date and time the resource was created, in the timestamp format defined by RFC3339.\n" }, { "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. The default order for timeCreated is descending. If no value is specified timeCreated is used by default." } ] }, "docs": "Returns a list of annotations.\n" }, { "info": { "name": "Create an annotation.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20211001/annotations", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an annotation.\n" }, { "info": { "name": "Get an annotation.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20211001/annotations/:annotationId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "annotationId", "value": "", "type": "path", "description": "A unique annotation identifier." } ] }, "docs": "Gets an annotation.\n" }, { "info": { "name": "Update an annotation.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20211001/annotations/:annotationId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "annotationId", "value": "", "type": "path", "description": "A unique annotation identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an annotation.\n" }, { "info": { "name": "Delete an Annotation", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20211001/annotations/:annotationId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "annotationId", "value": "", "type": "path", "description": "A unique annotation identifier." } ] }, "docs": "It deletes an annotation resource by identifier.\n" }, { "info": { "name": "Get a 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": "A unique dataset OCID." } ] }, "docs": "Gets a dataset by identifier." }, { "info": { "name": "Summarize records created for a given dataset.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20211001/recordAnalytics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources whose lifecycleState matches the given lifecycleState." }, { "name": "datasetId", "value": "", "type": "query", "description": "Filter the results by the OCID of the dataset." }, { "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": "recordGroupBy", "value": "", "type": "query", "description": "The field to group by. If no value is specified isLabeled is used by default.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. The default order is descending. If no value is specified, count is used by default." } ] }, "docs": "Summarize the records created for a given dataset.\n" }, { "info": { "name": "List records in the specified compartment.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20211001/records", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources whose lifecycleState matches the given lifecycleState." }, { "name": "name", "value": "", "type": "query", "description": "The name of the record." }, { "name": "id", "value": "", "type": "query", "description": "The unique OCID identifier." }, { "name": "datasetId", "value": "", "type": "query", "description": "Filter the results by the OCID of the dataset." }, { "name": "isLabeled", "value": "", "type": "query", "description": "Whether the record has been labeled and has associated annotations." }, { "name": "annotationLabelsContains", "value": "", "type": "query", "description": "Lets the user filter records based on the related annotations.\n" }, { "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. The default order for timeCreated is descending. The default order for name is ascending. If no value is specified, timeCreated is used by default.\n" } ] }, "docs": "The list of records in the specified compartment.\n" }, { "info": { "name": "Create a record", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20211001/records", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a record.\n" }, { "info": { "name": "Get a record.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20211001/records/:recordId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "recordId", "value": "", "type": "path", "description": "The OCID of the record annotated." } ] }, "docs": "Gets a record.\n" }, { "info": { "name": "Update a record.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20211001/records/:recordId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "recordId", "value": "", "type": "path", "description": "The OCID of the record annotated." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a record.\n" }, { "info": { "name": "Delete a record.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20211001/records/:recordId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "recordId", "value": "", "type": "path", "description": "The OCID of the record annotated." } ] }, "docs": "Deletes a record resource by identifier.\n" }, { "info": { "name": "Gets the content of the record.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20211001/records/:recordId/content", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-none-match", "value": "" } ], "params": [ { "name": "recordId", "value": "", "type": "path", "description": "The OCID of the record annotated." } ] }, "docs": "Retrieves the content of the record from the dataset source.\n" }, { "info": { "name": "Gets the preview of the record content.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20211001/records/:recordId/preview/content", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-none-match", "value": "" } ], "params": [ { "name": "recordId", "value": "", "type": "path", "description": "The OCID of the record annotated." } ] }, "docs": "Retrieves the preview of the record content from the dataset source.\n" } ] } ], "bundled": true }