Versions Compared

Old Version 1

changes.mady.by.user Technische Redaktion

Saved on

compared with

New Version Current

changes.mady.by.user Technische Redaktion

Saved on

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
Antje18 MAY 20212021 SummerPage created.
Agnieszka02 JUNE 20212021 SummerrLANG



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_TENANT_ADMIN role.

>> AUTHENTICATION Service
Description


Excerpt

Retrieves the catalog specified by its

name qname, with optional restriction to either

technical name of either global/app-specific or tenant-specific

or global resource

origin.

If necessary

Behind the technical name, add the query parameter ?global=

true

false (?global=

false

true) for a

global

tenant-specific (

tenant

app-specific or global) catalog

with name qname

. The endpoint returns null

,

if no catalog with qname is available in the

global (

tenant-specific

) resource.

If no query parameter is specified, 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 required.

(app-specific or global) resource. 

Response HTTP status codes:

HTTP Status CodeMeaning
200 
200
OK
Successful.
400 
400
Bad Request
Not successful.
401 
401
Unauthorized
Not successful.
404 
404
Not found
Not successful.


Request Example

https://<host>/api-web/api/admin/dms/catalogs/

entries

appInvoice:type?global=true

no request body

Response Example

200 OK

Code Block
languageyml
titleresponse body
{

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

      "disabled": false
    },
    {
      "name": "Public",
      "disabled": false
    }
  ]
}