Skip to content

Latest commit

 

History

History
483 lines (327 loc) · 15.4 KB

AppPackagesApi.md

File metadata and controls

483 lines (327 loc) · 15.4 KB
Raw

Autodesk\Forge\Client\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/AppPackages/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

\Autodesk\Forge\Client\Model\AppPackage createAppPackage($app_package)

Creates an AppPackage module.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Autodesk\Forge\Client\Api\AppPackagesApi($authObject);
$app_package = new \Autodesk\Forge\Client\Model\AppPackage(); // \Autodesk\Forge\Client\Model\AppPackage | 

try {
    $result = $apiInstance->createAppPackage($app_package);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AppPackagesApi->createAppPackage: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
app_package \Autodesk\Forge\Client\Model\AppPackage

Return type

\Autodesk\Forge\Client\Model\AppPackage

Authorization

oauth2_application

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteAppPackage

deleteAppPackage($id)

Removes a specific AppPackage.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Autodesk\Forge\Client\Api\AppPackagesApi($authObject);
$id = "id_example"; // string | 

try {
    $apiInstance->deleteAppPackage($id);
} catch (Exception $e) {
    echo 'Exception when calling AppPackagesApi->deleteAppPackage: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id string

Return type

void (empty response body)

Authorization

oauth2_application

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteAppPackageHistory

deleteAppPackageHistory($id)

Removes the version history of the specified AppPackage.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Autodesk\Forge\Client\Api\AppPackagesApi($authObject);
$id = "id_example"; // string | 

try {
    $apiInstance->deleteAppPackageHistory($id);
} catch (Exception $e) {
    echo 'Exception when calling AppPackagesApi->deleteAppPackageHistory: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id string

Return type

void (empty response body)

Authorization

oauth2_application

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAllAppPackages

\Autodesk\Forge\Client\Model\DesignAutomationAppPackages getAllAppPackages()

Returns the details of all AppPackages.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Autodesk\Forge\Client\Api\AppPackagesApi($authObject);

try {
    $result = $apiInstance->getAllAppPackages();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AppPackagesApi->getAllAppPackages: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\Autodesk\Forge\Client\Model\DesignAutomationAppPackages

Authorization

oauth2_application

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAppPackage

\Autodesk\Forge\Client\Model\AppPackage getAppPackage($id)

Returns the details of a specific AppPackage.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Autodesk\Forge\Client\Api\AppPackagesApi($authObject);
$id = "id_example"; // string | 

try {
    $result = $apiInstance->getAppPackage($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AppPackagesApi->getAppPackage: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id string

Return type

\Autodesk\Forge\Client\Model\AppPackage

Authorization

oauth2_application

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAppPackageVersions

\Autodesk\Forge\Client\Model\DesignAutomationAppPackages getAppPackageVersions($id)

Returns all old versions of a specified AppPackage.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Autodesk\Forge\Client\Api\AppPackagesApi($authObject);
$id = "id_example"; // string | 

try {
    $result = $apiInstance->getAppPackageVersions($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AppPackagesApi->getAppPackageVersions: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id string

Return type

\Autodesk\Forge\Client\Model\DesignAutomationAppPackages

Authorization

oauth2_application

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getUploadUrl

getUploadUrl()

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Autodesk\Forge\Client\Api\AppPackagesApi($authObject);

try {
    $apiInstance->getUploadUrl();
} catch (Exception $e) {
    echo 'Exception when calling AppPackagesApi->getUploadUrl: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

oauth2_application

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

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.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Autodesk\Forge\Client\Api\AppPackagesApi($authObject);
$require = true; // bool | 

try {
    $apiInstance->getUploadUrlWithRequireContentType($require);
} catch (Exception $e) {
    echo 'Exception when calling AppPackagesApi->getUploadUrlWithRequireContentType: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
require bool

Return type

void (empty response body)

Authorization

oauth2_application

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

patchAppPackage

patchAppPackage($id, $app_package)

Updates an AppPackage by specifying only the changed attributes.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Autodesk\Forge\Client\Api\AppPackagesApi($authObject);
$id = "id_example"; // string | 
$app_package = new \Autodesk\Forge\Client\Model\AppPackageOptional(); // \Autodesk\Forge\Client\Model\AppPackageOptional | 

try {
    $apiInstance->patchAppPackage($id, $app_package);
} catch (Exception $e) {
    echo 'Exception when calling AppPackagesApi->patchAppPackage: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id string
app_package \Autodesk\Forge\Client\Model\AppPackageOptional

Return type

void (empty response body)

Authorization

oauth2_application

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

setAppPackageVersion

setAppPackageVersion($id, $app_package_version)

Sets the AppPackage to the specified version.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Autodesk\Forge\Client\Api\AppPackagesApi($authObject);
$id = "id_example"; // string | 
$app_package_version = new \Autodesk\Forge\Client\Model\AppPackageVersion(); // \Autodesk\Forge\Client\Model\AppPackageVersion | 

try {
    $apiInstance->setAppPackageVersion($id, $app_package_version);
} catch (Exception $e) {
    echo 'Exception when calling AppPackagesApi->setAppPackageVersion: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id string
app_package_version \Autodesk\Forge\Client\Model\AppPackageVersion

Return type

void (empty response body)

Authorization

oauth2_application

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateAppPackage

updateAppPackage($id, $app_package)

Updates an AppPackage by redefining the entire Activity object.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Autodesk\Forge\Client\Api\AppPackagesApi($authObject);
$id = "id_example"; // string | 
$app_package = new \Autodesk\Forge\Client\Model\AppPackage(); // \Autodesk\Forge\Client\Model\AppPackage | 

try {
    $apiInstance->updateAppPackage($id, $app_package);
} catch (Exception $e) {
    echo 'Exception when calling AppPackagesApi->updateAppPackage: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id string
app_package \Autodesk\Forge\Client\Model\AppPackage

Return type

void (empty response body)

Authorization

oauth2_application

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]