Get Service Definition Using GET
Get external service definition details
Access Policy
| Role | User Accounts | Service Accounts (Client Credentials Applications) |
|---|---|---|
| Service Owner | ✔️ | ✔️ |
| Read-only Operator | ✔️ | ✔️ |
The id of the service
The locale of the user
Enable to Include sub roles
Include Service Roles
Include Service Instances
OK
{
"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
}The service name
The service display name
The service long description
The product identifier in the Billing Provider
Specify whether the service could be accessed using an invitation
Specify whether the service could be seen in CSP portal
Subscription lifecycle event handlers
Service Urls
Service Level Roles
The organization self link
The service definition self link
The health check relative url of the service
The marketing campaign ID for the service
The service icon URL
The service nav bar icon URL
Subscription status change notification URL
Order created notify url
This field is no longer used and values are historical only
assignedInstance
Define the access type for this service, default value is PAID
The trial details of the service
Default trial period in days
This field is no longer used and values are historical only
Service ticker
Service instances assigned to this org
Default Service instance assigned to this org
List of all existing service instances of this service
Allow to create invitation for this service instead of redirect to url
Default onboarding context id for this service
Set True if the service should be handled as using only sales-led flow when creating subscriptions
End trial configuration properties
Determine whether a message email upon access to the service granted to an org
Determine whether and how a notification email should be sent to org owner when access is given to this service
Set True if the service tile should be hidden from the list of the org services in the MyService UI tab. Default: false
Set True to display 'set up service' on the CSP service tile for any new service from initial purchase. Default: false
Set max number of organizations that can have access to this service. Null if unlimited
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
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
Is the service definition isPrimary
Determine whether the service is beta or not. Default: false
Determine whether the service has integrated with checkout flow. Default: false
Determine whether the service supports self subscription creation. Default: false
Determine whether the service is disabled. Default: false
Determine whether the service has binary downloads available
Determine whether the service supports instance scoped role assignments. Default: true
curl -H 'Authorization: <value>' https://{api_host}/csp/slc/api/definitions/external/{id}