Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FilesApi

FilesApi - object-oriented interface

export

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

createFile

  • Create a file. Once created, upload file content via the uploadFile API. For details including supported file formats, see our Import data guide.

    throws

    {RequiredError}

    memberof

    FilesApi

    Parameters

    Returns Promise<AxiosResponse<FileMetadata, any>>

deleteFile

  • Delete a file.

    throws

    {RequiredError}

    memberof

    FilesApi

    Parameters

    Returns Promise<AxiosResponse<FileMetadata, any>>

getFile

  • Get a file by ID.

    throws

    {RequiredError}

    memberof

    FilesApi

    Parameters

    Returns Promise<AxiosResponse<FileMetadata, any>>

getFiles

  • Get files.

    throws

    {RequiredError}

    memberof

    FilesApi

    Parameters

    Returns Promise<AxiosResponse<FileList, any>>

uploadFile

  • uploadFile(requestParameters: FilesApiUploadFileRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<void, any>>

  • Upload a file. Once uploaded, create either parts or geometry sets via the createPart or createGeometrySet APIs.

    throws

    {RequiredError}

    memberof

    FilesApi

    Parameters

    Returns Promise<AxiosResponse<void, any>>