Versions Compared

Old Version 167

changes.mady.by.user Annegret Bernhardt

Saved on

compared with

New Version 168

changes.mady.by.user Annegret Bernhardt

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: note_allowlist_blocklist added

...

Table Filter
fixedCols
totalrow,,,
hidelabelsfalse
ddSeparator
sparkNameSparkline
hidePaneFiltration panel
customNoTableMsgText
limitHeight
sparklinefalse
default,,
isFirstTimeEntertrue
cell-width250,250,250
hideColumnsfalse
totalRowName
totalColName
customNoTableMsgfalse
disabledfalse
enabledInEditorfalse
globalFiltertrue
id1695709478759_-341880947
iconfilter
order1,2,0
hideControlstrue
inversefalse,false,false
numbering
datefilter
column
sortGroup ⇧,Name ⇧
totalcol
disableSavefalse
rowsPerPage
separatorPoint (.)
labelsName‚Chapter‚Filter whole table
thousandSeparator
ignoreFirstNrows
ddOperator
userfilterName,Chapter
datepatterndd M yy
numberfilter
heightValue
updateSelectOptionsfalse
worklog365|5|8|y w d h m|y w d h m
isORAND
showNRowsifNotFiltered


ChapterNameExcerptUsage
Generaladding_versions


Multiexcerpt
MultiExcerptNameadding_versions

To create a new version, click (go to The Concepts of API Management > Versioning for detailed information).


Generalapi_learn_more


Multiexcerpt
MultiExcerptNameapi_learn_more

Use the Learn More button on the API that you want to consume.

This will open the API's details.


General
Policiescors_policy_chain_textcreate_button


Multiexcerpt
MultiExcerptNamecreate_button

No matter where you are in the API Management, the Create button Image Removed is always displayed at the bottom right and opens the creation menu.

cors_policy_chain_text

API Management sets the CORS headers in the following order:

  1. CORS headers from the CORS policy have the highest priority.
  2. If no CORS policy has been defined, CORS headers from the external API are used.
Tip

For detailed explanations about Cross-Origin Resource Sharing (CORS) visit the official Mozilla documentation.



Generalcreate_buttonGeneralcreation_wizard


Multiexcerpt
MultiExcerptNamecreationcreate_wizardbutton

No matter where you are in the API Management, the Create button Image Added is always displayed at the bottom right and opens the creation menu.


Generalcreation_wizard


Multiexcerpt
MultiExcerptNamecreation_wizard

A wizard will now guide you through the creation process.

First you need to enter the mandatory

A wizard will now guide you through the creation process.

First you need to enter the mandatory settings:

  • Name: Enter a name. The name is not changeable after creation.

  • Version: Enter a version number or name.
Info

You can enter numbers and text in field Version. Go to The Concepts of API Management > Versioning for detailed information.

You can then enter a description. The description is optional and can also be entered or changed later on the details page.

Click Next to continue.


Generalenable_delete_button


Multiexcerpt
MultiExcerptNameenable_delete_button

The Delete button is only enabled if you activate the checkbox.


APIsPoliciesinfo_testingjava_apissyntax


Multiexcerpt
MultiExcerptNameinfo_testingjava_apissyntax


Info

Testing of API configurations is only possible with REST APIs that are coming with an OpenAPI Specification.

Regular expressions must be written in Java syntax.



Policiesinfo_stateful_request_payloadGeneralplan_sign_up


Multiexcerpt
MultiExcerptNameplaninfo_stateful_signrequest_up

In the Plans section, you find all available plans for the API and information on whether approval is required for a plan.

Click the Sign Up button on the plan you want to register for.

payload


Info

If you want to cache POST requests, you have to enable stateful request payload inspection in the settings of your API.



APIsinfo_testing_apisGeneralsuccessful_deletion


Multiexcerpt
MultiExcerptNamesuccessfulinfo_testing_deletion

A toast message indicates successful deletion.

apis


Info

Testing of API configurations is only possible with REST APIs that are coming with an OpenAPI Specification.



Policiesnote_allowlist_blocklistGeneraltip_infos_about_policies


Multiexcerpt
MultiExcerptNametipnote_infosallowlist_about_policiesblocklist
Tip

Refer to chapter Policies for an overview of the standard policies supplied with Scheer PAS API Management. Page Attaching Policies explains how to attach and configure a policy.

General


Note

An BLOCKLIST policy overrides an ALLOWLIST policy.



Policiestip_navigationnote_api_behind_proxy


Multiexcerpt
MultiExcerptNametip_navigation
Tip

For detailed information about navigating and filtering the list go to Working With the API Management.

General
note_api_behind_proxy


Note

Please disable the TLS check if you are using Scheer PAS 21.1 or a newer version, because all PAS components are running behind a proxy server.




Generalplan_sign_uptip_visibility_concept


Multiexcerpt
MultiExcerptNametipplan_visibilitysign_concept
Tip

For detailed information about the visibility concept, visit page The Concepts of API Management.

up

In the Plans section, you find all available plans for the API and information on whether approval is required for a plan.

Click the Sign Up button on the plan you want to register for.


Generalsuccessful_deletionPoliciescors_policy_chain_text


API Management sets the CORS headers in the following order:

  1. CORS headers from the CORS policy have the highest priority.
  2. If no CORS policy has been defined, CORS headers from the external API are used.
Multiexcerpt
MultiExcerptNamecors_policy_chain_text
Tip

For detailed explanations about Cross-Origin Resource Sharing (CORS) visit the official Mozilla documentation.

successful_deletion

A toast message indicates successful deletion.


Generaltip_infos_about_policiesPoliciesinfo_java_syntax


Multiexcerpt
MultiExcerptNameinfotip_infos_javaabout_syntaxpolicies
Info

Regular expressions must be written in Java syntax.


Tip

Refer to chapter Policies for an overview of the standard policies supplied with Scheer PAS API Management. Page Attaching Policies explains how to attach and configure a policy.



Generaltip_navigationPoliciesinfo_stateful_request_payload


Multiexcerpt
MultiExcerptNameinfo_stateful_request_payload
Info

If you want to cache POST requests, you have to enable stateful request payload inspection in the settings of your API.

tip_navigation


Tip

For detailed information about navigating and filtering the list go to Working With the API Management.



Generaltip_visibility_conceptPoliciesnote_api_behind_proxy


Please disable the TLS check if you are using Scheer PAS 21.1 or a newer version, because all PAS components are running behind a proxy server.
Multiexcerpt
MultiExcerptNamenotetip_apivisibility_behind_proxyconcept
Note


Tip

For detailed information about the visibility concept, visit page The Concepts of API Management.




Policiesxxx




Excerpts up to Version 23.1.1

...