4 Schema Management Specifications
4.1 Profile Data Schema Management
The following table lists the Profile Data Schema Management operations.
OpenAPI for Management URI: OpenAPIMGM.yml
Table 4-1 Profile Data SchemaManagement Operations
HTTP Method | Sample REST URL | Description | Possible Error Codes |
---|---|---|---|
PUT | http://localhost:8081/nudr-dr-mgm/v1/profile-data/schema |
To add new field "customFieldKey" for profile-data, see PUT Profile Data This operation adds a new schema with version tag as "v1" and current schema points to "v1" now. To rollback to any other schema version, which already
exists in database:
|
|
GET |
|
NA |
|
DELETE |
You cannot delete schema, which is currently in use. To delete any other stored schema:
|
NA |
|
4.1.1 Management APIs for Attribute Mapping
The following table lists attribute mapping APIs on 5G UDR for conversion of 4G to 5G quota and dynamic quota attributes:
Table 4-2 Attribute Mapping
Operation Type | Sample REST URL | Description | Possible error codes |
---|---|---|---|
PUT - Quota Attribute (Individual field) | http://localhost:8080/nudr-dr-mgm/v1/attribute-mapping/quota/{4g-attribute-name} Example:
|
Adding or updating a quota attribute Payload:
Result Code: 201 on creation and 204 on updates |
400: Invalid value for fiveg-attribute-placeholde 400: Invalid URI 400: Invalid value for quota-type 400: quota type in url and payload should be same 400: 4G attribute name in url and payload should be same 404: Attribute Mapping not found 405: Operation not allowed |
PUT - Dynamic Quota Attribute (Individual field) | http://localhost:8080/nudr-dr-mgm/v1/attribute-mapping/dynamicquota/{4g-attribute-name} Example: |
Adding or updating a dynamic quota attribute Payload:
Result Code: 201 on creation and 204 on update |
400: Invalid value for fiveg-attribute-placeholde 400: Invalid URI 400: Invalid value for quota-type 400: quota type in url and payload should be same 400: 4G attribute name in url and payload should be same 404: Attribute Mapping not found 405: Operation not allowed |
GET - Quota Attribute (Individual field) | http://localhost:8080/nudr-dr-mgm/v1/attribute-mapping/quota/{4g-attribute-name} Example:
|
Payload: Result
Code: 200 on success
|
400: Invalid URI 404: Attribute mapping not found 405: Operation not allowed |
GET - Dynamic Quota Attribute (Individual field) | http://localhost:8080/nudr-dr-mgm/v1/attribute-mapping/dynamicquota/{4g-attribute-name} Example: |
Response
payload: Result
Code: 200 on success
|
400: Invalid URI 404: Attribute mapping not found 405: Operation not allowed |
DELETE - Quota Attribute (Individual field) | http://localhost:8080/nudr-dr-mgm/v1/attribute-mapping/quota/{4g-attribute-name}/version/v1 Example:
|
Result Code: 204 on deletion |
400: Invalid URI 404: Attribute mapping not found 405: Operation not allowed |
DELETE - Dynamic Quota Attribute (Individual field) | http://localhost:8080/nudr-dr-mgm/v1/attribute-mapping/dynamicquota/{4g-attribute-name}/version/v1 Example:
|
Result Code: 204 on deletion |
400: Invalid URI 404: Attribute mapping not found 405: Operation not allowed |
GET (All Quota Attribute) | http://localhost:8080/nudr-dr-mgm/v1/attribute-mapping/quota |
Payload:
Return
200 on success |
400: Invalid URI 404: Attribute mapping not found 405: Operation not allowed |
GET (All Dynamic Quota Attribute) | http://localhost:8080/nudr-dr-mgm/v1/attribute-mapping/dynamicquota |
Payload:
Return
200 on success |
400: Invalid URI 404: Attribute mapping not found 405: Operation not allowed |
PUT (All Quota Attribute) | http://localhost:8080/nudr-dr-mgm/v1/attribute-mapping/quota |
To Add, Update, or Delete quota attributes.
Payload:
Return
201 on creation and 204 on updates |
400: Invalid value for fiveg-attribute-placeholde 400: Invalid URI 400: Invalid value for quota-type 400: quota type in url and payload should be same 404: Attribute Mapping not found 405: Operation not allowed |
PUT (All Dynamic Quota Attribute) |
http://localhost:8080/nudr-dr-mgm/v1/attribute-mapping/dynamicquota |
To Add, Update, or Delete dynamic quota
attributes.
Payload:
Return
201 on creation and 204 on updates |
400: Invalid value for fiveg-attribute-placeholde 400: Invalid URI 400: Invalid value for quota-type 400: quota type in url and payload should be same 404: Attribute Mapping not found 405: Operation not allowed |
4.2 PCF Schema Management
The following table lists the PCF Schema Management operations.
OpenAPI for Management URI: OpenAPIMGM.yml
Table 4-3 PCF Schema Management Operations
HTTP Method | Sample REST URL | Description | Possible Error Codes |
---|---|---|---|
PUT | https://localhost:9443/nudr-dr-mgm/v1/policy-data/schema/am-data |
Adding new field "custom" for am-data. Source: PCF Schema Management - PUTThis operation adds one new schema with version tag as "v1" and current points to "v1" now. 2) To rollback to any other schema version which already exist in db:
|
|
GET |
|
NA |
|
DELETE |
|
NA |
|
PUT | https://localhost:9443/nudr-dr-mgm/v1/policy-data/schema/sm-data |
Remove mandatory parameter for sm-data, see, PUT - sm-data schema This operation will add one new schema with version tag as "v2" and current will point to "v2" now. To rollback to any other schema version which already
exists in db:
|
|
GET |
To get currently supported schema:
To get all schema versions supported by a resource:
To get any specific schema version:
|
405: Operation not allowed | |
DELETE |
Schema which is currently in use could not be deleted. To delete any other stored schema:
|
405: Operation not allowed | |
PUT | https://localhost:8081/nudr-dr-mgm/v1/policy-data/schema/ue-policy-set |
For ue-policy-set schema, see, PUT-ue-policy-set schema This operation will add one new schema with version tag as "v2" and current will point to "v2" now. To rollback to any other
schema version which already exist in db:
|
|
GET |
To get currently supported
schema: To get all schema versions supported by a resource.
To get any specific schema
version |
405: Operation not allowed | |
DELETE |
Schema which is currently in use could not be deleted To delete any other stored schema:
|
405: Operation not allowed | |
PUT (vsa) | https://localhost:9443/nudr-dr-mgm/v1/policy-data/schema/sm-data/vsa |
|
|
GET(VSA) |
|
VSA_GET_CURRENT_SCHEMA PCF Schema Management - GET (VSA) VSA_GET_ALL_SCHEMA PCF Schema Management - VSA GET ALL SCHEMA VSA_GET_V1 |
|
DELETE |
|
NA |
|
4.3 SLF Schema Management
The following table lists the SLF Schema Management operations.
OpenAPI for Management URI: OpenAPIMGM.yml
Table 4-4 SLF Schema Management Operations
HTTP Method | Sample REST URL | Description | Possible Error Codes |
---|---|---|---|
PUT | https://localhost:9443/nudr-dr-mgm/v1/slf-group/schema/slf-group-prov |
|
|
GET |
|
NA |
|
DELETE |
To delete any other stored schema:
|
Schema, which is currently in use could not be deleted. |
|
4.4 EIR Schema Management
The following table lists the EIR Schema Management operations.
OpenAPI for Management URI: OpenAPIMGM.yml
Table 4-5 EIR Schema Management Operations
HTTP Method | Sample REST URL | Description | Possible Error Codes |
---|---|---|---|
PUT | http://localhost:8080/nudr-dr-mgm/v1/equipment-status/schema/n5g-eir-prov |
201 CREATED This schema will support equipment status with multiple combination of grey, black, and white. This serves as the default schema. Body
This schema will allow one of grey, white, and black inside equipment status only when it is set to true. Body
|
|
GET |
|
NA |
|
DELETE |
You cannot delete schema, which is currently in use. To delete any other stored schema:
|
NA |
|
4.5 UDM Schema Management
The following table list the UDM Schema Management operations.
OpenAPI for Management URI: OpenAPIMGM.yml
Table 4-6 UDM Schema Management Operations
HTTP Method | Sample REST URL | Description | Possible Error Codes |
---|---|---|---|
PUT (provisioned-data/am-data) | http://localhost:8086/nudr-dr-mgm/v1/subscription-data/schema/provisioned-data/am-data |
To add a new field "custom" for am-data. Schema for provisioned/am-data:UDM Schema Management - PUT (provisioned-data/am-data) This operation adds one new schema with version tag as "v1" and current points to "v1" now. To rollback to any other schema version, which already exist in db: http://localhost:8086/nudr-dr-mgm/v1/subscription-data/schema/provisioned-data/am-data/version/v0 |
|
GET |
|
NA |
|
DELETE |
To delete any other stored schema:
|
Schema currently in use cannot not be deleted. |
405: "Operation not allowed" (in case of deleting current schema) |
PUT (provisioned/sm-data) | http://localhost:8086/nudr-dr-mgm/v1/subscription-data/schema/provisioned-data/sm-data |
|
|
GET |
|
NA |
|
DELETE |
To delete any other stored schema:
|
Schema currently in use could not be deleted. |
|
PUT (provisioned/smf-selection-subscription-data) | http://localhost:8086/nudr-dr-mgm/v1/subscription-data/schema/provisioned-data/smf-selection-subscription-data |
To add a new field "custom" for smf-selection-subscription-data provisioned/smf-selection-subscription-data: UDM Schema Management - PUT (provisioned/smf-selection-subscription-data) This operation adds one new schema with version tag as "v1" and current points to "v1" now. To rollback to any other schema version which already exist in db:
|
|
GET |
|
NA |
|
DELETE |
To delete any other stored schema:
|
Schema currently in use could not be deleted. |
|
PUT (provisioned/sms-mng-data) | http://localhost:8086/nudr-dr-mgm/v1/subscription-data/schema/provisioned-data/sms-mng-data |
To add a new field "custom" for sms-mng-data provisioned/sms-mng-data: UDM Schema Management - PUT(provisioned/sms-mng-data) This operation adds one new schema with version tag as "v1" and current points to "v1" now. To rollback to any other schema version which already exist in db:
|
|
GET |
|
NA |
|
DELETE |
To delete any other stored schema:
|
Schema currently in use could not be deleted. |
|
PUT (provisioned/trace-data) | http://localhost:8086/nudr-dr-mgm/v1/subscription-data/schema/provisioned-data/trace-data |
To add a new field "custom" for trace-data
provisioned/trace-data:
UDM Schema Management - PUT(provisioned/trace-data).
This operation adds one new schema with version tag as "v1" and current point to "v1" now. To rollback to any other schema version, which already exist in db:
|
|
GET |
|
NA |
|
DELETE |
To delete any other stored schema:
|
Schema currently in use could not be deleted. |
|
PUT (provisioned/sms-data) | http://localhost:8086/nudr-dr-mgm/v1/subscription-data/schema/provisioned-data/sms-data |
To add a new field "custom" for sms-data provisioned/sms-data: UDM Schema Management - PUT(provisioned/sms-data) This operation adds one new schema with version tag as "v1" and current points to "v1" now. To rollback to any other schema version, which already exist in database:
|
|
GET |
|
NA |
|
DELETE |
To delete any other stored schema:
|
Schema currently in use could not be deleted. |
|