Skip to content

JOBSBATCH-224: Updated jobs batch v2 create endpoint examples #294

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
PavelLoparev merged 2 commits into from
Dec 11, 2025
+43 −1
Merged

JOBSBATCH-224: Updated jobs batch v2 create endpoint examples #294

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aa8153c
Updated jobs batch v2 create endpoint examples
PavelLoparev Dec 9, 2025
85213bc
Job batches: Updated create job endpoint description
PavelLoparev Dec 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 43 additions & 1 deletion spec/job_batches_v2/job_batches_endpoints.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -608,7 +608,7 @@ x-paths:
**Job creation behavior** depends on the `mode` parameter:

- **REUSE_EXISTING**: Returns an existing job if one matches the evaluated name template. If the matching job is
closed or completed, creates a new job with a unique name using the specified `salt` strategy.
cancelled, deleted or closed, creates a new job with a unique name using the specified `salt` strategy.
- **CREATE_NEW**: Attempts to create a new job with the evaluated name. If a job with that name already exists,
appends a unique identifier using the specified `salt` strategy to ensure creation succeeds.

Expand Down Expand Up @@ -643,6 +643,48 @@ x-paths:
}
```
Creates: "Feature Release 2025 2025-10-08 02:34:15 PM" (if job already exists)

4. **Job reuse with salt suffix**:
**First request** - Creates initial job:
```json
POST /job-batches-api/v2/projects/abc123/jobs
{
"nameTemplate": "Daily Report {yyyy-MM-dd}",
"mode": "REUSE_EXISTING",
"salt": "RANDOM_ALPHANUMERIC",
"targetLocaleIds": ["fr-FR", "de-DE"]
}
```
Response: `{"jobName": "Daily Report 2025-12-09", "translationJobUid": "job001"}`

**After job is completed and closed...**

**Second request** - Creates job with salt (original is closed):
```json
POST /job-batches-api/v2/projects/abc123/jobs
{
"nameTemplate": "Daily Report {yyyy-MM-dd}",
"mode": "REUSE_EXISTING",
"salt": "RANDOM_ALPHANUMERIC",
"targetLocaleIds": ["fr-FR", "de-DE"]
}
```
Response: `{"jobName": "Daily Report 2025-12-09 a7x9k", "translationJobUid": "job002"}`

**Third request** - Reuses job with salt (prevents duplicate):
```json
POST /job-batches-api/v2/projects/abc123/jobs
{
"nameTemplate": "Daily Report {yyyy-MM-dd}",
"mode": "REUSE_EXISTING",
"salt": "RANDOM_ALPHANUMERIC",
"targetLocaleIds": ["fr-FR", "de-DE"]
}
```
Response: `{"jobName": "Daily Report 2025-12-09 a7x9k", "translationJobUid": "job002"}` (same job)

**Key behavior**: The third request reuses the job with salt suffix instead of creating another duplicate,
preventing multiple jobs with different salts for the same day.
tags:
- Job Batches V2
operationId: createJobV2
Expand Down