Retrieve NAR File
post
/v1/nodeManagers/{id}/nars/view
Retrieves NAR records from the specified file on the given Node Manager.
Request
Path Parameters
-
id(required): string
The identifier of the Node Manager from which the NAR records are retrieved.
Query Parameters
-
filePath(required): string
Minimum Length:
1The path to the NAR file from which records should be read. -
includeNarOffset: boolean
Indicates whether the response should include the byte offset for each NAR record.Default Value:
false -
limit: integer(int32)
The maximum number of NAR records to return.
-
offset: integer(int32)
The starting position from which records should be fetched.Default Value:
0
Supported Media Types
- application/json
Root Schema : schema
Type:
objectThe schema that defines the search parameters for filtering NARs.
Show Source
-
key: string
-
value: array
value
The list of values to match against the specified filter key.
Nested Schema : value
Type:
arrayThe list of values to match against the specified filter key.
Show Source
Response
Supported Media Types
- application/json
200 Response
The NAR records were retrieved successfully.
Root Schema : NARResponse
Type:
Show Source
object-
hasMore: boolean
Flag indicating whether there are additional records available beyond the current response.
-
limit: integer
(int32)
The maximum number of records included in the current response.
-
offset: integer
(int32)
The starting index from which records are returned in the current response.
-
records: array
records
The list of NAR record items retrieved.
-
totalRecords: integer
(int32)
The total number of NAR records available.
Nested Schema : NARItem
Type:
Show Source
object-
attributes: array
attributes
The list of attributes associated with the NAR.
-
filterPath: array
filterPath
The list of path indexes for matched attributes.
-
narOffset: integer
(int32)
The offset value of the NAR.
Nested Schema : attributes
Type:
arrayThe list of attributes associated with the NAR.
Show Source
-
Array of:
object NARAttribute
The schema that defines the details of a record attribute.
Nested Schema : NARAttribute
Type:
objectThe schema that defines the details of a record attribute.
Show Source
-
key: string
The name of the variable key.
-
length: integer
(int32)
The length of the value in bytes.
-
type: string
The type of value that the key holds.
-
value:
The value assigned to the variable.
-
values: array
values
The list of nested NAR attributes.
Nested Schema : values
Type:
arrayThe list of nested NAR attributes.
Show Source
-
Array of:
object NARAttribute
The schema that defines the details of a record attribute.
400 Response
The request could not be understood or was missing required parameters.
Root Schema : Error
Type:
objectUsed 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
401 Response
The client does not have the correct privileges.
Root Schema : Error
Type:
objectUsed 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
403 Response
The request was not authorized.
Root Schema : Error
Type:
objectUsed 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
404 Response
The requested resource cannot be found.
Root Schema : Error
Type:
objectUsed 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
405 Response
This method is not allowed.
Root Schema : Error
Type:
objectUsed 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
409 Response
The request could not be processed due to a conflict with the existing state of the resource.
Root Schema : Error
Type:
objectUsed 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
500 Response
The system has encountered an internal server error.
Root Schema : Error
Type:
objectUsed 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
Examples
The following example shows how to search and filter through NAR records by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL.
The -d option specifies the file to attach as the request body.
curl -X POST 'http://host:port/nodeManagers/{id}/nars/view?filePath=%2Fhome%2Focomcuser%2Finstall%2Focomc%2Ftest.arch&includeNarOffset=true&offset=0&limit=200' -d @sampleFilterCriteria.json
Example of Request Body
The following is an example of the contents of the sampleFilterCriteria.json file sent as the request body.
{
"key": "OriginatingIOI",
"value": ["nigel", "com"]
}Example of Response Body
If successful, the response code 200 is displayed with the following response
body.
{
"hasMore": false,
"limit": 200,
"offset": 0,
"records": [
{
"attributes": [
{
"key": "SIP-Response-Timestamp",
"length": 9,
"type": "Bytes",
"value": "05 01 28 08 50 54 2b 00 00 "
},
{
"key": "InterOperatorIdentifiers",
"length": 264,
"type": "List",
"values": [
{
"key": "OriginatingIOI",
"length": 9,
"type": "String",
"value": "nigel.com"
}
]
}
],
"filterPath": [[3, 0, 0]],
"narOffset": 0
}
],
"recordsCount": 1
}