Import Asset Template

24 Feb 2025
6 Minutes to read

Print
Dark
Light
PDF

Import Asset Template

Updated on 24 Feb 2025
6 Minutes to read

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback!

Post

/api/1.0/asset-templates/{envId}

This API is designed to support CREATE and UPDATE operations to the indicated Environment. An import operation occurs when a new templateId is used. An update operation occurs if the templateId already exists.

Notice

Accessing the APIs is through a dedicated domain/URL, according to your PlainID Tenant Location

United States (US) - `https://api.us1.plainid.io`

Canada (CA) - `https://api.ca1.plainid.io`

Europe (EU) - `https://api.eu1.plainid.io`

Using 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"`
Content-Type	`application/json`	`-H "Content-Type: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.

Security

HTTP

Type bearer

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

Path parameters

envId

string (uuid) Required

The Environment ID can be found under the Details Tab in the Environment Settings.

Query parameters

authWsId

string (uuid) Required

Authorization Workspace ID. This can be found in your Authorization Workspace Settings under Workspace ID.

Body parameters

Fields to update in the Asset Template

example

{
  "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": false,
      "canBeUpdated": "ONLY_ON_CREATE",
      "isAvailableForPolicies": true,
      "nameForRequest": "accountNum",
      "sourceAttribute": "accountNumber"
    },
    {
      "attributeId": "accounttype",
      "displayName": "accountType",
      "type": "STRING",
      "maxLength": 21,
      "isRequired": false,
      "isMultiValue": true,
      "canBeUpdated": "ALWAYS",
      "isAvailableForPolicies": true,
      "nameForRequest": "accountType",
      "sourceAttribute": "accountType"
    }
  ],
  "actions": [
    {
      "actionId": "Approve",
      "value": "Approve"
    },
    {
      "actionId": "Update",
      "value": "Update123"
    }
  ]
}

Expand All

object

Asset Type

displayName

string Required

A display name that acts as a label for your Asset Template.

Min length1

Max length100

templateId

string Required

A unique string for the Asset Template.

Min length1

Max length128

description

string

A description for your Asset Template.

logoUrl

string

Logo URL for the Asset Template.

source

string Required

Repository type. This parameter refers to the location of your Assets.
Note that some parameters are required based on the repository type.

Valid values[ "EXTERNAL", "PLAINID", "REQUEST" ]

isAttributeSentInRequest

boolean

*Required if using "source": "EXTERNAL" or "source": "PLAINID"
Indicates if Asset Attributes in the request can override the source.

isUsedForFiltering

boolean

Indicates if the Asset Template is used for data filtering.

paaGroupId

string

*Required if using "source": "EXTERNAL".
PAA Group ID. PAA Groups at the Tenant level have a suffix of _GLOBAL

Max length128

viewName

string

*Required if using "source": "EXTERNAL".
Asset Template View name. The View Name that supports the External Asset as predefined in the PIP Settings

attributes

Array of object (Attribute)

object

Attribute

displayName

string Required

A display name that acts as a label for your Attribute.

Min length1

Max length100

attributeId

string Required

A unique string for the Attribute.

Min length1

Max length128

type

string Required

Attribute Data Type

Valid values[ "STRING", "NUMERIC" ]

isCalculated

boolean

Set whether the Attribute is calculated.

calculationFunction

string

Calculated Attribute calculation function. See Working with Calculated Attributes for more information.

sourceAttribute

string

*Required if using "source": "EXTERNAL".
Source Attribute name for the Attribute as defined in the View.

isAvailableForPolicies

boolean

Indicates if the Attribute is allowed for Policies.

nameForRequest

string Required

The name of the Attribute as it should appear in an Authorization Request.

Min length1

isMultiValue

boolean

*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.

defaultValue

Array

*Required if using "source": "PLAINID".
Default Values for the Attribute.

OneOf

string

integer

maxLength

integer

*Required if using "source": "PLAINID".
Attribute maximum length

Minimum1

Maximum9999

isRequired

boolean

*Required if using "source": "PLAINID".
Indicates if the Attribute is required.

canBeUpdated

string

*Required if using "source": "PLAINID".
Indicates if the PlainID Attribute can be updated.

Valid values[ "False", "ONLY_ON_CREATE", "ALWAYS" ]

actions

Array of object (Action)

object

Action

actionId

string Required

Action ID

Min length1

Max length100

value

string Required

Action Value

Max length1000

type

string

Action Type. This parameter is only relevant for Orchestration Asset Templates.

Responses

201

Successful operation

Headers

x-request-id

string

The ID of the request

example

{
  "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"
      }
    ]
  }
}

Expand All

object

Asset Type

data

object (AssetTemplate)

Asset Type

displayName

string

A display name that acts as a label for your Asset Template.

Min length1

Max length100

templateId

string

A unique string for the Asset Template.

Min length1

Max length128

description

string

A description for your Asset Template.

logoUrl

string

Logo URL for the Asset Template.

source

string

Repository type. This parameter refers to the location of your Assets.
Note that some parameters are required based on the repository type.

Valid values[ "EXTERNAL", "PLAINID", "REQUEST" ]

isAttributeSentInRequest

boolean

*Required if using "source": "EXTERNAL" or "source": "PLAINID"
Indicates if Asset Attributes in the request can override the source.

isUsedForFiltering

boolean

Indicates if the Asset Template is used for data filtering.

paaGroupId

string

*Required if using "source": "EXTERNAL".
PAA Group ID. PAA Groups at the Tenant level have a suffix of _GLOBAL

Max length128

viewName

string

*Required if using "source": "EXTERNAL".
Asset Template View name. The View Name that supports the External Asset as predefined in the PIP Settings

attributes

Array of object (Attribute)

object

Attribute

displayName

string

A display name that acts as a label for your Attribute.

Min length1

Max length100

attributeId

string

A unique string for the Attribute.

Min length1

Max length128

type

string

Attribute Data Type

Valid values[ "STRING", "NUMERIC" ]

isCalculated

boolean

Set whether the Attribute is calculated.

calculationFunction

string

Calculated Attribute calculation function. See Working with Calculated Attributes for more information.

sourceAttribute

string

*Required if using "source": "EXTERNAL".
Source Attribute name for the Attribute as defined in the View.

isAvailableForPolicies

boolean

Indicates if the Attribute is allowed for Policies.

nameForRequest

string

The name of the Attribute as it should appear in an Authorization Request.

Min length1

isMultiValue

boolean

defaultValue

Array

*Required if using "source": "PLAINID".
Default Values for the Attribute.

OneOf

string

integer

maxLength

integer

*Required if using "source": "PLAINID".
Attribute maximum length

Minimum1

Maximum9999

isRequired

boolean

*Required if using "source": "PLAINID".
Indicates if the Attribute is required.

canBeUpdated

string

*Required if using "source": "PLAINID".
Indicates if the PlainID Attribute can be updated.

Valid values[ "False", "ONLY_ON_CREATE", "ALWAYS" ]

actions

Array of object (Action)

object

Action

actionId

string

Action ID

Min length1

Max length100

value

string

Action Value

Max length1000

type

string

Action Type. This parameter is only relevant for Orchestration Asset Templates.

400

Validation Error

Headers

x-request-id

string

The ID of the request

validationError

{
  "errors": [
    {
      "code": "ATV-015",
      "args": {
        "0": "non_existing_paa_name_Global",
        "path": "$.paaGroupId"
      },
      "id": "EBS8Z6",
      "status": "400",
      "name": "AssetTemplatePaaGroupDoesNotExistError",
      "message": "Asset Template global PAA Group ID: [$.paaGroupId] does not exist"
    }
  ]
}

Expand All

object

Response object

errors

Array of object (Error)

object

code

string

status

integer

name

string

message

string

args

object

path

string

401

Unauthorized

Headers

x-request-id

string

The ID of the request

403

Forbidden

Headers

x-request-id

string

The ID of the request

404

Object not found

Headers

x-request-id

string

The ID of the request

422

Payload Validation Error

Headers

x-request-id

string

The ID of the request

500

Internal Server Error

Headers

x-request-id

string

The ID of the request

Was this article helpful?

What's Next

Export Asset Template