1. Cloud Native Unified Data Repository REST Specification Document
  2. REST Specifications
  3. Operations Supported for PCF

Operations Supported for PCF

This section provides information about the operations supported for PCF.

Note:

All APIs supported are as per TS29.500 v16.2.

Resource Name: AccessAndMobilityPolicyData

HTTP Method: GET

Base URI: {apiRoot}/nudr-dr/{version}/policy-data/ues/{ueId}/am-data

Sample Request URL: https://10.75.212.116:31873/nudr-dr/v2/policy-data/ues/msisdn-7777777779/am-data

Possible Error Codes:
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
  • 404: "Data field does not exist"
  • 400: "Unknown key, the key provided in the request is invalid"

Resource Name: SessionManagementPolicyData

HTTP Method: GET, PATCH

Base URI: {apiRoot}/nudr-dr/{version}/policy-data/ues/{ueId}/sm-data

Operation Type Sample REST URL Possible Error Codes
GET Different samples of GET
  • Complete SM data GET: https://10.75.212.116:31873/nudr-dr/v2/policy-data/ues/msisdn-7777777779/sm-data
  • Using query parameters
    • https://10.75.212.116:31873/nudr-dr/v2/policy-data/ues/msisdn-7777777779/sm-data?dnn=dnn1&snssai={"sst":11,"sd":"abc123"}&fields=umData
    • https://10.75.212.116:31873/nudr-dr/v2/policy-data/ues/msisdn-7777777779/sm-data?dnn=dnn1&fields=umData,smPolicySnssaiData
    • https://10.75.212.116:31873/nudr-dr/v2/policy-data/ues/msisdn-7777777779/sm-data?snssai={"sst":11,"sd":"abc123"}&fields=smPolicySnssaiData
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
  • 400: "Unknown key, the key provided in the request is invalid"
  • 404: "Requested data not found"
  • 400: "Invalid query parameters supplied"
PATCH

Base URI: {apiRoot}/nudr-dr/{version}/policy-data/ues/{ueId}/sm-data

Sample REST URL: See https://localhost:9443/nudr-dr/v2/policy-data/ues/msisdn-1111111111/sm-data

Payload: See PATCH-SessionManagementPolicyData
  • 400: "Blob syntax error with corresponding error details"
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
  • 400: "Unknown key, the key provided in the request is invalid"
  • 404: Data field does not exist.

Resource Name: UEPolicySet

HTTP Method: PUT, GET, PATCH

Base URI: {apiRoot}/nudr-dr/{version}/policy-data/ues/{ueId}/ue-policy-set

Operation Type Sample REST URL Possible Error Codes
PUT https://localhost:9443/nudr-dr/v2/policy-data/ues/msisdn-1111111111/ue-policy-set

Payload: See PUT-UEPolicySet

  • 400: "Blob syntax error with corresponding error details"
  • 400: "Invalid URI sent from client"
  • 404: "Subscriber does not exist"
  • 400: "Unknown key, the key provided in the request is invalid"
GET

https://localhost:9443/nudr-dr/v2/policy-data/ues/msisdn-1111111111/ue-policy-set
  • 400: "Invalid URI sent from client"
  • 404:"Subscriber does not exist"
  • 400: "Unknown key, the key provided in the request is invalid"
PATCH https://localhost:9443/nudr-dr/v2/policy-data/ues/msisdn-1111111111/ue-policy-set

Payload: See PATCH-UEPolicySet

  • 400 : "Blob syntax error with corresponding error details"
  • 400 : "Invalid URI sent from client"
  • 404 : "Subscriber does not exist"
  • 400 : "Unknown key, the key provided in the request is invalid"
  • 404: "Data field does not exist"

Resource Name: UsageMonitoringInformation

HTTP Method: GET, PUT, DELETE

Base URI: {apiRoot}/nudr-dr/{version}/policy-data/ues/{ueId}/sm-data/{usageMonId}

Operation Type Sample REST URL Possible Error Codes
GET https://localhost:9443/nudr-dr/v2/policy-data/ues/msisdn-1111111111/sm-data/mk1
  • 400 : "Invalid URI sent from client"
  • 404 : "Subscriber does not exist"
  • 404 : "Data field does not exist "
  • 400 : "Unknown key, the key provided in the request is invalid"
PUT https://localhost:9443/nudr-dr/v2/policy-data/ues/msisdn-1111111111/sm-data/mk1

Payload: See PUT-UsageMonitoringInformation

  • 400 : "Blob syntax error with corresponding error details"
  • 400 : "Invalid URI sent from client"
  • 404 : "Subscriber does not exist"
  • 400 : "Unknown key, the key provided in the request is invalid"
  • 404: "Data field does not exist"
DELETE https://localhost:9443/nudr-dr/v2/policy-data/ues/msisdn-1111111111/sm-data/mk1
  • 400 : "Invalid URI sent from client"
  • 404 : "Subscriber does not exist"
  • 400 : "Unknown key, the key provided in the request is invalid"
  • 404: "Data field does not exist"