Skip to content

Commit 42c665e

Browse files
gregra81gregra81
committed
reference documentation
1 parent f551ec4 commit 42c665e

File tree

148 files changed

+4431
-21
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

148 files changed

+4431
-21
lines changed

Diff for: ‎README.md

+116-21
Large diffs are not rendered by default.

Diff for: ‎docs/ActivitiesApi.md

+242
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,242 @@
1+
# ForgeSdk.ActivitiesApi
2+
3+
All URIs are relative to *https://developer.api.autodesk.com/*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**createActivity**](ActivitiesApi.md#createActivity) | **POST** /autocad.io/us-east/v2/Activities | Creates a new Activity.
8+
[**deleteActivity**](ActivitiesApi.md#deleteActivity) | **DELETE** /autocad.io/us-east/v2/Activities(%27{id}%27) | Removes a specific Activity.
9+
[**deleteActivityHistory**](ActivitiesApi.md#deleteActivityHistory) | **POST** /autocad.io/us-east/v2/Activities(%27{id}%27)/Operations.DeleteHistory | Removes the version history of the specified Activity.
10+
[**getActivity**](ActivitiesApi.md#getActivity) | **GET** /autocad.io/us-east/v2/Activities(%27{id}%27) | Returns the details of a specific Activity.
11+
[**getActivityVersions**](ActivitiesApi.md#getActivityVersions) | **GET** /autocad.io/us-east/v2/Activities(%27{id}%27)/Operations.GetVersions | Returns all old versions of a specified Activity.
12+
[**getAllActivities**](ActivitiesApi.md#getAllActivities) | **GET** /autocad.io/us-east/v2/Activities | Returns the details of all Activities.
13+
[**patchActivity**](ActivitiesApi.md#patchActivity) | **PATCH** /autocad.io/us-east/v2/Activities(%27{id}%27) | Updates an Activity by specifying only the changed attributes.
14+
[**setActivityVersion**](ActivitiesApi.md#setActivityVersion) | **POST** /autocad.io/us-east/v2/Activities(%27{id}%27)/Operations.SetVersion | Sets the Activity to the specified version.
15+
[**updateActivity**](ActivitiesApi.md#updateActivity) | **PUT** /autocad.io/us-east/v2/Activities(%27{id}%27) | Updates an Activity by redefining the entire Activity object.
16+
17+
18+
<a name="createActivity"></a>
19+
# **createActivity**
20+
> Activity createActivity(activity, oauth2client)
21+
22+
Creates a new Activity.
23+
24+
### Parameters
25+
26+
Name | Type | Description | Notes
27+
------------- | ------------- | ------------- | -------------
28+
**activity** | [**Activity**](Activity.md)| |
29+
30+
### Return type
31+
32+
[**Activity**](Activity.md)
33+
34+
### Authorization
35+
36+
[oauth2_application](../README.md#authentication)
37+
38+
### HTTP request headers
39+
40+
- **Content-Type**: application/json
41+
- **Accept**: application/vnd.api+json, application/json
42+
43+
<a name="deleteActivity"></a>
44+
# **deleteActivity**
45+
> deleteActivity(id, oauth2client)
46+
47+
Removes a specific Activity.
48+
49+
### Parameters
50+
51+
Name | Type | Description | Notes
52+
------------- | ------------- | ------------- | -------------
53+
**id** | **String**| |
54+
55+
### Return type
56+
57+
null (empty response body)
58+
59+
### Authorization
60+
61+
[oauth2_application](../README.md#authentication)
62+
63+
### HTTP request headers
64+
65+
- **Content-Type**: application/json
66+
- **Accept**: application/vnd.api+json, application/json
67+
68+
<a name="deleteActivityHistory"></a>
69+
# **deleteActivityHistory**
70+
> deleteActivityHistory(id, oauth2client)
71+
72+
Removes the version history of the specified Activity.
73+
74+
### Parameters
75+
76+
Name | Type | Description | Notes
77+
------------- | ------------- | ------------- | -------------
78+
**id** | **String**| |
79+
80+
### Return type
81+
82+
null (empty response body)
83+
84+
### Authorization
85+
86+
[oauth2_application](../README.md#authentication)
87+
88+
### HTTP request headers
89+
90+
- **Content-Type**: application/json
91+
- **Accept**: application/vnd.api+json, application/json
92+
93+
<a name="getActivity"></a>
94+
# **getActivity**
95+
> Activity getActivity(id, oauth2client)
96+
97+
Returns the details of a specific Activity.
98+
99+
### Parameters
100+
101+
Name | Type | Description | Notes
102+
------------- | ------------- | ------------- | -------------
103+
**id** | **String**| |
104+
105+
### Return type
106+
107+
[**Activity**](Activity.md)
108+
109+
### Authorization
110+
111+
[oauth2_application](../README.md#authentication)
112+
113+
### HTTP request headers
114+
115+
- **Content-Type**: application/json
116+
- **Accept**: application/vnd.api+json, application/json
117+
118+
<a name="getActivityVersions"></a>
119+
# **getActivityVersions**
120+
> [Activity] getActivityVersions(id, oauth2client)
121+
122+
Returns all old versions of a specified Activity.
123+
124+
### Parameters
125+
126+
Name | Type | Description | Notes
127+
------------- | ------------- | ------------- | -------------
128+
**id** | **String**| |
129+
130+
### Return type
131+
132+
[**[Activity]**](Activity.md)
133+
134+
### Authorization
135+
136+
[oauth2_application](../README.md#authentication)
137+
138+
### HTTP request headers
139+
140+
- **Content-Type**: application/json
141+
- **Accept**: application/vnd.api+json, application/json
142+
143+
<a name="getAllActivities"></a>
144+
# **getAllActivities**
145+
> [Activity] getAllActivities(oauth2client)
146+
147+
Returns the details of all Activities.
148+
149+
### Parameters
150+
This endpoint does not need any parameter.
151+
152+
### Return type
153+
154+
[**[Activity]**](Activity.md)
155+
156+
### Authorization
157+
158+
[oauth2_application](../README.md#authentication)
159+
160+
### HTTP request headers
161+
162+
- **Content-Type**: application/json
163+
- **Accept**: application/vnd.api+json, application/json
164+
165+
<a name="patchActivity"></a>
166+
# **patchActivity**
167+
> patchActivity(id, activity, oauth2client)
168+
169+
Updates an Activity by specifying only the changed attributes.
170+
171+
### Parameters
172+
173+
Name | Type | Description | Notes
174+
------------- | ------------- | ------------- | -------------
175+
**id** | **String**| |
176+
**activity** | [**ActivityOptional**](ActivityOptional.md)| |
177+
178+
### Return type
179+
180+
null (empty response body)
181+
182+
### Authorization
183+
184+
[oauth2_application](../README.md#authentication)
185+
186+
### HTTP request headers
187+
188+
- **Content-Type**: application/json
189+
- **Accept**: application/vnd.api+json, application/json
190+
191+
<a name="setActivityVersion"></a>
192+
# **setActivityVersion**
193+
> setActivityVersion(id, activityVersion, oauth2client)
194+
195+
Sets the Activity to the specified version.
196+
197+
### Parameters
198+
199+
Name | Type | Description | Notes
200+
------------- | ------------- | ------------- | -------------
201+
**id** | **String**| |
202+
**activityVersion** | [**ActivityVersion**](ActivityVersion.md)| |
203+
204+
### Return type
205+
206+
null (empty response body)
207+
208+
### Authorization
209+
210+
[oauth2_application](../README.md#authentication)
211+
212+
### HTTP request headers
213+
214+
- **Content-Type**: application/json
215+
- **Accept**: application/vnd.api+json, application/json
216+
217+
<a name="updateActivity"></a>
218+
# **updateActivity**
219+
> updateActivity(id, activity, oauth2client)
220+
221+
Updates an Activity by redefining the entire Activity object.
222+
223+
### Parameters
224+
225+
Name | Type | Description | Notes
226+
------------- | ------------- | ------------- | -------------
227+
**id** | **String**| |
228+
**activity** | [**Activity**](Activity.md)| |
229+
230+
### Return type
231+
232+
null (empty response body)
233+
234+
### Authorization
235+
236+
[oauth2_application](../README.md#authentication)
237+
238+
### HTTP request headers
239+
240+
- **Content-Type**: application/json
241+
- **Accept**: application/vnd.api+json, application/json
242+

Diff for: ‎docs/Activity.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# ForgeSdk.Activity
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**id** | **String** | |
7+
**instruction** | **Object** | |
8+
**appPackages** | **[String]** | |
9+
**requiredEngineVersion** | **String** | |
10+
**parameters** | **Object** | |
11+
**allowedChildProcesses** | **[Object]** | |
12+
**version** | **Integer** | |
13+
**description** | **String** | | [optional]
14+
**hostApplication** | **String** | | [optional]
15+
**isPublic** | **Boolean** | |
16+
17+

Diff for: ‎docs/ActivityOptional.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# ForgeSdk.ActivityOptional
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**id** | **String** | | [optional]
7+
**instruction** | **Object** | | [optional]
8+
**appPackages** | **[String]** | | [optional]
9+
**requiredEngineVersion** | **String** | | [optional]
10+
**parameters** | **Object** | | [optional]
11+
**allowedChildProcesses** | **[Object]** | | [optional]
12+
**version** | **Integer** | | [optional]
13+
**description** | **String** | | [optional]
14+
**hostApplication** | **String** | | [optional]
15+
**isPublic** | **Boolean** | | [optional]
16+
17+

Diff for: ‎docs/ActivityVersion.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# ForgeSdk.ActivityVersion
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**version** | **Integer** | | [optional]
7+
8+

Diff for: ‎docs/AppPackage.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# ForgeSdk.AppPackage
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**id** | **String** | |
7+
**resource** | **String** | |
8+
**references** | **[String]** | |
9+
**requiredEngineVersion** | **String** | |
10+
**version** | **Integer** | |
11+
**description** | **String** | | [optional]
12+
**isPublic** | **Boolean** | | [optional]
13+
**isObjectEnabler** | **Boolean** | | [optional]
14+
15+

Diff for: ‎docs/AppPackageOptional.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# ForgeSdk.AppPackageOptional
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**id** | **String** | | [optional]
7+
**resource** | **String** | | [optional]
8+
**references** | **[String]** | | [optional]
9+
**requiredEngineVersion** | **String** | | [optional]
10+
**version** | **Integer** | | [optional]
11+
**description** | **String** | | [optional]
12+
**isPublic** | **Boolean** | | [optional]
13+
**isObjectEnabler** | **Boolean** | | [optional]
14+
15+

Diff for: ‎docs/AppPackageVersion.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# ForgeSdk.AppPackageVersion
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**version** | **Integer** | | [optional]
7+
8+

0 commit comments

Comments
 (0)