Jump to

• Request
• Response

Create a Delta Share recipient

post

/20260430/aiDataPlatforms/{aiDataPlatformId}/recipients

Creates a recipient for a Delta Share protocol in AI Data Platform Workbench.

Request

Path Parameters

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

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.
• opc-retry-token: string
  Minimum Length: 1

  Maximum Length: 64

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of running that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and removed from the system, then a retry of the original creation request might be rejected.
• should-update-recent: boolean
  A flag to identify if the recent list should be updated.

  Default Value: false

Body ()

Details for the new recipient for Delta Share protocol in AI Data Platform Workbench.

Root Schema : CreateRecipientDetails

Type: object

The details for creating a Delta Share recipient in AI Data Platform Workbench.

Show Source

• 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.
• properties: object properties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing a defined tag key and value. Example: `{ "CostCenter": "42" }`

{
    "description":"The details for creating a Delta Share recipient in AI Data Platform Workbench.",
    "type":"object",
    "required":[
        "displayName"
    ],
    "properties":{
        "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"
        },
        "properties":{
            "description":"Key-value pair representing a defined tag key and value.\nExample: `{ \"CostCenter\": \"42\" }`\n",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    }
}

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"Key-value pair representing a defined tag key and value.\nExample: `{ \"CostCenter\": \"42\" }`\n",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Key-value pair representing a defined tag key and value. Example: `{ "CostCenter": "42" }`

Back to Top

Response

Supported Media Types

• application/json

200 Response

A Delta Share recipient is created.

Headers

• etag: string
  For optimistic concurrency control. See `if-match`.
• 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 : Recipient

Type: object

A Delta Share recipient can access the data assets in AI Data Platform Workbench through Delta Share Protocol.

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.
• lifecycleState(required): string
  Allowed Values: [ "ACTIVE", "INACTIVE" ]

  The state of the recipient.
• lifecycleStateDetails: string
  A message describing the current state in more detail.
• properties: object properties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing a defined tag key and value. Example: `{ "CostCenter": "42" }`
• shareCount(required): 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":"A Delta Share recipient can access the data assets in AI Data Platform Workbench through Delta Share Protocol.\n",
    "type":"object",
    "required":[
        "key",
        "timeCreated",
        "displayName",
        "createdBy",
        "shareCount",
        "lifecycleState"
    ],
    "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"
        },
        "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"
        },
        "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"
        },
        "shareCount":{
            "description":"The number of shares this recipient has access on.\n",
            "type":"integer"
        },
        "createdBy":{
            "description":"The ID of the user who created the recipient.\n",
            "type":"string"
        },
        "updatedBy":{
            "description":"The ID of the user who last updated the recipient.\n",
            "type":"string"
        },
        "properties":{
            "description":"Key-value pair representing a defined tag key and value.\nExample: `{ \"CostCenter\": \"42\" }`\n",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "lifecycleState":{
            "description":"The state of the recipient.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/RecipientLifecycleState",
            "enum":[
                "ACTIVE",
                "INACTIVE"
            ]
        },
        "lifecycleStateDetails":{
            "description":"A message describing the current state in more detail.",
            "type":"string"
        }
    }
}

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"Key-value pair representing a defined tag key and value.\nExample: `{ \"CostCenter\": \"42\" }`\n",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Key-value pair representing a defined tag key and value. Example: `{ "CostCenter": "42" }`

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"
        }
    }
}

409 Response

Conflict. Request conflicts with the current state of the resource.

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