This API is designed to support CREATE and UPDATE operations to the indicated Environment. An import operation occurs when a new applicationId is used. An update operation occurs if the applicationId already exists.
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"` |
| 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.
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.
Authorization Workspace ID. This can be found in your Authorization Workspace Settings under Workspace ID.
Fields to update in the Application
{
"applicationId": "accountsApp",
"displayName": "Bank Accounts Application",
"description": "This is the Bank's Application for Accounts",
"logoUrl": "https://logourl.com",
"colorIndication": "#85574A",
"assetTemplateIds": [
"accounts",
"loans"
]
}Application
Unique identifier for the Application.
Application Name
Application Description
Application Logo URL
Application Color
List of Asset Templates IDs that are associated with this Application.
Successful operation
{
"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"
]
}
}Application
Application
Unique identifier for the Application.
Application Name
Application Description
Application Logo URL
Application Color
List of Asset Templates IDs that are associated with this Application.
Validation Error
{
"errors": [
{
"code": "APV-004",
"args": {
"0": "appId",
"path": "$.id"
},
"id": "EBS8Z6",
"status": "400",
"name": "applicationIdUniquenessError",
"message": "Application ID: [appId] must be unique"
}
]
}Response object
Unauthorized
Forbidden
Object not found
Payload Validation Error
Internal Server Error