Develop > Developer Reference > Using APIs > Universal CMDB REST API > Reference > Activate or Deactivate an Integration Point

Activate or Deactivate an Integration Point

This call activates or deactivates integration points.

URL

/integrationpoint/light/{integrationId}

Method

PATCH

Headers

Authorization: Bearer <token>

Request type

JSON

Response type

JSON

URL Parameters

Required: integrationId

Optional: None

Payload 

{
  "name" : [integration point name], "enabled": true/false
}

Example: 

{
  "name" : [integration point name], "enabled": true
}

Success response

Code: 200

Content: 

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

Example:

Code: 200

Content: 

{
"errorCode" : 200,
"errorSource" : null,
"message" : {
"code" : 2200,
"description" : null,
"errorParametersValues" : [ "tmp1" ],
"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": [
			"ucmdb1"
		],
		"parametrizedError": true
	},
	"details": [detail error message],
	"recommendedActions": null,
	"nestedErrors": null,
	"data": null			
}

Example:

Code: 500

Content: 

{
"errorCode" : 500,
"errorSource" : null,
"message" : {
"code" : 5500,
"description" : null,
"errorParametersValues" : [ "tmp1" ],
"parametrizedError" : true
},
"details" : "Error while executing operation.",
"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