Develop > Developer Reference > Using APIs > Universal CMDB REST API > Reference > Synchronize Jobs

Synchronize Jobs

This call performs a full or delta synchronization of the jobs.

URL

/jobstate/{jobId}

Method

PATCH

Headers

Authorization: Bearer <token>

Request type

JSON

Response type

JSON

URL Parameters

Required: jobId

Optional: None

Payload 

{
  "operationType" : "POPULATION_FULL"/"POPULATION_DELTA"/"PUSH_FULL"/"PUSH_DELTA"
}

Example: 

{
  "operationType" : "POPULATION_FULL"
}

Success response

Code: 200

Content: 

{
	"errorCode": [error code],
	"errorSource": null,
	"message": {
		"code": [deep error code],
		"description": null,
		"errorParametersValues": ["POPULATION_DELTA" ],
		"parametrizedError": true
	},
	"details": [detail error message],
	"recommendedActions": null,
	"nestedErrors": null,
	"data": null
}

Example:

Code: 200

Content: 

{
	"errorCode" : 200,
	"errorSource" : null,
	"message" : {
		"code" : 13200,
		"description" : null,
		"errorParametersValues" : [ "POPULATION_FULL" ],
		"parametrizedError" : true
	},
	"details" : null,
	"recommendedActions" : null,
	"nestedErrors" : null,
	"data" : null				
}

Error response

Code: 404, 400, or 500

Content: 

{
	"errorCode": [error code],
	"errorSource": null,
	"message": {
		"code": [deep error code],
		"description": null,
		"errorParametersValues": [
		"POPULATION_DELTA"
		],
		"parametrizedError": true
	},
	"details": [detail error message],
	"recommendedActions": null,
	"nestedErrors": null,
	"data": null		
}

Example:

Code: 500

Content: 

{
	"errorCode" : 404,
	"errorSource" : null,
	"message" : {
		"code" : 4404,
		"description" : null,
		"errorParametersValues" : [ "POPULATION_DELTA" ],
		"parametrizedError" : true
	},
	"details" : "Resources not found.",
	"recommendedActions" : null,
	"nestedErrors" : null,
	"data" : null
}

Notes

  • The user needs permission to access integrations.
  • An ellipsis (…) indicates that there can be 0 or more values.

Send Help Center feedback