Using abbreviation management for API metadata, you are able simplify complex terms, improve efficiency, aid effective communication of API metadata information, and most importantly save time and space. You can create or delete abbreviations or acronyms that are used with API metadata to help clarify their meaning, avoid confusion and maintain consistency.
Creating abbreviations for API metadata
You can create an abbreviation for an API metadata by following these steps:
- Select the Administration link from the top navigation menu or the Administration task feature link options within the body of the Home page. This will show you the Administration page with a 3 section grouping of administration tasks that can be performed including:
- User data
- Reports
- System administration
- Select the Abbreviations option under the System administration section. This will show you the Abbreviations page including:
- an abbreviations search form with a search button and a Clear search link
- Create a new abbreviation link
- abbreviations listing in alphabetical order with abbreviation, description and a delete action link.
- Select the Create a new abbreviation link located above the abbreviations listings table. This will show you the Add an abbreviation page for you to add the new abbreviation.
- Enter a abbreviation into the Abbreviation textbox and a description into the Description textbox.
- Select the Save abbreviation button to save and add the new abbreviation. Or the Return to abbreviations link to cancel.
Viewing abbreviations for API metadata
You can view an abbreviation for an API metadata by following these steps:
- Select the Administration link from the top navigation menu or the Administration task feature link options within the body of the Home page. This will show you the Administration page with a 3 section grouping of administration tasks that can be performed including:
- User data
- Reports
- System administration
- Select the Abbreviations option under the System administration section. This will show you the Abbreviations page including:
- an abbreviations search form with a search button and a Clear search link
- Create a new abbreviation link
- abbreviations listing in alphabetical order with abbreviation, description and a delete action link.
- Locate the abbreviation you wish to view description from the abbreviation listing (which may span several pages) using the pagination Previous or Next controls or by searching the listing using the search form and following the steps detailed in the Searching abbreviations for API metadata to find the abbreviation you wish to view description or abbreviation.
Searching abbreviations for API metadata
You can search for an abbreviation for an API metadata by following these steps:
- Select the Administration link from the top navigation menu or the Administration task feature link options within the body of the Home page. This will show you the Administration page with a 3 section grouping of administration tasks that can be performed including:
- User data
- Reports
- System administration
- Select the Abbreviations option under the System administration section. This will show you the Abbreviations page including:
- an abbreviations search form with a search button and a Clear search link
- Create a new abbreviation link
- abbreviations listing in alphabetical order with abbreviation, description and a delete action link.
- Type an abbreviations, acronyms, word or phrase for the API metadate you wish to find into the Search box within the search form. The search function allows you to search for API metadata abbreviations and their description. You will have the options to apply pagination before or after your search.
The relevant result is returned from any matches.
You can clear the search using the Clear search link next to the Search button.
Applying Pagination
You can change the number of results you wish returned per page using the Display results dropdown box option.
Search is not case sensitive. Applying pagination will add the pagination controls 'Next' and 'Previous' links to the page display.
Deleting abbreviations for API metadata
You can delete the abbreviation for an API metadata by following these steps:
- Select the Administration link from the top navigation menu or the Administration task feature link options within the body of the Home page. This will show you the Administration page with a 3 section grouping of administration tasks that can be performed including:
- User data
- Reports
- System administration
- Select the Abbreviations option under the System administration section. This will show you to the Abbreviations page including:
- an abbreviations search form with a search button and a Clear search link
- Create a new abbreviation link
- abbreviations listing in alphabetical order with abbreviation, description and a delete action link.
- Locate the abbreviation you wish to delete from the abbreviation listing (which may span several pages) or search the list using the search form and following the steps detailed in the Searching abbreviations for API metadata to find the abbreviation you wish to delete, browse
- Select the Delete link under the to the Actions colunmn of the abbreviation entry listing. This will show you the Delete abbreviation confirmation page.
- Select the Delete button to confirm and delete the abbreviation. Or the Return to abbreviations link to cancel.