Use HTML encoded patterns when working with values that contain special characters like spaces, dashes, etc. Refer to this HTML URL Encoding Reference for a full list.
Refer to the headers below to modify your cURL sample. Check if the following headers are in the sample, if not, ensure you add it to your cURL sample before pasting into your API tool.
| Header | Value | cURL Line |
|---|---|---|
| Accept | `application/json` | `-H "Accept:application/json"` |
In order for the relevant parameters to appear in the cURL sample, you can input the values in the interactive API console on the right in the Try It or Code Sample tabs. You can then copy the cURL sample from the Code Sample tab in the correct format.
## OpenAPI ````json GET /api/1.0/api-mapper-sets/{envId}/{apiMapperSetId}/mappers/{mapperId} { "openapi": "3.0.3", "info": { "title": "Management APIs", "version": "1.0.0", "contact": { "name": "PlainID", "url": "https://plainid.com", "email": "contact@plainid.com" }, "license": { "name": "Commercial", "url": "https://plainid.com/license" }, "termsOfService": "https://www.plainid.com/terms/", "description": "| Region | Base URL |
|---|---|
| United States (US) | https://api.us1.plainid.io |
| Canada (CA) | https://api.ca1.plainid.io |
| Europe (EU) | https://api.eu1.plainid.io |
| Local PAA | https://api.plainid.local |
Use HTML encoded patterns when working with values that contain special characters like spaces, dashes, etc. Refer to this HTML URL Encoding Reference for a full list.
Refer to the headers below to modify your cURL sample. Check if the following headers are in the sample, if not, ensure you add it to your cURL sample before pasting into your API tool.
| Header | Value | cURL Line |
|---|---|---|
| Accept | `application/json` | `-H \"Accept:application/json\"` |
In order for the relevant parameters to appear in the cURL sample, you can input the values in the interactive API console on the right in the Try It or Code Sample tabs. You can then copy the cURL sample from the Code Sample tab in the correct format.
", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "envId", "in": "path", "required": "true", "schema": { "type": "string", "format": "uuid" }, "description": "The Environment ID can be found in the Environment Settings." }, { "name": "apiMapperSetId", "in": "path", "required": "true", "schema": { "type": "string" }, "description": "API Mapper Set Unique Identifier. This can be found using the Export API Mapper Set By Filter call." }, { "name": "mapperId", "in": "path", "required": "true", "schema": { "type": "string" }, "description": "This can be found in the relevant Application's Mapper section." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseManagedApiMapperDto" }, "examples": { "exportMapper": { "value": { "data": { "mapperId": "marketing_api_mapper", "displayName": "Marketing API", "isActive": "true", "matchPattern": "/api/marketing/*", "matchType": "WILDCARDS", "restMethods": [ "GET", "POST" ], "priority": "10", "isRequireIdentitySourcesFiltering": "false", "assetTemplates": [] } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } } }, "components": { "schemas": { "ResponseManagedApiMapperDto": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ManagedApiMapperDto" } } }, "Error": { "type": "object", "properties": { "code": { "type": "string" }, "id": { "type": "string" }, "status": { "type": "integer" }, "name": { "type": "string" }, "message": { "type": "string" }, "args": { "type": "object", "properties": { "path": { "type": "string" } } } } }, "ManagedApiMapperDto": { "type": "object", "properties": { "mapperId": { "type": "string", "pattern": "^[a-zA-Z0-9_:.-]+$", "maxLength": "128" }, "displayName": { "type": "string", "maxLength": "100" }, "description": { "type": "string", "maxLength": "200" }, "isActive": { "type": "boolean" }, "matchPattern": { "type": "string" }, "matchType": { "type": "string", "enum": [ "EXACT", "WILDCARDS", "REGEX" ] }, "restMethods": { "type": "array", "items": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] } }, "priority": { "type": "integer", "minimum": "1", "maximum": "9999" }, "isRequireIdentitySourcesFiltering": { "type": "boolean" }, "filteringType": { "type": "string", "enum": [ "INCLUDE", "EXCLUDE" ] }, "identitySourceIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "assetTemplates": { "type": "array", "items": { "$ref": "#/components/schemas/ManagedAssetTemplateApiMappingDto" } } }, "required": [ "mapperId", "displayName", "isActive", "matchPattern", "matchType", "restMethods", "priority", "isRequireIdentitySourcesFiltering", "assetTemplates" ] }, "ManagedAssetTemplateApiMappingDto": { "type": "object", "properties": { "templateId": { "type": "string" }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/ManagedAssetTemplateAttributeDto" } }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/ManagedAssetTemplateActionDto" } } } }, "ManagedAssetTemplateAttributeDto": { "type": "object", "properties": { "attributeId": { "type": "string" }, "source": { "type": "string", "enum": [ "BODY", "HEADER", "PATH", "URI_REGEX", "QUERY" ] }, "path": { "type": "string" } } }, "ManagedAssetTemplateActionDto": { "type": "object", "properties": { "actionId": { "type": "string" }, "source": { "type": "string", "enum": [ "BODY", "HEADER", "METHOD", "PATH", "URI_REGEX", "QUERY" ] }, "value": { "type": "string" }, "path": { "type": "string" } } } } } } ````