GuidesChangelogTypeScript API ReferencePython v2 API Reference

ArtifactApi

Index

Interfaces

Type Aliases

Functions

Type Aliases

OrderEnum

OrderEnum: "ASC" | "DESC"

PermissionsEnum

PermissionsEnum: "READ" | "MODIFY" | "SHARE"

TypeEnum

TypeEnum: "User" | "App" | "Group"

Functions

deleteArtifactUsingDELETE

  • deleteArtifactUsingDELETE(builder: RequestBuilder, params: {</span>artifactHrn<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">}): Promise<DeleteArtifactResponseObj>

deleteFileUsingDELETE

  • deleteFileUsingDELETE(builder: RequestBuilder, params: {</span>artifactHrn<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>fileName<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">}): Promise<DeleteFileResponseObj>

  • Requires permission to 'modifyResource' for the given HRN

    summary
    Delete a specific artifact file

    Parameters

    • builder: RequestBuilder
    • params: {</span>artifactHrn<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>fileName<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">}
      • artifactHrn: string
      • fileName: string

    Returns Promise<DeleteFileResponseObj>

deleteSchemaUsingDELETE

  • deleteSchemaUsingDELETE(builder: RequestBuilder, params: {</span>schemaHrn<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">}): Promise<DeleteSchemaResponseObj>

getArtifactFileUsingGET

  • getArtifactFileUsingGET(builder: RequestBuilder, params: {</span>artifactHrn<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>fileName<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">}): Promise<string>

  • Requires permission to 'readResource' for the given HRN

    summary
    Retrieve a specific artifact file

    Parameters

    • builder: RequestBuilder
    • params: {</span>artifactHrn<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>fileName<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">}
      • artifactHrn: string
      • fileName: string

    Returns Promise<string>

getArtifactUsingGET

  • getArtifactUsingGET(builder: RequestBuilder, params: {</span>artifactHrn<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">}): Promise<Response>

  • summary
    getArtifact

    Parameters

    • builder: RequestBuilder
    • params: {</span>artifactHrn<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">}
      • artifactHrn: string

    Returns Promise<Response>

getDocumentUsingGET

  • getDocumentUsingGET(builder: RequestBuilder, params: {</span>file<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>schemaHrn<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">}): Promise<string>

  • Requires permission to 'readResource' for the given HRN

    summary
    Resolve a schema doc variant URL

    Parameters

    • builder: RequestBuilder
    • params: {</span>file<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>schemaHrn<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">}
      • file: string
      • schemaHrn: string

    Returns Promise<string>

getSchemaUsingGET

  • getSchemaUsingGET(builder: RequestBuilder, params: {</span>schemaHrn<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">}): Promise<GetSchemaResponseObj>

listUsingGET

  • listUsingGET(builder: RequestBuilder, params: {</span>from<span class="typedoc-tsd-signature-symbol">?: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>limit<span class="typedoc-tsd-signature-symbol">?: </span><span class="typedoc-tsd-signature-type">number</span><span class="typedoc-tsd-signature-symbol">; </span>order<span class="typedoc-tsd-signature-symbol">?: </span><span class="typedoc-tsd-signature-type">"ASC"</span><span class="typedoc-tsd-signature-symbol"> | </span><span class="typedoc-tsd-signature-type">"DESC"</span><span class="typedoc-tsd-signature-symbol">; </span>sort<span class="typedoc-tsd-signature-symbol">?: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">}): Promise<ListSchemasResponseObj>

  • Requires permission to 'apiAccess'

    summary
    List the available schemas

    Parameters

    • builder: RequestBuilder
    • params: {</span>from<span class="typedoc-tsd-signature-symbol">?: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>limit<span class="typedoc-tsd-signature-symbol">?: </span><span class="typedoc-tsd-signature-type">number</span><span class="typedoc-tsd-signature-symbol">; </span>order<span class="typedoc-tsd-signature-symbol">?: </span><span class="typedoc-tsd-signature-type">"ASC"</span><span class="typedoc-tsd-signature-symbol"> | </span><span class="typedoc-tsd-signature-type">"DESC"</span><span class="typedoc-tsd-signature-symbol">; </span>sort<span class="typedoc-tsd-signature-symbol">?: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">}
      • Optional from?: string
      • Optional limit?: number
      • Optional order?: "ASC" | "DESC"
      • Optional sort?: string

    Returns Promise<ListSchemasResponseObj>

putArtifactFileUsingPUT

  • putArtifactFileUsingPUT(builder: RequestBuilder, params: {</span>artifactHrn<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>file<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>fileName<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">}): Promise<Response>

  • Requires permission to 'modifyResource' for the given HRN

    summary
    Create or update a specific artifact

    Parameters

    • builder: RequestBuilder
    • params: {</span>artifactHrn<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>file<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>fileName<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">}
      • artifactHrn: string
      • file: string
      • fileName: string

    Returns Promise<Response>

registerArtifactUsingPUT

  • registerArtifactUsingPUT(builder: RequestBuilder, params: {</span>artifactId<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>groupId<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>registerRequest<span class="typedoc-tsd-signature-symbol">?: </span><a href="sdk-for-typescript-interfaces-olp_sdk_dataservice_api-artifactapi-registerartifactrequest" class="typedoc-tsd-signature-type" data-tsd-kind="Interface">RegisterArtifactRequest</a><span class="typedoc-tsd-signature-symbol">}): Promise<RegisterArtifactResponse>

  • Requires permission to 'apiAccess'

    summary
    Register a new group and artifact

    Parameters

    • builder: RequestBuilder
    • params: {</span>artifactId<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>groupId<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>registerRequest<span class="typedoc-tsd-signature-symbol">?: </span><a href="sdk-for-typescript-interfaces-olp_sdk_dataservice_api-artifactapi-registerartifactrequest" class="typedoc-tsd-signature-type" data-tsd-kind="Interface">RegisterArtifactRequest</a><span class="typedoc-tsd-signature-symbol">}

    Returns Promise<RegisterArtifactResponse>

updateSchemaPermissionUsingPOST

  • updateSchemaPermissionUsingPOST(builder: RequestBuilder, params: {</span>schemaHrn<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>updatePermissionRequest<span class="typedoc-tsd-signature-symbol">?: </span><a href="sdk-for-typescript-interfaces-olp_sdk_dataservice_api-artifactapi-updatepermissionrequest" class="typedoc-tsd-signature-type" data-tsd-kind="Interface">UpdatePermissionRequest</a><span class="typedoc-tsd-signature-symbol">}): Promise<UpdatePermissionResponse>

  • READ grants 'readResource', MODIFY grants 'modifyResource', SHARE grants 'shareResource'. Requires permission to 'shareResource' for the given HRN.

    summary
    Update schema permissions for user on the specified schema and associated artifact.

    Parameters

    • builder: RequestBuilder
    • params: {</span>schemaHrn<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>updatePermissionRequest<span class="typedoc-tsd-signature-symbol">?: </span><a href="sdk-for-typescript-interfaces-olp_sdk_dataservice_api-artifactapi-updatepermissionrequest" class="typedoc-tsd-signature-type" data-tsd-kind="Interface">UpdatePermissionRequest</a><span class="typedoc-tsd-signature-symbol">}

    Returns Promise<UpdatePermissionResponse>

olp- sdk- dataservice- api

On this page