Projects

Project's details

Retrieves the detailed information of the specified project

GET /v1/{accountUrl}/projects/{projectUrl}

PARAMETERS:

accountUrl* required (path) - Account url. It is derived from the name of the organization.

projectUrl* required (path) - Project url. It is derived from the project's title.

RESPONSES DESCRIPTION

OK: Returns the project's details including its title, description, locales, etc.

RESPONSE
{
 "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's status

Retrieves the translation's status of the specified project

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

PARAMETERS

accountUrl* required (path) - Account url. It is derived from the name of the organization.

projectUrl* required (path) - Project url. It is derived from the project's title.

RESPONSES DESCRIPTION

OK: Returns a a list of the project's resource files with their different translation statuses

RESPONSE

{
 "resourceFiles": [
  {
   "uuid": "string",
   "basename": "string",
   "filePathWithLocalePlaceholder": "string",
   "files": [
    {
     "name": "string",
     "iso2Slug": "string",
     "mimeType": "string",
     "statuses": {},
     "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"
 ]
}

________________________________________________________________________

Projects' information

Retrieves a list of the specified organization's projects with the standard attributes for each of them (title, url...) and the different translation statuses.

GET /v1/{accountUrl}/projects/status

PARAMETERS

accountUrl* required (path) - Account url. It is derived from the name of the organization

RESPONSES DESCRIPTION

OK: Returns a list of projects. For each project, the translation statuses of the different resource files is given.

RESPONSE

[
 {
  "title": "string",
  "url": "string",
  "totalCount": "integer",
  "status": {}
 }
]

________________________________________________________________________

Projects' list

Retrieves a list of projects of the authenticated user.

GET /v1/projects

RESPONSES DESCRIPTION

OK: Returns a list of projects. Not only those the user owns, but also those he is collaborating on

RESPONSE

{
 "members": [
  {
   "title": "string",
   "links": [
    {
     "rel": "string",
     "href": "string",
     "media": "string",
     "title": "string",
     "type": "string"
    }
   ]
  }
 ],
 "links": [
  {
   "rel": "string",
   "href": "string",
   "media": "string",
   "title": "string",
   "type": "string"
  }
 ]
}