Skip to content

Latest commit

 

History

History
291 lines (179 loc) · 8.57 KB

AppPackagesApi.md

File metadata and controls

291 lines (179 loc) · 8.57 KB

AppPackagesApi

All URIs are relative to https://developer.api.autodesk.com/

Method HTTP request Description
createAppPackage POST /autocad.io/us-east/v2/AppPackages Creates an AppPackage module.
deleteAppPackage DELETE /autocad.io/us-east/v2/AppPackages('{id}') Removes a specific AppPackage.
deleteAppPackageHistory POST /autocad.io/us-east/v2/AppPackages('{id}')/Operations.DeleteHistory Removes the version history of the specified AppPackage.
getAllAppPackages GET /autocad.io/us-east/v2/AppPackages Returns the details of all AppPackages.
getAppPackage GET /autocad.io/us-east/v2/AppPackages('{id}') Returns the details of a specific AppPackage.
getAppPackageVersions GET /autocad.io/us-east/v2/AppPackages('{id}')/Operations.GetVersions Returns all old versions of a specified AppPackage.
getUploadUrl GET /autocad.io/us-east/v2/AppPackages/Operations.GetUploadUrl Requests a pre-signed URL for uploading a zip file that contains the binaries for this AppPackage.
getUploadUrlWithRequireContentType GET /autocad.io/us-east/v2/AppPackage/Operations.GetUploadUrl(RequireContentType={require}) Requests a pre-signed URL for uploading a zip file that contains the binaries for this AppPackage. Unlike the GetUploadUrl method that takes no parameters, this method allows the client to request that the pre-signed URL to be issued so that the subsequent HTTP PUT operation will require Content-Type=binary/octet-stream.
patchAppPackage PATCH /autocad.io/us-east/v2/AppPackages('{id}') Updates an AppPackage by specifying only the changed attributes.
setAppPackageVersion POST /autocad.io/us-east/v2/AppPackages('{id}')/Operations.SetVersion Sets the AppPackage to the specified version.
updateAppPackage PUT /autocad.io/us-east/v2/AppPackages('{id}') Updates an AppPackage by redefining the entire Activity object.

createAppPackage

AppPackage createAppPackage(appPackage)

Creates an AppPackage module.

Parameters

Name Type Description Notes
appPackage AppPackage

Return type

AppPackage

Authorization

oauth2_application

HTTP request headers

  • Content-Type: application/json
  • Accept: application/vnd.api+json, application/json

deleteAppPackage

deleteAppPackage(id)

Removes a specific AppPackage.

Parameters

Name Type Description Notes
id String

Return type

null (empty response body)

Authorization

oauth2_application

HTTP request headers

  • Content-Type: application/json
  • Accept: application/vnd.api+json, application/json

deleteAppPackageHistory

deleteAppPackageHistory(id)

Removes the version history of the specified AppPackage.

Parameters

Name Type Description Notes
id String

Return type

null (empty response body)

Authorization

oauth2_application

HTTP request headers

  • Content-Type: application/json
  • Accept: application/vnd.api+json, application/json

getAllAppPackages

DesignAutomationAppPackages getAllAppPackages()

Returns the details of all AppPackages.

Parameters

This endpoint does not need any parameter.

Return type

DesignAutomationAppPackages

Authorization

oauth2_application

HTTP request headers

  • Content-Type: application/json
  • Accept: application/vnd.api+json, application/json

getAppPackage

AppPackage getAppPackage(id)

Returns the details of a specific AppPackage.

Parameters

Name Type Description Notes
id String

Return type

AppPackage

Authorization

oauth2_application

HTTP request headers

  • Content-Type: application/json
  • Accept: application/vnd.api+json, application/json

getAppPackageVersions

DesignAutomationAppPackages getAppPackageVersions(id)

Returns all old versions of a specified AppPackage.

Parameters

Name Type Description Notes
id String

Return type

DesignAutomationAppPackages

Authorization

oauth2_application

HTTP request headers

  • Content-Type: application/json
  • Accept: application/vnd.api+json, application/json

getUploadUrl

getUploadUrl()

Requests a pre-signed URL for uploading a zip file that contains the binaries for this AppPackage.

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

oauth2_application

HTTP request headers

  • Content-Type: application/json
  • Accept: application/vnd.api+json, application/json

getUploadUrlWithRequireContentType

getUploadUrlWithRequireContentType(require)

Requests a pre-signed URL for uploading a zip file that contains the binaries for this AppPackage. Unlike the GetUploadUrl method that takes no parameters, this method allows the client to request that the pre-signed URL to be issued so that the subsequent HTTP PUT operation will require Content-Type=binary/octet-stream.

Parameters

Name Type Description Notes
require Boolean

Return type

null (empty response body)

Authorization

oauth2_application

HTTP request headers

  • Content-Type: application/json
  • Accept: application/vnd.api+json, application/json

patchAppPackage

patchAppPackage(id, appPackage)

Updates an AppPackage by specifying only the changed attributes.

Parameters

Name Type Description Notes
id String
appPackage AppPackageOptional

Return type

null (empty response body)

Authorization

oauth2_application

HTTP request headers

  • Content-Type: application/json
  • Accept: application/vnd.api+json, application/json

setAppPackageVersion

setAppPackageVersion(id, appPackageVersion)

Sets the AppPackage to the specified version.

Parameters

Name Type Description Notes
id String
appPackageVersion AppPackageVersion

Return type

null (empty response body)

Authorization

oauth2_application

HTTP request headers

  • Content-Type: application/json
  • Accept: application/vnd.api+json, application/json

updateAppPackage

updateAppPackage(id, appPackage)

Updates an AppPackage by redefining the entire Activity object.

Parameters

Name Type Description Notes
id String
appPackage AppPackage

Return type

null (empty response body)

Authorization

oauth2_application

HTTP request headers

  • Content-Type: application/json
  • Accept: application/vnd.api+json, application/json