Skip to content

Latest commit

 

History

History
183 lines (123 loc) · 5.22 KB

WorkItemsApi.md

File metadata and controls

183 lines (123 loc) · 5.22 KB

Autodesk\Forge\Client\WorkItemsApi

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

Method HTTP request Description
createWorkItem POST /autocad.io/us-east/v2/WorkItems Creates a new WorkItem.
deleteWorkItem DELETE /autocad.io/us-east/v2/WorkItems('{id}') Removes a specific WorkItem.
getAllWorkItems GET /autocad.io/us-east/v2/WorkItems Returns the details of all WorkItems.
getWorkItem GET /autocad.io/us-east/v2/WorkItems('{id}') Returns the details of a specific WorkItem.

createWorkItem

\Autodesk\Forge\Client\Model\WorkItemResp createWorkItem($work_item)

Creates a new WorkItem.

Example

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

$apiInstance = new Autodesk\Forge\Client\Api\WorkItemsApi($authObject);
$work_item = new \Autodesk\Forge\Client\Model\WorkItem(); // \Autodesk\Forge\Client\Model\WorkItem | 

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

Parameters

Name Type Description Notes
work_item \Autodesk\Forge\Client\Model\WorkItem

Return type

\Autodesk\Forge\Client\Model\WorkItemResp

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]

deleteWorkItem

deleteWorkItem($id)

Removes a specific WorkItem.

Example

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

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

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

getAllWorkItems

\Autodesk\Forge\Client\Model\DesignAutomationWorkItems getAllWorkItems($skip)

Returns the details of all WorkItems.

Example

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

$apiInstance = new Autodesk\Forge\Client\Api\WorkItemsApi($authObject);
$skip = 56; // int | 

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

Parameters

Name Type Description Notes
skip int [optional]

Return type

\Autodesk\Forge\Client\Model\DesignAutomationWorkItems

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]

getWorkItem

\Autodesk\Forge\Client\Model\WorkItemResp getWorkItem($id)

Returns the details of a specific WorkItem.

Example

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

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

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

Parameters

Name Type Description Notes
id string

Return type

\Autodesk\Forge\Client\Model\WorkItemResp

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]