btpsa-usecase-properties-name-of-the-service.md

aboutThisUseCase Type

object (name of the service)

aboutThisUseCase Properties

Property	Type	Required	Nullable	Defined by
id	string	Optional	cannot be null	JSON Schema for BTPSA use case definitions
name	string	Required	cannot be null	JSON Schema for BTPSA use case definitions
description	string	Optional	cannot be null	JSON Schema for BTPSA use case definitions
author	string	Required	cannot be null	JSON Schema for BTPSA use case definitions
testStatus	string	Required	cannot be null	JSON Schema for BTPSA use case definitions
usageStatus	string	Required	cannot be null	JSON Schema for BTPSA use case definitions
relatedLinks	array	Optional	cannot be null	JSON Schema for BTPSA use case definitions

id

ID of the service (internal use only)

id

• is optional

• Type: string (ID of the service (internal use only))

• cannot be null

• defined in: JSON Schema for BTPSA use case definitions

id Type

string (ID of the service (internal use only))

id Default Value

The default value is:

"1234"

name

name of the use case

name

• is required

• Type: string (name of the use case)

• cannot be null

• defined in: JSON Schema for BTPSA use case definitions

name Type

string (name of the use case)

description

description of the use case

description

• is optional

• Type: string (description of the use case)

• cannot be null

• defined in: JSON Schema for BTPSA use case definitions

description Type

string (description of the use case)

author

email of the author of this use case

author

• is required

• Type: string (email of the author of this use case)

• cannot be null

• defined in: JSON Schema for BTPSA use case definitions

author Type

string (email of the author of this use case)

author Constraints

email: the string must be an email address, according to RFC 5322, section 3.4.1

testStatus

test status of the use case

testStatus

• is required

• Type: string (test status of the use case)

• cannot be null

• defined in: JSON Schema for BTPSA use case definitions

testStatus Type

string (test status of the use case)

testStatus Constraints

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

Value	Explanation
"tested successfully"
"not tested"

usageStatus

usage status of the use case

usageStatus

• is required

• Type: string (usage status of the use case)

• cannot be null

• defined in: JSON Schema for BTPSA use case definitions

usageStatus Type

string (usage status of the use case)

usageStatus Constraints

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

Value	Explanation
"READY TO BE USED"
"NOT READY TO BE USED"

relatedLinks

links related to this use case

relatedLinks

• is optional

• Type: array (links related to this use case)

• cannot be null

• defined in: JSON Schema for BTPSA use case definitions

relatedLinks Type

array (links related to this use case)