Export Asset Template from the indicated Environment. This API is designed to support EXPORT (read) operations in Asset Templates.
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.
The Asset Template ID
Successful operation
{
"data": {
"templateId": "Bank Accounts",
"displayName": "Bank Accounts",
"description": "This Asset Template describes the bank accounts",
"logoUrl": "url",
"source": "EXTERNAL",
"paaGroupId": "my_paa_group",
"viewName": "accounts",
"isAttributeSentInRequest": false,
"isUsedForFiltering": false,
"attributes": [
{
"attributeId": "accountnum",
"displayName": "accountNum",
"type": "STRING",
"maxLength": 21,
"isRequired": false,
"isMultiValue": true,
"canBeUpdated": "ONLY_ON_CREATE",
"isAvailableForPolicies": true,
"nameForRequest": "accountNum",
"sourceAttribute": "accountNumber"
},
{
"attributeId": "accounttype",
"displayName": "accountType",
"type": "STRING",
"maxLength": 21,
"isRequired": false,
"isMultiValue": false,
"canBeUpdated": "ALWAYS",
"isAvailableForPolicies": true,
"nameForRequest": "accountType",
"sourceAttribute": "accountType"
}
],
"actions": [
{
"actionId": "Approve",
"value": "Approve"
},
{
"actionId": "Update",
"value": "Update123"
}
]
}
}Asset Type
Asset Type
A display name that acts as a label for your Asset Template.
A unique string for the Asset Template.
A description for your Asset Template.
Logo URL for the Asset Template.
Repository type. This parameter refers to the location of your Assets.
Note that some parameters are required based on the repository type.
*Required if using "source": "EXTERNAL" or "source": "PLAINID"
Indicates if Asset Attributes in the request can override the source.
Indicates if the Asset Template is used for data filtering.
*Required if using "source": "EXTERNAL".
PAA Group ID. PAA Groups at the Tenant level have a suffix of _GLOBAL
*Required if using "source": "EXTERNAL".
Asset Template View name. The View Name that supports the External Asset as predefined in the PIP Settings
Attribute
A display name that acts as a label for your Attribute.
A unique string for the Attribute.
Attribute Data Type
*Required if using "source": "EXTERNAL".
Source Attribute name for the Attribute as defined in the View.
Indicates if the Attribute is allowed for Policies.
The name of the Attribute as it should appear in an Authorization Request.
*Required if using "source": "EXTERNAL" or "source": "PLAINID".
Indicates if the Attribute accepts either a single or multi value. If set to false, the Attribute accepts a single value. If set to true, the Attribute accepts a multivalue.
*Required if using "source": "PLAINID".
Default Values for the Attribute.
*Required if using "source": "PLAINID".
Attribute maximum length
*Required if using "source": "PLAINID".
Indicates if the Attribute is required.
*Required if using "source": "PLAINID".
Indicates if the PlainID Attribute can be updated.
Action
Action ID
Action Value
Action Type. This parameter is only relevant for Orchestration Asset Templates.
Validation Error
Unauthorized
Forbidden
Object not found
{
"errors": [
{
"code": "ATV-001",
"id": "EQ7CMX",
"status": "404",
"name": "AssetTemplateNotFoundError",
"message": "Asset Template: [non-existing-id] not found in Environment: [2d4a0591-dfe4-45fb-8a69-d183f5c75c0d]"
}
]
}Response object
Internal Server Error