Versions Compared

Key

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

...

Page Properties
hiddentrue
idPROGRESSDONE

Product Version
Report Note
AssigneeInga

Resources & Remarks

  • 16 Jan 2020 - page created (Inga)
    ToDo - short term - the information of the endpoints should be available as a brief overview (similar to the core API overview endpoint tables). A link to the provided Swagger UI should point the system integrator as well as the administrator into that direction. Background - if you do not have the yuuvis® installed yet the Swagger UI won't be available (e.g. https://momentum23.enaioci.net/api-web/swagger-ui.html#/).

    Located in https://help.optimal-systems.com/yuuvis_develop/pages/viewpage.action?pageId=40141818 all available controller should be described somehow - including the information from the Jira issues's description (https://jira.optimal-systems.de/browse/DOKU-761)

    Note: for accessing the admin-controller special roles are needed for the Administrator. Similar behavior for the System Integrator - a special role needs to be assigned to be able to set up calls - check the rights for the other controller as well ...

  • For a quick try out without the need to install yuuvis® Momentum, consider our yuuvis® Ultimate SaaS (Software as a Service) offer. Keep in mind that you need to set up a (free) account.

    (error) LINK to the SWAGGER UI and back ...

Modification History

NameDateProduct VersionAction
Antje08 FEB 20212.4New page properties macro.
Agnieszka02 JUNE 20212.4rLANG


...

HTTP Method
as of product version
PurposeResponse FormatDescription
GET
as of 2021 Summer
getCatalogNamesJSON

Insert excerpt
GET /api-web/api/admin/dms/catalogs/{qname}
GET /api-web/api/admin/dms/catalogs/{qname}
nopaneltrue

/api-web/api/admin/dms/catalogs

GET
as of 2021 Summer
getCatalog JSON

Insert excerpt
GET /api-web/api/admin/dms/catalogs/{qname}
GET /api-web/api/admin/dms/catalogs/{qname}
nopaneltrue

/api-web/api/admin/dms/catalogs/{qname}

POST
as of 202
1 Summer
postCatalog JSON

Insert excerpt
POST /api-web/api/admin/dms/catalogs/{qname}
POST /api-web/api/admin/dms/catalogs/{qname}
nopaneltrue

/api-web/api/admin/dms/catalogs/{qname}

PATCH
as of 2021 Summer
updateCatalog JSON

Insert excerpt
PATCH /api-web/api/admin/dms/catalogs/{qname}
PATCH /api-web/api/admin/dms/catalogs/{qname}
nopaneltrue

/api-web/api/admin/dms/catalogs/{qname}

GET
as of 2020 Autumn

getForm JSON

Insert excerpt
GET /api-web/api/admin/dms/forms/{objecttype}
GET /api-web/api/admin/dms/forms/{objecttype}
nopaneltrue

/api-web/api/admin/dms/forms/{objecttype}

POST
as of 2020 Autumn

postForm 

JSON

Insert excerpt
POST /api-web/api/admin/dms/forms/{objecttype}
POST /api-web/api/admin/dms/forms/{objecttype}
nopaneltrue

/api-web/api/admin/dms/forms/{objecttype}

GET
as of 2020 Winter

getConfig JSON

Insert excerpt
GET /api-web/api/admin/resources/config/{name}
GET /api-web/api/admin/resources/config/{name}
nopaneltrue

/api-web/api/admin/resources/config/{name}

POST
as of 2020 Winter
postConfig HTTP status code

Insert excerpt
POST /api-web/api/admin/resources/config/{name}
POST /api-web/api/admin/resources/config/{name}
nopaneltrue

/api-web/api/admin/resources/config/{name}

GET
as of 2020 Autumn

getIcon 

SVG

Insert excerpt
GET /api-web/api/admin/resources/icon/{path}
GET /api-web/api/admin/resources/icon/{path}
nopaneltrue

/api-web/api/admin/resources/icon/{path}

POST
as of 2020 Autumn

postIcon

HTTP status code

Insert excerpt
POST /api-web/api/admin/resources/icon/{path}
POST /api-web/api/admin/resources/icon/{path}
nopaneltrue

/api-web/api/admin/resources/icon/{path}

GET
as of 2020 Autumn

getLocalizedTextResources 

JSON

Insert excerpt
GET /api-web/api/admin/resources/text
GET /api-web/api/admin/resources/text
nopaneltrue

/api-web/api/admin/resources/text

POST
as of 2020 Autumn
postLocalizedTextResources HTTP status code

Insert excerpt
POST /api-web/api/admin/resources/text/{locale}
POST /api-web/api/admin/resources/text/{locale}
nopaneltrue

/api-web/api/admin/resources/text/{locale}

GET
as of 2020 Autumn

getSupportedLanguages 

JSON

Insert excerpt
GET /api-web/api/admin/resources/text/languages
GET /api-web/api/admin/resources/text/languages
nopaneltrue

/api-web/api/admin/resources/text/languages