ServiceDefinitionDto

ServiceDefinitionDto
ServiceDefinitionDto
JSON Example
{
    "name": "string",
    "displayName": "string",
    "descriptionLong": "string",
    "productIdentifier": "string",
    "isGated": false,
    "visible": false,
    "subscriptionLifecycleEventHandlers": {
        "onFulfillment": "string",
        "onExpiration": "string",
        "onCancellation": "string"
    },
    "serviceUrls": {
        "offerConfiguration": "string",
        "serviceHome": "string",
        "requestAccess": "string",
        "pricingInformation": "string",
        "marketing": "string"
    },
    "serviceRoles": [
        {
            "refLink": "string",
            "name": "string",
            "displayName": "string",
            "status": "string",
            "isDefault": false,
            "isHidden": false,
            "type": "string",
            "description": "string",
            "isComposable": false,
            "isBundled": false,
            "subRoles": [
                "SubRolesDto Object"
            ],
            "disallowedResourceTypes": [
                "string"
            ]
        }
    ],
    "organizationLink": "string",
    "documentSelfLink": "string",
    "healthCheckURL": "string",
    "campaignId": "string",
    "serviceIcon": "string",
    "serviceNavBarIcon": "string",
    "subscriptionStatusChangeNotificationUrl": "string",
    "orderCreatedNotifyUrl": "string",
    "supportedBillingEngines": [
        {
            "name": "string",
            "isDefault": false
        }
    ],
    "assignedInstance": {
        "displayName": "string",
        "url": "string",
        "globalizationKey": "string",
        "isDefault": false,
        "id": "string",
        "serviceId": "string"
    },
    "serviceType": "string",
    "trialDetails": {
        "trialEnd": "string",
        "trialStart": "string",
        "trialEndReason": "string",
        "paymentCommitment": false,
        "seller": "string",
        "status": "string",
        "endTrialConfiguration": {
            "postTrialConfiguration": {
                "roles": [
                    "string"
                ],
                "duration": 0,
                "notifyPostTrialEnded": false
            },
            "serviceEndTrialBehaviour": {
                "endTrialBehaviourType": "string",
                "endTrialOnPaymentConfirmation": false,
                "subscriptionType": [
                    "string"
                ]
            }
        }
    },
    "trialPeriod": 0,
    "sellers": [
        {
            "seller": "string",
            "enabled": false
        }
    ],
    "serviceTicker": "string",
    "allOrgInstances": [
        {
            "instanceId": "string",
            "displayName": "string",
            "url": "string",
            "default": false
        }
    ],
    "defaultOrgInstance": {
        "instanceId": "string",
        "displayName": "string",
        "url": "string",
        "default": false
    },
    "serviceInstances": [
        {
            "displayName": "string",
            "url": "string",
            "globalizationKey": "string",
            "isDefault": false,
            "id": "string",
            "serviceId": "string"
        }
    ],
    "accessRequestAllowed": false,
    "defaultOnboardingContextId": "string",
    "salesLedOnly": false,
    "endTrialConfiguration": {
        "postTrialConfiguration": {
            "roles": [
                "string"
            ],
            "duration": 0,
            "notifyPostTrialEnded": false
        },
        "serviceEndTrialBehaviour": {
            "endTrialBehaviourType": "string",
            "endTrialOnPaymentConfirmation": false,
            "subscriptionType": [
                "string"
            ]
        }
    },
    "shouldSendEmailUponGrantedAccess": false,
    "customEmail": {
        "customEmailSubject": "string",
        "customEmailBody": "string"
    },
    "hideServiceTile": false,
    "setupNeeded": false,
    "maxOrgServiceAccess": 0,
    "isCloudPackHelper": false,
    "isComposite": false,
    "isPrimary": false,
    "isBeta": false,
    "isCheckoutEnabled": false,
    "isSelfSubscriptionCreationEnabled": false,
    "isDisabled": false,
    "isBinaryDownloadsAllowed": false,
    "isInstanceScopedRolesSupported": false
}
string
name
Required

The service name

string
displayName
Required

The service display name

string
descriptionLong
Optional

The service long description

string
productIdentifier
Optional

The product identifier in the Billing Provider

boolean
isGated
Optional

Specify whether the service could be accessed using an invitation

boolean
visible
Optional

Specify whether the service could be seen in CSP portal

subscriptionLifecycleEventHandlers
Optional

Subscription lifecycle event handlers

serviceUrls
Optional

Service Urls

serviceRoles
Optional

Service Level Roles

string
organizationLink
Optional

The organization self link

string
documentSelfLink
Optional

The service definition self link

string
healthCheckURL
Optional

The health check relative url of the service

string
campaignId
Optional

The marketing campaign ID for the service

string
serviceIcon
Optional

The service icon URL

string
serviceNavBarIcon
Optional

The service nav bar icon URL

string
subscriptionStatusChangeNotificationUrl
Optional

Subscription status change notification URL

string
orderCreatedNotifyUrl
Optional

Order created notify url

supportedBillingEngines
Optional

This field is no longer used and values are historical only

assignedInstance
Optional

assignedInstance

string
serviceType
Optional

Define the access type for this service, default value is PAID

Possible values are : PAID, FREE, PAID_WITH_FREE_TRIAL,
trialDetails
Optional

The trial details of the service

integer As int32 As int32
trialPeriod
Optional

Default trial period in days

sellers
Optional

This field is no longer used and values are historical only

string
serviceTicker
Optional

Service ticker

allOrgInstances
Optional

Service instances assigned to this org

defaultOrgInstance
Optional

Default Service instance assigned to this org

serviceInstances
Optional

List of all existing service instances of this service

boolean
accessRequestAllowed
Optional

Allow to create invitation for this service instead of redirect to url

string As uuid As uuid
defaultOnboardingContextId
Optional

Default onboarding context id for this service

boolean
salesLedOnly
Optional

Set True if the service should be handled as using only sales-led flow when creating subscriptions

endTrialConfiguration
Optional

End trial configuration properties

boolean
shouldSendEmailUponGrantedAccess
Optional

Determine whether a message email upon access to the service granted to an org

customEmail
Optional

Determine whether and how a notification email should be sent to org owner when access is given to this service

boolean
hideServiceTile
Optional

Set True if the service tile should be hidden from the list of the org services in the MyService UI tab. Default: false

boolean
setupNeeded
Optional

Set True to display 'set up service' on the CSP service tile for any new service from initial purchase. Default: false

integer As int32 As int32
maxOrgServiceAccess
Optional

Set max number of organizations that can have access to this service. Null if unlimited

boolean
isCloudPackHelper
Optional

Set True to mark the service as cloud pack helper. The service will be hidden from service tiles and dedicated only for cloud packs. Default: false

boolean
isComposite
Optional

Set True to mark the service as a composite service. A composite service is otherwise known as the lead of an offer bundle. Default: false

boolean
isPrimary
Optional

Is the service definition isPrimary

boolean
isBeta
Optional

Determine whether the service is beta or not. Default: false

boolean
isCheckoutEnabled
Optional

Determine whether the service has integrated with checkout flow. Default: false

boolean
isSelfSubscriptionCreationEnabled
Optional

Determine whether the service supports self subscription creation. Default: false

boolean
isDisabled
Optional

Determine whether the service is disabled. Default: false

boolean
isBinaryDownloadsAllowed
Optional

Determine whether the service has binary downloads available

boolean
isInstanceScopedRolesSupported
Optional

Determine whether the service supports instance scoped role assignments. Default: true