B2BI / Client / test_mapping

test_mapping#

B2BI.Client.test_mapping(**kwargs)#

Maps the input file according to the provided template file. The API call downloads the file contents from the Amazon S3 location, and passes the contents in as a string, to the inputFileContent parameter.

See also: AWS API Documentation

Request Syntax

response = client.test_mapping(
    inputFileContent='string',
    mappingTemplate='string',
    fileFormat='XML'|'JSON'|'NOT_USED'
)
Parameters:

  • inputFileContent (string) –

    [REQUIRED]

    Specify the contents of the EDI (electronic data interchange) XML or JSON file that is used as input for the transform.

  • mappingTemplate (string) –

    [REQUIRED]

    Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.

    Note

    This parameter is available for backwards compatibility. Use the Mapping data type instead.

  • fileFormat (string) –

    [REQUIRED]

    Specifies that the currently supported file formats for EDI transformations are JSON and XML.

Return type:

dict

Returns:

Response Syntax

{
    'mappedFileContent': 'string'
}

Response Structure

  • (dict) –

    • mappedFileContent (string) –

      Returns a string for the mapping that can be used to identify the mapping. Similar to a fingerprint

Exceptions