Skip to main content

Update a Service Desk integration

PUT 

/service-desk-integrations/: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.

Request

Path Parameters

    id stringrequired

    ID of the Service Desk integration to update

Body

required

The specifics of the integration to update

    name stringrequired

    Service Desk integration's name. The name must be unique.

    description stringrequired

    Service Desk integration's description.

    type stringrequired

    Default value: ServiceNowSDIM

    Service Desk integration types:

    • ServiceNowSDIM
    • ServiceNow
    ownerRef object

    Owner's identity.

    type string

    Possible values: [IDENTITY]

    Owner's DTO type.

    id string

    Owner's identity ID.

    name string

    Owner's display name.

    clusterRef object

    Source cluster.

    type string

    Possible values: [CLUSTER]

    Source cluster DTO type.

    id string

    Source cluster ID.

    name string

    Source cluster display name.

    cluster stringdeprecated

    Cluster ID 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.

  • Array [
  • 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.

    noProvisioningRequests boolean

    Default value: false

    Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration.

    provisioningRequestExpiration int32

    When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation.

    attributes objectrequired

    Service Desk integration's attributes. Validation constraints enforced by the implementation.

    property name* any

    Service Desk integration's attributes. Validation constraints enforced by the implementation.

    beforeProvisioningRule object

    Before Provisioning Rule.

    type string

    Possible values: [RULE]

    Before Provisioning Rule DTO type.

    id string

    Before Provisioning Rule ID.

    name string

    Rule display name.

Responses

ServiceDeskIntegrationDto as updated

Schema
    name stringrequired

    Service Desk integration's name. The name must be unique.

    description stringrequired

    Service Desk integration's description.

    type stringrequired

    Default value: ServiceNowSDIM

    Service Desk integration types:

    • ServiceNowSDIM
    • ServiceNow
    ownerRef object

    Owner's identity.

    type string

    Possible values: [IDENTITY]

    Owner's DTO type.

    id string

    Owner's identity ID.

    name string

    Owner's display name.

    clusterRef object

    Source cluster.

    type string

    Possible values: [CLUSTER]

    Source cluster DTO type.

    id string

    Source cluster ID.

    name string

    Source cluster display name.

    cluster stringdeprecated

    Cluster ID 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

    Default value: false

    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.

  • Array [
  • 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.

    noProvisioningRequests boolean

    Default value: false

    Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration.

    provisioningRequestExpiration int32

    When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation.

    attributes objectrequired

    Service Desk integration's attributes. Validation constraints enforced by the implementation.

    property name* any

    Service Desk integration's attributes. Validation constraints enforced by the implementation.

    beforeProvisioningRule object

    Before Provisioning Rule.

    type string

    Possible values: [RULE]

    Before Provisioning Rule DTO type.

    id string

    Before Provisioning Rule ID.

    name string

    Rule display name.

Loading...