Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Page Properties
hiddentrue
idDONE

Product Version
Report Note
Assignee

Resources & Remarks

Modification History

NameDateProduct VersionAction
Antje19 MAY 20212021 SummerPage created.
Antje14 JUL 20222022 Autumnadd optional 'tenant' query parameter



As of Version

product version 2021 Summer | component version 

Request MethodGET
Response FormatJSON
Required Permission

Available if listed in authorization.accesses in authentication-prod.yml and the specified access condition is matched. In the default configuration, access is granted via the YUUVIS_SYSTEM_INTEGRATOR role.

>> AUTHENTICATION Service
Description


Excerpt

Retrieves the global or app-specific catalog specified by its name qname, with optional restriction to either tenant-specific or global resource.

If necessary, add the query parameter ?global=true (?global=false) for a global (tenant-specific) catalog with name qname. The endpoint returns null, if no catalog with with qname is available was found in the both global (tenantand app-specific ) resource.If no

As of 2022 Autumn, an optional query parameter is specified,  tenant can be specified in order to retrieve the tenant-specific resource will be checked first. If a catalog with name qname is available, it will be returned. Otherwise the global resource will be checked. If there is a catalog with name qname, it will be returned. The endpoint returns null if no catalog with qname was found in both global and tenant-specific resource.The role YUUVIS_TENANT_ADMIN is requiredcatalog instead of the global or app-specific one.

Response HTTP status codes:

HTTP Status CodeMeaning
200 200 OK
Successful.401 401 Unauthorized
Not successful.404 404 Not foundNot successful.


Request Example

https://<host>/api-web/api/system/dms/catalogs/entries?global=trueno appInvoice:type

No request body

Response Example

200 OK

Code Block
languageyml
{
	
  "readonly": false,
  "entries": [
   		{
			"disabled {
      "name": true,
			"name": "string"
		}
	],
	"readonly": true,
	"tenant": "string""Private",
      "disabled": false
    },
    {
      "name": "Public",
      "disabled": false
    }
  ]
}