Jump to

• Request
• Response

Get a list of recipients specific to a Delta Share

get

/20260430/aiDataPlatforms/{aiDataPlatformId}/shares/{shareKey}/recipients

Gets a list of recipients that have been given access on the specified Delta Share.

Request

Path Parameters

• aiDataPlatformId(required): string
  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the AI Data Platform (Data Lake) instance.
• shareKey(required): string
  Minimum Length: 1

  Maximum Length: 255

  The unique key of the Share.

Query Parameters

• displayName: string
  Minimum Length: 1

  Maximum Length: 255

  A filter to return only resources that match the given display name exactly.
• limit: integer
  Minimum Value: 1

  Maximum Value: 1000

  For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

  Default Value: 100
• page: string
  Minimum Length: 1

  For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
• sortBy: string
  The field to sort by. You can provide only one sort order. Default order for `timeCreated` is descending. Default order for `displayName` is ascending.

  Default Value: timeCreated

  Allowed Values: [ "timeCreated", "displayName" ]
• sortOrder: string
  The sort order to use, either ascending (`ASC`) or descending (`DESC`).

  Allowed Values: [ "ASC", "DESC" ]

Header Parameters

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.
• should-update-recent: boolean
  A flag to identify if the recent list should be updated.

  Default Value: false

Back to Top

Response

Supported Media Types

• application/json

200 Response

A list of recipients that have been given access on the specified Delta Share is retrieved.

Headers

• opc-next-page: string
  For 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.
• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : RecipientCollection

Type: object

Results of a listing Delta Share recipients. Contains summary information of recipients.

Show Source

• items(required): array items
  List of recipients.

{
    "type":"object",
    "description":"Results of a listing Delta Share recipients. Contains summary information of recipients.",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "description":"List of recipients.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/RecipientSummary"
            }
        }
    }
}

Nested Schema : items

Type: array

List of recipients.

Show Source

• Array of: object RecipientSummary
  Summary information about a recipient.

{
    "description":"List of recipients.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/RecipientSummary"
    }
}

Nested Schema : RecipientSummary

Type: object

Summary information about a recipient.

Show Source

• createdBy(required): string
  The ID of the user who created the recipient.
• description: string
  Short description of the Recipient
• displayName(required): string
  A user-friendly name. Has to be unique within the AI Data Platform Workbench instance.
• key(required): string
  Unique identifier for this recipient in AI Data Platform Workbench instance.
• lifecycleDetails: string
  A message describing the current state in more detail.
• lifecycleState: string
  Allowed Values: [ "ACTIVE", "INACTIVE" ]

  The state of the recipient.
• shareCount: integer
  The number of shares this recipient has access on.
• timeCreated(required): string(date-time)
  The date and time the Delta Share recipient was created, in the format defined by RFC 3339. Example: `2016-08-25T21:10:29.600Z`
• timeUpdated: string(date-time)
  The date and time the Delta Share recipient was updated, in the format defined by RFC 3339. Example: `2016-08-25T21:10:29.600Z`
• updatedBy: string
  The ID of the user who last updated the recipient.

{
    "description":"Summary information about a recipient.",
    "type":"object",
    "required":[
        "key",
        "displayName",
        "timeCreated",
        "createdBy"
    ],
    "properties":{
        "key":{
            "description":"Unique identifier for this recipient in AI Data Platform Workbench instance.",
            "type":"string"
        },
        "displayName":{
            "description":"A user-friendly name. Has to be unique within the AI Data Platform Workbench instance.",
            "type":"string"
        },
        "description":{
            "description":"Short description of the Recipient",
            "type":"string"
        },
        "shareCount":{
            "description":"The number of shares this recipient has access on.\n",
            "type":"integer"
        },
        "timeCreated":{
            "description":"The date and time the Delta Share recipient was created, in the format defined by <a href=\"https://tools.ietf.org/html/rfc3339\" target=\"_blank\" rel=\"noopener noreferrer\">RFC 3339</a>.\nExample: `2016-08-25T21:10:29.600Z`\n",
            "type":"string",
            "format":"date-time"
        },
        "createdBy":{
            "description":"The ID of the user who created the recipient.\n",
            "type":"string"
        },
        "lifecycleState":{
            "description":"The state of the recipient.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/RecipientLifecycleState",
            "enum":[
                "ACTIVE",
                "INACTIVE"
            ]
        },
        "lifecycleDetails":{
            "description":"A message describing the current state in more detail.",
            "type":"string"
        },
        "updatedBy":{
            "description":"The ID of the user who last updated the recipient.\n",
            "type":"string"
        },
        "timeUpdated":{
            "description":"The date and time the Delta Share recipient was updated, in the format defined by <a href=\"https://tools.ietf.org/html/rfc3339\" target=\"_blank\" rel=\"noopener noreferrer\">RFC 3339</a>.\nExample: `2016-08-25T21:10:29.600Z`\n",
            "type":"string",
            "format":"date-time"
        }
    }
}

400 Response

Bad Request (invalid query parameters, malformed headers, and so on).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

401 Response

Unauthorized (missing or expired credentials, and so on).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

404 Response

Not Found. The requested resource was not found.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

429 Response

Too Many Requests. Too many requests sent to the server in a short period.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

500 Response

Internal Server Error. The server encountered an unexpected condition preventing fulfilment of the request.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Default Response

Unknown Error. Error is not recognized by the system.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Back to Top