Skip to content

Latest commit

 

History

History
112 lines (68 loc) · 2.85 KB

WorkItemsApi.md

File metadata and controls

112 lines (68 loc) · 2.85 KB

ForgeSdk.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(%27{id}%27) 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(%27{id}%27) Returns the details of a specific WorkItem.

createWorkItem

WorkItemResp createWorkItem(workItem, oauth2client, credentials)

Creates a new WorkItem.

Parameters

Name Type Description Notes
workItem WorkItem

Return type

WorkItemResp

Authorization

oauth2_application

HTTP request headers

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

deleteWorkItem

deleteWorkItem(id, oauth2client, credentials)

Removes a specific WorkItem.

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

getAllWorkItems

DesignAutomationWorkItems getAllWorkItems(opts, oauth2client, credentials)

Returns the details of all WorkItems.

Parameters

Name Type Description Notes
skip Integer [optional]

Return type

DesignAutomationWorkItems

Authorization

oauth2_application

HTTP request headers

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

getWorkItem

WorkItemResp getWorkItem(id, oauth2client, credentials)

Returns the details of a specific WorkItem.

Parameters

Name Type Description Notes
id String

Return type

WorkItemResp

Authorization

oauth2_application

HTTP request headers

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