{ "opencollection": "1.0.0", "info": { "name": "Phrase Strings API Reference Accounts Job Locales API", "version": "2.0.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Job Locales", "type": "folder" }, "items": [ { "info": { "name": "List job target locales", "type": "http" }, "http": { "method": "GET", "url": "https://api.phrase.com/v2/projects/:project_id/jobs/:job_id/locales", "headers": [ { "name": "X-PhraseApp-OTP", "value": "" } ], "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Project ID" }, { "name": "job_id", "value": "", "type": "path", "description": "Job ID" }, { "name": "page", "value": "1", "type": "query", "description": "Page number" }, { "name": "per_page", "value": "25", "type": "query", "description": "Limit on the number of objects to be returned, between 1 and 100. 25 by default" }, { "name": "branch", "value": "my-feature-branch", "type": "query", "description": "Branch to use" }, { "name": "include_annotations", "value": "", "type": "query", "description": "Include job-locale annotations in the response" } ] }, "docs": "List all target locales for a given job." }, { "info": { "name": "Add a target locale to a job", "type": "http" }, "http": { "method": "POST", "url": "https://api.phrase.com/v2/projects/:project_id/jobs/:job_id/locales", "headers": [ { "name": "X-PhraseApp-OTP", "value": "" } ], "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Project ID" }, { "name": "job_id", "value": "", "type": "path", "description": "Job ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a target locale to a job." }, { "info": { "name": "Show single job target locale", "type": "http" }, "http": { "method": "GET", "url": "https://api.phrase.com/v2/projects/:project_id/jobs/:job_id/locales/:id", "headers": [ { "name": "X-PhraseApp-OTP", "value": "" } ], "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Project ID" }, { "name": "job_id", "value": "", "type": "path", "description": "Job ID" }, { "name": "id", "value": "", "type": "path", "description": "ID" }, { "name": "branch", "value": "my-feature-branch", "type": "query", "description": "Branch to use" }, { "name": "include_annotations", "value": "", "type": "query", "description": "Include job-locale annotations in the response" } ] }, "docs": "Get a single target locale for a given job." }, { "info": { "name": "Update a job target locale", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.phrase.com/v2/projects/:project_id/jobs/:job_id/locales/:id", "headers": [ { "name": "X-PhraseApp-OTP", "value": "" } ], "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Project ID" }, { "name": "job_id", "value": "", "type": "path", "description": "Job ID" }, { "name": "id", "value": "", "type": "path", "description": "ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing job target locale." }, { "info": { "name": "Remove a target locale from a job", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.phrase.com/v2/projects/:project_id/jobs/:job_id/locales/:id", "headers": [ { "name": "X-PhraseApp-OTP", "value": "" } ], "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Project ID" }, { "name": "job_id", "value": "", "type": "path", "description": "Job ID" }, { "name": "id", "value": "", "type": "path", "description": "ID" }, { "name": "branch", "value": "my-feature-branch", "type": "query", "description": "Branch to use" } ] }, "docs": "Removes a target locale from a job." }, { "info": { "name": "Complete a job locale", "type": "http" }, "http": { "method": "POST", "url": "https://api.phrase.com/v2/projects/:project_id/jobs/:job_id/locales/:id/complete", "headers": [ { "name": "X-PhraseApp-OTP", "value": "" } ], "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Project ID" }, { "name": "job_id", "value": "", "type": "path", "description": "Job ID" }, { "name": "id", "value": "", "type": "path", "description": "ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Mark a job locale as completed." }, { "info": { "name": "Review a job locale", "type": "http" }, "http": { "method": "POST", "url": "https://api.phrase.com/v2/projects/:project_id/jobs/:job_id/locales/:id/complete_review", "headers": [ { "name": "X-PhraseApp-OTP", "value": "" } ], "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Project ID" }, { "name": "job_id", "value": "", "type": "path", "description": "Job ID" }, { "name": "id", "value": "", "type": "path", "description": "ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Mark job locale as reviewed." }, { "info": { "name": "Reopen a job locale", "type": "http" }, "http": { "method": "POST", "url": "https://api.phrase.com/v2/projects/:project_id/jobs/:job_id/locales/:id/reopen", "headers": [ { "name": "X-PhraseApp-OTP", "value": "" } ], "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Project ID" }, { "name": "job_id", "value": "", "type": "path", "description": "Job ID" }, { "name": "id", "value": "", "type": "path", "description": "ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Mark a job locale as uncompleted." } ] } ], "bundled": true }