GroupShare API

GroupShare WebHooks Service

Patrick Andrew Hartnett — Tue, 09 Sep 2025 09:01:03 GMT

Current Revision posted to GroupShare API by Patrick Andrew Hartnett on 9/9/2025 9:01:03 AM

Learn how to configure and use the Trados GroupShare WebHooks Service.

GroupShare WebHooks Service

Patrick Andrew Hartnett — Tue, 09 Sep 2025 09:00:39 GMT

Revision 3 posted to GroupShare API by Patrick Andrew Hartnett on 9/9/2025 9:00:39 AM

Using the Trados GroupShare WebHooks Service

Learn how to configure and use the Trados GroupShare WebHooks Service.

Getting started

Georgiana Iancu — Thu, 03 Aug 2023 08:12:25 GMT

Current Revision posted to GroupShare API by Georgiana Iancu on 8/3/2023 8:12:25 AM

GroupShare related articles.

GroupShare API

Georgiana Iancu — Wed, 02 Aug 2023 14:30:39 GMT

Current Revision posted to GroupShare API by Georgiana Iancu on 8/2/2023 2:30:39 PM

GroupShare WebHooks Service

Paul — Thu, 07 May 2020 16:47:17 GMT

Revision 2 posted to GroupShare API by Paul on 5/7/2020 4:47:17 PM

WebHooks provide a publish / subscribe model for wiring together Web APIs and services. You can subcribe to GroupShare events and get notified when that event happens, through a callback.

When subscribing to an event you need to provide a callback URI where you want to be notified when the event occurs. When the event occurs an HTTP POST request is sent to your callback URI with information about what happened.

GroupShare WebHooks Service

GroupShare WebHooks Service is implemented as a standalone self hosted Rest API application, that can be run as a Windows Service or in console mode (using --console switch).
The default port that the Rest API self hosted service listens is 41239.

Configuration

Configuration for the WebHooks service is done in Sdl.GroupShare.WebHooksService.exe.config under C:\Program Files\SDL\SDL Server\WebHooks Service (only relevant settings are shown):

<appSettings>
  <add key="RestHostUrl" value="http://+:41239" />
  <add key="MessageQueueHost" value="localhost" />
  <add key="MessageQueueUserName" value="gssvc" />
  <add key="MessageQueueUserPassword" value="u5F/lWdnD+snwvYcjKv/Fg==" />
  <add key="WebHookQueueName" value="GsWebHookQueue" />
  <add key="WebHookQueueDeadLetterName" value="GsWebHookQueueDeadLetter" />
  <add key="WebHookQueueDLXName" value="GsWebHookDlx" />
  <add key="Server" value="gs-test-url.sdltest.com" />
  <add key="serilog:write-to:RollingFile.pathFormat" value="C:\ProgramData\SDL\Service\logs\WebHooks.Log" />
</appSettings>
<connectionStrings>
  <add name="MS_SqlStoreConnectionString" connectionString="Server=(local)\sqlserver2014;Database=SDLSystem;Trusted_Connection=True;" providerName="System.Data.SqlClient" />
</connectionStrings>

Above you can see the configuration used for the service listening port, the RabbitMQ message queue and the database where the web hook registrations will be stored.

RestHostUrl

The host and port setting that the Web Hooks Service will use to listen on.

MessageQueueHost, MessageQueueUserName, MessageQueuePassword

These are configured by GroupShare installer and are needed to consume messages from RabbitMQ.

WebHookQueueName, WebHookQueueDeadLetterName, WebHookQueueDLXName

Used to specify the queues to consume messages from. It would be possible to create new queues with different routing keys. Recommended to leave as it is.

Server

The value of the Server setting will be included in the callback request body, to know the web hook sender of the message. See the "Server" property in each message body.

Supported Filters

You can subscribe to all existing events by using the "*" filter and a single callback handling URL.
The available filter types are as follows:

Sdl.GroupShare.Events.V2.ProjectCreatedEvent
Sdl.GroupShare.Events.V2.PhaseChangeEvent
Sdl.GroupShare.Events.V2.AssignmentEvent
Sdl.GroupShare.Events.V2.CheckOutEvent
Sdl.GroupShare.Events.V2.CheckInEvent
*

Rest API endpoint of WebHooks Service

Interaction with the GroupShare WebHooks Service happens through Rest API calls, secured with bearer tokens (that you get using GS Management Rest API login endpoint).

GET api/webhooks/filters

Returns all WebHooks filters that a user can register with. Basically, these are the events that you'll get notification of when it happens.

Request information

URI parameters: none.
Body parameters: none.

GET /api/webhooks/filters HTTP/1.1
Host: localhost:41239
Authorization: Bearer token

Response information

A JSON array of the existing filters.

HTTP response: 200 OK

[
    {
        "Name": "Sdl.GroupShare.Events.V2.ProjectCreatedEvent",
        "Description": "A project has been created"
    },
    {
        "Name": "Sdl.GroupShare.Events.V2.PhaseChangeEvent",
        "Description": "A files phase has been changed"
    },
    {
        "Name": "Sdl.GroupShare.Events.V2.AssignmentEvent",
        "Description": "An assignment has been changed"
    },
    {
        "Name": "Sdl.GroupShare.Events.V2.CheckOutEvent",
        "Description": "A file has been checked out"
    },
    {
        "Name": "Sdl.GroupShare.Events.V2.CheckInEvent",
        "Description": "A file has been checked in"
    },
    {
        "Name": "*",
        "Description": "Listen in on all events."
    }
]

GET /api/webhooks/registrations

Returns all existing registrations to GS WebHooks.

Request information

URI parameters: none.
Body parameters: none.

GET /api/webhooks/registrations HTTP/1.1
Host: localhost:41239
Authorization: Bearer token

Response information

HTTP response: 200 OK

[
    {
        "Id": "1e41d718057743c5ab91492a7d23ea19",
        "WebHookUri": "http://localhost:41240/api/phasechange?noecho",
        "Secret": "GroupShareRocks",
        "Description": "PhaseChange callback endpoint",
        "IsPaused": false,
        "Filters": [
            "Sdl.GroupShare.Events.V2.PhaseChangeEvent"
        ],
        "Headers": {},
        "Properties": {}
    },
    {
        "Id": "6614a59a71434511b399a9a3eb8bda7c",
        "WebHookUri": "http://localhost:41240/api/callbacks?noecho",
        "Secret": "GroupShareRocks",
        "Description": "Subscription to all filters",
        "IsPaused": false,
        "Filters": [
            "*"
        ],
        "Headers": {},
        "Properties": {}
    }
]

POST /api/webhooks/registrations

Request information

Parameter	Explanation
WebHookUri	The URI used by GroupShare to do a POST request when the event occurs, that you subscribed to using the filter. WebHookUri query string parameters Use the 'noecho' parameter to register a web hook without endpoint verification. If you don't supply this parameter GroupShare will do endpoint verification to check that the supplied endpoint exists i.e. upon receiving the web hook registration request GroupShare will do a GET request to the WebHookUri. If this is desired then you need to send also an echo query string parameter and when receiving the verification request you need to return the exact content of that parameter in plain text. Otherwise GroupShare will reject webhook registration with a message: "WebHook verification failed. Please ensure that the WebHook URI is valid and that the endpoint is accessible."
Secret	A shared secret, created as part of subscribing to events. The receiver uses this shared secret to validate that the request comes from GroupShare. The WebHook secret key parameter must be between 32 and 64 characters long.
Filters	Array of filters that you are interested in subscribing. You can subscribe to multiple events at once, in this case your callback needs to know how to handle the different callback data. Or subscribe to events one by one with different callback endpoints.

POST /api/webhooks/registrations HTTP/1.1
Host: localhost:41239
Authorization: Bearer token
Content-Type: application/json
{
    WebHookUri: "http://localhost:41240/api/phasechange?noecho",
    Secret: "GroupShareRocks",
    Description: "PhaseChange callback endpoint",
    Filters: ["Sdl.GroupShare.Events.V2.PhaseChangeEvent"]
}

Response information

HTTP response: 201 Created

{
    "Id": "1e41d718057743c5ab91492a7d23ea19",
    "WebHookUri": "http://localhost:41240/api/phasechange?noecho",
    "Secret": "GroupShareRocks",
    "Description": "PhaseChange callback endpoint",
    "IsPaused": false,
    "Filters": [
        "Sdl.GroupShare.Events.V2.PhaseChangeEvent"
    ],
    "Headers": {},
    "Properties": {}
}

DELETE /api/webhooks/registrations

Delete a web hook registration.

Request information

URI parameters: WebHook registration id. If no registration id is supplied in the URI all registrations will be deleted.
Body parameters: none.

DELETE /api/webhooks/registrations/{registration id} HTTP/1.1
Host: localhost:41239
Authorization: Bearer

Response information

HTTP response: 200 OK or 404 Not Found

Receiving WebHooks Notifications (callbacks)

After a WebHook URI was registered for a certain event you will get callbacks when that event occurs. The callback is a POST request.

Request headers

Parameter	Explanation
ms-signature	An SHA 256 signature on the request body. The signature uses the secret key from the WebHook registration. Example: "sha256=275F1BFF2327BBAF7F61A1BB1920BAC0A5295C2F4C78312345247031D37A8031"
X-Correlation-ID	A correlation guid - this is the actual id of a webhook item (from GroupShare)

Request body

Body type

Explanation

JSON (application/json)

The event details as a JSON string.

Example request body of an assignment event callback:

{                                                             
  "Id": "9745600de970448b97f1cff97dbf1860",                   
  "Attempt": 1,                                               
  "Properties": {},                                           
  "Notifications": [                                          
    {                                                         
      "Action": "Sdl.GroupShare.Events.V2.AssignmentEvent",   
      "From": [                                               
        {                                                     
          "userEmail": "projman@testsdl.com"                      
        }                                                     
      ],                                                      
      "To": [                                                 
        {                                                     
          "userEmail": "translator@testsdl.com"                   
        }                                                     
      ],                                                      
      "LanguageFileId": "1c210645-8b48-4557-b6e3-d50d1ca18ab4",
      "ProjectId": "6ed3763d-0a93-4484-89e3-c9b4b824701d",    
      "RaisedBy": "test",                                     
      "Server": "groupshare.local"                            
    }                                                         
  ]                                                           
}

Postman collection

see GS WebHooks.postman_collection.json

Other informations related to GroupShare WebHooks

Receiver and Sending flows

WebHook Receiver Registration Flow

Registration Request Structure

{
  "WebHookUri":"http://<hosturl>/api/webhooks/incoming/custom",
  "Secret":"12345678901234567890123456789033",
  "Description":"Sample WebHook Reciever.",
  "Filters":[ "Sdl.GroupShare.Events.V2.ProjectCreatedEvent",
              "Sdl.GroupShare.Events.V2.PhaseChangeEvent",
              "Sdl.GroupShare.Events.V2.AssignmentEvent",
              "Sdl.GroupShare.Events.V2.CheckInEvent",
              "Sdl.GroupShare.Events.V2.CheckoutEvent"
            ]
}

Sending WebHook Messages Flow

Event Message Design

Project Created Event

Headers
Key	Value
X-Correlation-ID	Correlation ID
Message Body
Property Name	Value
ProjectId	Project ID
ProjectName	Project name
RaisedBy	Username of the user who triggered the event.
Server	GroupShare server name, read from WebHookService settings.
Action	Sdl.GroupShare.Events.V2.ProjectCreatedEvent

{
      "Action": "Sdl.GroupShare.Events.V2.ProjectCreatedEvent",
      "ProjectName": "0430 - 1311",
      "ProjectId": "3b7755a7-9ad3-4541-824e-81f8accadbaa",
      "RaisedBy": "sa",
      "Server": "groupshare.local"
}

Phase Change Event

Headers
Key	Value
X-Correlation-ID	Correlation ID
Message Body
Property Name	Value
ProjectId	Project ID
LanguageFileId	File ID
Phase	JSON object that contains "id" and "name" members for phase id and phase name.
RaisedBy	Email address of the user who triggered the event
Server	GroupShare server name, read from WebHookService settings.
Action	Sdl.GroupShare.Events.V2.PhaseChangeEvent

Example Message Body

{
  "Action": "Sdl.GroupShare.Events.V2.PhaseChangeEvent",
  "Phase": {
    "id": 22,
    "name": "Translation"
  },
  "LanguageFileId": "ce88d061-284c-4af6-9902-62c1b9e5decf",
  "ProjectId": "2a299c68-20c0-4bd3-87d0-a0d8c1490cf4",
  "RaisedBy": "sa",
  "Server": "groupshare.local"
}

Assignment Change Event

Headers
Key	Value
X-Correlation-ID	Correlation ID
Message Body
Property Name	Value
ProjectId	Project ID
LanguageFileId	File ID
From	Collection of users who were assigned before the assignment change.
To	Collection of user who are now assigned.
RaisedBy	Email address of the user who triggered the event
Server	GroupShare server name, read from WebHookService settings.
Action	Sdl.GroupShare.Events.V2.AssignmentEvent

Example Message Body

{
  "Action": "Sdl.GroupShare.Events.V2.AssignmentEvent",
  "From": [
    {
      "userEmail": "sa"
    }
  ],
  "To": [
    {
      "userEmail": "pm"
    },
    {
      "userEmail": "sa"
    }
  ],
  "LanguageFileId": "ce88d061-284c-4af6-9902-62c1b9e5decf",
  "ProjectId": "2a299c68-20c0-4bd3-87d0-a0d8c1490cf4",
  "RaisedBy": "sa",
  "Server": "groupshare.local"
}

Check Out Change Event

Headers
Key	Value
X-Correlation-ID	Correlation ID
Message Body
Property Name	Value
ProjectId	Project ID
LanguageFileId	File ID
RaisedBy	Email address of the user who triggered the event
Server	GroupShare server name, read from WebHookService settings.
Action	Sdl.GroupShare.Events.V2.CheckOutEvent

Example Message Body

{
  "Action": "Sdl.GroupShare.Events.V2.CheckOutEvent",
  "LanguageFileId": "ce88d061-284c-4af6-9902-62c1b9e5decf",
  "ProjectId": "2a299c68-20c0-4bd3-87d0-a0d8c1490cf4",
  "RaisedBy": "sa",
  "Server": "groupshare.local"
}

Check In Change Event

Headers
Key	Value
X-Correlation-ID	Correlation ID
Message Body
Property Name	Value
ProjectId	Project ID
LanguageFileId	File ID
RaisedBy	Email address of the user who triggered the event
Server	GroupShare server name, read from WebHookService settings.
Action	Sdl.GroupShare.Events.V2.CheckInEvent

Example Message Body

{
   "Action": "Sdl.GroupShare.Events.V2.CheckInEvent",
   "LanguageFileId": "ce88d061-284c-4af6-9902-62c1b9e5decf",
   "ProjectId": "2a299c68-20c0-4bd3-87d0-a0d8c1490cf4",
   "RaisedBy": "sa",
   "Server": "groupshare.local"
 }

GroupShare Api endpoints step by step

Paul — Thu, 07 May 2020 16:46:52 GMT

Current Revision posted to GroupShare API by Paul on 5/7/2020 4:46:52 PM

In the following pages will be described how to use Swagger UI to make calls to GroupShare.

Tags: GroupShare, GroupShareApisDocumentation, Tips&Tricks

GroupShare

Paul — Thu, 07 May 2020 16:46:33 GMT

Revision 1 posted to GroupShare API by Paul on 5/7/2020 4:46:33 PM

GroupShare related articles.

How to upload files to an existing GS Project

Andrea-Melinda Ghisa — Thu, 12 Sep 2019 08:38:06 GMT

Current Revision posted to GroupShare API by Andrea-Melinda Ghisa on 9/12/2019 8:38:06 AM

In this example we'll use Postman to upload a file to GroupShare by making a call to the following endpoint:

What is Postman?

Postman is a FREE tool which allows you to easily make calls to a server. You can download the tool from here.

How upload file using Postman

After you downloaded the tool you'll see a tab where we need to add following information:

Call type (GET, POST, PUT..) , we'll use POST
The endpoint we want to make the call [GSUrl]/api/projectserver/v2/projects/[projectId]/files/upload
We need to add the token in the "Authorization" area (the token from Swagger can be used). See following post on how to get the token.
In the "Body" we need to add the zip with the files we want to upload

Headers and Body area

Click on "Headers" tab and add a new key "Content-Type" with "application/zip" as value.

Next step is to add information in "Body" tab. In this tab make sure you have checked radio button "form-data" . In the key column select "File" from dropdown list. In the "Value" column select from the zip which contains the files you want to upload.

After all the required data is filled click on "Send" button. If the request was successful the status will be "200 OK"

Refresh projects view in GroupShare and you'll see the project in the grid.

Tags: Documentation, GroupShareApisDocumentation

How to use developer console

Andrea-Melinda Ghisa — Tue, 05 Feb 2019 13:45:44 GMT

Current Revision posted to GroupShare API by Andrea-Melinda Ghisa on 2/5/2019 1:45:44 PM

No enough support from API documentation? Web Browser console is here to help us.

Firs of all the documentation for GS Api can be found at the following address:

{YourGSUrl}/documentation/api/index

The process which I'll describe bellow should be used only to find more information regarding the headers/response/ request parameters for api calls. For this example I'll use the console from Chrome.

Before opening the console make sure you have loaded GroupShare in browser.

Where I can find the browser console?

In browser hit "F12" or simply right click-> "Inspect". All the magic will happen in "Network" tab.

What can I see in "Network" tab?

In this tab you can see in real time all the calls which a web page does to server. It doesn't mater on which page you are in, for any web pages you are able to see the calls made.

How can I see the calls?

Let assume that we want in our application to make a call to receive all the translation memories from Groupshare but we don't know what call we need to do.

Navigate to Translation memories page -> hit "F12" navigate to "Network" tab. At the beginning the tab is empty.

To see all the calls reload the page (F5)

So many calls! What should I do next?

Next step is to find exactly the call we want to see the details. We know that we want to see tms information so we'll search for calls which contains the word "tms".

All the "cool" things we want to see are displayed when you click on the call for which you want to see more information. A new window will appear near the link which has multiple tabs.

Lets take a look at each tab and see what it displays:

Headers tab

It shows the request URL, request headers like: "Accept", "Encoding", "Authorization" . If you scroll down you are able to see more information regarding the "Query String Parameters"

Preview

In this tab you are able to see the objects which are displayed like as json object

Response

Here you can see the json response from the server. To read more easy the response you can use json formater. Copy the response and paste it intro Json Formater and Validator and click "Process". You'll be able to see the json formatted in a way which is more easy to read.

Conclusion

Using above steps you are able to see details regarding any flow in GS.

Tags: Documentation, GroupShareApisDocumentation

How to use developer console

Andrea-Melinda Ghisa — Tue, 05 Feb 2019 13:41:45 GMT

Revision 4 posted to GroupShare API by Andrea-Melinda Ghisa on 2/5/2019 1:41:45 PM

No enough support from API documentation? Web Browser console is here to help us.

Firs of all the documentation for GS Api can be found at the following address:

{YourGSUrl}/documentation/api/index

Before opening the console make sure you have loaded GroupShare in browser.

Where I can find the browser console?

In browser hit "F12" or simply right click-> "Inspect". All the magic will happen in "Network" tab.

What can I see in "Network" tab?

In this tab you can see in real time all the calls which a web page does to server. It doesn't mater on which page you are in, for any web pages you are able to see the calls made.

How can I see the calls?

Let assume that we want in our application to make a call to receive all the translation memories from Groupshare but we don't know what call we need to do.

Navigate to Translation memories page -> hit "F12" navigate to "Network" tab. At the beginning the tab is empty.

To see all the calls reload the page (F5)

So many calls! What should I do next?

Next step is to find exactly the call we want to see the details. We know that we want to see tms information so we'll search for calls which contains the word "tms".

All the "cool" things we want to see are displayed when you click on the call for which you want to see more information. A new window will appear near the link which has multiple tabs.

Lets take a look at each tab and see what it displays:

Headers tab

It shows the request URL, request headers like: "Accept", "Encoding", "Authorization" . If you scroll down you are able to see more information regarding the "Query String Parameters"

Preview

In this tab you are able to see the objects which are displayed like as json object

Response

Here you can see the json response from the server. To read more easy the response you can use json formater. Copy the response and paste it intro Json Formater and Validator and click "Process". You'll be able to see the json formatted in a way which is more easy to read.

Conclusion

Using above steps you are able to see details regarding any flow in GS.

Tags: documentation, GroupShareApisDocumentation

How to use developer console

Andrea-Melinda Ghisa — Tue, 05 Feb 2019 13:24:31 GMT

Revision 3 posted to GroupShare API by Andrea-Melinda Ghisa on 2/5/2019 1:24:31 PM

No enough support from API documentation? Web Browser console is here to help us.

Firs of all the documentation for GS Api can be found at the following address:

{YourGSUrl}/documentation/api/index

Before opening the console make sure you have loaded GroupShare in browser.

Where I can find the browser console?

In browser hit "F12" or simply right click-> "Inspect". All the magic will happen in "Network" tab.

What can I see in "Network" tab?

In this tab you can see in real time all the calls which a web page does to server. It doesn't mater on which page you are in, for any web pages you are able to see the calls made.

How can I see the calls?

Let assume that we want in our application to make a call to receive all the translation memories from Groupshare but we don't know what call we need to do.

Navigate to Translation memories page -> hit "F12" navigate to "Network" tab. At the beginning the tab is empty.

To see all the calls reload the page (F5)

So many calls! What should I do next?

Next step is to find exactly the call we want to see the details. We know that we want to see tms information so we'll search for calls which contains the word "tms".

All the "cool" things we want to see are displayed when you click on the call for which you want to see more information. A new window will appear near the link which has multiple tabs.

Lets take a look at each tab and see what it displays:

Headers tab

It shows the request URL, request headers like: "Accept", "Encoding", "Authorization" . If you scroll down you are able to see more information regarding the "Query String Parameters"

Preview

In this tab you are able to see the objects which are displayed like as json object

Response

Here you can see the json response from the server. To read more easy the response you can use json formater. Copy the response and paste it intro Json Formater and Validator and click "Process". You'll be able to see the json formatted in a way which is more easy to read.

Conclusion

Using above steps you are able to see details regarding any flow in GS.

Tags: documentation, GroupShareApisDocumentation

How to use developer console

Andrea-Melinda Ghisa — Tue, 05 Feb 2019 13:17:44 GMT

Revision 2 posted to GroupShare API by Andrea-Melinda Ghisa on 2/5/2019 1:17:44 PM

No enough support from API documentation? Web Browser console is here to help us.

Firs of all the documentation for GS Api can be found at the following address:

{YourGSUrl}/documentation/api/index

Before opening the console make sure you have loaded GroupShare in browser.

Where I can find the browser console?

In browser hit "F12" or simply right click-> "Inspect". All the magic will happen in "Network" tab.

What can I see in "Network" tab?

In this tab you can see in real time all the calls which a web page does to server. It doesn't mater on which page you are in, for any web pages you are able to see the calls made.

How can I see the calls?

Let assume that we want in our application to make a call to receive all the translation memories from Groupshare but we don't know what call we need to do.

Navigate to Translation memories page -> hit "F12" navigate to "Network" tab. At the beginning the tab is empty.

To see all the calls reload the page (F5)

So many calls! What should I do next?

Next step is to find exactly the call we want to see the details. We know that we want to see tms information so we'll search for calls which contains the word "tms".

All the "cool" things we want to see are displayed when you click on the call for which you want to see more information. A new window will appear near the link which has multiple tabs.

Lets take a look at each tab and see what it displays:

Headers tab

It shows the request URL, request headers like: "Accept", "Encoding", "Authorization" . If you scroll down you are able to see more information regarding the "Query String Parameters"

Preview

In this tab you are able to see the objects which are displayed like as json object

Response

Here you can see the json response from the server. To read more easy the response you can use json formater. Copy the response and paste it intro Json Formater and Validator and click "Process". You'll be able to see the json formatted in a way which is more easy to read.

Conclusion

Using above steps you are able to see details regarding any flow in GS.

Tags: documentation, GroupShareApisDocumentation

Project creation flow chart

Andrea-Melinda Ghisa — Tue, 05 Feb 2019 07:32:40 GMT

Current Revision posted to GroupShare API by Andrea-Melinda Ghisa on 2/5/2019 7:32:40 AM

How to search in a termbase using Swagger UI.

Andrea-Melinda Ghisa — Fri, 01 Feb 2019 07:03:26 GMT

Current Revision posted to GroupShare API by Andrea-Melinda Ghisa on 2/1/2019 7:03:26 AM

To search a specific term in a termbase an Http Get call must be made to:

/multiterm/api/1.0/termbases/search

Tags: GroupShareApisDocumentation

How to search in a termbase using Swagger UI.

Andrea-Melinda Ghisa — Fri, 01 Feb 2019 06:44:49 GMT

Revision 1 posted to GroupShare API by Andrea-Melinda Ghisa on 2/1/2019 6:44:49 AM

Tags: GroupShareApisDocumentation

How to assign a file to a user in GS using Swagger UI

Andrea-Melinda Ghisa — Thu, 17 Jan 2019 09:09:07 GMT

Current Revision posted to GroupShare API by Andrea-Melinda Ghisa on 1/17/2019 9:09:07 AM

What we want to achieve:

Before

After

In order to change the user assignment a POST call should be made to

/api/projectserver/v2/projects/{projectId}/changeassignment

In the body of the call we need to send additional information about the LanguageFileId, PhaseId, Assigned Users.

How to get the PhaseId and Assigned Users parameters

PhaseId can be retrieved by making a call to

/api/projectserver/v2/phases/{projectId}
In order to get the name of the user you want to assign the file you need to make a call to the following endpoint
/api/management/v2/users

From the response "UserName" parameter must be used. You can assign the file to multiple users.

How assign body looks like

If the call was completed successfully you'll the the changes in GroupShare UI.

Tags: GroupShareApisDocumentation

How to assign a file to a user in GS using Swagger UI

Andrea-Melinda Ghisa — Thu, 17 Jan 2019 09:04:33 GMT

Revision 2 posted to GroupShare API by Andrea-Melinda Ghisa on 1/17/2019 9:04:33 AM

What we want to achieve:

Before

After

In order to change the user assignment a POST call should be made to

/api/projectserver/v2/projects/{projectId}/changeassignment

In the body of the call we need to send additional information about the LanguageFileId, PhaseId, Assigned Users.

How to get the PhaseId and Assigned Users parameters

PhaseId can be retrieved by making a call to

/api/projectserver/v2/phases/{projectId}
In order to get the name of the user you want to assign the file you need to make a call to the following endpoint
/api/management/v2/users

From the response "UserName" parameter must be used. You can assign the file to multiple users.

Tags: GroupShareApisDocumentation

How to assign a file to a user in GS using Swagger UI

Andrea-Melinda Ghisa — Thu, 17 Jan 2019 09:00:33 GMT

Revision 1 posted to GroupShare API by Andrea-Melinda Ghisa on 1/17/2019 9:00:33 AM

What we want to achieve:

Before

After

In order to change the user assignment a POST call should be made to

/api/projectserver/v2/projects/{projectId}/changeassignment

In the body of the call we need to send additional information about the LanguageFileId, PhaseId, Assigned Users.

How to get the PhaseId and Assigned Users parameters

PhaseId can be retrieved by making a call to

/api/projectserver/v2/phases/{projectId}
In order to get the name of the user you want to assign the file you need to make a call to the following endpoint
/api/management/v2/users

From the response "UserName" parameter must be used. You can assign the file to multiple users.

Tags: GroupShareApisDocumentation

How to change a phase of the file using Swagger UI

Andrea-Melinda Ghisa — Tue, 15 Jan 2019 09:34:58 GMT

Current Revision posted to GroupShare API by Andrea-Melinda Ghisa on 1/15/2019 9:34:58 AM

The goal of this tutorial is to move a file from:

Preparation phase

To Translation phase

In order to change the phase of a file a POST call must be made to:

/api/projectserver/v2/projects/{projectId}/changephase

In the body of the request we need to sent couple information like: "LanguageFileId" and "PhaseId"

How to obtain the LanguageFileId

LanguageFileId can be obtained by doing a GET call to

/api/projectserver/v2/projects/{projectId}/files

From the response object take the value of "UniqueId" property (make sure you take the id for the target file)

How to obtain the PhaseId

First step is to get all the Phases Ids. We'll make a GET to:

/api/projectserver/v2/phases/{projectId}

From the response take the id of the phase you want. In out case we'll take the translation phase id.

We gathered all the information necessary now we are able to make a POST to actually change the phase.

The body of the /api/projectserver/v2/projects/{projectId}/changephase call should look like this:

If the response code of the call is "201" that means the file phase was changed successfully. If you refresh the GroupShare UI you should see the file in the new phase.

Tags: Documentation, GroupShareApisDocumentation

How to change a phase of the file using Swagger UI

Andrea-Melinda Ghisa — Tue, 15 Jan 2019 09:28:12 GMT

Revision 8 posted to GroupShare API by Andrea-Melinda Ghisa on 1/15/2019 9:28:12 AM

The goal of this tutorial is to move a file from:

Preparation phase

To Translation phase

In order to change the phase of a file a POST call must be made to:

/api/projectserver/v2/projects/{projectId}/changephase

In the body of the request we need to sent couple information like: "LanguageFileId" and "PhaseId"

How to obtain the LanguageFileId

LanguageFileId can be obtained by doing a GET call to

/api/projectserver/v2/projects/{projectId}/files

From the response object take the value of "UniqueId" property (make sure you take the id for the target file)

How to obtain the PhaseId

First step is to get all the Phases Ids. We'll make a GET to:

/api/projectserver/v2/phases/{projectId}

From the response take the id of the phase you want. In out case we'll take the translation phase id.

Tags: documentation, GroupShareApisDocumentation