Skip to content

Latest commit

 

History

History
215 lines (132 loc) · 5.84 KB

ActivitiesApi.md

File metadata and controls

215 lines (132 loc) · 5.84 KB

ForgeSdk.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(%27{id}%27) Removes a specific Activity.
deleteActivityHistory POST /autocad.io/us-east/v2/Activities(%27{id}%27)/Operations.DeleteHistory Removes the version history of the specified Activity.
getActivity GET /autocad.io/us-east/v2/Activities(%27{id}%27) Returns the details of a specific Activity.
getActivityVersions GET /autocad.io/us-east/v2/Activities(%27{id}%27)/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(%27{id}%27) Updates an Activity by specifying only the changed attributes.
setActivityVersion POST /autocad.io/us-east/v2/Activities(%27{id}%27)/Operations.SetVersion Sets the Activity to the specified version.

createActivity

Activity createActivity(activity, oauth2client, credentials)

Creates a new Activity.

Parameters

Name Type Description Notes
activity Activity

Return type

Activity

Authorization

oauth2_application

HTTP request headers

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

deleteActivity

deleteActivity(id, oauth2client, credentials)

Removes a specific Activity.

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

deleteActivityHistory

deleteActivityHistory(id, oauth2client, credentials)

Removes the version history of the specified Activity.

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

getActivity

Activity getActivity(id, oauth2client, credentials)

Returns the details of a specific Activity.

Parameters

Name Type Description Notes
id String

Return type

Activity

Authorization

oauth2_application

HTTP request headers

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

getActivityVersions

DesignAutomationActivities getActivityVersions(id, oauth2client, credentials)

Returns all old versions of a specified Activity.

Parameters

Name Type Description Notes
id String

Return type

DesignAutomationActivities

Authorization

oauth2_application

HTTP request headers

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

getAllActivities

DesignAutomationActivities getAllActivities(oauth2client, credentials)

Returns the details of all Activities.

Parameters

This endpoint does not need any parameter.

Return type

DesignAutomationActivities

Authorization

oauth2_application

HTTP request headers

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

patchActivity

patchActivity(id, activity, oauth2client, credentials)

Updates an Activity by specifying only the changed attributes.

Parameters

Name Type Description Notes
id String
activity ActivityOptional

Return type

null (empty response body)

Authorization

oauth2_application

HTTP request headers

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

setActivityVersion

setActivityVersion(id, activityVersion, oauth2client, credentials)

Sets the Activity to the specified version.

Parameters

Name Type Description Notes
id String
activityVersion ActivityVersion

Return type

null (empty response body)

Authorization

oauth2_application

HTTP request headers

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