Skip to content

Latest commit

 

History

History
356 lines (241 loc) · 10.6 KB

ActivitiesApi.md

File metadata and controls

356 lines (241 loc) · 10.6 KB
Raw

Autodesk\Forge\Client\ActivitiesApi

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

Method HTTP request Description
createActivity POST /autocad.io/us-east/v2/Activities Creates a new Activity.
deleteActivity DELETE /autocad.io/us-east/v2/Activities('{id}') Removes a specific Activity.
deleteActivityHistory POST /autocad.io/us-east/v2/Activities('{id}')/Operations.DeleteHistory Removes the version history of the specified Activity.
getActivity GET /autocad.io/us-east/v2/Activities('{id}') Returns the details of a specific Activity.
getActivityVersions GET /autocad.io/us-east/v2/Activities('{id}')/Operations.GetVersions Returns all old versions of a specified Activity.
getAllActivities GET /autocad.io/us-east/v2/Activities Returns the details of all Activities.
patchActivity PATCH /autocad.io/us-east/v2/Activities('{id}') Updates an Activity by specifying only the changed attributes.
setActivityVersion POST /autocad.io/us-east/v2/Activities('{id}')/Operations.SetVersion Sets the Activity to the specified version.

createActivity

\Autodesk\Forge\Client\Model\Activity createActivity($activity)

Creates a new Activity.

Example

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

$apiInstance = new Autodesk\Forge\Client\Api\ActivitiesApi($authObject);
$activity = new \Autodesk\Forge\Client\Model\Activity(); // \Autodesk\Forge\Client\Model\Activity | 

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

Parameters

Name Type Description Notes
activity \Autodesk\Forge\Client\Model\Activity

Return type

\Autodesk\Forge\Client\Model\Activity

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]

deleteActivity

deleteActivity($id)

Removes a specific Activity.

Example

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

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

try {
    $apiInstance->deleteActivity($id);
} catch (Exception $e) {
    echo 'Exception when calling ActivitiesApi->deleteActivity: ', $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]

deleteActivityHistory

deleteActivityHistory($id)

Removes the version history of the specified Activity.

Example

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

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

try {
    $apiInstance->deleteActivityHistory($id);
} catch (Exception $e) {
    echo 'Exception when calling ActivitiesApi->deleteActivityHistory: ', $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]

getActivity

\Autodesk\Forge\Client\Model\Activity getActivity($id)

Returns the details of a specific Activity.

Example

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

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

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

Parameters

Name Type Description Notes
id string

Return type

\Autodesk\Forge\Client\Model\Activity

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]

getActivityVersions

\Autodesk\Forge\Client\Model\DesignAutomationActivities getActivityVersions($id)

Returns all old versions of a specified Activity.

Example

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

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

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

Parameters

Name Type Description Notes
id string

Return type

\Autodesk\Forge\Client\Model\DesignAutomationActivities

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]

getAllActivities

\Autodesk\Forge\Client\Model\DesignAutomationActivities getAllActivities()

Returns the details of all Activities.

Example

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

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

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

Parameters

This endpoint does not need any parameter.

Return type

\Autodesk\Forge\Client\Model\DesignAutomationActivities

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]

patchActivity

patchActivity($id, $activity)

Updates an Activity by specifying only the changed attributes.

Example

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

$apiInstance = new Autodesk\Forge\Client\Api\ActivitiesApi($authObject);
$id = "id_example"; // string | 
$activity = new \Autodesk\Forge\Client\Model\ActivityOptional(); // \Autodesk\Forge\Client\Model\ActivityOptional | 

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

Parameters

Name Type Description Notes
id string
activity \Autodesk\Forge\Client\Model\ActivityOptional

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]

setActivityVersion

setActivityVersion($id, $activity_version)

Sets the Activity to the specified version.

Example

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

$apiInstance = new Autodesk\Forge\Client\Api\ActivitiesApi($authObject);
$id = "id_example"; // string | 
$activity_version = new \Autodesk\Forge\Client\Model\ActivityVersion(); // \Autodesk\Forge\Client\Model\ActivityVersion | 

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

Parameters

Name Type Description Notes
id string
activity_version \Autodesk\Forge\Client\Model\ActivityVersion

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]