Update Service Definition Fields Using PATCH
Patch a service definition fields.
Access Policy
| Role | User Accounts | Service Accounts (Client Credentials Applications) |
|---|---|---|
| Service Owner | ✔️ | ✔️ |
The id of the service
{
"subscriptionLifecycleEventHandlers": {
"onFulfillment": "string",
"onExpiration": "string",
"onCancellation": "string"
},
"serviceUrls": {
"offerConfiguration": "string",
"serviceHome": "string",
"requestAccess": "string",
"pricingInformation": "string",
"marketing": "string"
},
"visible": false,
"campaignId": "string",
"displayName": "string",
"descriptionLong": "string",
"productIdentifier": "string",
"serviceIcon": "string",
"serviceNavBarIcon": "string",
"serviceSvgIcon": "string",
"subscriptionStatusChangeNotificationUrl": "string",
"orderCreatedNotifyUrl": "string",
"supportedBillingEngines": [
{
"name": "string",
"isDefault": false
}
],
"sellers": [
{
"seller": "string",
"enabled": false
}
],
"trialPeriod": 0,
"serviceTicker": "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,
"isBeta": false,
"isPrimary": false,
"isCheckoutEnabled": false,
"isSelfSubscriptionCreationEnabled": false,
"isBinaryDownloadsAllowed": false,
"isInstanceScopedRolesSupported": false
}Subscription lifecycle event handlers
Service Urls
Determine whether the service is visible or not
Marketing Campaign ID for the service
Service display name
Longer description of the service
The product identifier in the Billing Provider
The service icon URL
The service nav bar icon URL
The service SVG icon string. UI will prefer this icon over others
Subscription status change notification URL
Order created notify url
This field is no longer used and values are historical only
This field is no longer used and values are historical only
Set default trial period in days.
Service ticker
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
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
Determine whether the service is beta or not
Determine whether the service is primary for its product
Determine whether the service has integrated with checkout flow. Offer configuration URL must not be null to enable checkout flow
Determine whether the service supports self subscription creation.
Determine whether the service has binary downloads available
Determine whether the service supports instance scoped role assignments
OK
"RefLinkDto Object"Relative reference link to the resource.
curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}'