Update a job
Updates an existing job, identified by its internal ID or an external reference.
Tip
Check the Swagger page for more technical information on the endpoints.
Endpoint details
PUT
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/jobs/{jobReference}
Headers: Authorization: Bearer {token}, User-Agent: {agent}
Scope: connector-protimeapi-jobs.write
URL parameters
| Parameter | Description |
|---|---|
{jobReference} |
The internal ID or external reference of the job. |
Body properties
| Field | Type | Required | Writable | Description |
|---|---|---|---|---|
name.default |
string | Yes | Yes | Default name of the job. |
name.translations |
object | No | Yes | Translated names, keyed by ISO language code (for example nl, fr). |
External references
The endpoint resolves {jobReference} through the externalReferences query parameter. See the external references page for details.
| Collection | Predefined | Custom |
|---|---|---|
jobs |
Not available | Supported |
Error responses
| Status | Condition |
|---|---|
400 |
Invalid external reference specification, or validation failed (missing name.default, invalid translation key) |
401 |
Missing or invalid access token, or insufficient scope |
404 |
Job with the given ID or external reference not found |
Success response
200 OK. The response body is empty.
Examples
Update a job by internal ID
PUT
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/jobs/98
{
"name": {
"default": "Senior machine operator"
}
}Update a job by custom external reference
PUT
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/jobs/JOB-14?externalReferences=(jobs,customJobCode)
{
"name": {
"default": "Senior machine operator",
"translations": {
"nl": "Senior machineoperator"
}
}
}