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
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.
    Chris07 FEB 20222022 Springadded getOldVersion (DOKU-2321)


    ...

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

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

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

    POST
    as of 2021 Summer    		postCatalogJSON

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

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

    PATCH
    as of 2021 Summer    		updateCatalogJSON

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

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

    GET
    as of 2021 Summer    		validateEntriesJSON

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

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

    GET
    as of 2020 Autumn    		getFormJSON

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

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

    POST
    as of 2020 Autumn    		createJSON

    Insert excerpt
    POST /api-web/api/dms/objects
    POST /api-web/api/dms/objects
    nopaneltrue

    /api-web/api/dms/objects

    GET
    as of 2020 Autumn    		getMetadataJSON

    Insert excerpt
    GET /api-web/api/dms/objects/{id}
    GET /api-web/api/dms/objects/{id}
    nopaneltrue

    /api-web/api/dms/objects/{id}

    DELETE
    as of 2020 Autumn    		delete dms objectHTTP status code

    Insert excerpt
    DELETE /api-web/api/dms/objects/{id}
    DELETE /api-web/api/dms/objects/{id}
    nopaneltrue

    /api-web/api/dms/objects/{id}

    PATCH
    as of 2020 Autumn    		updateJSON

    Insert excerpt
    PATCH /api-web/api/dms/objects/{id}
    PATCH /api-web/api/dms/objects/{id}
    nopaneltrue

    /api-web/api/dms/objects/{id}

    GET
    as of 2020 Autumn    		getContentJSON

    Insert excerpt
    GET /api-web/api/dms/objects/{id}/contents/file
    GET /api-web/api/dms/objects/{id}/contents/file
    nopaneltrue

    /api-web/api/dms/objects/{id}/contents/file

    POST
    as of 2020 Autumn    		update content of dms objectJSON

    Insert excerpt
    POST /api-web/api/dms/objects/{id}/contents/file
    POST /api-web/api/dms/objects/{id}/contents/file
    nopaneltrue

    /api-web/api/dms/objects/{id}/contents/file

    GET
    as of 2020 Autumn    		getAllVersionsJSON

    Insert excerpt
    GET /api-web/api/dms/objects/{id}/versions
    GET /api-web/api/dms/objects/{id}/versions
    nopaneltrue

    /api-web/api/dms/objects/{id}/versions

    GET
    as of 2020 Autumn    		getMetadataJSON

    Insert excerpt
    GET /api-web/api/dms/objects/{id}/versions/{version}
    GET /api-web/api/dms/objects/{id}/versions/{version}
    nopaneltrue

    /api-web/api/dms/objects/{id}/versions/{version}

    GET
    as of 2022 Spring    		getOldVersionJSON

    Insert excerpt
    GET /api-web/api/dms/objects/{id}/versions/{Nr}/actions/restore
    GET /api-web/api/dms/objects/{id}/versions/{Nr}/actions/restore
    nopaneltrue

    /api-web/api/dms/objects/{id}/versions/{Nr}/actions/restore

    POST
    as of 2020 Autumn    		searchJSON

    Insert excerpt
    POST /api-web/api/dms/objects/search
    POST /api-web/api/dms/objects/search
    nopaneltrue

    /api-web/api/dms/objects/search

    POST
    as of 2022 Winter    		search and export objects as CSV fileCSV
    Insert excerpt
    POST /api-web/api/dms/objects/export
    POST /api-web/api/dms/objects/export
    nopaneltrue

    /api-web/api/dms/objects/export

    ...