Skip to content

Latest commit

 

History

History
242 lines (149 loc) · 6.36 KB

ActivitiesApi.md

File metadata and controls

242 lines (149 loc) · 6.36 KB

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.
updateActivity PUT /autocad.io/us-east/v2/Activities('{id}') Updates an Activity by redefining the entire Activity object.

createActivity

Activity createActivity(activity)

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)

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)

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)

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)

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()

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)

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)

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

updateActivity

updateActivity(id, activity)

Updates an Activity by redefining the entire Activity object.

Parameters

Name Type Description Notes
id String
activity Activity

Return type

null (empty response body)

Authorization

oauth2_application

HTTP request headers

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