1. Cloud Native Unified Data Repository REST Specification Document
  2. REST Specifications
  3. Management URI Schema Update

Management URI Schema Update

The table provides information about the operations supported for management URI schema update.

The OpenAPI for Management URI: mgmapi.yml

Operation Type URI Sample Schema Possible Error Codes
PUT https://localhost:9443/nudr-dr-mgm/v1/policy-data/schema/am-data To add a new field, custom for am-data.
Payload:

PUT-schemablob

{ "$schema": "http://json-schema.org/draft-07/schema#"
, "additionalProperties": false, "type": "object", 
"properties": { "subscCats": { "minItems": 1, "type":
 "array", "items": { "type": "string" } }, "custom":
 { "type": "string" }, "praInfos": 
{ "patternProperties": { "^(.*)$": 
{ "additionalProperties": false, "type": "object", 
"properties": { "ecgiList": { "minItems": 1, "type":
 "array", "items": { "additionalProperties": false,
 "type": "object", "required": [ "plmnId", 
"eutraCellId" ], "properties": { "eutraCellId":
 { "pattern": "^[A-Fa-f0-9]{7}$", "type": 
"string" }, "plmnId": { "additionalProperties":
 false, "type": "object", "required": [ "mcc", 
"mnc" ], "properties": { "mnc": { "pattern": 
"^\\d{2,3}$", "type": "string" }, "mcc": 
{ "pattern": "^\\d{3}$", "type": "string" }
 } } } } }, "globalRanNodeIdList": { "minItems":
 1, "type": "array", "items": 
{ "additionalProperties": false, "type": "object",
 "required": [ "plmnId" ], "properties": { "gNbId":
 { "additionalProperties": false, "type": "object",
 "required": [ "bitLength", "gNbValue" ],
 "properties": { "bitLength": { "type": "integer" },
 "gNbValue": { "pattern": "^[A-Fa-f0-9]{6,8}$",
 "type": "string" } } }, "plmnId": 
{ "additionalProperties": false, "type": "object",
 "required": [ "mcc", "mnc" ], "properties":
 { "mnc": { "pattern": "^\\d{2,3}$", "type": "string"
 }, "mcc": { "pattern": "^\\d{3}$", "type": "string" }
 } }, "n3IwfId": { "pattern": "^[A-Fa-f0-9]+$",
 "type": "string" }, "ngeNbId": { "pattern":
 "^(MacroNGeNB-[A-Fa-f0-9]{5}|LMacroNGeNB-[A-Fa-f0-9]
{6}|SMacroNGeNB-[A-Fa-f0-9]{5})$", "type": "string" }
 } } }, "praId": { "type": "string" }, "ncgiList":
 { "minItems": 1, "type": "array", "items": 
{ "additionalProperties": false, "type": "object",
 "required": [ "plmnId", "nrCellId" ], "properties":
 { "plmnId": { "additionalProperties": false, "type":
 "object", "required": [ "mcc", "mnc" ], "properties":
 { "mnc": { "pattern": "^\\d{2,3}$", "type": "string"
 }, "mcc": { "pattern": "^\\d{3}$", "type": "string"
 } } }, "nrCellId": { "pattern": "^[A-Fa-f0-9]{9}$",
 "type": "string" } } } }, "trackingAreaList":
 { "minItems": 1, "type": "array", "items": 
{ "additionalProperties": false, "type": "object",
 "required": [ "plmnId", "tac" ], "properties": 
{ "tac": { "default": "", "pattern": 
"(^[A-Fa-f0-9]{4}$)|(^[A-Fa-f0-9]{6}$)", "type":
 "string" }, "plmnId": { "additionalProperties":
 false, "type": "object", "required": [ "mcc", "mnc" ],
 "properties": { "mnc": { "pattern": "^\\d{2,3}$",
 "type": "string" }, "mcc": { "pattern": "^\\d{3}$",
 "type": "string" } } } } } } } } }, 
"additionalProperties": false } } }

This operation adds one new schema with version tag as "v1" and database points to "v1" now.

To rollback to any other schema version, which already exists in database, see https://localhost:9443/nudr-dr-mgm/v1/policy-data/schema/am-data/version/v0.

  • 405: "Operation not allowed" (for nudr-dr)
  • 400: Incase of json syntax error, an appropriate error message is sent from SQL db.
GET
  • To get currently supported schema: https://localhost:9443/nudr-dr-mgm/v1/policy-data/schema/am-data
  • To get all schema versions supported by a resource. https://localhost:9443/nudr-dr-mgm/v1/policy-data/schema/am-data?version=all
  • To get any specific schema version: https://localhost:9443/nudr-dr-mgm/v1/policy-data/schema/am-data?version=v1
405: "Operation not allowed" (for nudr-dr)
DELETE
  • Schema, which is currently in use could not be deleted.
  • To delete any other stored schema: https://localhost:9443/nudr-dr-mgm/v1/policy-data/schema/am-data/version/v1

405: "Operation not allowed" (in case of deleting current schema)