Export API Mapper Set from the indicated Environment. This API is designed to support EXPORT (read) operations in API Mapper Sets.
Notice
Accessing the APIs is through a dedicated domain/URL, according to your PlainID Tenant LocationUsing HTML Encoded Special Characters
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.
Important note about headers
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.
Headers
*Required| Header | Value | cURL Line |
|---|---|---|
| Accept | `application/json` | `-H "Accept:application/json"` |
cURL Sample Guidelines
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. They will then appear in the cURL sample on the bottom of the page in the correct format.
For more details about Administration API Authentication, check out the Authentication APIs documentation. Provide your bearer token in the Authorization header when making requests to protected resources. Example: Authorization: Bearer 123
The Environment ID can be found under the Details Tab in the Environment Settings.
API Mapper Set Unique Identifier.
Successful operation
{
"data": {
"apiMappersSetId": "App1",
"applicationIds": [
"App1"
],
"apiMappers": [
{
"mapperId": "mapper_1",
"displayName": "mapper-1",
"isActive": true,
"matchPattern": "/bank/*/accountNum/**",
"matchType": "EXACT",
"restMethods": [
"GET",
"POST"
],
"priority": 1,
"isRequireIdentitySourcesFiltering": true,
"filteringType": "INCLUDE",
"identitySourceIds": [
"sourceId1234567"
],
"assetTemplates": [
{
"templateId": "accounts",
"attributes": [
{
"attributeId": "acctType",
"source": "PATH",
"path": "[0]"
}
],
"actions": [
{
"actionId": "read",
"source": "BODY",
"value": "fetchData",
"path": "$.function"
}
]
},
{
"templateId": "loans",
"attributes": [],
"actions": []
}
]
},
{
"mapperId": "mapper_2",
"displayName": "mapper-2",
"description": "desc",
"isActive": true,
"matchPattern": "/bank/*/loans/**",
"matchType": "EXACT",
"restMethods": [
"POST"
],
"priority": 2,
"isRequireIdentitySourcesFiltering": false,
"filteringType": "INCLUDE",
"identitySourceIds": [
"sourceId1234567"
],
"assetTemplates": [
{
"templateId": "loans",
"attributes": [],
"actions": []
}
]
}
]
}
}API Mapper Set
API Mapper Set
API Mapper Set Unique Identifier.
Associated Application IDs. These IDs can be found in the individual Application Details section under Application ID.
API Mapper
API Mapper Unique Identifier. This can be found the API Mappers details section within the relevant Application.
API Mapper Name
API Mapper Description
Indicates if the Mapper is active.
The URL pattern to which the Mapper applies.
Indicates if the matching is performed using a wildcard or exact match.
HTTP Methods that are applicable for the pattern.
Mapper priority. Set the API Mapper priority to adjust the processing priority. For more information, see Managing API Mappers.
Indicates if the API Mapper requires Identity Source filtering.
Indicates which Identity Source filtering type is required. This parameter is required if isRequireIdentitySourcesFiltering is set to true.
Indicates which Identity Sources need to be filtered. This parameter is required if isRequireIdentitySourcesFiltering is set to true. This can be located in the Attribute Source tab in the Identity Workspace Settings.
A list of Asset Templates associates with the API Mappers. You can locate Asset Template IDs under the relevant Assets' Details tab.
asset template api mapping
Asset Template unique identifier. You can locate the relevant Asset Template ID under the relevant Asset details.
List of Attributes associated with the Asset Template containing API Mappers. You can locate the relevant Attribute IDs under the relevant Assets' Asset Attribute tab.
Attribute unique identifier. You can locate the relevant Attribute ID under the relevant Asset's Asset Attribute tab.
Attribute Source. You can locate it in the Attribute Mapping Settings section under the relevant Asset Type's Asset Attribute.
JSON Path or relevant Path for the Attribute. You can locate it in the Attribute Mapping Settings section under the relevant Asset Type's Asset Attribute tab.
A list of Actions associated with the Asset Template. You can locate the relevant Action IDs under the relevant Assets' Actions tab.
Action unique identifier. You can locate the relevant Action ID under the relevant Asset Type's Actions tab.
Action source. You can locate it in the API Action Mappers section under the relevant Asset Type's Action tab.
Action value. You can locate it in the API Action Mappers section under the relevant Asset Type's Action tab.
Action path. You can locate it in the API Action Mappers section under the relevant Asset Type's Action tab.
Validation Error
Unauthorized
Forbidden
Object not found
{
"errors": [
{
"code": "APIV-001",
"id": "EQ7CMX",
"status": "404",
"name": "ApiMapperSetNotFoundError",
"message": "Api Mapper Set: [non-existing-id] not found in Environment: [2d4a0591-dfe4-45fb-8a69-d183f5c75c0d]"
}
]
}Response object
Internal Server Error