Invoke Mapping

Maps the provided JSON to a different shape according to the specified mapping definition.

POST /mappings/{id}/map

This functionality is available in a Stedi module. Contact us for details.

Authorizations

Authorization · string · required · header

API key authentication via the 'Authorization' header

Path Parameters

id · string

• Pattern: ^([A-Z0-9]+)$
• Required string length: 26

Query Parameters

validation_mode · string

Validation mode, when not provided - no validation of input and output is applied, for the 'strict' option JSON Schema validation is applied to the input JSON and the output JSON using source and target JSON Schema.

Possible values

strict

Body

application/json

Response

application/json

MapDocument 200 response

cURL

curl --request POST \
  --url "https://mappings.us.stedi.com/2021-06-01/mappings/{id}/map" \
  --header "Authorization: <api_key>"

JavaScript

fetch("https://mappings.us.stedi.com/2021-06-01/mappings/{id}/map", {
  headers: {
    "Authorization": "<api_key>"
  }
})

Go

package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {
  url := "https://mappings.us.stedi.com/2021-06-01/mappings/{id}/map"

  req, _ := http.NewRequest("POST", url, nil)
  req.Header.Add("Authorization", "<api_key>")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}

Python

import requests

url = "https://mappings.us.stedi.com/2021-06-01/mappings/{id}/map"

response = requests.request("POST", url, headers = {
  "Authorization": "<api_key>"
})

print(response.text)

Java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.http.HttpResponse.BodyHandlers;
import java.time.Duration;

HttpClient client = HttpClient.newBuilder()
  .connectTimeout(Duration.ofSeconds(10))
  .build();

HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
  .uri(URI.create("https://mappings.us.stedi.com/2021-06-01/mappings/{id}/map"))
  .header("Content-Type", "application/json")
  .header("Authorization", "<api_key>")
  .POST()
  .build();

try {
  HttpResponse<String> response = client.send(requestBuilder.build(), BodyHandlers.ofString());
  System.out.println("Status code: " + response.statusCode());
  System.out.println("Response body: " + response.body());
} catch (Exception e) {
  e.printStackTrace();
}

200

null

400

{
  "code": "mapping_failed",
  "message": "string",
  "validation_errors": {
    "source": {
      "errors": [
        {
          "code": "string",
          "message": "string",
          "json_pointer": "string",
          "json_schema_pointer": "string"
        }
      ],
      "mapping_input": null
    },
    "target": {
      "errors": [
        {
          "code": "string",
          "message": "string",
          "json_pointer": "string",
          "json_schema_pointer": "string"
        }
      ],
      "mapping_output": null
    }
  }
}

401

{
  "message": "string",
  "code": "unauthorized"
}

403

{
  "message": "string",
  "code": "access_denied"
}

404

{
  "message": "string",
  "code": "not_found"
}

413

{
  "message": "string",
  "code": "size_exceeded"
}

429

{
  "message": "string",
  "code": "too_many_requests"
}