Upload Import File
post
/v1/imports/uploadImportFile
Upload input file for importing.
Request
There are no request parameters for this operation.
Supported Media Types
- multipart/form-data
Root Schema : schema
Type:
string(binary)Response
Supported Media Types
- application/json
200 Response
The file was uploaded successfully.
Root Schema : NodeChainTestUploadResponse
Type:
objectThe response schema to get the node chain test upload operation's information.
Show Source
-
inputType(required): string
The input file type of the uploaded file, for example, NAR, TEXT, etc.
-
records(required): array
records
File records part of the input file.
-
uploadId(required): string
The identifier of the file upload operation.
Nested Schema : items
Type:
Show Source
array-
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 server could not process the request due to a client 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
401 Response
The client is not authorized to perform this request.
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
Access to the requested resource is forbidden.
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 could not 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
The request method is not allowed for this endpoint.
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
A conflict occurred with the current 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
413 Response
The uploaded file exceeds the maximum allowed size.
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
415 Response
The media type of the request is not supported.
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 server encountered an internal error while processing the request.
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 upload customization and configuration files for importing by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL.
The -F option specifies the individual files to attach as parts of the multipart request body.
curl -X POST 'http://hostname:port/imports/uploadImportFile' \ -H "Content-Type: multipart/form-data" \ -F "customizationFile=@inputFiles/2NM/export_20240407_163132.nmx" \ -F "configurationFile=@inputFiles/2NM/export_20240407_163132.xml"
Example of Request Body
The following is an example of the structured contents of the multipart/form-data request body. Each part is seperated by a bounary string and includes a Content-Disposition header identifying the form field name.
--boundary
Content-Disposition: form-data; name="customizationFile"; filename="customizationFile.nmx"
< inputFiles/2NM/export_20240407_163132.nmx
--boundary
Content-Disposition: form-data; name="configurationFile"; filename="configurationFile.xml"
< inputFiles/2NM/export_20240407_163132.xml
--boundary--Example of Response Body
If successful, the response code 200 is displayed along with the following response
body.
{
"configurationMapping": [
{
"sourceTriplet": {
"ip": "node-mgr-app",
"name": "test",
"port": 55109
},
"valid": false
},
{
"sourceTriplet": {
"ip": "node-mgr-app-2",
"name": "test",
"port": 55109
},
"valid": false
}
],
"configurationMappingCount": 2,
"customJarsToRemove": [],
"customizationMapping": [
{
"sourceTriplet": {
"ip": "node-mgr-app",
"name": "test",
"port": 55109
},
"valid": false
},
{
"sourceTriplet": {
"ip": "node-mgr-app-2",
"name": "test",
"port": 55109
},
"valid": false
}
],
"customizationMappingCount": 2,
"importId": "I-5fa40130-3632-4edc-bedf-93e00b22b53b",
"isNodeChainImport": false,
"regenerateNodeIds": true,
"skipConfiguration": false,
"skipCustomization": false,
"skipRestart": false
}