# Update Endpoint - UpdateSyncJobById

Updates a sync job

# HTTP Request

One of the following requests should be made:

PUT /odata/syncjobs({key})
PUT /odata/syncjobs/{key}

# Path parameters

Name Description
key required

# Query parameters

Name Description
repository optional. Destination repository key.

# Request headers

Name Description
Authorization required. Bearer {token}. See authorization
Content-Type required. application/json

# Request body

Information

Only properties with new values need to be specified, unmodified properties are optional and can be skipped.

Information

If readonly properties are specified the response will always be a 400 Bad Request error.

# Responses

Code Description Type
200 If update of syncjob was successful. SyncJobEntity
400 If no syncjob data could be loaded from request for update.
401 If access is not allowed with the given credentials/data.
404 If no sync job with the given id could be found.
500 When an internal server occurs during the update of sync job.

# Example

# Request

The following is an example of how to call the endpoint:

PUT /odata/syncjobs(1)?repository=repo1
Content-Type: application/json

{
  "name": "New SyncJob Name"
}

# Response

The following example shows the response:

Information

The response object is truncated for clarity. Default properties will be returned from the call.

{
  "syncJobId": 1,
  "name": "New SyncJob Name"
}
Last updated: February 14, 2025 at 8:26 AM