1. REST API Reference for Offline Mediation Controller
  2. Tasks
  3. Import

Update Import Mapping

put

/v1/imports/{importId}

Update the import mapping for a specific import.

Request

Path Parameters
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : configurationMapping
Type: array
The list of configuration mappings.
Show Source
Nested Schema : customizationMapping
Type: array
The list of customization mappings.
Show Source
Nested Schema : customJarsToRemove
Type: array
The list of custom Jars to remove.
Show Source
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
  • Allowed Values: [ "NODE_MANAGER", "NODE_CHAIN" ]
Nested Schema : Mapping
Type: object
Mapping class
Show Source
Nested Schema : destinationTriplet
Type: object
he 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: object
The 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: object
Triplet class
Show Source
Back to Top

Response

Supported Media Types

200 Response

The import mapping was updated successfully.
Body ()
Root Schema : NodeChainTestUploadResponse
Type: object
The response schema to get the node chain test upload operation's information.
Show Source
Nested Schema : records
Type: array
File records part of the input file.
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : NARAttribute
Type: object
The schema that defines the details of a record attribute.
Show Source
Nested Schema : values
Type: array
The list of nested NAR attributes.
Show Source

400 Response

The server could not process the request due to a client error.
Body ()
Root Schema : Error
Type: object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

401 Response

The client is not authorized to perform this request.
Body ()
Root Schema : Error
Type: object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

403 Response

Access to the requested resource is forbidden.
Body ()
Root Schema : Error
Type: object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

404 Response

The specified import could not be found.
Body ()
Root Schema : Error
Type: object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

405 Response

The request method is not allowed for this endpoint.
Body ()
Root Schema : Error
Type: object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

409 Response

A conflict occurred with the current state of the resource.
Body ()
Root Schema : Error
Type: object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

413 Response

The request payload is too large.
Body ()
Root Schema : Error
Type: object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

415 Response

The media type of the request is not supported.
Body ()
Root Schema : Error
Type: object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

500 Response

The server encountered an internal error while processing the request.
Body ()
Root Schema : Error
Type: object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
Back to Top

Examples

This example shows how to update the configuration mapping of an imported file by submitting a PUT request on the REST resource using cURL. For more information about cURL, see Use cURL. 

curl -X PUT 'http://hostname:port/imports/importId' -d @sampleUpdateImport.json

Example of the Request Body

The following is an example of the contents of the sampleUpdateImport.json file sent as the request body. This includes the source and destination triplets for both configuration and customization.
{
  "configurationMapping": [
    {
      "sourceTriplet": {
        "ip": "node-mgr-app",
        "name": "test",
        "port": 55109
      },
      "destinationTriplet": {
        "ip": "node-mgr-app",
        "name": "test",
        "port": 55109
      }
    },
    {
      "sourceTriplet": {
        "ip": "node-mgr-app-2",
        "name": "test",
        "port": 55109
      },
      "destinationTriplet": {
        "ip": "node-mgr-app-2",
        "name": "test",
        "port": 55109
      }
    }
  ],
  "customizationMapping": [
    {
    "sourceTriplet": {
      "ip": "node-mgr-app",
      "name": "test",
      "port": 55109
    },
    "destinationTriplet": {
      "ip": "node-mgr-app",
      "name": "test",
      "port": 55109
    }
    },
    {
      "sourceTriplet": {
        "ip": "node-mgr-app-2",
        "name": "test",
        "port": 55109
      },
      "destinationTriplet": {
        "ip": "node-mgr-app-2",
        "name": "test",
        "port": 55109
      }
    }],
  "skipConfiguration": false,
  "skipCustomization": false,
  "customJarsToRemove" : [],
  "regenerateNodeIds": false
}

Example of the Response Body

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

{
  "configurationMapping": [
    {
      "destinationTriplet": {
        "ip": "node-mgr-app-2",
        "name": "test",
        "port": 55109
      },
      "sourceTriplet": {
        "ip": "node-mgr-app-2",
        "name": "test",
        "port": 55109
      },
      "valid": true
    },
    {
      "destinationTriplet": {
        "ip": "node-mgr-app",
        "name": "test",
        "port": 55109
      },
      "sourceTriplet": {
        "ip": "node-mgr-app",
        "name": "test",
        "port": 55109
      },
      "valid": true
    }
  ],
  "configurationMappingCount": 2,
  "customJarsToRemove": [],
  "customizationMapping": [
    {
      "destinationTriplet": {
        "ip": "node-mgr-app-2",
        "name": "test",
        "port": 55109
      },
      "sourceTriplet": {
        "ip": "node-mgr-app-2",
        "name": "test",
        "port": 55109
      },
      "valid": true
    },
    {
      "destinationTriplet": {
        "ip": "node-mgr-app",
        "name": "test",
        "port": 55109
      },
      "sourceTriplet": {
        "ip": "node-mgr-app",
        "name": "test",
        "port": 55109
      },
      "valid": true
    }
  ],
  "customizationMappingCount": 2,
  "importId": "I-5fa40130-3632-4edc-bedf-93e00b22b53b",
  "skipConfiguration": false,
  "skipCustomization": false,
  "regenerateNodeIds": false,
  "importType": "NODE_MANAGER"
}
Back to Top