REST API Reference for Offline Mediation Controller

List NPL Files of a Specified Type

get

/v1/actions/rules

This operation fetches a list of NPL files of a specified type.

Request

Query Parameters

nodeContext(required): string

The context of the node.

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

The requested files were fetched and listed successfully.

400 Response

The server cannot process the request due to a client error.

Root Schema : Error

Type: object

Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

@type: string

Defines the sub-class entity when sub-classing.
cause: string

Cause of the exception
code(required): string

The application relevant details defined in the API or a common list.
message: string

The details and corrective actions for the error shown to the client user.
reason(required): string

The reason for the error, which is shown to a client user.
referenceError: string (uri)

URI of documentation describing the error
status: string

HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "description":"The application relevant details defined in the API or a common list.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, which is shown to a client user.",
            "type":"string"
        },
        "message":{
            "description":"The details and corrective actions for the error shown to the client user.",
            "type":"string"
        },
        "cause":{
            "description":"Cause of the exception",
            "type":"string"
        },
        "status":{
            "description":"HTTP Error code extension",
            "type":"string"
        },
        "referenceError":{
            "description":"URI of documentation describing the error",
            "format":"uri",
            "type":"string"
        },
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        }
    },
    "description":"Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).",
    "type":"object"
}

401 Response

The client does not have the correct privileges.

Root Schema : Error

Type: object

Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

@type: string

Defines the sub-class entity when sub-classing.
cause: string

Cause of the exception
code(required): string

The application relevant details defined in the API or a common list.
message: string

The details and corrective actions for the error shown to the client user.
reason(required): string

The reason for the error, which is shown to a client user.
referenceError: string (uri)

URI of documentation describing the error
status: string

HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "description":"The application relevant details defined in the API or a common list.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, which is shown to a client user.",
            "type":"string"
        },
        "message":{
            "description":"The details and corrective actions for the error shown to the client user.",
            "type":"string"
        },
        "cause":{
            "description":"Cause of the exception",
            "type":"string"
        },
        "status":{
            "description":"HTTP Error code extension",
            "type":"string"
        },
        "referenceError":{
            "description":"URI of documentation describing the error",
            "format":"uri",
            "type":"string"
        },
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        }
    },
    "description":"Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).",
    "type":"object"
}

403 Response

The request was not authorized.

Root Schema : Error

Type: object

Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

@type: string

Defines the sub-class entity when sub-classing.
cause: string

Cause of the exception
code(required): string

The application relevant details defined in the API or a common list.
message: string

The details and corrective actions for the error shown to the client user.
reason(required): string

The reason for the error, which is shown to a client user.
referenceError: string (uri)

URI of documentation describing the error
status: string

HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "description":"The application relevant details defined in the API or a common list.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, which is shown to a client user.",
            "type":"string"
        },
        "message":{
            "description":"The details and corrective actions for the error shown to the client user.",
            "type":"string"
        },
        "cause":{
            "description":"Cause of the exception",
            "type":"string"
        },
        "status":{
            "description":"HTTP Error code extension",
            "type":"string"
        },
        "referenceError":{
            "description":"URI of documentation describing the error",
            "format":"uri",
            "type":"string"
        },
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        }
    },
    "description":"Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).",
    "type":"object"
}

404 Response

The requested resource cannot be found.

Root Schema : Error

Type: object

Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

@type: string

Defines the sub-class entity when sub-classing.
cause: string

Cause of the exception
code(required): string

The application relevant details defined in the API or a common list.
message: string

The details and corrective actions for the error shown to the client user.
reason(required): string

The reason for the error, which is shown to a client user.
referenceError: string (uri)

URI of documentation describing the error
status: string

HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "description":"The application relevant details defined in the API or a common list.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, which is shown to a client user.",
            "type":"string"
        },
        "message":{
            "description":"The details and corrective actions for the error shown to the client user.",
            "type":"string"
        },
        "cause":{
            "description":"Cause of the exception",
            "type":"string"
        },
        "status":{
            "description":"HTTP Error code extension",
            "type":"string"
        },
        "referenceError":{
            "description":"URI of documentation describing the error",
            "format":"uri",
            "type":"string"
        },
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        }
    },
    "description":"Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).",
    "type":"object"
}

405 Response

This method is not allowed.

Root Schema : Error

Type: object

Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

@type: string

Defines the sub-class entity when sub-classing.
cause: string

Cause of the exception
code(required): string

The application relevant details defined in the API or a common list.
message: string

The details and corrective actions for the error shown to the client user.
reason(required): string

The reason for the error, which is shown to a client user.
referenceError: string (uri)

URI of documentation describing the error
status: string

HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "description":"The application relevant details defined in the API or a common list.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, which is shown to a client user.",
            "type":"string"
        },
        "message":{
            "description":"The details and corrective actions for the error shown to the client user.",
            "type":"string"
        },
        "cause":{
            "description":"Cause of the exception",
            "type":"string"
        },
        "status":{
            "description":"HTTP Error code extension",
            "type":"string"
        },
        "referenceError":{
            "description":"URI of documentation describing the error",
            "format":"uri",
            "type":"string"
        },
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        }
    },
    "description":"Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).",
    "type":"object"
}

409 Response

The request could not be processed due to a conflict with the existing state of the resource.

Root Schema : Error

Type: object

Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

@type: string

Defines the sub-class entity when sub-classing.
cause: string

Cause of the exception
code(required): string

The application relevant details defined in the API or a common list.
message: string

The details and corrective actions for the error shown to the client user.
reason(required): string

The reason for the error, which is shown to a client user.
referenceError: string (uri)

URI of documentation describing the error
status: string

HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "description":"The application relevant details defined in the API or a common list.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, which is shown to a client user.",
            "type":"string"
        },
        "message":{
            "description":"The details and corrective actions for the error shown to the client user.",
            "type":"string"
        },
        "cause":{
            "description":"Cause of the exception",
            "type":"string"
        },
        "status":{
            "description":"HTTP Error code extension",
            "type":"string"
        },
        "referenceError":{
            "description":"URI of documentation describing the error",
            "format":"uri",
            "type":"string"
        },
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        }
    },
    "description":"Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).",
    "type":"object"
}

422 Response

The entity is unprocessable due to a semantic error.

Root Schema : Error

Type: object

Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

@type: string

Defines the sub-class entity when sub-classing.
cause: string

Cause of the exception
code(required): string

The application relevant details defined in the API or a common list.
message: string

The details and corrective actions for the error shown to the client user.
reason(required): string

The reason for the error, which is shown to a client user.
referenceError: string (uri)

URI of documentation describing the error
status: string

HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "description":"The application relevant details defined in the API or a common list.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, which is shown to a client user.",
            "type":"string"
        },
        "message":{
            "description":"The details and corrective actions for the error shown to the client user.",
            "type":"string"
        },
        "cause":{
            "description":"Cause of the exception",
            "type":"string"
        },
        "status":{
            "description":"HTTP Error code extension",
            "type":"string"
        },
        "referenceError":{
            "description":"URI of documentation describing the error",
            "format":"uri",
            "type":"string"
        },
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        }
    },
    "description":"Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).",
    "type":"object"
}

500 Response

The system has encountered an internal server error.

Root Schema : Error

Type: object

Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

@type: string

Defines the sub-class entity when sub-classing.
cause: string

Cause of the exception
code(required): string

The application relevant details defined in the API or a common list.
message: string

The details and corrective actions for the error shown to the client user.
reason(required): string

The reason for the error, which is shown to a client user.
referenceError: string (uri)

URI of documentation describing the error
status: string

HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "description":"The application relevant details defined in the API or a common list.",
            "type":"string"
        },
        "reason":{
            "description":"The reason for the error, which is shown to a client user.",
            "type":"string"
        },
        "message":{
            "description":"The details and corrective actions for the error shown to the client user.",
            "type":"string"
        },
        "cause":{
            "description":"Cause of the exception",
            "type":"string"
        },
        "status":{
            "description":"HTTP Error code extension",
            "type":"string"
        },
        "referenceError":{
            "description":"URI of documentation describing the error",
            "format":"uri",
            "type":"string"
        },
        "@type":{
            "description":"Defines the sub-class entity when sub-classing.",
            "type":"string"
        }
    },
    "description":"Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).",
    "type":"object"
}

Examples

The following example shows how to list NPL files of a specified type by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X GET 'http://host:port/actions/rules?nodeContext=Wireless%23EI%23GTPPrime_Collection' -H accept: application/json

Example of the Response Body

If successful, the response code 200 is returned with the following response body.

[
  {
    "fileName": "DC1.npl",
    "isSysRule": false
  },
  {
    "fileName": "NewFile.npl",
    "isSysRule": true
  }
]