btpsa-usecase-properties-services-items.md

items Type

object (Details)

all of

• Untitled undefined type in JSON Schema for BTPSA use case definitions

• Untitled undefined type in JSON Schema for BTPSA use case definitions

• Untitled undefined type in JSON Schema for BTPSA use case definitions

• Untitled undefined type in JSON Schema for BTPSA use case definitions

items Properties

Property	Type	Required	Nullable	Defined by
amount	integer	Optional	cannot be null	JSON Schema for BTPSA use case definitions
assignrolecollections	array	Optional	cannot be null	JSON Schema for BTPSA use case definitions
category	string	Required	cannot be null	JSON Schema for BTPSA use case definitions
createServiceKeys	array	Optional	cannot be null	JSON Schema for BTPSA use case definitions
customerDeveloped	boolean	Optional	cannot be null	JSON Schema for BTPSA use case definitions
entitleonly	boolean	Optional	cannot be null	JSON Schema for BTPSA use case definitions
instancename	string	Optional	cannot be null	JSON Schema for BTPSA use case definitions
labels	object	Optional	cannot be null	JSON Schema for BTPSA use case definitions
name	string	Required	cannot be null	JSON Schema for BTPSA use case definitions
parameters	Multiple	Optional	cannot be null	JSON Schema for BTPSA use case definitions
plan	string	Optional	cannot be null	JSON Schema for BTPSA use case definitions
planCatalogName	string	Optional	cannot be null	JSON Schema for BTPSA use case definitions
relatedLinks	array	Optional	cannot be null	JSON Schema for BTPSA use case definitions
repeatstatusrequest	integer	Optional	cannot be null	JSON Schema for BTPSA use case definitions
repeatstatustimeout	integer	Optional	cannot be null	JSON Schema for BTPSA use case definitions
requiredrolecollections	array	Optional	cannot be null	JSON Schema for BTPSA use case definitions
requiredServices	array	Optional	cannot be null	JSON Schema for BTPSA use case definitions
serviceKeyLabels	array	Optional	cannot be null	JSON Schema for BTPSA use case definitions
serviceparameterfile	string	Optional	cannot be null	JSON Schema for BTPSA use case definitions
skipTrustSetupForXSUAA	boolean	Optional	cannot be null	JSON Schema for BTPSA use case definitions
statusResponse	object	Optional	cannot be null	JSON Schema for BTPSA use case definitions
targetenvironment	string	Optional	cannot be null	JSON Schema for BTPSA use case definitions

amount

amount to be used for the service

amount

• is optional

• Type: integer (amount to be used for the service)

• cannot be null

• defined in: JSON Schema for BTPSA use case definitions

amount Type

integer (amount to be used for the service)

assignrolecollections

list of role collections to be created within the btp account

assignrolecollections

• is optional

• Type: array (list of role collections to be created within the btp account)

• cannot be null

• defined in: JSON Schema for BTPSA use case definitions

assignrolecollections Type

array (list of role collections to be created within the btp account)

assignrolecollections Default Value

The default value is:

[]

category

category of the service

category

• is required

• Type: string (category of the service)

• cannot be null

• defined in: JSON Schema for BTPSA use case definitions

category Type

string (category of the service)

category Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
"SERVICE"
"APPLICATION"
"CF_CUP_SERVICE"
"ENVIRONMENT"

createServiceKeys

list of service keys to be created for the service

createServiceKeys

• is optional

• Type: array (list of service keys to be created for the service)

• cannot be null

• defined in: JSON Schema for BTPSA use case definitions

createServiceKeys Type

array (list of service keys to be created for the service)

createServiceKeys Default Value

The default value is:

[]

customerDeveloped

custom developed application

customerDeveloped

• is optional

• Type: boolean (custom developed application)

• cannot be null

• defined in: JSON Schema for BTPSA use case definitions

customerDeveloped Type

boolean (custom developed application)

entitleonly

only entitlement - if true, the service will only be entitled, but not assigned to a role collection

entitleonly

• is optional

• Type: boolean (only entitlement (no service instances will be created by the tool))

• cannot be null

• defined in: JSON Schema for BTPSA use case definitions

entitleonly Type

boolean (only entitlement (no service instances will be created by the tool))

entitleonly Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
true
false

instancename

name of the service instance

instancename

• is optional

• Type: string (name of the service instance)

• cannot be null

• defined in: JSON Schema for BTPSA use case definitions

instancename Type

string (name of the service instance)

labels

labels for the service

labels

• is optional

• Type: object (labels for the service)

• cannot be null

• defined in: JSON Schema for BTPSA use case definitions

labels Type

object (labels for the service)

name

name of the service

name

• is required

• Type: string (name of the service)

• cannot be null

• defined in: JSON Schema for BTPSA use case definitions

name Type

string (name of the service)

parameters

parameters for the service

parameters

• is optional

• Type: any of the following: object or string (parameters for the service)

• cannot be null

• defined in: JSON Schema for BTPSA use case definitions

parameters Type

any of the following: object or string (parameters for the service)

plan

plan name of the service

plan

• is optional

• Type: string (plan name of the service)

• cannot be null

• defined in: JSON Schema for BTPSA use case definitions

plan Type

string (plan name of the service)

planCatalogName

catalog name of the service plan

planCatalogName

• is optional

• Type: string (catalog name of the service plan)

• cannot be null

• defined in: JSON Schema for BTPSA use case definitions

planCatalogName Type

string (catalog name of the service plan)

relatedLinks

links related to this service

relatedLinks

• is optional

• Type: array (links related to this service)

• cannot be null

• defined in: JSON Schema for BTPSA use case definitions

relatedLinks Type

array (links related to this service)

repeatstatusrequest

number of seconds when status should be checked

repeatstatusrequest

• is optional

• Type: integer (number of seconds when status should be checked)

• cannot be null

• defined in: JSON Schema for BTPSA use case definitions

repeatstatusrequest Type

integer (number of seconds when status should be checked)

repeatstatusrequest Default Value

The default value is:

5

repeatstatustimeout

timeout in seconds after which the script will stop checking the status

repeatstatustimeout

• is optional

• Type: integer (timeout in seconds after which the script will stop checking the status)

• cannot be null

• defined in: JSON Schema for BTPSA use case definitions

repeatstatustimeout Type

integer (timeout in seconds after which the script will stop checking the status)

repeatstatustimeout Default Value

The default value is:

3600

requiredrolecollections

list of role collections to assign users to

requiredrolecollections

• is optional

• Type: object[] (Details)

• cannot be null

• defined in: JSON Schema for BTPSA use case definitions

requiredrolecollections Type

object[] (Details)

requiredServices

list of services that need to be instantiated before instantiating this service

requiredServices

• is optional

• Type: array (list of services that need to be instantiated before instantiating this service)

• cannot be null

• defined in: JSON Schema for BTPSA use case definitions

requiredServices Type

array (list of services that need to be instantiated before instantiating this service)

requiredServices Default Value

The default value is:

[]

serviceKeyLabels

labels for service keys as JSON

serviceKeyLabels

• is optional

• Type: object[] (Details)

• cannot be null

• defined in: JSON Schema for BTPSA use case definitions

serviceKeyLabels Type

object[] (Details)

serviceKeyLabels Default Value

The default value is:

[]

serviceparameterfile

parameter file for the service in case you want to provide the parameters via a file

serviceparameterfile

• is optional

• Type: string (parameter file for the service)

• cannot be null

• defined in: JSON Schema for BTPSA use case definitions

serviceparameterfile Type

string (parameter file for the service)

skipTrustSetupForXSUAA

skip the trust setup to an IdP for XSUAA. Only relevant for the plan apiaccess!

skipTrustSetupForXSUAA

• is optional

• Type: boolean (skip trust setup to IdP for XSUAA (plan apiaccess))

• cannot be null

• defined in: JSON Schema for BTPSA use case definitions

skipTrustSetupForXSUAA Type

boolean (skip trust setup to IdP for XSUAA (plan apiaccess))

statusResponse

information that is available only durng the execution of the script (should not be set in the usecase.json file)

statusResponse

• is optional

• Type: object (creation info)

• cannot be null

• defined in: JSON Schema for BTPSA use case definitions

statusResponse Type

object (creation info)

targetenvironment

environment in which the service should be created

targetenvironment

• is optional

• Type: string (environment in which the service should be created)

• cannot be null

• defined in: JSON Schema for BTPSA use case definitions

targetenvironment Type

string (environment in which the service should be created)

targetenvironment Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
"cloudfoundry"
"kymaruntime"
"sapbtp"

targetenvironment Default Value

The default value is:

"cloudfoundry"