Page tree
Skip to end of metadata
Go to start of metadata

 

In addition to the standard application metadata (such as name, version, and description) that you specify when you add an app to Apperian, you can manage custom metadata that is unique and meaningful to your business. For example, say your organization is a university and you manage multiple apps for students and faculty. You can use custom metadata to store values for School, Major, Year of Study, Campus, and so on. 

To define your custom metadata fields, you enter a template on the Settings page. Using JSON (JavaScript Object Notation) format, the template can define data types as text fields, password fields, checkboxes, and lists. For instructions on defining the template and entering valid JSON, see Define a Custom Metadata Template.

 

Add, Edit, and View Custom Metadata

Once the template is saved in Apperian, the custom metadata fields you defined will appear in a "Custom Metadata" section on the Add New Application and Edit Application pages for any application type.
  

 Click here to view an example of custom metadata fields on the Add Application page...

You will also be able to see any custom metadata specified for an app on the app's Details page.

Manage Custom Metadata with API Requests

If you are an Apperian API user, you can send/receive custom metadata with your API requests/responses. Note that you do not need to define a custom metadata template for your organization in order to send custom metadata via the API. The request simply needs to include a custom metadata object in the supported JSON data format.

For instructions on specifying custom metadata for an app via the API, see PUT /applications/<app_psk>

For instructions on listing custom metadata for an app via the API, see GET /applications/<app_psk>.

  • No labels