Export Asset Template
  • 23 Sep 2024
  • 3 Minutes to read
  • Dark
    Light
  • PDF

Export Asset Template

  • Dark
    Light
  • PDF

Article summary

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

Export Asset Template in 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 Location
  • United States (US) - `https://api.us1.plainid.io`
  • Canada (CA) - `https://api.ca1.plainid.io`
  • Europe (EU) - `https://api.eu1.plainid.io`
  • Cloud PAA - `https://api.plainid.local`

  • 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
    HeaderValuecURL Line
    Accept`text/plain;language=rego``-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.

    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.

    assetTemplateId
    stringRequired

    The Asset Template ID

    Responses
    200

    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\"" ]
    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

    *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
    string
    integer
    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[ "\"NO\"", "\"ONLY_ON_CREATE\"", "\"ALWAYS\"" ]
    actions
    Array of object (Action)
    object

    Action

    actionId
    string

    Action ID

    Min length1
    Max length100
    type
    string

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

    value
    string

    Action Value

    Max length1000
    400

    Validation Error

    Headers
    x-request-id
    string
    The ID of the request
    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
    validationError
    {
      "errors": [
        {
          "code": "ATV-001",
          "id": "EQ7CMX",
          "message": "Asset Template: [non-existing-id] not found in Environment: [2d4a0591-dfe4-45fb-8a69-d183f5c75c0d]",
          "name": "AssetTemplateNotFoundError",
          "status": "404"
        }
      ]
    }
    Expand All
    object

    Response object

    errors
    Array of object (Error)
    object
    args
    object
    path
    string
    code
    string
    id
    string
    message
    string
    name
    string
    status
    integer
    500

    Internal Server Error

    Headers
    x-request-id
    string
    The ID of the request

    Was this article helpful?