Export Application

  • Updated on Jan 6, 2025
  • Published on Nov 24, 2024
  • 2 minute(s) read
Prev Next
Get
/api/1.0/applications/{envId}/{appId}

Export Application from the indicated Environment. This API is designed to support EXPORT (read) operations in Application.

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"`

    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.

    appId
    stringRequired

    Unique identifier for the Application. You can find the Application ID in the relevant Application's Details section in the Platform.

    Responses
    200

    Successful operation

    Headers
    x-request-id
    string
    The ID of the request
    example
    {
  "data": {
    "applicationId": "accountsApp",
    "displayName": "Bank Accounts Application",
    "description": "This is the Bank's Application for Accounts",
    "logoUrl": "https://logourl.com",
    "colorIndication": "#85574A",
    "assetTemplateIds": [
      "accounts",
      "loans"
    ]
  }
}
    Expand All
    object

    Application

    data
    object (Application)

    Application

    applicationId
    string

    Unique identifier for the Application.

    Min length1
    Max length128
    Pattern^[a-zA-Z0-9_:.-]+$
    displayName
    string

    Application Name

    Min length1
    Max length100
    description
    string

    Application Description

    Max length200
    logoUrl
    string (uri)

    Application Logo URL

    colorIndication
    string

    Application Color

    assetTemplateIds
    Array of string

    List of Asset Templates IDs that are associated with this Application.

    string
    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": "APV-001",
      "id": "EQ7CMX",
      "status": "404",
      "name": "ApplicationNotFoundError",
      "message": "Application: [non-existing-id] not found in Environment: [2d4a0591-dfe4-45fb-8a69-d183f5c75c0d]"
    }
  ]
}
    Expand All
    object

    Response object

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

    Internal Server Error

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