Start Import Task
post
/v1/imports/{importId}/tasks
Start an import task for a specific import.
Request
Path Parameters
-
importId(required): string
The unique identifier of the import.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
configurationMapping(required): array
configurationMapping
The list of configuration mappings.
-
customizationMapping(required): array
customizationMapping
The list of customization mappings.
-
customJarsToRemove: array
customJarsToRemove
The list of custom Jars to remove.
-
importType(required): string
importType
The flag to check if the node chain has been imported.
-
regenerateNodeIds(required): boolean
The flag to regenerate node IDs while importing configuration.
-
skipConfiguration: boolean
The flag to skip configuration.
-
skipCustomization: boolean
The flag to skip customization.
-
skipRestart: boolean
The flag to skip restart after importing customization.
Nested Schema : configurationMapping
Type:
arrayThe list of configuration mappings.
Show Source
-
Array of:
object Mapping
Mapping class
Nested Schema : customizationMapping
Type:
arrayThe list of customization mappings.
Show Source
-
Array of:
object Mapping
Mapping class
Nested Schema : importType
The flag to check if the node chain has been imported.
Match All
The flag to check if the node chain has been imported.
Show Source
-
string
Allowed Values:
[ "NODE_MANAGER", "NODE_CHAIN" ]
Nested Schema : Mapping
Type:
objectMapping class
Show Source
-
destinationTriplet(required): object
destinationTriplet
he triplet object that defines the destination of the mapping.
-
skip: boolean
The flag that indicates whether this mapping should be skipped.
-
sourceTriplet(required): object
sourceTriplet
The triplet object that defines the source of the mapping.
Nested Schema : destinationTriplet
Type:
objecthe triplet object that defines the destination of the mapping.
Match All
he triplet object that defines the destination of the mapping.
Show Source
Nested Schema : sourceTriplet
Type:
objectThe triplet object that defines the source of the mapping.
Match All
The triplet object that defines the source of the mapping.
Show Source
Nested Schema : Triplet
Type:
objectTriplet class
Show Source
-
ip(required): string
IP address
-
name(required): string
Name
-
port(required): integer
(int32)
Port number
Response
Supported Media Types
- application/json
200 Response
The import task was submitted 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 specified import 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 request payload is too large.
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 start an import task by submitting a POST request on the REST resource using cURL. This step triggers the final processing of the uploaded files based on the provided mappings. For more information about cURL, see Use cURL.
The -d option specifies the JSON file containing the details of the task.
curl -X POST 'http://hostname:port/version/imports/importId/tasks' -d @sampleStartImportTask
Example of Request Body
The following is an example of the contents of the sampleStartImportTask.json file. This payload specifies the final triplet mappings and instructions for node restarts and ID regeneration.
{
"customizationMapping": [
{
"sourceTriplet": {
"ip": "100.77.60.203",
"name": "asd",
"port": 55109
},
"destinationTriplet": {
"ip": "node-mgr-app",
"name": "NM1",
"port": 55109
}
}
],
"configurationMapping": [
{
"sourceTriplet": {
"ip": "100.77.60.203",
"name": "asd",
"port": 55109
},
"destinationTriplet": {
"ip": "node-mgr-app",
"name": "NM1",
"port": 55109
}
}
],
"skipCustomization": false,
"skipConfiguration": false,
"skipRestart": true
"regenerateNodeIds": false,
"importType": "NODE_MANAGER"
}Example of Response Body
If successful, the response code 200 is displayed along with the following response
body.
{
"importId": "I-5fa40130-3632-4edc-bedf-93e00b22b53b",
"importTaskId": "IT-a828152f-0f96-419f-9aa5-963f9511dd9c",
"startTime": "2024-04-23T08:18:45Z[UTC]",
"status": "STARTED",
"taskFinished": false
}