openapi: 3.2.0 info: description: Use Data Labeling API to create Annotations on Images, Texts & Documents, and generate snapshots. title: Data Labeling API version: '20211001' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/1392e537ef1367fd9356a9545e4dc5a6053ea0441d31c576d53322e1c864e260.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Data Labeling API OCI service and stored verbatim; API Evangelist added only this provenance block. x-evidence: - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json what: Oracle's own index of every OCI service specification - url: https://docs.oracle.com/en-us/iaas/api/specs/1392e537ef1367fd9356a9545e4dc5a6053ea0441d31c576d53322e1c864e260.yaml what: the harvested document for Data Labeling API servers: - url: http://127.0.0.1/20211001 - url: https://127.0.0.1/20211001 tags: - name: dataLabeling paths: /annotationAnalytics: get: description: 'Summarize the annotations created for a given dataset. ' operationId: SummarizeAnnotationAnalytics parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DatasetIdQueryParam' - $ref: '#/components/parameters/AnnotationLifecycleStateQueryParam' - $ref: '#/components/parameters/LabelQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/AnnotationAggregationSortByQueryParam' - $ref: '#/components/parameters/AnnotationGroupByParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The collection of annotation aggregations. headers: opc-next-page: description: 'For the pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AnnotationAnalyticsAggregationCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Summarize annotations created for a given dataset. tags: - dataLabeling x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/AnnotationAnalyticsAggregationCollection' /annotations: get: description: 'Returns a list of annotations. ' operationId: ListAnnotations parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/AnnotationLifecycleStateQueryParam' - $ref: '#/components/parameters/OcidQueryParam' - $ref: '#/components/parameters/DatasetIdQueryParam' - $ref: '#/components/parameters/UpdatedByQueryParam' - $ref: '#/components/parameters/RecordIdQueryParam' - $ref: '#/components/parameters/TimeCreatedGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeCreatedLessThanOrEqualToQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/AnnotationSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of annotation summary objects. headers: opc-next-page: description: 'For the pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AnnotationCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List annotations in the specified compartment. These query parameters may not be combined. tags: - dataLabeling x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/AnnotationCollection' post: description: 'Creates an annotation. ' operationId: CreateAnnotation parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The annotation is created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Annotation' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Create an annotation. tags: - dataLabeling x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Annotation' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateAnnotationDetails' description: Details for the new CreateAnnotation. required: true /annotations/{annotationId}: delete: description: 'It deletes an annotation resource by identifier. ' operationId: DeleteAnnotation parameters: - $ref: '#/components/parameters/AnnotationIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The annotation is deleted. headers: opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete an Annotation tags: - dataLabeling x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Annotation' get: description: 'Gets an annotation. ' operationId: GetAnnotation parameters: - $ref: '#/components/parameters/AnnotationIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: An annotation Object. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Annotation' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get an annotation. tags: - dataLabeling x-obmcs-client-retries-enabled: true put: description: 'Updates an annotation. ' operationId: UpdateAnnotation parameters: - $ref: '#/components/parameters/AnnotationIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The annotation is updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Annotation' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update an annotation. tags: - dataLabeling x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Annotation' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAnnotationDetails' description: The information to be updated. required: true /datasets/{datasetId}: get: description: Gets a dataset by identifier. operationId: GetDataset parameters: - $ref: '#/components/parameters/DatasetIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the Dataset with the given ID. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Dataset' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get a dataset. tags: - dataLabeling x-obmcs-client-retries-enabled: true /recordAnalytics: get: description: 'Summarize the records created for a given dataset. ' operationId: SummarizeRecordAnalytics parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/RecordLifecycleStateQueryParam' - $ref: '#/components/parameters/DatasetIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RecordGroupByQueryParam' - $ref: '#/components/parameters/RecordAggregationSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The collection of record aggregations. headers: opc-next-page: description: 'For the pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/RecordAnalyticsAggregationCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Summarize records created for a given dataset. tags: - dataLabeling x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/RecordAnalyticsAggregationCollection' /records: get: description: 'The list of records in the specified compartment. ' operationId: ListRecords parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/RecordLifecycleStateQueryParam' - $ref: '#/components/parameters/RecordNameQueryParam' - $ref: '#/components/parameters/OcidQueryParam' - $ref: '#/components/parameters/DatasetIdQueryParam' - $ref: '#/components/parameters/IsLabeledQueryParam' - $ref: '#/components/parameters/AnnotationLabelsContainsQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RecordSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of RecordSummary objects. headers: opc-next-page: description: 'For the pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/RecordCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List records in the specified compartment. tags: - dataLabeling x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/RecordCollection' post: description: 'Creates a record. ' operationId: CreateRecord parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The record is created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Record' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Create a record tags: - dataLabeling x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Record' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateRecordDetails' description: The details for the new record. required: true /records/{recordId}: delete: description: 'Deletes a record resource by identifier. ' operationId: DeleteRecord parameters: - $ref: '#/components/parameters/RecordIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The record is deleted. headers: opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a record. tags: - dataLabeling x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Record' get: description: 'Gets a record. ' operationId: GetRecord parameters: - $ref: '#/components/parameters/RecordIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The record object. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Record' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get a record. tags: - dataLabeling x-obmcs-client-retries-enabled: true put: description: 'Updates a record. ' operationId: UpdateRecord parameters: - $ref: '#/components/parameters/RecordIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The record is updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Record' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update a record. tags: - dataLabeling x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Record' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateRecordDetails' description: Information to be updated. required: true /records/{recordId}/content: get: description: 'Retrieves the content of the record from the dataset source. ' operationId: GetRecordContent parameters: - $ref: '#/components/parameters/RecordIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfNoneMatchHeader' responses: 200: description: The content of the record. headers: cache-control: description: 'Cache-control allows us to tell browsers to cache assets, how long to store them, and whether to validate them. ' schema: type: string content-disposition: description: The content disposition of the body, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 19.5.1. schema: type: string content-length: description: The content size of the body in bytes. schema: type: integer format: int64 content-type: description: The content type as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 14.17. schema: type: string etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/octet-stream: schema: format: binary type: string 304: $ref: '#/components/responses/304' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the content of the record. tags: - dataLabeling x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Record' /records/{recordId}/preview/content: get: description: 'Retrieves the preview of the record content from the dataset source. ' operationId: GetRecordPreviewContent parameters: - $ref: '#/components/parameters/RecordIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfNoneMatchHeader' responses: 200: description: A preview of the record content. headers: cache-control: description: 'Cache-control allows us to tell browsers to cache assets, how long to store them, and whether to validate them. ' schema: type: string content-disposition: description: The content disposition of the body, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 19.5.1. schema: type: string content-length: description: The content size of the body in bytes. schema: type: integer format: int64 content-type: description: The content type as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 14.17. schema: type: string etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/octet-stream: schema: format: binary type: string 304: $ref: '#/components/responses/304' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the preview of the record content. tags: - dataLabeling x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Record' components: schemas: LabelName: description: It represents a label. properties: name: description: An unique name for a label within its dataset. maxLength: 255 type: string type: object RecordMetadata: description: 'Collection of record''s metadata. This can be, for example, the height, width or depth of image for an image record. ' discriminator: propertyName: recordType properties: recordType: description: 'The record type based on dataset format details. IMAGE_METADATA - Collection of metadata related to image record. TEXT_METADATA - Collection of metadata related to text record. DOCUMENT_METADATA - Collection of metadata related to document record. ' enum: - IMAGE_METADATA - TEXT_METADATA - DOCUMENT_METADATA type: string type: object SourceDetails: description: 'The source information is a polymorphic entity. It captures the details of data used for record creation. The discriminator type must match the dataset''s source type. The convention is enforced by the API. ' discriminator: propertyName: sourceType properties: sourceType: description: 'The type of data source. OBJECT_STORAGE - The source details for an object storage bucket. ' enum: - OBJECT_STORAGE type: string required: - sourceType type: object Error: description: Error Information. properties: code: description: A short error code that defines the error. It is for programmatic parsing. type: string message: description: A human-readable error string. type: string required: - code - message AnnotationAnalyticsAggregationCollection: description: Aggregation entities are required by the API consistency guidelines for API Consistency Guidelines#AnalyticsAPIs. These are used to summarize annotations for a given dataset and will be used to populate UI elements. Aggregations need to have the fields that identify the exact scope that they're summarizing. Any filters applied to the list API, have to show up in the aggregation. properties: items: description: The list of annotation entities. items: $ref: '#/components/schemas/AnnotationAnalyticsAggregation' type: array required: - items type: object RecordAggregationDimensions: description: The dimensions to summarize record information for a given dataset. properties: annotationLabelContains: description: Whether or not the annotation contains a label. type: string isLabeled: description: Whether or not the record has been labeled and has associated annotations. type: boolean type: object AnnotationCollection: description: The results of an annotations search. It contains AnnotationSummary items and other information, such as metadata. properties: items: description: The list of annotations. items: $ref: '#/components/schemas/AnnotationSummary' type: array required: - items type: object CreateAnnotationDetails: description: This is the payload sent in the CreateAnnotation operation. It contains all the information required for a user to create an annotation for a record. properties: compartmentId: description: The OCID of the compartment for the annotation. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing predefined tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'The defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object entities: description: The entity types are validated against the dataset to ensure consistency. items: $ref: '#/components/schemas/Entity' maxItems: 4000 minItems: 1 type: array freeformTags: additionalProperties: type: string description: 'A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}` ' type: object recordId: description: The OCID of the record annotated. maxLength: 255 minLength: 1 type: string required: - recordId - compartmentId - entities type: object UpdateAnnotationDetails: description: This is the payload sent in the CreateAnnotation operation. It contains all the information required for a user to create an annotation for a record. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing predefined tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'The defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object entities: description: The entity types are validated against the dataset to ensure consistency. items: $ref: '#/components/schemas/Entity' maxItems: 4000 minItems: 1 type: array freeformTags: additionalProperties: type: string description: 'A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}` ' type: object type: object Entity: description: 'An entity allows the labeler to identify an object in the record to label. This can be, for example, a snippet of text, an entire image, or a bounding box within an image. All entity types have an array of labels that are indexed. If more than one label is provided, but the annotationType on the corresponding dataset is for a single class, the API rejects the create annotation request. ' discriminator: propertyName: entityType properties: entityType: description: 'The entity type described in the annotation. GENERIC - An extensible entity type that is the base entity type for some annotation formats. IMAGEOBJECTSELECTION- - This allows the labeler to use specify a bounding polygon on the image to represent an object and apply labels to it. TEXTSELECTION - This allows the labeler to highlight text, by specifying an offset and a length, and apply labels to it. ' enum: - GENERIC - IMAGEOBJECTSELECTION - TEXTSELECTION type: string required: - entityType type: object UpdateRecordDetails: description: The details of the tags that is updated. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing predefined tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'The defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}` ' type: object recordMetadata: $ref: '#/components/schemas/RecordMetadata' type: object RecordSummary: description: A record summary is the representation returned in list views. It is usually a subset of the full record entity and should not contain any potentially sensitive information. properties: compartmentId: description: The OCID of the compartment for the task. maxLength: 255 minLength: 1 type: string datasetId: description: The OCID of the dataset to associate the record with. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing predefined tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'The defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}` ' type: object id: description: The OCID of the record. maxLength: 255 minLength: 1 type: string isLabeled: description: Whether or not the record has been labeled and has associated annotations. type: boolean lifecycleState: description: Describes the lifecycle state. type: string x-obmcs-enumref: '#/definitions/Record/lifecycleState' name: description: The name is automatically assigned by the service. It is unique and immutable maxLength: 255 minLength: 1 type: string timeCreated: description: The date and time the resource was created, in the timestamp format defined by RFC3339. format: date-time type: string timeUpdated: description: The date and time the resource was updated, in the timestamp format defined by RFC3339. format: date-time type: string required: - id - name - timeCreated - timeUpdated - datasetId - compartmentId - isLabeled - lifecycleState type: object AnnotationAggregationDimensions: description: The dimensions to summarize annotations for a given dataset. properties: label: $ref: '#/components/schemas/Label' updatedBy: description: The OCID of the principal which updated the resource. maxLength: 255 minLength: 1 type: string type: object Label: description: A label is a string value. The API validates that it's one of the dataset's pre-defined labels. properties: label: description: The label provided by the annotator. maxLength: 255 minLength: 1 type: string required: - label type: object AnnotationAnalyticsAggregation: description: Aggregation entities are required by the API consistency guidelines for API Consistency Guidelines#AnalyticsAPIs. These are used to summarize annotations for a given dataset and will be used to populate UI elements. Aggregations need to have the fields that identify the exact scope that they're summarizing. Any filters applied to the list API, have to show up in the aggregation. properties: compartmentId: description: The OCID of the compartment containing the annotations. maxLength: 255 minLength: 1 type: string count: description: The count of the matching results. format: integer minimum: 0 type: number datasetId: description: The OCID of the dataset the annotations belong to. maxLength: 255 minLength: 1 type: string dimensions: $ref: '#/components/schemas/AnnotationAggregationDimensions' lifecycleState: description: Describes the lifecycle state. type: string x-obmcs-enumref: '#/definitions/Annotation/lifecycleState' updatedBy: description: The OCID of the principal which updated the annotation. maxLength: 255 type: string required: - count - datasetId - compartmentId type: object CreateSourceDetails: description: 'The source information is a polymorphic entity. It captures the details of how to access the data for record creation. The discriminator type must match the dataset''s source type. The convention will be enforced by the API. It should only provide the difference in data necessary to access the content, i.e. the object storage path, or the database record id. ' discriminator: propertyName: sourceType properties: sourceType: description: 'The type of data source. OBJECT_STORAGE - The source details for an object storage bucket. ' enum: - OBJECT_STORAGE type: string required: - sourceType type: object Record: description: A record represents an entry in a dataset that needs labeling. properties: compartmentId: description: The OCID of the compartment for the task. maxLength: 255 minLength: 1 type: string datasetId: description: The OCID of the dataset to associate the record with. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing predefined tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'The defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}` ' type: object id: description: The OCID of the record. maxLength: 255 minLength: 1 type: string isLabeled: description: Whether or not the record has been labeled and has associated annotations. type: boolean lifecycleState: description: 'The lifecycle state of the record. ACTIVE - The record is active and ready for labeling. INACTIVE - The record has been marked as inactive and should not be used for labeling. DELETED - The record has been deleted and is no longer available for labeling. ' enum: - ACTIVE - INACTIVE - DELETED type: string name: description: The name is created by the user. It is unique and immutable. maxLength: 255 minLength: 1 type: string recordMetadata: $ref: '#/components/schemas/RecordMetadata' sourceDetails: $ref: '#/components/schemas/SourceDetails' timeCreated: description: The date and time the resource was created, in the timestamp format defined by RFC3339. format: date-time type: string timeUpdated: description: The date and time the resource was updated, in the timestamp format defined by RFC3339. format: date-time type: string required: - id - name - timeCreated - timeUpdated - datasetId - compartmentId - sourceDetails - isLabeled - lifecycleState type: object AnnotationSummary: description: An annotation summary is the representation returned in list views. It is usually a subset of the full annotation entity and should not contain any potentially sensitive information. properties: compartmentId: description: The OCID of the compartment for the annotation. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing predefined tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'The defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}` ' type: object id: description: The OCID of the annotation. maxLength: 255 minLength: 1 type: string lifecycleState: description: Describes the lifecycle state. type: string x-obmcs-enumref: '#/definitions/Annotation/lifecycleState' recordId: description: The OCID of the record annotated. maxLength: 255 minLength: 1 type: string timeCreated: description: The date and time the annotation was created, in the timestamp format defined by RFC3339. format: date-time type: string timeUpdated: description: The date and time the resource was updated, in the timestamp format defined by RFC3339. format: date-time type: string required: - id - timeCreated - timeUpdated - recordId - compartmentId - lifecycleState type: object LabelSet: description: 'An ordered collection of labels that are unique by name. ' properties: items: description: An ordered collection of labels that are unique by name. items: $ref: '#/components/schemas/LabelName' maxItems: 250 minItems: 0 type: array type: object RecordAnalyticsAggregation: description: Aggregation entities are required by the API consistency guidelines for API Consistency Guidelines#AnalyticsAPIs. These are used to summarize record information for a given dataset and are used to populate UI elements. Aggregations need to have the fields that identify the exact scope that they're summarizing. Any filters applied to the list API, have to show up in the aggregation. properties: compartmentId: description: ocid of the compartment the records maxLength: 255 minLength: 1 type: string count: description: the count of the matching results format: integer minimum: 0 type: number datasetId: description: ocid of the dataset the annotation belongs to maxLength: 255 minLength: 1 type: string dimensions: $ref: '#/components/schemas/RecordAggregationDimensions' lifecycleState: description: Describes the lifecycle state. type: string x-obmcs-enumref: '#/definitions/Record/lifecycleState' required: - count - datasetId - compartmentId type: object RecordCollection: description: The results of a record search. It contains RecordSummary items and other data. properties: items: description: The list of records. items: $ref: '#/components/schemas/RecordSummary' type: array required: - items type: object CreateRecordDetails: description: A record represents an entry in a dataset that needs labeling. properties: compartmentId: description: The OCID of the compartment for the record. This is tied to the dataset. It is not changeable on the record itself. maxLength: 255 minLength: 1 type: string datasetId: description: The OCID of the dataset to associate the record with. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing predefined tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'The defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}` ' type: object name: description: The name is automatically assigned by the service. It is unique and immutable. maxLength: 255 minLength: 1 type: string recordMetadata: $ref: '#/components/schemas/RecordMetadata' sourceDetails: $ref: '#/components/schemas/CreateSourceDetails' required: - name - datasetId - compartmentId - sourceDetails type: object InitialRecordGenerationConfiguration: description: The initial generate records configuration. It generates records from the dataset's source. properties: limit: description: The maximum number of records to generate. format: integer type: number type: object DatasetSourceDetails: description: This allows the customer to specify the source of the dataset. discriminator: propertyName: sourceType properties: sourceType: description: The source type. OBJECT_STORAGE allows the user to describe where in object storage the dataset is. enum: - OBJECT_STORAGE type: string required: - sourceType type: object DatasetFormatDetails: description: It specifies how to process the data. Supported formats include DOCUMENT, IMAGE, and TEXT. discriminator: propertyName: formatType properties: formatType: description: The format type. DOCUMENT format is for record contents that are PDFs or TIFFs. IMAGE format is for record contents that are JPEGs or PNGs. TEXT format is for record contents that are TXT files. enum: - DOCUMENT - IMAGE - TEXT type: string required: - formatType Annotation: description: An annotation represents a user- or machine-generated annotation for a given record. The details of the annotation are captured in the RecordAnnotationDetails. properties: compartmentId: description: The OCID of the compartment for the annotation. This is tied to the dataset. It is not changeable on the record itself. maxLength: 255 minLength: 1 type: string createdBy: description: The OCID of the principal which created the annotation. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing predefined tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'The defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object entities: description: The entity types are validated against the dataset to ensure consistency. items: $ref: '#/components/schemas/Entity' maxItems: 4000 minItems: 1 type: array freeformTags: additionalProperties: type: string description: 'A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}` ' type: object id: description: The OCID of the annotation. maxLength: 255 minLength: 1 type: string lifecycleState: description: 'The lifecycle state of an annotation. ACTIVE - The annotation is active to be used for labeling. INACTIVE - The annotation has been marked as inactive and should not be used for labeling. DELETED - Tha annotation been deleted and no longer available for labeling. ' enum: - ACTIVE - INACTIVE - DELETED type: string recordId: description: The OCID of the record annotated. maxLength: 255 minLength: 1 type: string timeCreated: description: The date and time the annotation was created, in the timestamp format defined by RFC3339. format: date-time type: string timeUpdated: description: The date and time the resource was updated, in the timestamp format defined by RFC3339. format: date-time type: string updatedBy: description: The OCID of the principal which updated the annotation. maxLength: 255 minLength: 1 type: string required: - id - timeCreated - timeUpdated - createdBy - updatedBy - recordId - entities - compartmentId - lifecycleState type: object Dataset: description: 'A dataset is a logical collection of records. The dataset contains all the information necessary to describe a record''s source, format, the type of annotations allowed for the record, and the labels allowed on annotations. ' properties: annotationFormat: description: The annotation format name required for labeling records. maxLength: 255 minLength: 1 type: string compartmentId: description: The OCID of the compartment of the resource. maxLength: 255 minLength: 1 type: string datasetFormatDetails: $ref: '#/components/schemas/DatasetFormatDetails' datasetSourceDetails: $ref: '#/components/schemas/DatasetSourceDetails' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing predefined tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'The defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: A user provided description of the dataset maxLength: 1024 type: string displayName: description: A user-friendly display name for the resource. maxLength: 255 type: string freeformTags: additionalProperties: type: string description: 'A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}` ' type: object id: description: The OCID of the Dataset. maxLength: 255 minLength: 1 type: string initialRecordGenerationConfiguration: $ref: '#/components/schemas/InitialRecordGenerationConfiguration' labelSet: $ref: '#/components/schemas/LabelSet' labelingInstructions: description: The labeling instructions for human labelers in rich text format maxLength: 32767 minLength: 0 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in FAILED or NEEDS_ATTENTION state. type: string lifecycleState: description: 'The state of a dataset. CREATING - The dataset is being created. It will transition to ACTIVE when it is ready for labeling. ACTIVE - The dataset is ready for labeling. UPDATING - The dataset is being updated. It and its related resources may be unavailable for other updates until it returns to ACTIVE. NEEDS_ATTENTION - A dataset updation operation has failed due to validation or other errors and needs attention. DELETING - The dataset and its related resources are being deleted. DELETED - The dataset has been deleted and is no longer available. FAILED - The dataset has failed due to validation or other errors. ' enum: - CREATING - UPDATING - ACTIVE - NEEDS_ATTENTION - DELETING - DELETED - FAILED type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing the system tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'The usage of system tag keys. These predefined keys are scoped to namespaces. For example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The date and time the resource was created, in the timestamp format defined by RFC3339. format: date-time type: string timeUpdated: description: The date and time the resource was last updated, in the timestamp format defined by RFC3339. format: date-time type: string required: - id - compartmentId - timeCreated - timeUpdated - lifecycleState - annotationFormat - datasetSourceDetails - datasetFormatDetails - labelSet type: object RecordAnalyticsAggregationCollection: description: Collection of records aggregated. properties: items: description: The list of record entities. items: $ref: '#/components/schemas/RecordAnalyticsAggregation' type: array required: - items type: object parameters: RecordIdentifierPathParam: description: The OCID of the record annotated. in: path name: recordId required: true schema: type: string maxLength: 255 PaginationTokenQueryParam: description: The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. in: query name: page x-default-description: 'null' schema: type: string minLength: 1 RecordSortByQueryParam: 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. ' in: query name: sortBy schema: type: string enum: - timeCreated - name default: timeCreated AnnotationAggregationSortByQueryParam: 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. in: query name: sortBy schema: type: string enum: - count - label - updatedBy default: updatedBy IfNoneMatchHeader: description: 'For optimistic concurrency control. In the GET call for a resource, set the `if-none-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be fetched only if the etag you provide does not match the resource''s current etag value. ' in: header name: if-none-match required: false x-default-description: 'null' schema: type: string RecordGroupByQueryParam: description: 'The field to group by. If no value is specified isLabeled is used by default. ' in: query name: recordGroupBy schema: type: string enum: - isLabeled - annotationLabelContains default: isLabeled DatasetIdPathParam: description: A unique dataset OCID. in: path name: datasetId required: true schema: type: string maxLength: 255 minLength: 1 IfMatchHeader: description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource''s current etag value. ' in: header name: if-match required: false x-default-description: 'null' schema: type: string TimeCreatedGreaterThanOrEqualToQueryParam: description: 'The date and time the resource was created, in the timestamp format defined by RFC3339. ' in: query name: timeCreatedGreaterThanOrEqualTo schema: type: string format: date-time CompartmentIdQueryParam: description: The ID of the compartment in which to list resources. in: query name: compartmentId required: true schema: type: string maxLength: 255 RecordAggregationSortByQueryParam: 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. in: query name: sortBy schema: type: string enum: - count - isLabeled default: count AnnotationIdentifierPathParam: description: A unique annotation identifier. in: path name: annotationId required: true schema: type: string AnnotationGroupByParam: description: The field to group by. If no value is specified, updatedBy is used by default. in: query name: annotationGroupBy schema: type: string enum: - updatedBy - label default: updatedBy RecordLifecycleStateQueryParam: description: A filter to return only resources whose lifecycleState matches the given lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/Record/lifecycleState' schema: type: string PaginationLimitQueryParam: description: The maximum number of items to return. in: query name: limit schema: type: integer default: 10 maximum: 1000 minimum: 1 SortOrderQueryParam: description: The sort order to use, either 'asc' or 'desc'. in: query name: sortOrder x-obmcs-top-level-enum: '#/definitions/SortOrders' schema: type: string enum: - ASC - DESC default: ASC RecordIdQueryParam: description: The OCID of the record annotated. in: query name: recordId required: false x-default-description: 'null' schema: type: string maxLength: 255 AnnotationSortByQueryParam: 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. in: query name: sortBy schema: type: string enum: - timeCreated - label default: timeCreated AnnotationLifecycleStateQueryParam: description: A filter to return only resources whose lifecycleState matches the given lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/Annotation/lifecycleState' schema: type: string LabelQueryParam: description: It summarizes annotations with the specified label. in: query name: label required: false x-default-description: 'null' schema: type: string RetryTokenHeader: description: 'A token that uniquely identifies a request so it can be retried, without risk of executing that same action again, if there is a timeout or server error. Retry tokens expire after 24 hours, but can be invalidated before then if there are conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. ' in: header name: opc-retry-token required: false x-default-description: 'null' schema: type: string maxLength: 64 minLength: 1 IsLabeledQueryParam: description: Whether the record has been labeled and has associated annotations. in: query name: isLabeled required: false x-default-description: 'null' schema: type: boolean UpdatedByQueryParam: description: The OCID of the principal which updated the annotation. in: query name: updatedBy required: false x-default-description: 'null' schema: type: string RequestIdHeader: description: The client request ID for tracing. in: header name: opc-request-id schema: type: string RecordNameQueryParam: description: The name of the record. in: query name: name required: false x-default-description: 'null' schema: type: string maxLength: 255 AnnotationLabelsContainsQueryParam: description: 'Lets the user filter records based on the related annotations. ' in: query name: annotationLabelsContains x-default-description: 'null' style: form explode: true schema: type: array items: type: string TimeCreatedLessThanOrEqualToQueryParam: description: 'The date and time the resource was created, in the timestamp format defined by RFC3339. ' in: query name: timeCreatedLessThanOrEqualTo schema: type: string format: date-time DatasetIdQueryParam: description: Filter the results by the OCID of the dataset. in: query name: datasetId required: true schema: type: string maxLength: 255 OcidQueryParam: description: The unique OCID identifier. in: query name: id schema: type: string maxLength: 255 responses: default: description: Unknown Error headers: opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' x-anchors: x-headers: cache-control: description: 'Cache-control allows us to tell browsers to cache assets, how long to store them, and whether to validate them. ' type: string content-disposition: description: The content disposition of the body, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 19.5.1. type: string content-length: description: The content size of the body in bytes. format: int64 type: integer content-type: description: The content type as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 14.17. type: string etag: description: 'For optimistic concurrency control. See `if-match`. ' type: string opc-next-page: description: 'For the pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' type: string opc-request-id: description: 'A unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string opc-work-request-id: description: 'A unique Oracle-assigned identifier for the asynchronous request. You can use this to query the status of the asynchronous operation. ' type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. type: integer x-properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing predefined tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'The defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object existingTags: downstream.invoke('dls-data-plane-api','GetRecord',request.resourceId).freeformTags.'.splatAuthorizedTagSlug' extendedMetadata: additionalProperties: type: string description: 'A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}` ' type: object freeformTags: additionalProperties: type: string description: 'A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}` ' type: object getDatasetAuthorizationExpression: resources['dataset']?.grantedPermissions?.contains('DATA_LABELING_DATASET_READ') || (request.getPrincipalClaim(request.principal, 'svc') == 'datalabeling' && splat.getTenant(downstream.invoke('dls-data-plane-api', 'GetDataset', request.resourceId).compartmentId)?.propertyMap?.is_deleted_tenant == 'true') getDatasetSkipAuthorizationExpression: request.getPrincipalClaim(request.principal, 'svc') == 'datalabeling' && splat.getTenant(downstream.invoke('dls-data-plane-api', 'GetDataset', request.resourceId).compartmentId)?.propertyMap?.is_deleted_tenant == 'true' listRecordAuthorizationExpression: resources['record']?.grantedPermissions?.contains('DATA_LABELING_RECORD_INSPECT') || (request.getPrincipalClaim(request.principal, 'svc') == 'datalabeling' && splat.getTenant(request.parameter.compartmentId)?.propertyMap?.is_deleted_tenant == 'true') listRecordSkipAuthorizationExpression: request.getPrincipalClaim(request.principal, 'svc') == 'datalabeling' && splat.getTenant(request.parameter.compartmentId)?.propertyMap?.is_deleted_tenant == 'true' resourceNameExpressionAnnotation: downstream.invoke('dls-data-plane-api', 'GetAnnotation', request.resourceId).displayName resourceNameExpressionRecord: downstream.invoke('dls-data-plane-api', 'GetRecord', request.resourceId).name serviceList: - dls-data-plane-api systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'A key-value pair representing the system tags'' keys and values scoped to a namespace. For example: `{"bar-key": "value"}` ' type: object description: 'The usage of system tag keys. These predefined keys are scoped to namespaces. For example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object targetCompartmentIdDataset: downstream.invoke('dls-data-plane-api', 'GetDataset', request.resourceId).compartmentId targetCompartmentIdDatasetAnnotation: downstream.invoke('dls-data-plane-api', 'GetAnnotation', request.resourceId).compartmentId targetCompartmentIdRecord: downstream.invoke('dls-data-plane-api', 'GetRecord', request.resourceId).compartmentId x-oracle-package: com.oracle.dls.dp