Constructor Detail

Method Detail

• deleteAuditEntriesForAuditApp

  @Headers(value = {"Content-Type: application/json"})@DELETE(value = "alfresco/versions/1/audit-applications/{auditApplicationId}/audit-entries") abstract Unit deleteAuditEntriesForAuditApp(@Path(value = "auditApplicationId") String auditApplicationId, @Query(value = "where") String where)

  Permanently delete audit entries for an audit application Note: this endpoint is available in Alfresco 5.2.2 and newer versions. Permanently delete audit entries for an audit application auditApplicationId. The where clause must be specified, either with an inclusive time period or for an inclusive range of ids. The delete is within the context of the given audit application. For example: * ``where=(createdAt BETWEEN ('2017-06-02T12:13:51.593+01:00' , '2017-06-04T10:05:16.536+01:00')`` * ``where=(id BETWEEN ('1234', '4321')`` You must have admin rights to delete audit information. The endpoint is owned by defaultname service owner @param auditApplicationId The identifier of an audit application. (required) @param where Audit entries to permanently delete for an audit application, given an inclusive time period or range of ids. For example: * ```where=(createdAt BETWEEN ('2017-06-02T12:13:51.593+01:00' , '2017-06-04T10:05:16.536+01:00')``` * ```where=(id BETWEEN ('1234', '4321')``` (required)

• deleteAuditEntry

  @Headers(value = {"Content-Type: application/json"})@DELETE(value = "alfresco/versions/1/audit-applications/{auditApplicationId}/audit-entries/{auditEntryId}") abstract Unit deleteAuditEntry(@Path(value = "auditApplicationId") String auditApplicationId, @Path(value = "auditEntryId") String auditEntryId)

  Permanently delete an audit entry Note: this endpoint is available in Alfresco 5.2.2 and newer versions. Permanently delete a single audit entry auditEntryId. You must have admin rights to delete audit information. The endpoint is owned by defaultname service owner

  Parameters:

  auditApplicationId - The identifier of an audit application.

  auditEntryId - The identifier of an audit entry.

• getAuditApp

  @Headers(value = {"Content-Type: application/json"})@GET(value = "alfresco/versions/1/audit-applications/{auditApplicationId}") abstract AuditApp getAuditApp(@Path(value = "auditApplicationId") String auditApplicationId, @Query(value = "fields") List<String> fields, @Query(value = "include") List<String> include)

  Get audit application info Note: this endpoint is available in Alfresco 5.2.2 and newer versions. Get status of an audit application auditApplicationId. You must have admin rights to retrieve audit information. You can use the include parameter to return the minimum and/or maximum audit record id for the application. The endpoint is owned by defaultname service owner

  Parameters:

  auditApplicationId - The identifier of an audit application.

  fields - A list of field names.

  include - Also include the current minimum and/or maximum audit entry ids for the application.

• getAuditEntry

  @Headers(value = {"Content-Type: application/json"})@GET(value = "alfresco/versions/1/audit-applications/{auditApplicationId}/audit-entries/{auditEntryId}") abstract AuditEntryEntry getAuditEntry(@Path(value = "auditApplicationId") String auditApplicationId, @Path(value = "auditEntryId") String auditEntryId, @Query(value = "fields") List<String> fields)

  Get audit entry Note: this endpoint is available in Alfresco 5.2.2 and newer versions. Gets audit entry auditEntryId. You must have admin rights to access audit information. The endpoint is owned by defaultname service owner

  Parameters:

  auditApplicationId - The identifier of an audit application.

  auditEntryId - The identifier of an audit entry.

  fields - A list of field names.

• listAuditApps

  @Headers(value = {"Content-Type: application/json"})@GET(value = "alfresco/versions/1/audit-applications") abstract AuditAppPaging listAuditApps(@Query(value = "skipCount") Integer skipCount, @Query(value = "maxItems") Integer maxItems, @Query(value = "fields") List<String> fields)

  List audit applications Note: this endpoint is available in Alfresco 5.2.2 and newer versions. Gets a list of audit applications in this repository. This list may include pre-configured audit applications, if enabled, such as: * alfresco-access * CMISChangeLog * Alfresco Tagging Service * Alfresco Sync Service (used by Enterprise Cloud Sync) You must have admin rights to retrieve audit information. The endpoint is owned by defaultname service owner

  Parameters:

  skipCount - The number of entities that exist in the collection before those included in this list.

  maxItems - The maximum number of items to return in the list.

  fields - A list of field names.

• listAuditEntriesForAuditApp

  @Headers(value = {"Content-Type: application/json"})@GET(value = "alfresco/versions/1/audit-applications/{auditApplicationId}/audit-entries") abstract AuditEntryPaging listAuditEntriesForAuditApp(@Path(value = "auditApplicationId") String auditApplicationId, @Query(value = "skipCount") Integer skipCount, @Query(value = "omitTotalItems") Boolean omitTotalItems, @Query(value = "orderBy") List<String> orderBy, @Query(value = "maxItems") Integer maxItems, @Query(value = "where") String where, @Query(value = "include") List<String> include, @Query(value = "fields") List<String> fields)

  List audit entries for an audit application Note: this endpoint is available in Alfresco 5.2.2 and newer versions. Gets a list of audit entries for audit application auditApplicationId. You can use the include parameter to return additional values information. The list can be filtered by one or more of: * createdByUser person id * createdAt inclusive time period * id inclusive range of ids * valuesKey audit entry values contains the exact matching key * valuesValue audit entry values contains the exact matching value The default sort order is createdAt ascending, but you can use an optional ASC or DESC modifier to specify an ascending or descending sort order. For example, specifying ``orderBy=createdAt DESC`` returns audit entries in descending createdAt order. You must have admin rights to retrieve audit information. The endpoint is owned by defaultname service owner @param auditApplicationId The identifier of an audit application. (required) @param skipCount The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0. (optional, default to 0) @param omitTotalItems A boolean to control if the response provides the total numbers of items in the collection. If not supplied then the default value is false. (optional, default to false) @param orderBy 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. 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. To sort the entities in a specific order, you can use the ASC and DESC keywords for any field. (optional) @param maxItems The maximum number of items to return in the list. If not supplied then the default value is 100. (optional, default to 100) @param where Optionally filter the list. Here are some examples: * ```where=(createdByUser='jbloggs')``` * ```where=(id BETWEEN ('1234', '4321')``` * ```where=(createdAt BETWEEN ('2017-06-02T12:13:51.593+01:00' , '2017-06-04T10:05:16.536+01:00')``` * ```where=(createdByUser='jbloggs' and createdAt BETWEEN ('2017-06-02T12:13:51.593+01:00' , '2017-06-04T10:05:16.536+01:00')``` * ```where=(valuesKey='/alfresco-access/login/user')``` * ```where=(valuesKey='/alfresco-access/transaction/action' and valuesValue='DELETE')``` (optional) @param include Returns additional information about the audit entry. The following optional fields can be requested: * values (optional) @param fields A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. 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)

• listAuditEntriesForNode

  @Headers(value = {"Content-Type: application/json"})@GET(value = "alfresco/versions/1/nodes/{nodeId}/audit-entries") abstract AuditEntryPaging listAuditEntriesForNode(@Path(value = "nodeId") String nodeId, @Query(value = "skipCount") Integer skipCount, @Query(value = "orderBy") List<String> orderBy, @Query(value = "maxItems") Integer maxItems, @Query(value = "where") String where, @Query(value = "include") List<String> include, @Query(value = "fields") List<String> fields)

  List audit entries for a node Note: this endpoint is available in Alfresco 5.2.2 and newer versions. Gets a list of audit entries for node nodeId. The list can be filtered by createdByUser and for a given inclusive time period. The default sort order is createdAt ascending, but you can use an optional ASC or DESC modifier to specify an ascending or descending sort order. For example, specifying ``orderBy=createdAt DESC`` returns audit entries in descending createdAt order. This relies on the pre-configured 'alfresco-access' audit application. The endpoint is owned by defaultname service owner @param nodeId The identifier of a node. (required) @param skipCount The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0. (optional, default to 0) @param orderBy 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. 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. To sort the entities in a specific order, you can use the ASC and DESC keywords for any field. (optional) @param maxItems The maximum number of items to return in the list. If not supplied then the default value is 100. (optional, default to 100) @param where Optionally filter the list. Here are some examples: * ```where=(createdByUser='-me-')``` * ```where=(createdAt BETWEEN ('2017-06-02T12:13:51.593+01:00' , '2017-06-04T10:05:16.536+01:00')``` * ```where=(createdByUser='jbloggs' and createdAt BETWEEN ('2017-06-02T12:13:51.593+01:00' , '2017-06-04T10:05:16.536+01:00')``` (optional) @param include Returns additional information about the audit entry. The following optional fields can be requested: * values (optional) @param fields A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. 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)

• updateAuditApp

  @Headers(value = {"Content-Type: application/json"})@PUT(value = "alfresco/versions/1/audit-applications/{auditApplicationId}") abstract AuditApp updateAuditApp(@Path(value = "auditApplicationId") String auditApplicationId, @Body() AuditBodyUpdate auditAppBodyUpdate, @Query(value = "fields") List<String> fields)

  Update audit application info Note: this endpoint is available in Alfresco 5.2.2 and newer versions. Disable or re-enable the audit application auditApplicationId. New audit entries will not be created for a disabled audit application until it is re-enabled (and system-wide auditing is also enabled). Note, it is still possible to query &/or delete any existing audit entries even if auditing is disabled for the audit application. You must have admin rights to update audit application. The endpoint is owned by defaultname service owner

  Parameters:

  auditApplicationId - The identifier of an audit application.

  auditAppBodyUpdate - The audit application to update.

  fields - A list of field names.