UNPKG

forge-apis

Version:

⚠️ Deprecated: This package is no longer maintained. Use 'https://github.com/autodesk-platform-services/aps-sdk-node' instead.

www.npmjs.com/package/@aps_sdk/autodesk-sdkmanager

autodesk-platform-services/aps-sdk-node

155 lines (90 loc) • 4.55 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
# ForgeSdk.ProjectsApi All URIs are relative to *https://developer.api.autodesk.com/* Method | HTTP request | Description ------------- | ------------- | ------------- [**getHubProjects**](ProjectsApi.md#getHubProjects) | **GET** /project/v1/hubs/{hub_id}/projects | [**getProject**](ProjectsApi.md#getProject) | **GET** /project/v1/hubs/{hub_id}/projects/{project_id} | [**getProjectHub**](ProjectsApi.md#getProjectHub) | **GET** /project/v1/hubs/{hub_id}/projects/{project_id}/hub | [**getProjectTopFolders**](ProjectsApi.md#getProjectTopFolders) | **GET** /project/v1/hubs/{hub_id}/projects/{project_id}/topFolders | [**postStorage**](ProjectsApi.md#postStorage) | **POST** /data/v1/projects/{project_id}/storage | <a name="getHubProjects"></a> # **getHubProjects** > Projects getHubProjects(hubId, opts, oauth2client, credentials) Returns a collection of projects for a given &#x60;hub_id&#x60;. A project represents an A360 project or a BIM 360 project which is set up under an A360 hub or BIM 360 account, respectively. Within a hub or an account, multiple projects can be created to be used. ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **hubId** | **String**| the &#x60;hub id&#x60; for the current operation | **filterId** | [**[String]**](String.md)| filter by the &#x60;id&#x60; of the &#x60;ref&#x60; target | [optional] **filterExtensionType** | [**[String]**](String.md)| filter by the extension type | [optional] ### Return type [**Projects**](Projects.md) ### Authorization [oauth2_access_code](../README.md#authentication) ### HTTP request headers - **Content-Type**: application/vnd.api+json - **Accept**: application/vnd.api+json, application/json <a name="getProject"></a> # **getProject** > Project getProject(hubId, projectId, oauth2client, credentials) Returns a project for a given &#x60;project_id&#x60;. ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **hubId** | **String**| the &#x60;hub id&#x60; for the current operation | **projectId** | **String**| the &#x60;project id&#x60; | ### Return type [**Project**](Project.md) ### Authorization [oauth2_access_code](../README.md#authentication) ### HTTP request headers - **Content-Type**: application/vnd.api+json - **Accept**: application/vnd.api+json, application/json <a name="getProjectHub"></a> # **getProjectHub** > Hub getProjectHub(hubId, projectId, oauth2client, credentials) Returns the hub for a given &#x60;project_id&#x60;. ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **hubId** | **String**| the &#x60;hub id&#x60; for the current operation | **projectId** | **String**| the &#x60;project id&#x60; | ### Return type [**Hub**](Hub.md) ### Authorization [oauth2_access_code](../README.md#authentication) ### HTTP request headers - **Content-Type**: application/vnd.api+json - **Accept**: application/vnd.api+json, application/json <a name="getProjectTopFolders"></a> # **getProjectTopFolders** > TopFolders getProjectTopFolders(hubId, projectId, oauth2client, credentials) Returns the details of the highest level folders the user has access to for a given project ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **hubId** | **String**| the &#x60;hub id&#x60; for the current operation | **projectId** | **String**| the &#x60;project id&#x60; | ### Return type [**TopFolders**](TopFolders.md) ### Authorization [oauth2_access_code](../README.md#authentication) ### HTTP request headers - **Content-Type**: application/vnd.api+json - **Accept**: application/vnd.api+json, application/json <a name="postStorage"></a> # **postStorage** > StorageCreated postStorage(projectId, body, oauth2client, credentials) Creates a storage location in the OSS where data can be uploaded to. ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **projectId** | **String**| the &#x60;project id&#x60; | **body** | [**CreateStorage**](CreateStorage.md)| describe the file the storage is created for | ### Return type [**StorageCreated**](StorageCreated.md) ### Authorization [oauth2_access_code](../README.md#authentication) ### HTTP request headers - **Content-Type**: application/vnd.api+json - **Accept**: application/vnd.api+json, application/json