Skip to content
This repository was archived by the owner on Jun 11, 2025. It is now read-only.

Commit df64684

Browse files
Table is broken. (#596)
1 parent 6da900b commit df64684

File tree

1 file changed

+19
-139
lines changed

1 file changed

+19
-139
lines changed

src/api/content-rest-api/docs/AuditApi.md

Lines changed: 19 additions & 139 deletions
Original file line numberDiff line numberDiff line change
@@ -61,11 +61,7 @@ auditApi.deleteAuditEntriesForAuditApp(auditApplicationIdwhere).then(() => {
6161
Name | Type | Description | Notes
6262
------------- | ------------- | ------------- | -------------
6363
**auditApplicationId** | **string**| The identifier of an audit application. |
64-
**where** | **string**| Audit entries to permanently delete for an audit application, given an inclusive time period or range of ids. For example:
65-
66-
* where=(createdAt BETWEEN ('2017-06-02T12:13:51.593+01:00' , '2017-06-04T10:05:16.536+01:00')
67-
* where=(id BETWEEN ('1234', '4321')
68-
|
64+
**where** | **string**| Audit entries to permanently delete for an audit application, given an inclusive time period or range of ids. For example: <br><br><ul><li>where=(createdAt BETWEEN ('2017-06-02T12:13:51.593+01:00' , '2017-06-04T10:05:16.536+01:00')</li><li>where=(id BETWEEN ('1234', '4321')</li></ul>|
6965

7066
### Return type
7167

@@ -169,18 +165,7 @@ auditApi.getAuditApp(auditApplicationIdopts).then((data) => {
169165
Name | Type | Description | Notes
170166
------------- | ------------- | ------------- | -------------
171167
**auditApplicationId** | **string**| The identifier of an audit application. |
172-
**fields** | [**string**](string.md)| A list of field names.
173-
174-
You can use this parameter to restrict the fields
175-
returned within a response if, for example, you want to save on overall bandwidth.
176-
177-
The list applies to a returned individual
178-
entity or entries within a collection.
179-
180-
If the API method also supports the **include**
181-
parameter, then the fields specified in the **include**
182-
parameter are returned in addition to those specified in the **fields** parameter.
183-
| [optional]
168+
**fields** | [**string**](string.md)| A list of field names.<br><br>You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth.<br><br>The list applies to a returned individual entity or entries within a collection.<br><br>If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter. | [optional]
184169

185170
### Return type
186171

@@ -240,18 +225,7 @@ Name | Type | Description | Notes
240225
------------- | ------------- | ------------- | -------------
241226
**auditApplicationId** | **string**| The identifier of an audit application. |
242227
**auditEntryId** | **string**| The identifier of an audit entry. |
243-
**fields** | [**string**](string.md)| A list of field names.
244-
245-
You can use this parameter to restrict the fields
246-
returned within a response if, for example, you want to save on overall bandwidth.
247-
248-
The list applies to a returned individual
249-
entity or entries within a collection.
250-
251-
If the API method also supports the **include**
252-
parameter, then the fields specified in the **include**
253-
parameter are returned in addition to those specified in the **fields** parameter.
254-
| [optional]
228+
**fields** | [**string**](string.md)| A list of field names.<br><br>You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth.<br><br>The list applies to a returned individual entity or entries within a collection.<br><br>If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter. | [optional]
255229

256230
### Return type
257231

@@ -322,24 +296,9 @@ auditApi.listAuditApps(opts).then((data) => {
322296

323297
Name | Type | Description | Notes
324298
------------- | ------------- | ------------- | -------------
325-
**skipCount** | **number**| The number of entities that exist in the collection before those included in this list.
326-
If not supplied then the default value is 0.
327-
| [optional] [default to 0]
328-
**maxItems** | **number**| The maximum number of items to return in the list.
329-
If not supplied then the default value is 100.
330-
| [optional] [default to 100]
331-
**fields** | [**string**](string.md)| A list of field names.
332-
333-
You can use this parameter to restrict the fields
334-
returned within a response if, for example, you want to save on overall bandwidth.
335-
336-
The list applies to a returned individual
337-
entity or entries within a collection.
338-
339-
If the API method also supports the **include**
340-
parameter, then the fields specified in the **include**
341-
parameter are returned in addition to those specified in the **fields** parameter.
342-
| [optional]
299+
**skipCount** | **number**| The number of entities that exist in the collection before those included in this list.<br>If not supplied then the default value is 0. | [optional] [default to 0]
300+
**maxItems** | **number**| The maximum number of items to return in the list.<br>If not supplied then the default value is 100. | [optional] [default to 100]
301+
**fields** | [**string**](string.md)| A list of field names.<br><br>You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth.<br><br>The list applies to a returned individual entity or entries within a collection.<br><br>If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter. | [optional]
343302

344303
### Return type
345304

@@ -443,49 +402,12 @@ auditApi.listAuditEntriesForAuditApp(auditApplicationIdopts).then((data) => {
443402
Name | Type | Description | Notes
444403
------------- | ------------- | ------------- | -------------
445404
**auditApplicationId** | **string**| The identifier of an audit application. |
446-
**skipCount** | **number**| The number of entities that exist in the collection before those included in this list.
447-
If not supplied then the default value is 0.
448-
| [optional] [default to 0]
449-
**orderBy** | [**string**](string.md)| A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to
450-
sort the list by one or more fields.
451-
452-
Each field has a default sort order, which is normally ascending order. Read the API method implementation notes
453-
above to check if any fields used in this method have a descending default search order.
454-
455-
To sort the entities in a specific order, you can use the **ASC** and **DESC** keywords for any field.
456-
| [optional]
457-
**maxItems** | **number**| The maximum number of items to return in the list.
458-
If not supplied then the default value is 100.
459-
| [optional] [default to 100]
460-
**where** | **string**| Optionally filter the list. Here are some examples:
461-
462-
* where=(createdByUser='jbloggs')
463-
464-
* where=(id BETWEEN ('1234', '4321')
465-
466-
* where=(createdAt BETWEEN ('2017-06-02T12:13:51.593+01:00' , '2017-06-04T10:05:16.536+01:00')
467-
468-
* where=(createdByUser='jbloggs' and createdAt BETWEEN ('2017-06-02T12:13:51.593+01:00' , '2017-06-04T10:05:16.536+01:00')
469-
470-
* where=(valuesKey='/alfresco-access/login/user')
471-
472-
* where=(valuesKey='/alfresco-access/transaction/action' and valuesValue='DELETE')
473-
| [optional]
474-
**include** | [**string**](string.md)| Returns additional information about the audit entry. The following optional fields can be requested:
475-
* values
476-
| [optional]
477-
**fields** | [**string**](string.md)| A list of field names.
478-
479-
You can use this parameter to restrict the fields
480-
returned within a response if, for example, you want to save on overall bandwidth.
481-
482-
The list applies to a returned individual
483-
entity or entries within a collection.
484-
485-
If the API method also supports the **include**
486-
parameter, then the fields specified in the **include**
487-
parameter are returned in addition to those specified in the **fields** parameter.
488-
| [optional]
405+
**skipCount** | **number**| The number of entities that exist in the collection before those included in this list.<br>If not supplied then the default value is 0. | [optional] [default to 0]
406+
**orderBy** | [**string**](string.md)| A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to sort the list by one or more fields.<br><br>Each field has a default sort order, which is normally ascending order. Read the API method implementation notes above to check if any fields used in this method have a descending default search order.<br><br>To sort the entities in a specific order, you can use the **ASC** and **DESC** keywords for any field. | [optional]
407+
**maxItems** | **number**| The maximum number of items to return in the list.<br>If not supplied then the default value is 100. | [optional] [default to 100]
408+
**where** | **string**| Optionally filter the list. Here are some examples:<br><ul><li>where=(createdByUser='jbloggs')</li><li>where=(id BETWEEN ('1234', '4321')</li><li>where=(createdAt BETWEEN ('2017-06-02T12:13:51.593+01:00' , '2017-06-04T10:05:16.536+01:00')</li><li>where=(createdByUser='jbloggs' and createdAt BETWEEN ('2017-06-02T12:13:51.593+01:00' , '2017-06-04T10:05:16.536+01:00')</li><li>where=(valuesKey='/alfresco-access/login/user')</li><li>where=(valuesKey='/alfresco-access/transaction/action' and valuesValue='DELETE')</li></ul> | [optional]
409+
**include** | [**string**](string.md)| Returns additional information about the audit entry. The following optional fields can be requested:<ul><li>values</li></ul> | [optional]
410+
**fields** | [**string**](string.md)| A list of field names.<br><br>You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth.<br><br>The list applies to a returned individual entity or entries within a collection.<br><br>If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter. | [optional]
489411
490412
### Return type
491413
@@ -576,43 +498,12 @@ auditApi.listAuditEntriesForNode(nodeIdopts).then((data) => {
576498
Name | Type | Description | Notes
577499
------------- | ------------- | ------------- | -------------
578500
**nodeId** | **string**| The identifier of a node. |
579-
**skipCount** | **number**| The number of entities that exist in the collection before those included in this list.
580-
If not supplied then the default value is 0.
581-
| [optional] [default to 0]
582-
**orderBy** | [**string**](string.md)| A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to
583-
sort the list by one or more fields.
584-
585-
Each field has a default sort order, which is normally ascending order. Read the API method implementation notes
586-
above to check if any fields used in this method have a descending default search order.
587-
588-
To sort the entities in a specific order, you can use the **ASC** and **DESC** keywords for any field.
589-
| [optional]
590-
**maxItems** | **number**| The maximum number of items to return in the list.
591-
If not supplied then the default value is 100.
592-
| [optional] [default to 100]
593-
**where** | **string**| Optionally filter the list. Here are some examples:
594-
595-
* where=(createdByUser='-me-')
596-
597-
* where=(createdAt BETWEEN ('2017-06-02T12:13:51.593+01:00' , '2017-06-04T10:05:16.536+01:00')
598-
599-
* where=(createdByUser='jbloggs' and createdAt BETWEEN ('2017-06-02T12:13:51.593+01:00' , '2017-06-04T10:05:16.536+01:00')
600-
| [optional]
601-
**include** | [**string**](string.md)| Returns additional information about the audit entry. The following optional fields can be requested:
602-
* values
603-
| [optional]
604-
**fields** | [**string**](string.md)| A list of field names.
605-
606-
You can use this parameter to restrict the fields
607-
returned within a response if, for example, you want to save on overall bandwidth.
608-
609-
The list applies to a returned individual
610-
entity or entries within a collection.
611-
612-
If the API method also supports the **include**
613-
parameter, then the fields specified in the **include**
614-
parameter are returned in addition to those specified in the **fields** parameter.
615-
| [optional]
501+
**skipCount** | **number**| The number of entities that exist in the collection before those included in this list.<br>If not supplied then the default value is 0. | [optional] [default to 0]
502+
**orderBy** | [**string**](string.md)| A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to sort the list by one or more fields.<br><br>Each field has a default sort order, which is normally ascending order. Read the API method implementation notes above to check if any fields used in this method have a descending default search order.<br><br>To sort the entities in a specific order, you can use the **ASC** and **DESC** keywords for any field. | [optional]
503+
**maxItems** | **number**| The maximum number of items to return in the list.<br>If not supplied then the default value is 100. | [optional] [default to 100]
504+
**where** | **string**| Optionally filter the list. Here are some examples:<br><ul><li>where=(createdByUser='-me-')</li><li>where=(createdAt BETWEEN ('2017-06-02T12:13:51.593+01:00' , '2017-06-04T10:05:16.536+01:00')</li><li>where=(createdByUser='jbloggs' and createdAt BETWEEN ('2017-06-02T12:13:51.593+01:00' , '2017-06-04T10:05:16.536+01:00')</li></ul> | [optional]
505+
**include** | [**string**](string.md)| Returns additional information about the audit entry. The following optional fields can be requested:<ul><li>values</li></ul> | [optional]
506+
**fields** | [**string**](string.md)| A list of field names.<br><br>You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth.<br><br>The list applies to a returned individual entity or entries within a collection.<br><br>If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter. | [optional]
616507
617508
### Return type
618509
@@ -678,18 +569,7 @@ Name | Type | Description | Notes
678569
------------- | ------------- | ------------- | -------------
679570
**auditApplicationId** | **string**| The identifier of an audit application. |
680571
**auditAppBodyUpdate** | [**AuditBodyUpdate**](AuditBodyUpdate.md)| The audit application to update. |
681-
**fields** | [**string**](string.md)| A list of field names.
682-
683-
You can use this parameter to restrict the fields
684-
returned within a response if, for example, you want to save on overall bandwidth.
685-
686-
The list applies to a returned individual
687-
entity or entries within a collection.
688-
689-
If the API method also supports the **include**
690-
parameter, then the fields specified in the **include**
691-
parameter are returned in addition to those specified in the **fields** parameter.
692-
| [optional]
572+
**fields** | [**string**](string.md)| A list of field names.<br><br>You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth.<br><br>The list applies to a returned individual entity or entries within a collection.<br><br>If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter. | [optional]
693573
694574
### Return type
695575

0 commit comments

Comments
 (0)