Here's what's new with the TeamForge 20.1 REST APIs as compared to TeamForge 20.0.

Source Code Management API

Here’s a list of what’s new with the Source Code Management REST APIs in TeamForge 20.1 as compared to Source Code Management REST APIs in TeamForge 20.0.

New APIs

API Group Operation API Signature / Description
Repositories GET /repositories/{repositoryId}/repositoryConsumers

Gets a list of repositories that use given repository as submodule
Repositories POST /repositories/updateSubmodulesUsage

Updates the list of submodules used by given repositories

New Response Attributes

Recent Activities > GET /myself/recent/repositories Gets recent repository list for the current user

  • New attribute in 200 response: items[]/projectTitle (in: body, type: string)
  • New attribute in 200 response: items[]/projectPath (in: body, type: string)

Document Management API

Here’s a list of what’s new with the Document Management REST APIs in TeamForge 20.1 as compared to Document Management REST APIs in TeamForge 20.0.

New APIs

API Group Operation API Signature / Description
DocumentFolders and Documents POST /projects/{projectIdOrPath}/favourites

Gets favourite folders and documents for the user
DocumentFolders and Documents POST /{folderId}/advanced-search/results

Gets documents matching the advanced search criteria which current user can view

New Request Parameters

DocumentFolders and Documents > DELETE /projects/{projectIdOrPath}/documentfolders-documents/multiple Delete multiple folders and documents

  • fieldValues[]/projectIdOrPath (in: path, type: string)

DocumentFolders > GET /documentfolders/{docfolderid}/users Gets users who have the view permission under a folder

  • fieldValues[]/allUsers (in: query, type: boolean)

Fields > GET /documents/{folderId}/fields Get list of document fields in the given folder’s project

  • fieldValues[]/includeNone (in: query, type: boolean)

New Response Attributes

A new 200 response attribute, folders/items[]/isFavourite (in: body, type: boolean), has been added to the following methods:

  • DocumentFolders and Documents > GET /documentfolders/{docfolderid}/documentfolders-documents Gets document folders and documents under given folder which current user can view
  • DocumentFolders and Documents > POST /documentfolders/{docfolderid}/documentfolders-documents/results Gets document folders and documents under given folder which current user can view
  • Documents > POST /projects/{projectIdOrPath}/tags/{tagId} Gets documents under given tag which current user can view

The following new 200 response attributes have been added to the PUT /projects/{projectid}/documentfolders/{docfolderid}/move method.

  • folderSuccessIds (in: body, type: string[])
  • folderFailureMap (in: body, type: Hash[string, array])
  • documentSuccessIds (in: body, type: string[])
  • documentFailureMap (in: body, type: Hash[string, array])

Planning Folder API

Here’s a list of what’s new with the Planning Folder REST APIs in TeamForge 20.1 as compared to Planning Folder REST APIs in TeamForge 20.0.

New Request Parameters

PlanningFolders > PATCH /projects/{projectId}/planningfolders/statuses Updates planning folder status

  • fieldValues[]/id (in: body, type: string)
  • fieldValues[]/isDefault (in: body, type: string)

PlanningFolders > POST /projects/{projectId}/planningfolders/statuses Create status field value for planning folder

  • fieldValues[]/id (in: body, type: string)
  • fieldValues[]/isDefault (in: body, type: string)

Foundation API

Here’s a list of what’s new with the Foundation REST APIs in TeamForge 20.1 as compared to Foundation REST APIs in TeamForge 20.0.

New APIs

API Group Operation API Signature / Description
Server PUT /server/broadcast-message/

Sets/updates the broadcast message

TeamForge Baselines

Here’s a list of what’s new with TeamForge Baselines REST APIs.

New APIs

POST {HostName}/ctfrest/baseline/v1/router/baselines/{baselineId}—Deletes a baseline that is in either Open or Rejected meta status.

TeamForge Webhooks-based Event Broker (WEBR)

Here’s a list of what’s new with TeamForge WEBR REST APIs.

New APIs

Here’s the list of new APIs to create, list and edit WEBR orchestration scripts and endpoints.

  • POST {HostName}/orchscripts/v4—Creates WEBR orchestration scripts.
  • GET {HostName}/orchscripts/v4—Lists the WEBR orchestration scripts.
  • PUT {HostName}/orchscripts/v4/{OrchId}/script—Updates a WEBR orchestration script.
  • POST {HostName}/endpoints/v4—Creates new endpoint.
  • GET {HostName}/endpoints/v4—Lists the endpoints.
  • PUT {HostName}/endpoints/v4/{EndpointId}—Updates an endpoint.

[]:

[]:

Tags for this page: REST extend_teamforge ctf_20.1