UNPKG

alfresco-js-api

Version:

JavaScript client library for the Alfresco REST API

github.com/Alfresco/alfresco-js-api

Alfresco/alfresco-js-api

159 lines (98 loc) • 4.33 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
156
157
158
159
# ActivitiPublicRestApi.IntegrationAlfrescoOnPremiseApi All URIs are relative to *https://localhost:8080/activiti-app* Method | HTTP request | Description ------------- | ------------- | ------------- [**getAllSites**](IntegrationAlfrescoOnPremiseApi.md#getAllSites) | **GET** /api/enterprise/integration/alfresco/{repositoryId}/sites | List Alfresco sites [**getContentInFolder**](IntegrationAlfrescoOnPremiseApi.md#getContentInFolder) | **GET** /api/enterprise/integration/alfresco/{repositoryId}/folders/{folderId}/content | List file &amp; folders inside a specific folder [**getContentInSite**](IntegrationAlfrescoOnPremiseApi.md#getContentInSite) | **GET** /api/enterprise/integration/alfresco/{repositoryId}/sites/{siteId}/content | List file &amp; folders inside a specific site [**getRepositories**](IntegrationAlfrescoOnPremiseApi.md#getRepositories) | **GET** /api/enterprise/profile/accounts/alfresco | List Alfresco repositories <a name="getAllSites"></a> # **getAllSites** > ResultListDataRepresentation getAllSites(repositoryId) List Alfresco sites Returns ALL Sites ### Example ```javascript var repositoryId = "repositoryId_example"; // String | repositoryId this.alfrescoJsApi.activiti.integrationAlfrescoOnPremiseApi.getAllSites(repositoryId); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repositoryId** | **String**| repositoryId | ### Return type [**ResultListDataRepresentation**](ResultListDataRepresentation.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json <a name="getContentInFolder"></a> # **getContentInFolder** > ResultListDataRepresentation getContentInFolder(repositoryId, folderId) List file &amp; folders inside a specific folder ### Example ```javascript var repositoryId = "repositoryId_example"; // String | repositoryId var folderId = "folderId_example"; // String | folderId this.alfrescoJsApi.activiti.integrationAlfrescoOnPremiseApi.getContentInFolder(repositoryId, folderId); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repositoryId** | **String**| repositoryId | **folderId** | **String**| folderId | ### Return type [**ResultListDataRepresentation**](ResultListDataRepresentation.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json <a name="getContentInSite"></a> # **getContentInSite** > ResultListDataRepresentation getContentInSite(repositoryId, siteId) List file &amp; folders inside a specific site ### Example ```javascript var repositoryId = "repositoryId_example"; // String | repositoryId var siteId = "siteId_example"; // String | siteId this.alfrescoJsApi.activiti.integrationAlfrescoOnPremiseApi.getContentInSite(repositoryId, siteId); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repositoryId** | **String**| repositoryId | **siteId** | **String**| siteId | ### Return type [**ResultListDataRepresentation**](ResultListDataRepresentation.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json <a name="getRepositories"></a> # **getRepositories** > ResultListDataRepresentation getRepositories(opts) List Alfresco repositories A tenant administrator can configure one or more Alfresco repositories to use when working with content. ### Example ```javascript var opts = { 'tenantId': 789, // Integer | tenantId 'includeAccounts': true // Boolean | includeAccounts }; this.alfrescoJsApi.activiti.integrationAlfrescoOnPremiseApi.getRepositories(opts); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **tenantId** | **Integer**| tenantId | [optional] **includeAccounts** | **Boolean**| includeAccounts | [optional] ### Return type [**ResultListDataRepresentation**](ResultListDataRepresentation.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json