Projects

List accessible project

REQUEST

GET /v1/projects

RESPONSE

OK : Returns a list of all accessible projects

{
    "members": [
        {
            "title": "frontend",
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.lingohub.com/v1/<workspace>/projects/frontend"
                }
            ]
        },
        {
            "title": "backend",
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.lingohub.com/v1/<workspace>/projects/backend"
                }
            ]
        }

Project details

Retrieves the detailed information of a specified project

REQUEST

GET /v1/{workspaceUrl}/projects/{projectUrl}

PARAMETERS

• workspaceUrl required (path) - Workspace URL

• projectUrl required (path) - Project URL

RESPONSE

OK: Returns the project details including title, description, project languages (locales), etc.

{
 "title": "string",
 "description": "string",
 "links": [
  {
   "rel": "string",
   "href": "string",
   "media": "string",
   "title": "string",
   "type": "string"
  }
 ],
 "owner_email": "string",
 "project_locales": [
  "string"
 ],
 "created_at": "string",
 "updated_at": "string"
}

Project status

Retrieves a detailed status of the specified project. Including information about:

• the actual resource containers (files) of the project

• the statuses for the segments of those resource containers (files)

• the resource formats the resource containers (files) can be exported to

• the existence & status of repository connections

REQUEST

GET /v1/{workspaceUrl}/projects/{projectUrl}/status

PARAMETERS

• workspaceUrl required (path) - Workspace URL

• projectUrl required (path) - Project URL

RESPONSE

OK: Returns a list of the project's resource files and their status information and settings of the repository connection

{
 "resourceFiles": [
  {
   "uuid": "string",
   "basename": "string",
   "filePathWithLocalePlaceholder": "string",
   "files": [
    {
     "name": "string",
     "iso2Slug": "string",
     "mimeType": "string",
     "statuses": {
        "<language>" : {
           "<status>": "<count>"
        }
     },
     "failingLingochecksCount": "integer"
    }
   ]
  }
 ],
 "supportedExportFormats": [
  {
   "id": "string",
   "name": "string"
  }
 ],
 "repositoryConnections": [
  {
   "provider": "string",
   "connected": "boolean"
  }
 ],
 "repositoryConnected": "boolean",
 "pushToRepositoryPossible": "boolean",
 "pushType": "string",
 "oneFileForAllLocales": "boolean",
 "projectType": {
  "id": "string",
  "name": "string",
  "fileExtensions": [
   "string"
  ],
  "detectLocalePossible": "boolean"
 },
 "availableLocales": [
  "string"
 ]
}

Workspace Project information

Retrieves a list of the specified workspace projects with

• the standard attributes for each of them (title, URL...)

• the different translation statuses

REQUEST

GET /v1/{workspaceUrl}/projects/status

PARAMETERS

• workspaceUrl required (path) - Workspace URL

RESPONSE

OK: Returns a list of projects. For every project, the translation statuses of the different resource containers (files) are given.

[
  {
    "title": "string",
    "url": "string",
    "totalCount": "integer",
    "statuses": {
        "<language>" : {
           "<status>": "<count>"
        }
     }
 }
]