StediDOCS

Mappings

Mappings lets you define transformations between documents – from simple value-to-value data mapping to highly complex data transformations.

Authorization - API Key generated in Stedi terminal

Download OpenAPI

List mappings

GET/mappings

Retrieves a list of available mappings for current account

Parameters
page_size
Optionalquery
Maximum number of mappings to fetch. The value can range between 1 and 50, the default is 25.
page_token
Optionalquery
Last next_page_token seen in prior request from which to continue pagination The value must be a string.
metadata_only
Optionalquery
If true, only metadata of Mappings will be returned (without mapping itself and source/target properties) undefined

Example

GET
https://mappings.stedi.com/2021-06-01/mappings?page_size=48&page_token=2t7M75ZN1w4OnYFKKT0SUkT95w_ULzPR...&metadata_only=true

Create a new mapping

POST/mappings

Creates a mapping

Request body

application/json

name
Requiredstring
Name of the mapping. The value must be a string.
type
Requiredstring
Type of the mapping. The value must be a string.

Possible values

only_mapped_keys merge_with_target_example pass_through

source
Optional

Shape of the source object

One of:
jsonschema@2020-12
source.name
Optionalstring
JSONSchema name
source.type
Optionalstring

This property is a discriminator.

Possible values

jsonschema@2020-12

source.content
Optionalstring
Content
target
Optional

Shape of the target object

One of:
jsonschema@2020-12
target.name
Optionalstring
JSONSchema name
target.type
Optionalstring

This property is a discriminator.

Possible values

jsonschema@2020-12

target.content
Optionalstring
Content
mapping
Requiredstring
JSONata representation of the mapping. The value must be a string.

Example

POST
https://mappings.stedi.com/2021-06-01/mappings

Get a mapping

GET/mappings/{mapping_id}

Retrieves a mapping

Parameters
mapping_id
Requiredpath
id of the mapping The value must be a string.

Example

GET
https://mappings.stedi.com/2021-06-01/mappings/1f9c9cda-6188-4d9e-b96b-f8ad77452c08

Update a mapping

PUT/mappings/{mapping_id}

Updates a mapping

Parameters
mapping_id
Requiredpath
id of the mapping The value must be a string. The value must be a string. The value must be a string.
Request body

application/json

name
Optionalstring
Name of the mapping. The value must be a string.
type
Optionalstring
Type of the mapping. The value must be a string.

Possible values

only_mapped_keys merge_with_target_example pass_through

source
Optional

Shape of the source object

One of:
jsonschema@2020-12
source.name
Optionalstring
JSONSchema name
source.type
Optionalstring

This property is a discriminator.

Possible values

jsonschema@2020-12

source.content
Optionalstring
Content
target
Optional

Shape of the target object

One of:
jsonschema@2020-12
target.name
Optionalstring
JSONSchema name
target.type
Optionalstring

This property is a discriminator.

Possible values

jsonschema@2020-12

target.content
Optionalstring
Content
mapping
Optionalstring
JSONata representation of the mapping. The value must be a string.

Example

PUT
https://mappings.stedi.com/2021-06-01/mappings/aa226c5f-9d0c-4d9d-bec8-9e3db18ade48

Delete a mapping

DELETE/mappings/{mapping_id}

Deletes a mapping

Parameters
mapping_id
Requiredpath
id of the mapping The value must be a string. The value must be a string.

Example

DELETE
https://mappings.stedi.com/2021-06-01/mappings/391e6dcb-2123-49c6-a1b2-a6af4ab12a46

Map

POST/mappings/{mapping_id}/map

Maps an input according to the mapping

Parameters
mapping_id
Requiredpath
id of the mapping The value must be a string.
Request body

application/json

Requiredobject

Example

POST
https://mappings.stedi.com/2021-06-01/mappings/1dcb97e0-1bb8-4bd1-af0b-82ec238edc7d/map