Skip to content

Latest commit

 

History

History
277 lines (223 loc) · 5.37 KB

project.md

File metadata and controls

277 lines (223 loc) · 5.37 KB

Project

List - list projects of a project group

GET https://platform.api.onesky.io/1/project-groups/:project_group_id/projects

Authentication

Required. Details described here

Parameters

NONE

Response

status 200 OK

{
    "meta": {
        "status": 200,
        "record_count": 2
    },
    "data": [
        {
            "id": 6968,
            "name": "Company website"
        },
        {
            "id": 6969,
            "name": "Company blog"
        }
    ]
}

Back to top

Show - retrieve details of a project

GET https://platform.api.onesky.io/1/projects/:project_id

Authentication

Required. Details described here

Parameters

NONE

Response

status 200 OK

{
    "meta": {
        "status": 200
    },
    "data": {
        "id": 6968,
        "name": "Website",
        "description": "Words from company website.",
        "project_type": {
        	"code": "website",
        	"name": "Website"
        },
        "string_count": 1385,
        "word_count": 2956
    }
}

Back to top

Create - create a new project

POST https://platform.api.onesky.io/1/project-groups/:project_group_id/projects

Authentication

Required. Details described here

Parameters

Name Required? Default Sample Description
project_type required website Please refer to GET project_type
name optional Project name
description optional Project description

Response

status 201 Created

{
    "meta": {
        "status": 201
    },
    "data": {
        "id": 10476,
        "project_type": {
        	"code": "website",
        	"name": "Website"
        },
        "name": "Website",
        "description": "Words from company website"
    }
}

Back to top

Update - update project

PUT https://platform.api.onesky.io/1/projects/:project_id

Authentication

Required. Details described here

Parameters

Name Required? Default Sample Description
name optional New project name
description optional New project description

Response

status 200 OK

Back to top

Delete - remove project

DELETE https://platform.api.onesky.io/1/projects/:project_id

Authentication

Required. Details described here

Parameters

NONE

Response

status 200 OK

Back to top

Languages - list languages of a project

GET https://platform.api.onesky.io/1/projects/:project_id/languages

Authentication

Required. Details described here

Parameters

NONE

Response

status 200 OK

{
    "meta": {
        "status": 200,
        "record_count": 3
    },
    "data": [
        {
            "code": "en-US",
            "english_name": "English (United States)",
            "local_name": "English (United States)",
            "locale": "en",
            "region": "US",
            "is_base_language": true,
            "is_ready_to_publish": true,
            "translation_progress": "100%",
            "last_updated_at": "2013-10-07T15:27:10+0000",
            "last_updated_at_timestamp": 1381159630
        },
        {
            "code": "ja-JP",
            "english_name": "Japanese",
            "local_name": "日本語",
            "locale": "ja",
            "region": "JP",
            "is_base_language": false,
            "is_ready_to_publish": true,
            "translation_progress": "98%",
            "last_updated_at": "2013-10-07T15:27:10+0000",
            "last_updated_at_timestamp": 1381159630
        },
        {
            "code": "ko-KR",
            "english_name": "Korean",
            "local_name": "한국어",
            "locale": "ko",
            "region": "KR",
            "is_base_language": false,
            "is_ready_to_publish": true,
            "translation_progress": "56%",
            "last_updated_at": "2013-10-07T15:27:10+0000",
            "last_updated_at_timestamp": 1381159630
        },
        ...
    ]
}

Back to top