Mapping

Store

post

Validation Rules

These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements

Field	Type	Required
flow_version_id		☑
flow_step_id		☑
mapping
mapping_file

Authorizations

ApiKeyAuth

Body

application/json

flow_version_idstringRequired

flow_step_idstringRequired

mappingstringOptional

mapping_filestringOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/mapping

HTTPcURLJavaScriptPython

POST /api/v1/mapping HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 104

{
  "flow_version_id": 1,
  "flow_step_id": 1,
  "mapping": "example_mapping",
  "mapping_file": "example_mapping_file"
}

{
  "data": {
    "id": 1,
    "flow_version_id": 1,
    "flow_step_id": 1,
    "mapping": "example_mapping",
    "mapping_file": "example_mapping_file",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z"
  }
}

Generate

get

Generate for generate.

Authorizations

ApiKeyAuth

Path parameters

sourceEndpointstringRequired

The sourceEndpoint identifier.

destinationEndpointstringRequired

The destinationEndpoint identifier.

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

get

/api/v1/mapping/generate/{sourceEndpoint}/{destinationEndpoint}

HTTPcURLJavaScriptPython

GET /api/v1/mapping/generate/{sourceEndpoint}/{destinationEndpoint} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{}

Show

get

Get a single mapping.

Authorizations

ApiKeyAuth

Path parameters

mappingstringRequired

The mapping identifier.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/mapping/{mapping}

HTTPcURLJavaScriptPython

GET /api/v1/mapping/{mapping} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": {
    "id": 1,
    "flow_version_id": 1,
    "flow_step_id": 1,
    "mapping": "example_mapping",
    "mapping_file": "example_mapping_file",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z"
  }
}

Export

get

Export for export.

Authorizations

ApiKeyAuth

Path parameters

mappingstringRequired

The mapping identifier.

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

get

/api/v1/mapping/{mapping}/export

HTTPcURLJavaScriptPython

GET /api/v1/mapping/{mapping}/export HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{}