Software Artifact

View as Markdown

A software artifact in a Unity Catalog schema.

GetGET /api/2.1/unity-catalog/{name=software-artifacts/*}ListGET /api/2.1/unity-catalog/software-artifactsUpdatePATCH /api/2.1/unity-catalog/{name=software-artifacts/*}

SoftwareArtifact object

A software artifact in a Unity Catalog schema.

namestringBetaIDImmutable

Resource name of the artifact, of the form software-artifacts/{catalog}.{schema}.{artifact}.

ownerstringBeta

Principal name (a user, service principal, or group) that owns this artifact.

create_timestringBetaOutput only

Time at which this software artifact was created.

created_bystringBetaOutput only

Principal name of the software artifact creator.

update_timestringBetaOutput only

Time at which this software artifact was last updated.

updated_bystringBetaOutput only

Principal name that last updated this software artifact.

View as Markdown

The SoftwareArtifact object

{
  "name": "string",
  "owner": "string",
  "create_time": "string",
  "created_by": "string",
  "update_time": "string",
  "updated_by": "string"
}

Get Beta

GET /api/2.1/unity-catalog/{name=software-artifacts/*}

Gets a software artifact.

API scopes: unity-catalog

Parameters

namestringRequiredpath

Resource name of the artifact, of the form software-artifacts/{catalog}.{schema}.{artifact}.

Response

Returns the SoftwareArtifact object.

View as Markdown

Response

{
  "name": "string",
  "owner": "string",
  "create_time": "string",
  "created_by": "string",
  "update_time": "string",
  "updated_by": "string"
}

List Beta

GET /api/2.1/unity-catalog/software-artifacts

Lists software artifacts in a schema.

API scopes: unity-catalog

Parameters

parentstringRequiredquery

Resource name of the parent schema, of the form schemas/{catalog}.{schema}.

page_tokenstringquery

Opaque continuation token from a previous response's next_page_token. Omit for the first page.

page_sizeint32query

Maximum number of software artifacts to return. If omitted or set to 0, the page size defaults to 50. The maximum value is 50; values above 50 or below 0 are rejected.

Response

Returns a list of SoftwareArtifact objects.

View as Markdown

Response

{
  "software_artifacts": [
    {
      "name": "string",
      "owner": "string",
      "create_time": "string",
      "created_by": "string",
      "update_time": "string",
      "updated_by": "string"
    }
  ],
  "next_page_token": "string"
}

Update Beta

PATCH /api/2.1/unity-catalog/{name=software-artifacts/*}

Updates a software artifact. The name is immutable; only the owner may be changed. The destination owner must exist in the account. The caller needs MANAGE_ACCESS_CONTROL on the artifact. The response contains its name and the requested owner; audit fields are omitted.

API scopes: unity-catalog

Parameters

namestringRequiredIDImmutablepath

Resource name of the artifact, of the form software-artifacts/{catalog}.{schema}.{artifact}.

update_maskstringRequiredquery

Fields to update, relative to software_artifact. Accepts owner or *; owner is the only mutable field, so both select the same update. Output-only values in the resource are ignored.

Request body

The software artifact to update. Its name identifies the existing artifact; only owner may be changed.

ownerstring

Principal name (a user, service principal, or group) that owns this artifact.

Response

Returns the SoftwareArtifact object.

View as Markdown

Request

{
  "owner": "string"
}

Response

{
  "name": "string",
  "owner": "string",
  "create_time": "string",
  "created_by": "string",
  "update_time": "string",
  "updated_by": "string"
}