Get NPL Content of a Node
get
/actions/rulefile
Returns NPL Content using node Id, or by fileName and nodeContext
Request
Query Parameters
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
The requested NPL Content was fetched successfully.
400 Response
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
Application relevant details defined in the API or a common list.
-
message: string
Details and corrective actions related to the error which is shown to a client user.
-
reason(required): string
The reason for the error, shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error Code describiing the error.
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
Application relevant details defined in the API or a common list.
-
message: string
Details and corrective actions related to the error which is shown to a client user.
-
reason(required): string
The reason for the error, shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error Code describiing the error.
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
Application relevant details defined in the API or a common list.
-
message: string
Details and corrective actions related to the error which is shown to a client user.
-
reason(required): string
The reason for the error, shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error Code describiing the error.
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
Application relevant details defined in the API or a common list.
-
message: string
Details and corrective actions related to the error which is shown to a client user.
-
reason(required): string
The reason for the error, shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error Code describiing the error.
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
Application relevant details defined in the API or a common list.
-
message: string
Details and corrective actions related to the error which is shown to a client user.
-
reason(required): string
The reason for the error, shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error Code describiing the error.
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
Application relevant details defined in the API or a common list.
-
message: string
Details and corrective actions related to the error which is shown to a client user.
-
reason(required): string
The reason for the error, shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error Code describiing the error.
422 Response
The entity is unprocessable due to semantic errors.
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
Application relevant details defined in the API or a common list.
-
message: string
Details and corrective actions related to the error which is shown to a client user.
-
reason(required): string
The reason for the error, shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error Code describiing the error.
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
Application relevant details defined in the API or a common list.
-
message: string
Details and corrective actions related to the error which is shown to a client user.
-
reason(required): string
The reason for the error, shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error Code describiing the error.
Examples
The following example shows how to fetch 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/rulefile'
Example of the Response Body
If successful, the response code 200 is returned with the following response body.
{ "content": "//This npl is used to ECE_DC node chain\n\nInputRec {\n\n String calling_number;\n String seq_no;\n \n\n\n} in;\n\nOutputRec {\n\n String calling_number;\n Integer seq_no;\n \n\n\n} out;\n\n \n\n//Assign the input record attribute to output record attribute here...\n\nout.calling_number=in.calling_number;\nout.seq_no=str2int(in.seq_no);\n\nwrite(out);\n", "fileName": "DC1.npl", "majorType": "OI", "marketSegment": "CartridgeKit", "minorType": "FlatFile", "nodeId": "31eoef-otm-lna53s09" }