[{"label":"Latest (v1)","version":"latest"}]

cloud-partner-navigator

Service

Defines the properties of the Service.

Properties

boolean

configuratorEnabled Required

The flag to enable the configurator.

boolean

infraService Required

The flag to enable/ disable the infra services.

Accessibility

accessibility Optional

Defines the properties of the Accessibility.

Possible values are: FREE , TRIAL , PAID

boolean

commitContractSigned Optional

The flag to identify the signed commit contract.

array of ServiceObjectType

customSvcAccessTypes Optional

The list of object service object type.

string

descriptionLong Optional

The elaborated description of the service.

string

descriptionShort Optional

The short description of the service.

boolean

disableConsoleAccess Optional

The flag to disable the console access of the service.

boolean

disableProvisioningAtTenant Optional

The flag to disable provisioning at the tenant level.

string

displayName Optional

The display name of the service.

boolean

enabled Optional

The flag to identify the whether the service is enabled.

boolean

enabledAsAddOn Optional

The flag to enable a service as an add on.

string

id Optional

The ID of the service.

boolean

canBeEnabled Optional

The flag to enable/ disable a service.

string

name Optional

The name of the service.

array of string

productFamilies Optional

The list of the product families.

string

productIdentifier Optional

The product identifier of the service.

boolean

resourceBasedService Optional

The flag to enable/ disable resource based service.

array of ResourceType

resourceTypes Optional

Defines the properties of the Resource type.

Possible values are: INSTANCE

array of ServiceExtension

serviceExtensions Optional

The list of object of service extensions.

string

serviceIcon Optional

The icon of the service.

array of ServiceInstanceDto

serviceInstances Optional

The list of service instances.

string

serviceNavBarIcon Optional

The sevice nav bar icon of the service.

ServiceObjectExtention

serviceObjectExtention Optional

Defines the properties of the Service object extension.

string

serviceOrgId Optional

The service org id of the service.

array of ServiceRole

serviceRoles Optional

The list of the service roles.

ServiceStateType

serviceState Optional

Defines the properties of the Service state type.

Possible values are: AVAILABLE , TRIAL , ORDERED

ServiceUrlsDefinition

serviceUrls Optional

Defines the properties of the Service urls definition.

string

trialCompletionDate Optional

The end date of the trail of a service.

ServiceTrialDetails

trialDetails Optional

Defines the properties of the Service trial details.

boolean

visible Optional

The flag to mark the visibilty of the service.

JSON Example

Show optional properties

{
    "configuratorEnabled": true,
    "infraService": true
}

{
    "accessibility": "PAID",
    "canBeEnabled": true,
    "commitContractSigned": true,
    "configuratorEnabled": true,
    "customSvcAccessTypes": [
        {
            "displayName": "...",
            "enabled": true,
            "name": "...",
            "type": "..."
        },
        {
            "displayName": "...",
            "enabled": true,
            "name": "...",
            "type": "..."
        }
    ],
    "descriptionLong": "...",
    "descriptionShort": "...",
    "disableConsoleAccess": true,
    "disableProvisioningAtTenant": true,
    "displayName": "...",
    "enabled": true,
    "enabledAsAddOn": true,
    "id": "...",
    "infraService": true,
    "name": "...",
    "productFamilies": [
        "...",
        "..."
    ],
    "productIdentifier": "...",
    "resourceBasedService": true,
    "resourceTypes": [
        "INSTANCE",
        "INSTANCE"
    ],
    "serviceExtensions": [
        {
            "name": "...",
            "state": "OPEN"
        },
        {
            "name": "...",
            "state": "COMPLETED"
        }
    ],
    "serviceIcon": "...",
    "serviceInstances": [
        {
            "default": true,
            "displayName": "...",
            "id": "...",
            "isDefault": true,
            "roles": [
                "...",
                "..."
            ],
            "serviceId": "...",
            "url": "..."
        },
        {
            "default": true,
            "displayName": "...",
            "id": "...",
            "isDefault": true,
            "roles": [
                "...",
                "..."
            ],
            "serviceId": "...",
            "url": "..."
        }
    ],
    "serviceNavBarIcon": "...",
    "serviceObjectExtention": {
        "objectMetaData": {
            "property1": "...",
            "property2": "..."
        },
        "objectType": {
            "displayName": "...",
            "enabled": true,
            "name": "...",
            "type": "..."
        }
    },
    "serviceOrgId": "...",
    "serviceRoles": [
        {
            "associatedResources": [
                "...",
                "..."
            ],
            "defaultRole": true,
            "displayName": "...",
            "enabled": true,
            "hidden": true,
            "memberType": "DIRECT",
            "mspDefaultRole": true,
            "mspDefaultRoleOfProviderAtTenant": true,
            "name": "...",
            "resource": "...",
            "roleId": "...",
            "status": "..."
        },
        {
            "associatedResources": [
                "...",
                "..."
            ],
            "defaultRole": true,
            "displayName": "...",
            "enabled": true,
            "hidden": true,
            "memberType": "GROUP",
            "mspDefaultRole": true,
            "mspDefaultRoleOfProviderAtTenant": true,
            "name": "...",
            "resource": "...",
            "roleId": "...",
            "status": "..."
        }
    ],
    "serviceState": "AVAILABLE",
    "serviceUrls": {
        "offerConfiguration": "...",
        "requestAccess": "...",
        "serviceHome": "...",
        "termsOfService": "..."
    },
    "trialDetails": {
        "endTime": 12345,
        "startTime": 12345,
        "status": "ENDED"
    },
    "visible": true
}

[{"label":"Latest (v1)","version":"latest"}]

cloud-partner-navigator

Parameter To

Enable Service

Returned By

Get Services Of Org
Enable Service

Service

Properties

JSON Example

Parameter To

Returned By

Was this page helpful?