Skip to main content

Update a Service Desk integration by ID

Update an existing Service Desk integration by ID with updated value in JSON form as the request body. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.

Path Parameters
  • id string required

    ID of the Service Desk integration to update

Request Body required

The specifics of the integration to update

  • name string required

    Name of the Object

  • description string required

    Description of the Service Desk integration

  • type string required

    Default value: ServiceNowSDIM

    Service Desk integration types

    • ServiceNowSDIM
    • ServiceNow
  • ownerRef object

    Reference to the identity that is the owner of this Service Desk integration

  • type string

    Possible values: [IDENTITY]

    The type of object being referenced

  • id string

    ID of the identity

  • name string

    Human-readable display name of the identity

  • clusterRef object

    Reference to the source cluster for this Service Desk integration

  • type string

    Possible values: [CLUSTER]

    The type of object being referenced

  • id string

    ID of the cluster

  • name string

    Human-readable display name of the cluster

  • cluster string deprecated

    ID of the cluster for the Service Desk integration (replaced by clusterRef, retained for backward compatibility)

  • managedSources string[] deprecated

    Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility)

  • provisioningConfig object

    The 'provisioningConfig' property specifies the configuration used to provision integrations.

  • managedResourceRefs object[]

    References to sources for the Service Desk integration template. May only be specified if universalManager is false.

  • type string

    Possible values: [SOURCE]

    The type of object being referenced

  • id string

    ID of the source

  • name string

    Human-readable display name of the source

  • planInitializerScript object

    This is a reference to a plan initializer script.

  • source string

    This is a Rule that allows provisioning instruction changes.

  • attributes object required

    Attributes of the Service Desk integration. Validation constraints enforced by the implementation.

  • beforeProvisioningRule object

    Reference to beforeProvisioningRule for this Service Desk integration

  • type string

    Possible values: [RULE]

    The type of object being referenced

  • id string

    ID of the rule

  • name string

    Human-readable display name of the rule

Responses

ServiceDeskIntegrationDto as updated


Schema
  • id string

    System-generated unique ID of the Object

  • name string

    Name of the Object

  • created date-time

    Creation date of the Object

  • modified date-time

    Last modification date of the Object

  • description string

    Description of the Service Desk integration

  • type string

    Default value: ServiceNowSDIM

    Service Desk integration types

    • ServiceNowSDIM
    • ServiceNow
  • ownerRef object

    Reference to the identity that is the owner of this Service Desk integration

  • type string

    Possible values: [IDENTITY]

    The type of object being referenced

  • id string

    ID of the identity

  • name string

    Human-readable display name of the identity

  • clusterRef object

    Reference to the source cluster for this Service Desk integration

  • type string

    Possible values: [CLUSTER]

    The type of object being referenced

  • id string

    ID of the cluster

  • name string

    Human-readable display name of the cluster

  • cluster string deprecated

    ID of the cluster for the Service Desk integration (replaced by clusterRef, retained for backward compatibility)

  • managedSources string[] deprecated

    Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility)

  • provisioningConfig object

    The 'provisioningConfig' property specifies the configuration used to provision integrations.

  • universalManager boolean

    Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed.

  • managedResourceRefs object[]

    References to sources for the Service Desk integration template. May only be specified if universalManager is false.

  • type string

    Possible values: [SOURCE]

    The type of object being referenced

  • id string

    ID of the source

  • name string

    Human-readable display name of the source

  • planInitializerScript object

    This is a reference to a plan initializer script.

  • source string

    This is a Rule that allows provisioning instruction changes.

  • attributes object

    Attributes of the Service Desk integration. Validation constraints enforced by the implementation.

  • beforeProvisioningRule object

    Reference to beforeProvisioningRule for this Service Desk integration

  • type string

    Possible values: [RULE]

    The type of object being referenced

  • id string

    ID of the rule

  • name string

    Human-readable display name of the rule

Loading...