Add scoring service node API

HTTP method and URI path

POST /v3/deployments/ha/scoring/node

Standard headers

Use the following standard HTTP header with this request:

Content-Type: application/json

Authorization: <Bearer token>

Required authorizations

The user ID associated with the token which is specified in the request header needs to be granted with one of the following roles:

sysadm

Request body

The request content is expected to contain a JSON object. See Table 1 for the description of the fields.

Table 1. Supported parameters for the Add scoring service node API
In this table, the **Parameter** column lists the supported parameters; the **Type** column lists the data type for the parameter, the **Required or optional** column indicates whether the parameter is required or optional for this request; and the **Description** column provides a brief description of the parameter.
Parameter	Type	Required or optional	Description
scoringGroupId	String	Required	The ID of the scoring service where the scoring service node is to be added.
scoringServiceName	String	Required	A unique name of the scoring service node to be created.
host	String	Required	Host name or IP address where the scoring service node is to be created.
httpPort	String	Optional	HTTP port of the scoring service node.
httpsPort	String	Optional	HTTPS port of the scoring service node.
adminHttpPort	String	Optional	Admin HTTP port of the scoring service node.
adminHttpsPort	String	Optional	Admin HTTPS port of the scoring service node.
zosmfInfo	String	Required	The z/OSMF information.
zosmfEnabled	Boolean	Optional	z/OSMF enabled or not. The default is false.

Example of request body:

{
"host": "127.0.0.1",
"httpPort": "1234",
"httpsPort": "2345",
"scoringGroupId": "73b24728-50f7-4956-b51c-985d97b7c34b",
"adminHttpPort": "4578",
"adminHttpsPort": "6789",
"scoringServiceName":"Sample_Scoring_Service",
"zosmfInfo":""
}

Expected response

On completion, the service returns an HTTP response, which includes a status code that indicates whether your request is completed. Status code 201 indicates a successful completion. A status code of 4nn or 5nn indicates an error.

Response example of a successful request:

"scoringServiceID": "3e301250-83d7-4d0f-a6ea-5100d30af269"

HTTP status codes

Table 2. HTTP error response
HTTP status code	Error response	Description
400	parsing_error	A required item is missing in the request body.
404	scoring_resource_not_found	The requested scoring service group is not found.
409	duplicate_scoring_resource	The scoring service name already exists.
500	unhandled_exception_with_message	Failed to add the scoring service node with unhandled exception.