Skip to main content

List existing Service Desk Integrations

GET 

/service-desk-integrations

Get a list of ServiceDeskIntegrationDto for existing Service Desk Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint.

Request

Query Parameters

    offset int32

    Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.

    Example: 0
    limit int32

    Possible values: <= 250

    Default value: 250

    Max number of results to return. See V3 API Standard Collection Parameters for more information.

    Example: 250
    sorters string

    Sort results using the standard syntax described in V3 API Standard Collection Parameters

    Sorting is supported for the following fields: name

    Example: name
    filters comma-separated

    Filter results using the standard syntax described in V3 API Standard Collection Parameters

    Filtering is supported for the following fields and operators:

    id: eq, in

    name: eq

    type: eq, in

    cluster: eq, in

    Example: name eq "John Doe"
    count boolean

    If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored.

    Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used.

    See V3 API Standard Collection Parameters for more information.

    Example: true

Responses

List of ServiceDeskIntegrationDto

Schema
  • Array [
  • id string

    Unique identifier for the Service Desk integration

    name stringrequired

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

    created date-time

    The date and time the Service Desk integration was created

    modified date-time

    The date and time the Service Desk integration was last modified

    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 stringnullabledeprecated

    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]

    DTO type of source for service desk integration template.

    id string

    ID of source for service desk integration template.

    name string

    Human-readable name of source for service desk integration template.

  • ]
  • planInitializerScript objectnullable

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